plexcsharp/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

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetAllSubscriptionsRequest req = new GetAllSubscriptionsRequest() {
    IncludeGrabs = BoolInt.True,
    IncludeStorage = BoolInt.True,
};

var res = await sdk.Subscriptions.GetAllSubscriptionsAsync(req);

// 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
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

CreateSubscription

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

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

CreateSubscriptionRequest req = new CreateSubscriptionRequest() {
    TargetLibrarySectionID = 1,
    TargetSectionLocationID = 3,
    Type = 2,
    Hints = new Hints() {},
    Prefs = new CreateSubscriptionQueryParamPrefs() {},
    Params = new Params() {},
};

var res = await sdk.Subscriptions.CreateSubscriptionAsync(req);

// 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
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

ProcessSubscriptions

Process all subscriptions asynchronously

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(token: "<YOUR_API_KEY_HERE>");

var res = await sdk.Subscriptions.ProcessSubscriptionsAsync();

// handle response

Response

ProcessSubscriptionsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetScheduledRecordings

Get all scheduled recordings across all subscriptions

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(token: "<YOUR_API_KEY_HERE>");

var res = await sdk.Subscriptions.GetScheduledRecordingsAsync();

// handle response

Response

GetScheduledRecordingsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetTemplate

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

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetTemplateRequest req = new GetTemplateRequest() {
    Guid = "plex://episode/5fc70265c40548002d539d23",
};

var res = await sdk.Subscriptions.GetTemplateAsync(req);

// 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
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	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

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

CancelGrabRequest req = new CancelGrabRequest() {
    OperationId = "<id>",
};

var res = await sdk.Subscriptions.CancelGrabAsync(req);

// 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
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

DeleteSubscription

Delete a subscription, cancelling all of its grabs as well

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

DeleteSubscriptionRequest req = new DeleteSubscriptionRequest() {
    SubscriptionId = 974618,
};

var res = await sdk.Subscriptions.DeleteSubscriptionAsync(req);

// 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
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetSubscription

Get a single subscription and potentially the grabs too

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

GetSubscriptionRequest req = new GetSubscriptionRequest() {
    SubscriptionId = 186713,
    IncludeGrabs = BoolInt.True,
    IncludeStorage = BoolInt.True,
};

var res = await sdk.Subscriptions.GetSubscriptionAsync(req);

// 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
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

EditSubscriptionPreferences

Edit a subscription's preferences

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

EditSubscriptionPreferencesRequest req = new EditSubscriptionPreferencesRequest() {
    SubscriptionId = 673918,
    Prefs = new EditSubscriptionPreferencesQueryParamPrefs() {},
};

var res = await sdk.Subscriptions.EditSubscriptionPreferencesAsync(req);

// 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
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

ReorderSubscription

Re-order a subscription to change its priority

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    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: "<YOUR_API_KEY_HERE>"
);

ReorderSubscriptionRequest req = new ReorderSubscriptionRequest() {
    SubscriptionId = 440634,
};

var res = await sdk.Subscriptions.ReorderSubscriptionAsync(req);

// 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
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*