diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 9412a747..58be7402 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 16f22cbf-f23f-4419-8924-3a4b06381947 management: - docChecksum: a91eaf9ec1e6a3a6f4bf0571f5b18bae + docChecksum: 7a43cd3413d535205cfaee20a4b6a250 docVersion: 0.0.3 - speakeasyVersion: 1.260.6 - generationVersion: 2.311.1 - releaseVersion: 0.13.0 - configChecksum: 62265d55fc035cecbf6f03081c6e5587 + speakeasyVersion: 1.267.2 + generationVersion: 2.312.1 + releaseVersion: 0.13.1 + configChecksum: 1ff69678442629cebb3690db99f39502 repoURL: https://github.com/LukeHagar/plexjs.git repoSubDirectory: . installationURL: https://github.com/LukeHagar/plexjs diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 8d8729ed..7abe0981 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.267.0 +speakeasyVersion: 1.267.2 sources: my-source: {} targets: diff --git a/README.md b/README.md index 026d6c97..e86a53c0 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -176,7 +176,7 @@ import * as errors from "@lukehagar/plexjs/models/errors"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -228,7 +228,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ serverIdx: 0, accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -259,7 +259,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ serverURL: "{protocol}://{ip}:{port}", accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -280,12 +280,12 @@ The server URL can also be overridden on a per-operation basis, provided a serve import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { const strong = false; - const xPlexClientIdentifier = ""; + const xPlexClientIdentifier = "Postman"; const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier, { serverURL: "https://plex.tv/api/v2", @@ -366,7 +366,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -392,7 +392,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md). A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed. -For example, you can set `X-Plex-Client-Identifier` to `""` at SDK initialization and then you do not have to pass the same value on calls to operations like `getPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. +For example, you can set `X-Plex-Client-Identifier` to `"Postman"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. ### Available Globals @@ -413,12 +413,12 @@ This is used to track the client application and its usage import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { const strong = false; - const xPlexClientIdentifier = ""; + const xPlexClientIdentifier = "Postman"; const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier); diff --git a/RELEASES.md b/RELEASES.md index 8f942a05..4c072e21 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -338,4 +338,14 @@ Based on: ### Generated - [typescript v0.13.0] . ### Releases -- [NPM v0.13.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.0 - . \ No newline at end of file +- [NPM v0.13.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.0 - . + +## 2024-04-22 16:14:48 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.267.2 (2.312.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v0.13.1] . +### Releases +- [NPM v0.13.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.1 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index 21133332..df3ecee9 100644 --- a/USAGE.md +++ b/USAGE.md @@ -4,7 +4,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/models/operations/getpinrequest.md b/docs/models/operations/getpinrequest.md index be7db237..d8f4ca78 100644 --- a/docs/models/operations/getpinrequest.md +++ b/docs/models/operations/getpinrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for `Plex.tv/link`
| -| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for `Plex.tv/link`
| | +| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| Postman | \ No newline at end of file diff --git a/docs/models/operations/gettokenrequest.md b/docs/models/operations/gettokenrequest.md index 7ed39c0b..b970a65f 100644 --- a/docs/models/operations/gettokenrequest.md +++ b/docs/models/operations/gettokenrequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `pinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for | -| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `pinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for | | +| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| Postman | \ No newline at end of file diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md index 23d47d4e..155986f2 100644 --- a/docs/sdks/activities/README.md +++ b/docs/sdks/activities/README.md @@ -28,7 +28,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -70,7 +70,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/authentication/README.md b/docs/sdks/authentication/README.md index bbd92d75..917018de 100644 --- a/docs/sdks/authentication/README.md +++ b/docs/sdks/authentication/README.md @@ -24,7 +24,7 @@ import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -73,7 +73,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/butler/README.md b/docs/sdks/butler/README.md index bd8a1887..b575c874 100644 --- a/docs/sdks/butler/README.md +++ b/docs/sdks/butler/README.md @@ -25,7 +25,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -72,7 +72,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -115,7 +115,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -163,7 +163,7 @@ import { TaskName } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -210,7 +210,7 @@ import { PathParamTaskName } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/hubs/README.md b/docs/sdks/hubs/README.md index 58c7f138..da126474 100644 --- a/docs/sdks/hubs/README.md +++ b/docs/sdks/hubs/README.md @@ -23,7 +23,7 @@ import { OnlyTransient } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -72,7 +72,7 @@ import { QueryParamOnlyTransient } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/library/README.md b/docs/sdks/library/README.md index cf143218..18ba7c25 100644 --- a/docs/sdks/library/README.md +++ b/docs/sdks/library/README.md @@ -31,7 +31,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -79,7 +79,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -127,7 +127,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -209,7 +209,7 @@ import { IncludeDetails } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -256,7 +256,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -322,7 +322,7 @@ import { Tag } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -369,7 +369,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -433,7 +433,7 @@ import { Type } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -480,7 +480,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -526,7 +526,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -572,7 +572,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/log/README.md b/docs/sdks/log/README.md index 3b7e0c14..f625ea08 100644 --- a/docs/sdks/log/README.md +++ b/docs/sdks/log/README.md @@ -25,7 +25,7 @@ import { Level } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -95,7 +95,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -141,7 +141,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/media/README.md b/docs/sdks/media/README.md index 95945053..4e1c5a13 100644 --- a/docs/sdks/media/README.md +++ b/docs/sdks/media/README.md @@ -23,7 +23,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -68,7 +68,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -114,7 +114,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/playlists/README.md b/docs/sdks/playlists/README.md index 2a3d262f..52acc260 100644 --- a/docs/sdks/playlists/README.md +++ b/docs/sdks/playlists/README.md @@ -36,7 +36,7 @@ import { QueryParamType, Smart } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -85,7 +85,7 @@ import { PlaylistType, QueryParamSmart } from "@lukehagar/plexjs/models/operatio const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -134,7 +134,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -180,7 +180,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -226,7 +226,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -279,7 +279,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -327,7 +327,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -374,7 +374,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -425,7 +425,7 @@ import { Force } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/plex/README.md b/docs/sdks/plex/README.md index 3e1a95f0..16681555 100644 --- a/docs/sdks/plex/README.md +++ b/docs/sdks/plex/README.md @@ -21,12 +21,12 @@ Retrieve a Pin from Plex.tv for authentication flows import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { const strong = false; - const xPlexClientIdentifier = ""; + const xPlexClientIdentifier = "Postman"; const result = await plexAPI.plex.getPin(strong, xPlexClientIdentifier); @@ -39,13 +39,13 @@ run(); ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for `Plex.tv/link`
| -| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| -| `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.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `strong` | *boolean* | :heavy_minus_sign: | Determines the kind of code returned by the API call
Strong codes are used for Pin authentication flows
Non-Strong codes are used for `Plex.tv/link`
| | +| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| [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.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | ### Response @@ -68,12 +68,12 @@ Retrieve an Access Token from Plex.tv after the Pin has already been authenticat import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { const pinID = ""; - const xPlexClientIdentifier = ""; + const xPlexClientIdentifier = "Postman"; const result = await plexAPI.plex.getToken(pinID, xPlexClientIdentifier); @@ -86,13 +86,13 @@ run(); ### Parameters -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `pinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for | -| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| -| `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.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | +| Parameter | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `pinID` | *string* | :heavy_check_mark: | The PinID to retrieve an access token for | | +| `xPlexClientIdentifier` | *string* | :heavy_minus_sign: | The unique identifier for the client application
This is used to track the client application and its usage
(UUID, serial number, or other number unique per device)
| [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.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | ### Response diff --git a/docs/sdks/search/README.md b/docs/sdks/search/README.md index ddfe71a5..a70f318f 100644 --- a/docs/sdks/search/README.md +++ b/docs/sdks/search/README.md @@ -35,7 +35,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -88,7 +88,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -137,7 +137,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/server/README.md b/docs/sdks/server/README.md index 9e56493b..12706bb6 100644 --- a/docs/sdks/server/README.md +++ b/docs/sdks/server/README.md @@ -28,7 +28,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -70,7 +70,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -112,7 +112,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -154,7 +154,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -196,7 +196,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -238,7 +238,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -282,7 +282,7 @@ import { MinSize, Upscale } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -333,7 +333,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/sessions/README.md b/docs/sdks/sessions/README.md index 3f22091a..6f7c4712 100644 --- a/docs/sdks/sessions/README.md +++ b/docs/sdks/sessions/README.md @@ -24,7 +24,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -66,7 +66,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -108,7 +108,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -150,7 +150,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/statistics/README.md b/docs/sdks/statistics/README.md index ff598f67..fcac7181 100644 --- a/docs/sdks/statistics/README.md +++ b/docs/sdks/statistics/README.md @@ -21,7 +21,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/updater/README.md b/docs/sdks/updater/README.md index 1894d6cb..b4bea904 100644 --- a/docs/sdks/updater/README.md +++ b/docs/sdks/updater/README.md @@ -24,7 +24,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -67,7 +67,7 @@ import { Download } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -114,7 +114,7 @@ import { Skip, Tonight } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/docs/sdks/video/README.md b/docs/sdks/video/README.md index c2c01340..fa08596c 100644 --- a/docs/sdks/video/README.md +++ b/docs/sdks/video/README.md @@ -23,7 +23,7 @@ import { State } from "@lukehagar/plexjs/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { @@ -77,7 +77,7 @@ import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", - xPlexClientIdentifier: "", + xPlexClientIdentifier: "Postman", }); async function run() { diff --git a/gen.yaml b/gen.yaml index 8d48d933..27283850 100755 --- a/gen.yaml +++ b/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: false typescript: - version: 0.13.0 + version: 0.13.1 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/jsr.json b/jsr.json index efccdf9d..1434bca0 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@lukehagar/plexjs", - "version": "0.13.0", + "version": "0.13.1", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index 7aab23b3..e10cc9b2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@lukehagar/plexjs", - "version": "0.13.0", + "version": "0.13.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@lukehagar/plexjs", - "version": "0.13.0", + "version": "0.13.1", "devDependencies": { "@types/jsonpath": "^0.2.4", "@typescript-eslint/eslint-plugin": "^6.13.2", diff --git a/package.json b/package.json index acbd895e..ddaf8966 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@lukehagar/plexjs", - "version": "0.13.0", + "version": "0.13.1", "author": "LukeHagar", "main": "./index.js", "sideEffects": false, diff --git a/src/lib/config.ts b/src/lib/config.ts index fba51b16..8b39a835 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -87,7 +87,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.0.3", - sdkVersion: "0.13.0", - genVersion: "2.311.1", - userAgent: "speakeasy-sdk/typescript 0.13.0 2.311.1 0.0.3 @lukehagar/plexjs", + sdkVersion: "0.13.1", + genVersion: "2.312.1", + userAgent: "speakeasy-sdk/typescript 0.13.1 2.312.1 0.0.3 @lukehagar/plexjs", } as const;