plexjava/docs/sdks/subscriptions/README.md

Subscriptions

(subscriptions())

Overview

Subscriptions determine which media will be recorded and the criteria for selecting an airing when multiple are available

Available Operations

• getAllSubscriptions - Get all subscriptions
• createSubscription - Create a subscription
• processSubscriptions - Process all subscriptions
• getScheduledRecordings - Get all scheduled recordings
• getTemplate - Get the subscription template
• cancelGrab - Cancel an existing grab
• deleteSubscription - Delete a subscription
• getSubscription - Get a single subscription
• editSubscriptionPreferences - Edit a subscription
• reorderSubscription - Re-order a subscription

getAllSubscriptions

Get all subscriptions and potentially the grabs too

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetAllSubscriptionsRequest;
import dev.plexapi.sdk.models.operations.GetAllSubscriptionsResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.BoolInt;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        GetAllSubscriptionsRequest req = GetAllSubscriptionsRequest.builder()
                .includeGrabs(BoolInt.True)
                .includeStorage(BoolInt.True)
                .build();

        GetAllSubscriptionsResponse res = sdk.subscriptions().getAllSubscriptions()
                .request(req)
                .call();

        if (res.mediaContainerWithSubscription().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GetAllSubscriptionsRequest	✔️	The request object to use for the request.

Response

GetAllSubscriptionsResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

createSubscription

Create a subscription. The query parameters should be mostly derived from the template

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.*;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        CreateSubscriptionRequest req = CreateSubscriptionRequest.builder()
                .targetLibrarySectionID(1L)
                .targetSectionLocationID(3L)
                .type(2L)
                .hints(Hints.builder()
                    .build())
                .prefs(CreateSubscriptionQueryParamPrefs.builder()
                    .build())
                .params(Params.builder()
                    .build())
                .build();

        CreateSubscriptionResponse res = sdk.subscriptions().createSubscription()
                .request(req)
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	CreateSubscriptionRequest	✔️	The request object to use for the request.

Response

CreateSubscriptionResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

processSubscriptions

Process all subscriptions asynchronously

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.ProcessSubscriptionsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        ProcessSubscriptionsResponse res = sdk.subscriptions().processSubscriptions()
                .call();

        // handle response
    }
}

Response

ProcessSubscriptionsResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

getScheduledRecordings

Get all scheduled recordings across all subscriptions

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetScheduledRecordingsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        GetScheduledRecordingsResponse res = sdk.subscriptions().getScheduledRecordings()
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Response

GetScheduledRecordingsResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

getTemplate

Get the templates for a piece of media which could include fetching one airing, season, the whole show, etc.

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetTemplateRequest;
import dev.plexapi.sdk.models.operations.GetTemplateResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        GetTemplateRequest req = GetTemplateRequest.builder()
                .guid("plex://episode/5fc70265c40548002d539d23")
                .build();

        GetTemplateResponse res = sdk.subscriptions().getTemplate()
                .request(req)
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GetTemplateRequest	✔️	The request object to use for the request.

Response

GetTemplateResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

cancelGrab

Cancels an existing media grab (recording). It can be used to resolve a conflict which exists for a rolling subscription. Note: This cancellation does not persist across a server restart, but neither does a rolling subscription itself.

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.CancelGrabRequest;
import dev.plexapi.sdk.models.operations.CancelGrabResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        CancelGrabRequest req = CancelGrabRequest.builder()
                .operationId("<id>")
                .build();

        CancelGrabResponse res = sdk.subscriptions().cancelGrab()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	CancelGrabRequest	✔️	The request object to use for the request.

Response

CancelGrabResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

deleteSubscription

Delete a subscription, cancelling all of its grabs as well

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.DeleteSubscriptionRequest;
import dev.plexapi.sdk.models.operations.DeleteSubscriptionResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        DeleteSubscriptionRequest req = DeleteSubscriptionRequest.builder()
                .subscriptionId(974618L)
                .build();

        DeleteSubscriptionResponse res = sdk.subscriptions().deleteSubscription()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	DeleteSubscriptionRequest	✔️	The request object to use for the request.

Response

DeleteSubscriptionResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

getSubscription

Get a single subscription and potentially the grabs too

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.GetSubscriptionRequest;
import dev.plexapi.sdk.models.operations.GetSubscriptionResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import dev.plexapi.sdk.models.shared.BoolInt;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        GetSubscriptionRequest req = GetSubscriptionRequest.builder()
                .subscriptionId(186713L)
                .includeGrabs(BoolInt.True)
                .includeStorage(BoolInt.True)
                .build();

        GetSubscriptionResponse res = sdk.subscriptions().getSubscription()
                .request(req)
                .call();

        if (res.mediaContainerWithSubscription().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GetSubscriptionRequest	✔️	The request object to use for the request.

Response

GetSubscriptionResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

editSubscriptionPreferences

Edit a subscription's preferences

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.*;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        EditSubscriptionPreferencesRequest req = EditSubscriptionPreferencesRequest.builder()
                .subscriptionId(673918L)
                .prefs(EditSubscriptionPreferencesQueryParamPrefs.builder()
                    .build())
                .build();

        EditSubscriptionPreferencesResponse res = sdk.subscriptions().editSubscriptionPreferences()
                .request(req)
                .call();

        if (res.mediaContainerWithSubscription().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	EditSubscriptionPreferencesRequest	✔️	The request object to use for the request.

Response

EditSubscriptionPreferencesResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

reorderSubscription

Re-order a subscription to change its priority

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.ReorderSubscriptionRequest;
import dev.plexapi.sdk.models.operations.ReorderSubscriptionResponse;
import dev.plexapi.sdk.models.shared.Accepts;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .accepts(Accepts.APPLICATION_XML)
                .clientIdentifier("abc123")
                .product("Plex for Roku")
                .version("2.4.1")
                .platform("Roku")
                .platformVersion("4.3 build 1057")
                .device("Roku 3")
                .model("4200X")
                .deviceVendor("Roku")
                .deviceName("Living Room TV")
                .marketplace("googlePlay")
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        ReorderSubscriptionRequest req = ReorderSubscriptionRequest.builder()
                .subscriptionId(440634L)
                .build();

        ReorderSubscriptionResponse res = sdk.subscriptions().reorderSubscription()
                .request(req)
                .call();

        if (res.mediaContainerWithSubscription().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	ReorderSubscriptionRequest	✔️	The request object to use for the request.

Response

ReorderSubscriptionResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*