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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.394.0

Browse Source
This commit is contained in:
speakeasybot
2024-09-10 00:11:07 +00:00
parent 8dc802ca50
commit 39d3a40524
910 changed files with 51963 additions and 53271 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/sdks/activities/README.md
View File

@@ -86,11 +86,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| errors.GetServerActivitiesResponseBody | 400 | application/json |
| errors.GetServerActivitiesActivitiesResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.GetServerActivitiesBadRequest | 400 | application/json |
| errors.GetServerActivitiesUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## cancelServerActivities
@@ -163,8 +163,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| errors.CancelServerActivitiesResponseBody | 400 | application/json |
| errors.CancelServerActivitiesActivitiesResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.CancelServerActivitiesBadRequest | 400 | application/json |
| errors.CancelServerActivitiesUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

67
docs/sdks/authentication/README.md
View File

@@ -8,9 +8,9 @@ API Calls regarding authentication for Plex Media Server
### Available Operations
* [getTransientToken](#gettransienttoken) - Get a Transient Token.
* [getTransientToken](#gettransienttoken) - Get a Transient Token
* [getSourceConnectionInformation](#getsourceconnectioninformation) - Get Source Connection Information
* [getUserDetails](#getuserdetails) - Get User Data By Token
* [getTokenDetails](#gettokendetails) - Get Token Details
* [postUsersSignInData](#postuserssignindata) - Get User Sign In Data
## getTransientToken
@@ -87,11 +87,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
| errors.GetTransientTokenResponseBody | 400 | application/json |
| errors.GetTransientTokenAuthenticationResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| errors.GetTransientTokenBadRequest | 400 | application/json |
| errors.GetTransientTokenUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getSourceConnectionInformation
@@ -166,14 +166,14 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
| errors.GetSourceConnectionInformationResponseBody | 400 | application/json |
| errors.GetSourceConnectionInformationAuthenticationResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
| errors.GetSourceConnectionInformationBadRequest | 400 | application/json |
| errors.GetSourceConnectionInformationUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getUserDetails
## getTokenDetails
Get the User data from the provided X-Plex-Token
@@ -188,7 +188,7 @@ const plexAPI = new PlexAPI({
});
async function run() {
const result = await plexAPI.authentication.getUserDetails("CV5xoxjTpFKUzBTShsaf");
const result = await plexAPI.authentication.getTokenDetails();
// Handle the result
console.log(result)
@@ -203,7 +203,7 @@ The standalone function version of this method:
```typescript
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
import { authenticationGetUserDetails } from "@lukehagar/plexjs/funcs/authenticationGetUserDetails.js";
import { authenticationGetTokenDetails } from "@lukehagar/plexjs/funcs/authenticationGetTokenDetails.js";
// Use `PlexAPICore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
@@ -213,7 +213,7 @@ const plexAPI = new PlexAPICore({
});
async function run() {
const res = await authenticationGetUserDetails(plexAPI, "CV5xoxjTpFKUzBTShsaf");
const res = await authenticationGetTokenDetails(plexAPI);
if (!res.ok) {
throw res.error;
@@ -230,25 +230,24 @@ run();
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `xPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
| `options.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
| `options.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
### Response
**Promise\<[operations.GetUserDetailsResponse](../../sdk/models/operations/getuserdetailsresponse.md)\>**
**Promise\<[operations.GetTokenDetailsResponse](../../sdk/models/operations/gettokendetailsresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| errors.GetUserDetailsResponseBody | 400 | application/json |
| errors.GetUserDetailsAuthenticationResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.GetTokenDetailsBadRequest | 400 | application/json |
| errors.GetTokenDetailsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## postUsersSignInData
@@ -329,8 +328,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| errors.PostUsersSignInDataResponseBody | 400 | application/json |
| errors.PostUsersSignInDataAuthenticationResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.PostUsersSignInDataBadRequest | 400 | application/json |
| errors.PostUsersSignInDataUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

50
docs/sdks/butler/README.md
View File

@@ -83,11 +83,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| errors.GetButlerTasksResponseBody | 400 | application/json |
| errors.GetButlerTasksButlerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.GetButlerTasksBadRequest | 400 | application/json |
| errors.GetButlerTasksUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## startAllTasks
@@ -164,11 +164,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.StartAllTasksResponseBody | 400 | application/json |
| errors.StartAllTasksButlerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| errors.StartAllTasksBadRequest | 400 | application/json |
| errors.StartAllTasksUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## stopAllTasks
@@ -241,11 +241,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| errors.StopAllTasksResponseBody | 400 | application/json |
| errors.StopAllTasksButlerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| errors.StopAllTasksBadRequest | 400 | application/json |
| errors.StopAllTasksUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## startTask
@@ -325,11 +325,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.StartTaskResponseBody | 400 | application/json |
| errors.StartTaskButlerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------- | ---------------------------- | ---------------------------- |
| errors.StartTaskBadRequest | 400 | application/json |
| errors.StartTaskUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## stopTask
@@ -405,8 +405,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.StopTaskResponseBody | 400 | application/json |
| errors.StopTaskButlerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------- | --------------------------- | --------------------------- |
| errors.StopTaskBadRequest | 400 | application/json |
| errors.StopTaskUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

20
docs/sdks/hubs/README.md
View File

@@ -82,11 +82,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| errors.GetGlobalHubsResponseBody | 400 | application/json |
| errors.GetGlobalHubsHubsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| errors.GetGlobalHubsBadRequest | 400 | application/json |
| errors.GetGlobalHubsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getLibraryHubs
@@ -162,8 +162,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| errors.GetLibraryHubsResponseBody | 400 | application/json |
| errors.GetLibraryHubsHubsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.GetLibraryHubsBadRequest | 400 | application/json |
| errors.GetLibraryHubsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

120
docs/sdks/library/README.md
View File

@@ -92,11 +92,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| errors.GetFileHashResponseBody | 400 | application/json |
| errors.GetFileHashLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------ | ------------------------------ | ------------------------------ |
| errors.GetFileHashBadRequest | 400 | application/json |
| errors.GetFileHashUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getRecentlyAdded
@@ -171,11 +171,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.GetRecentlyAddedResponseBody | 400 | application/json |
| errors.GetRecentlyAddedLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| errors.GetRecentlyAddedBadRequest | 400 | application/json |
| errors.GetRecentlyAddedUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getAllLibraries
@@ -253,11 +253,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.GetAllLibrariesResponseBody | 400 | application/json |
| errors.GetAllLibrariesLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.GetAllLibrariesBadRequest | 400 | application/json |
| errors.GetAllLibrariesUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getLibraryDetails
@@ -370,11 +370,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| errors.GetLibraryDetailsResponseBody | 400 | application/json |
| errors.GetLibraryDetailsLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| errors.GetLibraryDetailsBadRequest | 400 | application/json |
| errors.GetLibraryDetailsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## deleteLibrary
@@ -447,11 +447,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| errors.DeleteLibraryResponseBody | 400 | application/json |
| errors.DeleteLibraryLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| errors.DeleteLibraryBadRequest | 400 | application/json |
| errors.DeleteLibraryUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getLibraryItems
@@ -562,11 +562,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.GetLibraryItemsResponseBody | 400 | application/json |
| errors.GetLibraryItemsLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.GetLibraryItemsBadRequest | 400 | application/json |
| errors.GetLibraryItemsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getRefreshLibraryMetadata
@@ -643,11 +643,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| errors.GetRefreshLibraryMetadataResponseBody | 400 | application/json |
| errors.GetRefreshLibraryMetadataLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| errors.GetRefreshLibraryMetadataBadRequest | 400 | application/json |
| errors.GetRefreshLibraryMetadataUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getSearchLibrary
@@ -741,11 +741,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.GetSearchLibraryResponseBody | 400 | application/json |
| errors.GetSearchLibraryLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| errors.GetSearchLibraryBadRequest | 400 | application/json |
| errors.GetSearchLibraryUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getMetaDataByRatingKey
@@ -819,11 +819,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| errors.GetMetaDataByRatingKeyResponseBody | 400 | application/json |
| errors.GetMetaDataByRatingKeyLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.GetMetaDataByRatingKeyBadRequest | 400 | application/json |
| errors.GetMetaDataByRatingKeyUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getMetadataChildren
@@ -898,11 +898,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| errors.GetMetadataChildrenResponseBody | 400 | application/json |
| errors.GetMetadataChildrenLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.GetMetadataChildrenBadRequest | 400 | application/json |
| errors.GetMetadataChildrenUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getTopWatchedContent
@@ -979,11 +979,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| errors.GetTopWatchedContentResponseBody | 400 | application/json |
| errors.GetTopWatchedContentLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| errors.GetTopWatchedContentBadRequest | 400 | application/json |
| errors.GetTopWatchedContentUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getOnDeck
@@ -1056,8 +1056,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| errors.GetOnDeckResponseBody | 400 | application/json |
| errors.GetOnDeckLibraryResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------- | ---------------------------- | ---------------------------- |
| errors.GetOnDeckBadRequest | 400 | application/json |
| errors.GetOnDeckUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

30
docs/sdks/log/README.md
View File

@@ -87,11 +87,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------- | ----------------------------- | ----------------------------- |
| errors.LogLineResponseBody | 400 | application/json |
| errors.LogLineLogResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------- | -------------------------- | -------------------------- |
| errors.LogLineBadRequest | 400 | application/json |
| errors.LogLineUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## logMultiLine
@@ -189,11 +189,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.LogMultiLineResponseBody | 400 | application/json |
| errors.LogMultiLineLogResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| errors.LogMultiLineBadRequest | 400 | application/json |
| errors.LogMultiLineUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## enablePaperTrail
@@ -266,8 +266,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.EnablePaperTrailResponseBody | 400 | application/json |
| errors.EnablePaperTrailLogResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| errors.EnablePaperTrailBadRequest | 400 | application/json |
| errors.EnablePaperTrailUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

50
docs/sdks/media/README.md
View File

@@ -84,11 +84,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.MarkPlayedResponseBody | 400 | application/json |
| errors.MarkPlayedMediaResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------- | ----------------------------- | ----------------------------- |
| errors.MarkPlayedBadRequest | 400 | application/json |
| errors.MarkPlayedUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## markUnplayed
@@ -161,11 +161,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| errors.MarkUnplayedResponseBody | 400 | application/json |
| errors.MarkUnplayedMediaResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| errors.MarkUnplayedBadRequest | 400 | application/json |
| errors.MarkUnplayedUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## updatePlayProgress
@@ -241,11 +241,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.UpdatePlayProgressResponseBody | 400 | application/json |
| errors.UpdatePlayProgressMediaResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| errors.UpdatePlayProgressBadRequest | 400 | application/json |
| errors.UpdatePlayProgressUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getBannerImage
@@ -332,11 +332,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.GetBannerImageResponseBody | 400 | application/json |
| errors.GetBannerImageMediaResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.GetBannerImageBadRequest | 400 | application/json |
| errors.GetBannerImageUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getThumbImage
@@ -423,8 +423,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| errors.GetThumbImageResponseBody | 400 | application/json |
| errors.GetThumbImageMediaResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| errors.GetThumbImageBadRequest | 400 | application/json |
| errors.GetThumbImageUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

90
docs/sdks/playlists/README.md
View File

@@ -106,11 +106,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.CreatePlaylistResponseBody | 400 | application/json |
| errors.CreatePlaylistPlaylistsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.CreatePlaylistBadRequest | 400 | application/json |
| errors.CreatePlaylistUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getPlaylists
@@ -184,11 +184,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| errors.GetPlaylistsResponseBody | 400 | application/json |
| errors.GetPlaylistsPlaylistsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| errors.GetPlaylistsBadRequest | 400 | application/json |
| errors.GetPlaylistsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getPlaylist
@@ -263,11 +263,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| errors.GetPlaylistResponseBody | 400 | application/json |
| errors.GetPlaylistPlaylistsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------ | ------------------------------ | ------------------------------ |
| errors.GetPlaylistBadRequest | 400 | application/json |
| errors.GetPlaylistUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## deletePlaylist
@@ -341,11 +341,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.DeletePlaylistResponseBody | 400 | application/json |
| errors.DeletePlaylistPlaylistsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.DeletePlaylistBadRequest | 400 | application/json |
| errors.DeletePlaylistUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## updatePlaylist
@@ -421,11 +421,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.UpdatePlaylistResponseBody | 400 | application/json |
| errors.UpdatePlaylistPlaylistsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.UpdatePlaylistBadRequest | 400 | application/json |
| errors.UpdatePlaylistUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getPlaylistContents
@@ -505,11 +505,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| errors.GetPlaylistContentsResponseBody | 400 | application/json |
| errors.GetPlaylistContentsPlaylistsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.GetPlaylistContentsBadRequest | 400 | application/json |
| errors.GetPlaylistContentsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## clearPlaylistContents
@@ -583,11 +583,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
| errors.ClearPlaylistContentsResponseBody | 400 | application/json |
| errors.ClearPlaylistContentsPlaylistsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| errors.ClearPlaylistContentsBadRequest | 400 | application/json |
| errors.ClearPlaylistContentsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## addPlaylistContents
@@ -664,11 +664,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| errors.AddPlaylistContentsResponseBody | 400 | application/json |
| errors.AddPlaylistContentsPlaylistsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.AddPlaylistContentsBadRequest | 400 | application/json |
| errors.AddPlaylistContentsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## uploadPlaylist
@@ -745,8 +745,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.UploadPlaylistResponseBody | 400 | application/json |
| errors.UploadPlaylistPlaylistsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.UploadPlaylistBadRequest | 400 | application/json |
| errors.UploadPlaylistUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

99
docs/sdks/plex/README.md
View File

@@ -86,11 +86,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| errors.GetCompanionsDataResponseBody | 400 | application/json |
| errors.GetCompanionsDataPlexResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| errors.GetCompanionsDataBadRequest | 400 | application/json |
| errors.GetCompanionsDataUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getUserFriends
@@ -163,11 +163,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| errors.GetUserFriendsResponseBody | 400 | application/json |
| errors.GetUserFriendsPlexResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.GetUserFriendsBadRequest | 400 | application/json |
| errors.GetUserFriendsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getGeoData
@@ -238,11 +238,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| errors.GetGeoDataResponseBody | 400 | application/json |
| errors.GetGeoDataPlexResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------- | ----------------------------- | ----------------------------- |
| errors.GetGeoDataBadRequest | 400 | application/json |
| errors.GetGeoDataUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getHomeData
@@ -314,11 +314,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.GetHomeDataResponseBody | 400 | application/json |
| errors.GetHomeDataPlexResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------ | ------------------------------ | ------------------------------ |
| errors.GetHomeDataBadRequest | 400 | application/json |
| errors.GetHomeDataUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getServerResources
@@ -337,12 +337,7 @@ const plexAPI = new PlexAPI({
});
async function run() {
const result = await plexAPI.plex.getServerResources({
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
includeHttps: IncludeHttps.One,
includeRelay: IncludeRelay.One,
includeIPv6: IncludeIPv6.One,
});
const result = await plexAPI.plex.getServerResources("gcgzw5rz2xovp84b4vha3a40", IncludeHttps.One, IncludeRelay.One, IncludeIPv6.One);
// Handle the result
console.log(result)
@@ -368,12 +363,7 @@ const plexAPI = new PlexAPICore({
});
async function run() {
const res = await plexGetServerResources(plexAPI, {
xPlexToken: "CV5xoxjTpFKUzBTShsaf",
includeHttps: IncludeHttps.One,
includeRelay: IncludeRelay.One,
includeIPv6: IncludeIPv6.One,
});
const res = await plexGetServerResources(plexAPI, "gcgzw5rz2xovp84b4vha3a40", IncludeHttps.One, IncludeRelay.One, IncludeIPv6.One);
if (!res.ok) {
throw res.error;
@@ -390,13 +380,16 @@ run();
### Parameters
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetServerResourcesRequest](../../sdk/models/operations/getserverresourcesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
| `options.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. |
| Parameter | 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/> | [object Object] |
| `includeHttps` | [operations.IncludeHttps](../../sdk/models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | [object Object] |
| `includeRelay` | [operations.IncludeRelay](../../sdk/models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | [object Object] |
| `includeIPv6` | [operations.IncludeIPv6](../../sdk/models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | [object Object] |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
| `options.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 |
### Response
@@ -404,11 +397,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.GetServerResourcesResponseBody | 400 | application/json |
| errors.GetServerResourcesPlexResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| errors.GetServerResourcesBadRequest | 400 | application/json |
| errors.GetServerResourcesUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getPin
@@ -482,10 +475,10 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------- | ------------------------- | ------------------------- |
| errors.GetPinResponseBody | 400 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------- | ----------------------- | ----------------------- |
| errors.GetPinBadRequest | 400 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getTokenByPinId
@@ -558,8 +551,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.GetTokenByPinIdResponseBody | 400 | application/json |
| errors.GetTokenByPinIdPlexResponseBody | 404 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.GetTokenByPinIdBadRequest | 400 | application/json |
| errors.GetTokenByPinIdResponseBody | 404 | application/json |
| errors.SDKError | 4xx-5xx | */* |

30
docs/sdks/search/README.md
View File

@@ -96,11 +96,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.PerformSearchResponseBody | 400 | application/json |
| errors.PerformSearchSearchResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| errors.PerformSearchBadRequest | 400 | application/json |
| errors.PerformSearchUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## performVoiceSearch
@@ -179,11 +179,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| errors.PerformVoiceSearchResponseBody | 400 | application/json |
| errors.PerformVoiceSearchSearchResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| errors.PerformVoiceSearchBadRequest | 400 | application/json |
| errors.PerformVoiceSearchUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getSearchResults
@@ -256,8 +256,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.GetSearchResultsResponseBody | 400 | application/json |
| errors.GetSearchResultsSearchResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| errors.GetSearchResultsBadRequest | 400 | application/json |
| errors.GetSearchResultsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

88
docs/sdks/server/README.md
View File

@@ -87,11 +87,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| errors.GetServerCapabilitiesResponseBody | 400 | application/json |
| errors.GetServerCapabilitiesServerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| errors.GetServerCapabilitiesBadRequest | 400 | application/json |
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getServerPreferences
@@ -163,11 +163,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| errors.GetServerPreferencesResponseBody | 400 | application/json |
| errors.GetServerPreferencesServerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| errors.GetServerPreferencesBadRequest | 400 | application/json |
| errors.GetServerPreferencesUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getAvailableClients
@@ -239,11 +239,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| errors.GetAvailableClientsResponseBody | 400 | application/json |
| errors.GetAvailableClientsServerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.GetAvailableClientsBadRequest | 400 | application/json |
| errors.GetAvailableClientsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getDevices
@@ -315,11 +315,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| errors.GetDevicesResponseBody | 400 | application/json |
| errors.GetDevicesServerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------- | ----------------------------- | ----------------------------- |
| errors.GetDevicesBadRequest | 400 | application/json |
| errors.GetDevicesUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getServerIdentity
@@ -389,10 +389,10 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| errors.GetServerIdentityResponseBody | 408 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.GetServerIdentityRequestTimeout | 408 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getMyPlexAccount
@@ -464,11 +464,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.GetMyPlexAccountResponseBody | 400 | application/json |
| errors.GetMyPlexAccountServerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| errors.GetMyPlexAccountBadRequest | 400 | application/json |
| errors.GetMyPlexAccountUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getResizedPhoto
@@ -560,11 +560,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| errors.GetResizedPhotoResponseBody | 400 | application/json |
| errors.GetResizedPhotoServerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.GetResizedPhotoBadRequest | 400 | application/json |
| errors.GetResizedPhotoUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getMediaProviders
@@ -637,11 +637,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.GetMediaProvidersResponseBody | 400 | application/json |
| errors.GetMediaProvidersServerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| errors.GetMediaProvidersBadRequest | 400 | application/json |
| errors.GetMediaProvidersUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getServerList
@@ -713,8 +713,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.GetServerListResponseBody | 400 | application/json |
| errors.GetServerListServerResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| errors.GetServerListBadRequest | 400 | application/json |
| errors.GetServerListUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

40
docs/sdks/sessions/README.md
View File

@@ -82,11 +82,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.GetSessionsResponseBody | 400 | application/json |
| errors.GetSessionsSessionsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------ | ------------------------------ | ------------------------------ |
| errors.GetSessionsBadRequest | 400 | application/json |
| errors.GetSessionsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getSessionHistory
@@ -162,11 +162,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| errors.GetSessionHistoryResponseBody | 400 | application/json |
| errors.GetSessionHistorySessionsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| errors.GetSessionHistoryBadRequest | 400 | application/json |
| errors.GetSessionHistoryUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getTranscodeSessions
@@ -238,11 +238,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| errors.GetTranscodeSessionsResponseBody | 400 | application/json |
| errors.GetTranscodeSessionsSessionsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| errors.GetTranscodeSessionsBadRequest | 400 | application/json |
| errors.GetTranscodeSessionsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## stopTranscodeSession
@@ -315,8 +315,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| errors.StopTranscodeSessionResponseBody | 400 | application/json |
| errors.StopTranscodeSessionSessionsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| errors.StopTranscodeSessionBadRequest | 400 | application/json |
| errors.StopTranscodeSessionUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

30
docs/sdks/statistics/README.md
View File

@@ -82,11 +82,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.GetStatisticsResponseBody | 400 | application/json |
| errors.GetStatisticsStatisticsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| errors.GetStatisticsBadRequest | 400 | application/json |
| errors.GetStatisticsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getResourcesStatistics
@@ -159,11 +159,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| errors.GetResourcesStatisticsResponseBody | 400 | application/json |
| errors.GetResourcesStatisticsStatisticsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.GetResourcesStatisticsBadRequest | 400 | application/json |
| errors.GetResourcesStatisticsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## getBandwidthStatistics
@@ -236,8 +236,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| errors.GetBandwidthStatisticsResponseBody | 400 | application/json |
| errors.GetBandwidthStatisticsStatisticsResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.GetBandwidthStatisticsBadRequest | 400 | application/json |
| errors.GetBandwidthStatisticsUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

30
docs/sdks/updater/README.md
View File

@@ -82,11 +82,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.GetUpdateStatusResponseBody | 400 | application/json |
| errors.GetUpdateStatusUpdaterResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.GetUpdateStatusBadRequest | 400 | application/json |
| errors.GetUpdateStatusUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## checkForUpdates
@@ -161,11 +161,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| errors.CheckForUpdatesResponseBody | 400 | application/json |
| errors.CheckForUpdatesUpdaterResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.CheckForUpdatesBadRequest | 400 | application/json |
| errors.CheckForUpdatesUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## applyUpdates
@@ -242,8 +242,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| errors.ApplyUpdatesResponseBody | 400 | application/json |
| errors.ApplyUpdatesUpdaterResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| errors.ApplyUpdatesBadRequest | 400 | application/json |
| errors.ApplyUpdatesUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

20
docs/sdks/video/README.md
View File

@@ -105,11 +105,11 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| errors.GetTimelineResponseBody | 400 | application/json |
| errors.GetTimelineVideoResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------ | ------------------------------ | ------------------------------ |
| errors.GetTimelineBadRequest | 400 | application/json |
| errors.GetTimelineUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
## startUniversalTranscode
@@ -216,8 +216,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| errors.StartUniversalTranscodeResponseBody | 400 | application/json |
| errors.StartUniversalTranscodeVideoResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| errors.StartUniversalTranscodeBadRequest | 400 | application/json |
| errors.StartUniversalTranscodeUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |

10
docs/sdks/watchlist/README.md
View File

@@ -93,8 +93,8 @@ run();
### Errors
| Error Object | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| errors.GetWatchListResponseBody | 400 | application/json |
| errors.GetWatchListWatchlistResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| Error Object | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| errors.GetWatchListBadRequest | 400 | application/json |
| errors.GetWatchListUnauthorized | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |