LukeParke/plexcsharp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-08 04:20:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.383.2

Browse Source
This commit is contained in:
speakeasybot
2024-08-30 00:10:10 +00:00
parent cc8bc7366d
commit ec1b25e152
148 changed files with 1044 additions and 954 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Models/Requests/DeleteLibraryRequest.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
| Field | Type | Required | Description | Example |
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |

6
docs/Models/Requests/Force.md
View File

@@ -1,10 +1,6 @@
# Force
Force overwriting of duplicate playlists.
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
The `force` argument is used to disable overwriting.
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
Force the refresh even if the library is already being refreshed.
## Values

8
docs/Models/Requests/GetLibrariesDirectory.md → docs/Models/Requests/GetAllLibrariesDirectory.md
View File

@@ -1,4 +1,4 @@
# GetLibrariesDirectory
# GetAllLibrariesDirectory
## Fields
@@ -18,9 +18,9 @@
| `Scanner` | *string* | :heavy_minus_sign: | N/A | Plex Movie |
| `Language` | *string* | :heavy_minus_sign: | N/A | en-US |
| `Uuid` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `UpdatedAt` | *int* | :heavy_minus_sign: | N/A | 1705615634 |
| `CreatedAt` | *int* | :heavy_minus_sign: | N/A | 1654131312 |
| `ScannedAt` | *int* | :heavy_minus_sign: | N/A | 1705615584 |
| `UpdatedAt` | *int* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `CreatedAt` | *int* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `ScannedAt` | *int* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
| `Content` | *bool* | :heavy_minus_sign: | N/A | true |
| `Directory` | *bool* | :heavy_minus_sign: | N/A | true |
| `ContentChangedAt` | *int* | :heavy_minus_sign: | N/A | 3192854 |

11
docs/Models/Requests/GetAllLibrariesMediaContainer.md Normal file
View File

@@ -0,0 +1,11 @@
# GetAllLibrariesMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_check_mark: | N/A | 5 |
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | false |
| `Title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
| `Directory` | List<[GetAllLibrariesDirectory](../../Models/Requests/GetAllLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |

4
docs/Models/Requests/GetLibrariesResponse.md → docs/Models/Requests/GetAllLibrariesResponse.md
View File

@@ -1,4 +1,4 @@
# GetLibrariesResponse
# GetAllLibrariesResponse
## Fields
@@ -8,4 +8,4 @@
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [Models.Requests.GetLibrariesResponseBody](../../Models/Requests/GetLibrariesResponseBody.md) | :heavy_minus_sign: | The libraries available on the Server |
| `Object` | [Models.Requests.GetAllLibrariesResponseBody](../../Models/Requests/GetAllLibrariesResponseBody.md) | :heavy_minus_sign: | The libraries available on the Server |

10
docs/Models/Requests/GetAllLibrariesResponseBody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetAllLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `MediaContainer` | [GetAllLibrariesMediaContainer](../../Models/Requests/GetAllLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |

11
docs/Models/Requests/GetLibrariesMediaContainer.md
View File

@@ -1,11 +0,0 @@
# GetLibrariesMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_minus_sign: | N/A | 5 |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | false |
| `Title1` | *string* | :heavy_minus_sign: | N/A | Plex Library |
| `Directory` | List<[GetLibrariesDirectory](../../Models/Requests/GetLibrariesDirectory.md)> | :heavy_minus_sign: | N/A | |

10
docs/Models/Requests/GetLibrariesResponseBody.md
View File

@@ -1,10 +0,0 @@
# GetLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `MediaContainer` | [GetLibrariesMediaContainer](../../Models/Requests/GetLibrariesMediaContainer.md) | :heavy_minus_sign: | N/A |

2
docs/Models/Requests/GetLibraryDirectory.md → docs/Models/Requests/GetLibraryDetailsDirectory.md
View File

@@ -1,4 +1,4 @@
# GetLibraryDirectory
# GetLibraryDetailsDirectory
## Fields

2
docs/Models/Requests/GetLibraryFilter.md → docs/Models/Requests/GetLibraryDetailsFilter.md
View File

@@ -1,4 +1,4 @@
# GetLibraryFilter
# GetLibraryDetailsFilter
## Fields

22
docs/Models/Requests/GetLibraryDetailsMediaContainer.md Normal file
View File

@@ -0,0 +1,22 @@
# GetLibraryDetailsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_minus_sign: | N/A | 29 |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | false |
| `Art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `Content` | *string* | :heavy_minus_sign: | N/A | secondary |
| `Identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `LibrarySectionID` | *int* | :heavy_minus_sign: | N/A | 1 |
| `MediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *int* | :heavy_minus_sign: | N/A | 1701731894 |
| `Thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `Title1` | *string* | :heavy_minus_sign: | N/A | Movies |
| `ViewGroup` | *string* | :heavy_minus_sign: | N/A | secondary |
| `ViewMode` | *int* | :heavy_minus_sign: | N/A | 65592 |
| `Directory` | List<[GetLibraryDetailsDirectory](../../Models/Requests/GetLibraryDetailsDirectory.md)> | :heavy_minus_sign: | N/A | |
| `Type` | List<[GetLibraryDetailsType](../../Models/Requests/GetLibraryDetailsType.md)> | :heavy_minus_sign: | N/A | |
| `FieldType` | List<[FieldType](../../Models/Requests/FieldType.md)> | :heavy_minus_sign: | N/A | |

4
docs/Models/Requests/GetLibraryRequest.md → docs/Models/Requests/GetLibraryDetailsRequest.md
View File

@@ -1,9 +1,9 @@
# GetLibraryRequest
# GetLibraryDetailsRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to query | 1000 |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |
| `IncludeDetails` | [IncludeDetails](../../Models/Requests/IncludeDetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |

4
docs/Models/Requests/GetLibraryResponse.md → docs/Models/Requests/GetLibraryDetailsResponse.md
View File

@@ -1,4 +1,4 @@
# GetLibraryResponse
# GetLibraryDetailsResponse
## Fields
@@ -8,4 +8,4 @@
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [Models.Requests.GetLibraryResponseBody](../../Models/Requests/GetLibraryResponseBody.md) | :heavy_minus_sign: | The details of the library |
| `Object` | [Models.Requests.GetLibraryDetailsResponseBody](../../Models/Requests/GetLibraryDetailsResponseBody.md) | :heavy_minus_sign: | The details of the library |

10
docs/Models/Requests/GetLibraryDetailsResponseBody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetLibraryDetailsResponseBody
The details of the library
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `MediaContainer` | [GetLibraryDetailsMediaContainer](../../Models/Requests/GetLibraryDetailsMediaContainer.md) | :heavy_minus_sign: | N/A |

14
docs/Models/Requests/GetLibraryDetailsType.md Normal file
View File

@@ -0,0 +1,14 @@
# GetLibraryDetailsType
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `Key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
| `Type` | *string* | :heavy_minus_sign: | N/A | movie |
| `Title` | *string* | :heavy_minus_sign: | N/A | Movies |
| `Active` | *bool* | :heavy_minus_sign: | N/A | false |
| `Filter` | List<[GetLibraryDetailsFilter](../../Models/Requests/GetLibraryDetailsFilter.md)> | :heavy_minus_sign: | N/A | |
| `Sort` | List<[Sort](../../Models/Requests/Sort.md)> | :heavy_minus_sign: | N/A | |
| `Field` | List<[Field](../../Models/Requests/Field.md)> | :heavy_minus_sign: | N/A | |

22
docs/Models/Requests/GetLibraryMediaContainer.md
View File

@@ -1,22 +0,0 @@
# GetLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_minus_sign: | N/A | 29 |
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | false |
| `Art` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
| `Content` | *string* | :heavy_minus_sign: | N/A | secondary |
| `Identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
| `LibrarySectionID` | *int* | :heavy_minus_sign: | N/A | 1 |
| `MediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *int* | :heavy_minus_sign: | N/A | 1701731894 |
| `Thumb` | *string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
| `Title1` | *string* | :heavy_minus_sign: | N/A | Movies |
| `ViewGroup` | *string* | :heavy_minus_sign: | N/A | secondary |
| `ViewMode` | *int* | :heavy_minus_sign: | N/A | 65592 |
| `Directory` | List<[GetLibraryDirectory](../../Models/Requests/GetLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |
| `Type` | List<[GetLibraryType](../../Models/Requests/GetLibraryType.md)> | :heavy_minus_sign: | N/A | |
| `FieldType` | List<[FieldType](../../Models/Requests/FieldType.md)> | :heavy_minus_sign: | N/A | |

10
docs/Models/Requests/GetLibraryResponseBody.md
View File

@@ -1,10 +0,0 @@
# GetLibraryResponseBody
The details of the library
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `MediaContainer` | [GetLibraryMediaContainer](../../Models/Requests/GetLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |

14
docs/Models/Requests/GetLibraryType.md
View File

@@ -1,14 +0,0 @@
# GetLibraryType
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `Key` | *string* | :heavy_minus_sign: | N/A | /library/sections/1/all?type=1 |
| `Type` | *string* | :heavy_minus_sign: | N/A | movie |
| `Title` | *string* | :heavy_minus_sign: | N/A | Movies |
| `Active` | *bool* | :heavy_minus_sign: | N/A | false |
| `Filter` | List<[GetLibraryFilter](../../Models/Requests/GetLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
| `Sort` | List<[Sort](../../Models/Requests/Sort.md)> | :heavy_minus_sign: | N/A | |
| `Field` | List<[Field](../../Models/Requests/Field.md)> | :heavy_minus_sign: | N/A | |

9
docs/Models/Requests/GetRefreshLibraryMetadataRequest.md Normal file
View File

@@ -0,0 +1,9 @@
# GetRefreshLibraryMetadataRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `SectionId` | *double* | :heavy_check_mark: | The id of the library | 15 |
| `Force` | [Force](../../Models/Requests/Force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |

2
docs/Models/Requests/RefreshLibraryResponse.md → docs/Models/Requests/GetRefreshLibraryMetadataResponse.md
View File

@@ -1,4 +1,4 @@
# RefreshLibraryResponse
# GetRefreshLibraryMetadataResponse
## Fields

2
docs/Models/Requests/GetTopWatchedContentMetadata.md
View File

@@ -36,4 +36,4 @@
| `Country` | List<[GetTopWatchedContentCountry](../../Models/Requests/GetTopWatchedContentCountry.md)> | :heavy_minus_sign: | N/A | |
| `Guids` | List<[GetTopWatchedContentGuids](../../Models/Requests/GetTopWatchedContentGuids.md)> | :heavy_minus_sign: | N/A | |
| `Role` | List<[GetTopWatchedContentRole](../../Models/Requests/GetTopWatchedContentRole.md)> | :heavy_minus_sign: | N/A | |
| `User` | List<[Models.Requests.User](../../Models/Requests/User.md)> | :heavy_minus_sign: | N/A | |
| `User` | List<[User](../../Models/Requests/User.md)> | :heavy_minus_sign: | N/A | |

34
docs/Models/Requests/PastSubscription.md
View File

@@ -3,20 +3,20 @@
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `Id` | *string* | :heavy_check_mark: | N/A | |
| `Mode` | *string* | :heavy_check_mark: | N/A | |
| `RenewsAt` | *int* | :heavy_check_mark: | Unix epoch datetime | |
| `EndsAt` | *int* | :heavy_check_mark: | Unix epoch datetime | 1556281940 |
| `Canceled` | *bool* | :heavy_minus_sign: | N/A | false |
| `GracePeriod` | *bool* | :heavy_minus_sign: | N/A | false |
| `OnHold` | *bool* | :heavy_minus_sign: | N/A | false |
| `CanReactivate` | *bool* | :heavy_minus_sign: | N/A | false |
| `CanUpgrade` | *bool* | :heavy_minus_sign: | N/A | false |
| `CanDowngrade` | *bool* | :heavy_minus_sign: | N/A | false |
| `CanConvert` | *bool* | :heavy_minus_sign: | N/A | false |
| `Type` | *string* | :heavy_check_mark: | N/A | plexpass |
| `Transfer` | *string* | :heavy_check_mark: | N/A | |
| `State` | [PostSignInState](../../Models/Requests/PostSignInState.md) | :heavy_check_mark: | N/A | ended |
| `Billing` | [Billing](../../Models/Requests/Billing.md) | :heavy_check_mark: | N/A | |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `Id` | *string* | :heavy_check_mark: | N/A | |
| `Mode` | *string* | :heavy_check_mark: | N/A | |
| `RenewsAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `EndsAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
| `Canceled` | *bool* | :heavy_minus_sign: | N/A | false |
| `GracePeriod` | *bool* | :heavy_minus_sign: | N/A | false |
| `OnHold` | *bool* | :heavy_minus_sign: | N/A | false |
| `CanReactivate` | *bool* | :heavy_minus_sign: | N/A | false |
| `CanUpgrade` | *bool* | :heavy_minus_sign: | N/A | false |
| `CanDowngrade` | *bool* | :heavy_minus_sign: | N/A | false |
| `CanConvert` | *bool* | :heavy_minus_sign: | N/A | false |
| `Type` | *string* | :heavy_check_mark: | N/A | plexpass |
| `Transfer` | *string* | :heavy_check_mark: | N/A | |
| `State` | [PostUsersSignInDataState](../../Models/Requests/PostUsersSignInDataState.md) | :heavy_check_mark: | N/A | ended |
| `Billing` | [Billing](../../Models/Requests/Billing.md) | :heavy_check_mark: | N/A | |

12
docs/Models/Requests/PostSignInServices.md
View File

@@ -1,12 +0,0 @@
# PostSignInServices
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `Identifier` | *string* | :heavy_check_mark: | N/A | metadata-dev |
| `Endpoint` | *string* | :heavy_check_mark: | N/A | https://epg.provider.plex.tv |
| `Token` | *string* | :heavy_check_mark: | N/A | DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv |
| `Secret` | *string* | :heavy_check_mark: | N/A | |
| `Status` | [PostSignInStatus](../../Models/Requests/PostSignInStatus.md) | :heavy_check_mark: | N/A | online |

15
docs/Models/Requests/PostSignInSubscription.md
View File

@@ -1,15 +0,0 @@
# PostSignInSubscription
If the account’s Plex Pass subscription is active
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `Features` | List<[PostSignInFeatures](../../Models/Requests/PostSignInFeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | *bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | *string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [PostSignInUserStatus](../../Models/Requests/PostSignInUserStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `PaymentService` | *string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `Plan` | *string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

13
docs/Models/Requests/PostSignInUserSubscription.md
View File

@@ -1,13 +0,0 @@
# PostSignInUserSubscription
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `Features` | List<[PostSignInUserFeatures](../../Models/Requests/PostSignInUserFeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | *bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | *string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [PostSignInUserResponseStatus](../../Models/Requests/PostSignInUserResponseStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `PaymentService` | *string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `Plan` | *string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

2
docs/Models/Requests/PostSignInUserFeatures.md → docs/Models/Requests/PostUsersSignInDataAuthenticationFeatures.md
View File

@@ -1,4 +1,4 @@
# PostSignInUserFeatures
# PostUsersSignInDataAuthenticationFeatures
## Values

2
docs/Models/Requests/PostSignInUserStatus.md → docs/Models/Requests/PostUsersSignInDataAuthenticationResponseStatus.md
View File

@@ -1,4 +1,4 @@
# PostSignInUserStatus
# PostUsersSignInDataAuthenticationResponseStatus
String representation of subscriptionActive

2
docs/Models/Requests/PostSignInUserResponseStatus.md → docs/Models/Requests/PostUsersSignInDataAuthenticationStatus.md
View File

@@ -1,4 +1,4 @@
# PostSignInUserResponseStatus
# PostUsersSignInDataAuthenticationStatus
String representation of subscriptionActive

13
docs/Models/Requests/PostUsersSignInDataAuthenticationSubscription.md Normal file
View File

@@ -0,0 +1,13 @@
# PostUsersSignInDataAuthenticationSubscription
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `Features` | List<[PostUsersSignInDataAuthenticationFeatures](../../Models/Requests/PostUsersSignInDataAuthenticationFeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | *bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | *string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [PostUsersSignInDataAuthenticationResponseStatus](../../Models/Requests/PostUsersSignInDataAuthenticationResponseStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `PaymentService` | *string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `Plan` | *string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

2
docs/Models/Requests/PostSignInAutoSelectSubtitle.md → docs/Models/Requests/PostUsersSignInDataAutoSelectSubtitle.md
View File

@@ -1,4 +1,4 @@
# PostSignInAutoSelectSubtitle
# PostUsersSignInDataAutoSelectSubtitle
The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled)

2
docs/Models/Requests/PostSignInDefaultSubtitleAccessibility.md → docs/Models/Requests/PostUsersSignInDataDefaultSubtitleAccessibility.md
View File

@@ -1,4 +1,4 @@
# PostSignInDefaultSubtitleAccessibility
# PostUsersSignInDataDefaultSubtitleAccessibility
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)

2
docs/Models/Requests/PostSignInDefaultSubtitleForced.md → docs/Models/Requests/PostUsersSignInDataDefaultSubtitleForced.md
View File

@@ -1,4 +1,4 @@
# PostSignInDefaultSubtitleForced
# PostUsersSignInDataDefaultSubtitleForced
The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles)

2
docs/Models/Requests/PostSignInFeatures.md → docs/Models/Requests/PostUsersSignInDataFeatures.md
View File

@@ -1,4 +1,4 @@
# PostSignInFeatures
# PostUsersSignInDataFeatures
## Values

2
docs/Models/Requests/PostSignInMailingListStatus.md → docs/Models/Requests/PostUsersSignInDataMailingListStatus.md
View File

@@ -1,4 +1,4 @@
# PostSignInMailingListStatus
# PostUsersSignInDataMailingListStatus
Your current mailing list status

2
docs/Models/Requests/PostSignInMediaReviewsVisibility.md → docs/Models/Requests/PostUsersSignInDataMediaReviewsVisibility.md
View File

@@ -1,4 +1,4 @@
# PostSignInMediaReviewsVisibility
# PostUsersSignInDataMediaReviewsVisibility
## Values

4
docs/Models/Requests/PostSignInRequest.md → docs/Models/Requests/PostUsersSignInDataRequest.md
View File

@@ -1,4 +1,4 @@
# PostSignInRequest
# PostUsersSignInDataRequest
## Fields
@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `XPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application<br/>This is used to track the client application and its usage<br/>(UUID, serial number, or other number unique per device)<br/> | Postman |
| `RequestBody` | [PostSignInRequestBody](../../Models/Requests/PostSignInRequestBody.md) | :heavy_minus_sign: | Login credentials | |
| `RequestBody` | [PostUsersSignInDataRequestBody](../../Models/Requests/PostUsersSignInDataRequestBody.md) | :heavy_minus_sign: | Login credentials | |

2
docs/Models/Requests/PostSignInRequestBody.md → docs/Models/Requests/PostUsersSignInDataRequestBody.md
View File

@@ -1,4 +1,4 @@
# PostSignInRequestBody
# PostUsersSignInDataRequestBody
Login credentials

4
docs/Models/Requests/PostSignInResponse.md → docs/Models/Requests/PostUsersSignInDataResponse.md
View File

File diff suppressed because one or more lines are too long

12
docs/Models/Requests/PostUsersSignInDataServices.md Normal file
View File

@@ -0,0 +1,12 @@
# PostUsersSignInDataServices
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `Identifier` | *string* | :heavy_check_mark: | N/A | metadata-dev |
| `Endpoint` | *string* | :heavy_check_mark: | N/A | https://epg.provider.plex.tv |
| `Token` | *string* | :heavy_check_mark: | N/A | DjoMtqFAGRL1uVtCyF1dKIorTbShJeqv |
| `Secret` | *string* | :heavy_check_mark: | N/A | |
| `Status` | [PostUsersSignInDataStatus](../../Models/Requests/PostUsersSignInDataStatus.md) | :heavy_check_mark: | N/A | online |

2
docs/Models/Requests/PostSignInState.md → docs/Models/Requests/PostUsersSignInDataState.md
View File

@@ -1,4 +1,4 @@
# PostSignInState
# PostUsersSignInDataState
## Values

2
docs/Models/Requests/PostSignInStatus.md → docs/Models/Requests/PostUsersSignInDataStatus.md
View File

@@ -1,4 +1,4 @@
# PostSignInStatus
# PostUsersSignInDataStatus
## Values

15
docs/Models/Requests/PostUsersSignInDataSubscription.md Normal file
View File

@@ -0,0 +1,15 @@
# PostUsersSignInDataSubscription
If the account’s Plex Pass subscription is active
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `Features` | List<[PostUsersSignInDataFeatures](../../Models/Requests/PostUsersSignInDataFeatures.md)> | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | *bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | *string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [PostUsersSignInDataAuthenticationStatus](../../Models/Requests/PostUsersSignInDataAuthenticationStatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |
| `PaymentService` | *string* | :heavy_minus_sign: | Payment service used for your Plex Pass subscription | |
| `Plan` | *string* | :heavy_minus_sign: | Name of Plex Pass subscription plan | |

12
docs/Models/Requests/PostSignInUserPlexAccount.md → docs/Models/Requests/PostUsersSignInDataUserPlexAccount.md
View File

@@ -1,4 +1,4 @@
# PostSignInUserPlexAccount
# PostUsersSignInDataUserPlexAccount
Returns the user account data with a valid auth token
@@ -29,19 +29,19 @@ Returns the user account data with a valid auth token
| `JoinedAt` | *int* | :heavy_check_mark: | Unix epoch datetime the account joined Plex | 1721154902 |
| `Locale` | *string* | :heavy_check_mark: | The account locale | |
| `MailingListActive` | *bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `MailingListStatus` | [PostSignInMailingListStatus](../../Models/Requests/PostSignInMailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
| `MailingListStatus` | [PostUsersSignInDataMailingListStatus](../../Models/Requests/PostUsersSignInDataMailingListStatus.md) | :heavy_check_mark: | Your current mailing list status | |
| `MaxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| ~~`Pin`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `Profile` | [PostSignInUserProfile](../../Models/Requests/PostSignInUserProfile.md) | :heavy_check_mark: | N/A | |
| `Profile` | [PostUsersSignInDataUserProfile](../../Models/Requests/PostUsersSignInDataUserProfile.md) | :heavy_check_mark: | N/A | |
| `Protected` | *bool* | :heavy_minus_sign: | If the account has a Plex Home PIN enabled | |
| `RememberExpiresAt` | *int* | :heavy_check_mark: | Unix epoch datetime the authtoken expires | 1722364046 |
| `Restricted` | *bool* | :heavy_minus_sign: | If the account is a Plex Home managed user | |
| `Roles` | List<*string*> | :heavy_minus_sign: | [Might be removed] List of account roles. Plexpass membership listed here | |
| `ScrobbleTypes` | *string* | :heavy_check_mark: | Unknown | |
| `Services` | List<[PostSignInServices](../../Models/Requests/PostSignInServices.md)> | :heavy_check_mark: | N/A | |
| `Subscription` | [PostSignInSubscription](../../Models/Requests/PostSignInSubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `Services` | List<[PostUsersSignInDataServices](../../Models/Requests/PostUsersSignInDataServices.md)> | :heavy_check_mark: | N/A | |
| `Subscription` | [PostUsersSignInDataSubscription](../../Models/Requests/PostUsersSignInDataSubscription.md) | :heavy_check_mark: | If the account’s Plex Pass subscription is active | |
| `SubscriptionDescription` | *string* | :heavy_check_mark: | Description of the Plex Pass subscription | |
| `Subscriptions` | List<[PostSignInUserSubscription](../../Models/Requests/PostSignInUserSubscription.md)> | :heavy_check_mark: | N/A | |
| `Subscriptions` | List<[PostUsersSignInDataAuthenticationSubscription](../../Models/Requests/PostUsersSignInDataAuthenticationSubscription.md)> | :heavy_check_mark: | N/A | |
| `Thumb` | *string* | :heavy_check_mark: | URL of the account thumbnail | https://plex.tv/users/a4f43c1ebfde43a5/avatar?c=8372075101 |
| `Title` | *string* | :heavy_check_mark: | The title of the account (username or friendly name) | UsernameTitle |
| `TwoFactorEnabled` | *bool* | :heavy_minus_sign: | If two-factor authentication is enabled | |

12
docs/Models/Requests/PostSignInUserProfile.md → docs/Models/Requests/PostUsersSignInDataUserProfile.md
View File

@@ -1,4 +1,4 @@
# PostSignInUserProfile
# PostUsersSignInDataUserProfile
## Fields
@@ -8,8 +8,8 @@
| `AutoSelectAudio` | *bool* | :heavy_minus_sign: | If the account has automatically select audio and subtitle tracks enabled | true |
| `DefaultAudioLanguage` | *string* | :heavy_check_mark: | The preferred audio language for the account | ja |
| `DefaultSubtitleLanguage` | *string* | :heavy_check_mark: | The preferred subtitle language for the account | en |
| `AutoSelectSubtitle` | [PostSignInAutoSelectSubtitle](../../Models/Requests/PostSignInAutoSelectSubtitle.md) | :heavy_minus_sign: | The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) | 1 |
| `DefaultSubtitleAccessibility` | [PostSignInDefaultSubtitleAccessibility](../../Models/Requests/PostSignInDefaultSubtitleAccessibility.md) | :heavy_minus_sign: | The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles) | 1 |
| `DefaultSubtitleForced` | [PostSignInDefaultSubtitleForced](../../Models/Requests/PostSignInDefaultSubtitleForced.md) | :heavy_minus_sign: | The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles) | 0 |
| `WatchedIndicator` | [PostSignInWatchedIndicator](../../Models/Requests/PostSignInWatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `MediaReviewsVisibility` | [PostSignInMediaReviewsVisibility](../../Models/Requests/PostSignInMediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 0 |
| `AutoSelectSubtitle` | [PostUsersSignInDataAutoSelectSubtitle](../../Models/Requests/PostUsersSignInDataAutoSelectSubtitle.md) | :heavy_minus_sign: | The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign audio, 2 = Always enabled) | 1 |
| `DefaultSubtitleAccessibility` | [PostUsersSignInDataDefaultSubtitleAccessibility](../../Models/Requests/PostUsersSignInDataDefaultSubtitleAccessibility.md) | :heavy_minus_sign: | The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles) | 1 |
| `DefaultSubtitleForced` | [PostUsersSignInDataDefaultSubtitleForced](../../Models/Requests/PostUsersSignInDataDefaultSubtitleForced.md) | :heavy_minus_sign: | The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer forced subtitles, 2 = Only show forced subtitles, 3 = Only show non-forced subtitles) | 0 |
| `WatchedIndicator` | [PostUsersSignInDataWatchedIndicator](../../Models/Requests/PostUsersSignInDataWatchedIndicator.md) | :heavy_minus_sign: | N/A | 1 |
| `MediaReviewsVisibility` | [PostUsersSignInDataMediaReviewsVisibility](../../Models/Requests/PostUsersSignInDataMediaReviewsVisibility.md) | :heavy_minus_sign: | N/A | 0 |

2
docs/Models/Requests/PostSignInWatchedIndicator.md → docs/Models/Requests/PostUsersSignInDataWatchedIndicator.md
View File

@@ -1,4 +1,4 @@
# PostSignInWatchedIndicator
# PostUsersSignInDataWatchedIndicator
## Values

15
docs/Models/Requests/QueryParamForce.md Normal file
View File

@@ -0,0 +1,15 @@
# QueryParamForce
Force overwriting of duplicate playlists.
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
The `force` argument is used to disable overwriting.
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

8
docs/Models/Requests/RefreshLibraryRequest.md
View File

@@ -1,8 +0,0 @@
# RefreshLibraryRequest
## Fields
| Field | Type | Required | Description |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `SectionId` | *double* | :heavy_check_mark: | the Id of the library to refresh |

8
docs/Models/Requests/SearchLibraryRequest.md
View File

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description |
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
| `SectionId` | *long* | :heavy_check_mark: | the Id of the library to query |
| `Type` | [Type](../../Models/Requests/Type.md) | :heavy_check_mark: | Plex content type to search for |
| Field | Type | Required | Description |
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
| `SectionId` | *long* | :heavy_check_mark: | the Id of the library to query |
| `Type` | [Models.Requests.Type](../../Models/Requests/Type.md) | :heavy_check_mark: | Plex content type to search for |

2
docs/Models/Requests/UploadPlaylistRequest.md
View File

@@ -6,4 +6,4 @@
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. <br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed. <br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename. <br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
| `Force` | [Force](../../Models/Requests/Force.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
| `Force` | [QueryParamForce](../../Models/Requests/QueryParamForce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |