ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.228.1

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.227.0
2025-12-06 20:47:46 +00:00 · 2024-03-29 16:38:38 +00:00 · 2024-03-27 00:27:27 +00:00
29 changed files with 231 additions and 69 deletions
--- a/.speakeasy/gen.lock
+++ b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 16f22cbf-f23f-4419-8924-3a4b06381947
 management:
-  docChecksum: e34dac84738ebf2d447ea2b9055a6eeb
+  docChecksum: a91eaf9ec1e6a3a6f4bf0571f5b18bae
  docVersion: 0.0.3
-  speakeasyVersion: 1.213.0
-  generationVersion: 2.283.1
-  releaseVersion: 0.10.4
-  configChecksum: 79121d7caddd1a69343bca5df91689af
+  speakeasyVersion: 1.228.1
+  generationVersion: 2.292.0
+  releaseVersion: 0.12.0
+  configChecksum: 96c0b6a9e85b7682aef0863ada1e00a7
  repoURL: https://github.com/LukeHagar/plexjs.git
  repoSubDirectory: .
  installationURL: https://github.com/LukeHagar/plexjs
@@ -14,13 +14,14 @@ management:
 features:
  typescript:
    constsAndDefaults: 0.1.5
-    core: 3.6.3
+    core: 3.7.0
    flattening: 2.81.1
    globalSecurity: 2.82.8
    globalServerURLs: 2.82.4
+    globals: 2.82.1
    methodServerURLs: 2.82.1
    nameOverrides: 2.81.1
-    responseFormat: 0.2.2
+    responseFormat: 0.2.3
 generatedFiles:
  - src/sdk/server.ts
  - src/sdk/media.ts
--- a/README.md
+++ b/README.md
@@ -34,6 +34,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
    const sdk = new PlexAPI({
        accessToken: "<YOUR_API_KEY_HERE>",
+        xPlexClientIdentifier: "<value>",
    });

    const result = await sdk.server.getServerCapabilities();
@@ -176,6 +177,7 @@ import * as errors from "@lukehagar/plexjs/models/errors";
 async function run() {
    const sdk = new PlexAPI({
        accessToken: "<YOUR_API_KEY_HERE>",
+        xPlexClientIdentifier: "<value>",
    });

    let result;
@@ -227,6 +229,7 @@ async function run() {
    const sdk = new PlexAPI({
        serverIdx: 0,
        accessToken: "<YOUR_API_KEY_HERE>",
+        xPlexClientIdentifier: "<value>",
    });

    const result = await sdk.server.getServerCapabilities();
@@ -257,6 +260,7 @@ async function run() {
    const sdk = new PlexAPI({
        serverURL: "{protocol}://{ip}:{port}",
        accessToken: "<YOUR_API_KEY_HERE>",
+        xPlexClientIdentifier: "<value>",
    });

    const result = await sdk.server.getServerCapabilities();
@@ -276,12 +280,14 @@ The server URL can also be overridden on a per-operation basis, provided a serve
 import { PlexAPI } from "@lukehagar/plexjs";

 async function run() {
-    const sdk = new PlexAPI();
+    const sdk = new PlexAPI({
+        xPlexClientIdentifier: "<value>",
+    });

-    const xPlexClientIdentifier = "<value>";
    const strong = false;
+    const xPlexClientIdentifier = "<value>";

-    const result = await sdk.plex.getPin(xPlexClientIdentifier, strong, {
+    const result = await sdk.plex.getPin(strong, xPlexClientIdentifier, {
        serverURL: "https://plex.tv/api/v2",
    });

@@ -361,6 +367,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
    const sdk = new PlexAPI({
        accessToken: "<YOUR_API_KEY_HERE>",
+        xPlexClientIdentifier: "<value>",
    });

    const result = await sdk.server.getServerCapabilities();
@@ -380,6 +387,50 @@ run();
 For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 <!-- End Requirements [requirements] -->

+<!-- Start Global Parameters [global-parameters] -->
+## Global Parameters
+
+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 `"<value>"` 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
+
+The following global parameter is available. The required parameter must be set when you initialize the SDK client.
+
+| Name | Type | Required | Description |
+| ---- | ---- |:--------:| ----------- |
+| xPlexClientIdentifier | string | ✔️ | 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)
+ |
+
+
+### Example
+
+```typescript
+import { PlexAPI } from "@lukehagar/plexjs";
+
+async function run() {
+    const sdk = new PlexAPI({
+        xPlexClientIdentifier: "<value>",
+    });
+
+    const strong = false;
+    const xPlexClientIdentifier = "<value>";
+
+    const result = await sdk.plex.getPin(strong, xPlexClientIdentifier);
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End Global Parameters [global-parameters] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->

 # Development
--- a/RELEASES.md
+++ b/RELEASES.md
@@ -268,4 +268,24 @@ Based on:
 ### Generated
 - [typescript v0.10.4] .
 ### Releases
- [NPM v0.10.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.4 - .
+- [NPM v0.10.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.4 - .
+
+## 2024-03-27 00:25:29
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.227.0 (2.291.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.11.0] .
+### Releases
+- [NPM v0.11.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.11.0 - .
+
+## 2024-03-29 16:36:42
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.228.1 (2.292.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.12.0] .
+### Releases
+- [NPM v0.12.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.0 - .
--- a/USAGE.md
+++ b/USAGE.md
@@ -5,6 +5,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
    const sdk = new PlexAPI({
        accessToken: "<YOUR_API_KEY_HERE>",
+        xPlexClientIdentifier: "<value>",
    });

    const result = await sdk.server.getServerCapabilities();
--- a/docs/models/operations/getpinrequest.md
+++ b/docs/models/operations/getpinrequest.md
@@ -5,5 +5,5 @@

 | Field                                                                                                                                                                 | Type                                                                                                                                                                  | Required                                                                                                                                                              | Description                                                                                                                                                           |
 | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `xPlexClientIdentifier`                                                                                                                                               | *string*                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                    | 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/> |
-| `strong`                                                                                                                                                              | *boolean*                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                    | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/>     |
+| `strong`                                                                                                                                                              | *boolean*                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                    | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/>     |
+| `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/> |
--- a/docs/models/operations/gettokenrequest.md
+++ b/docs/models/operations/gettokenrequest.md
@@ -6,4 +6,4 @@
 | Field                                                                                                                                                                 | Type                                                                                                                                                                  | Required                                                                                                                                                              | Description                                                                                                                                                           |
 | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `pinID`                                                                                                                                                               | *string*                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                    | The PinID to retrieve an access token for                                                                                                                             |
-| `xPlexClientIdentifier`                                                                                                                                               | *string*                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                    | 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/> |
+| `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/> |
--- a/docs/sdks/activities/README.md
+++ b/docs/sdks/activities/README.md
@@ -29,6 +29,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.activities.getServerActivities();
@@ -70,6 +71,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const activityUUID = "<value>";
--- a/docs/sdks/authentication/README.md
+++ b/docs/sdks/authentication/README.md
@@ -25,6 +25,7 @@ import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const type = GetTransientTokenQueryParamType.Delegation;
@@ -73,6 +74,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const source = "server://client-identifier";
--- a/docs/sdks/butler/README.md
+++ b/docs/sdks/butler/README.md
@@ -26,6 +26,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.butler.getButlerTasks();
@@ -72,6 +73,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.butler.startAllTasks();
@@ -114,6 +116,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.butler.stopAllTasks();
@@ -161,6 +164,7 @@ import { TaskName } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const taskName = TaskName.CleanOldBundles;
@@ -207,6 +211,7 @@ import { PathParamTaskName } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const taskName = PathParamTaskName.BackupDatabase;
--- a/docs/sdks/hubs/README.md
+++ b/docs/sdks/hubs/README.md
@@ -24,6 +24,7 @@ import { OnlyTransient } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const count = 1262.49;
@@ -72,6 +73,7 @@ import { QueryParamOnlyTransient } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const sectionId = 6728.76;
--- a/docs/sdks/library/README.md
+++ b/docs/sdks/library/README.md
@@ -32,6 +32,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const url = "file://C:\Image.png&type=13";
@@ -79,6 +80,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.library.getRecentlyAdded();
@@ -126,6 +128,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.library.getLibraries();
@@ -207,6 +210,7 @@ import { IncludeDetails } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const sectionId = 1000;
@@ -253,6 +257,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const sectionId = 1000;
@@ -318,6 +323,7 @@ import { Tag } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const sectionId = 451092;
@@ -364,6 +370,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const sectionId = 934.16;
@@ -427,6 +434,7 @@ import { Type } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const sectionId = 933505;
@@ -473,6 +481,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const ratingKey = 8382.31;
@@ -518,6 +527,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const ratingKey = 1539.14;
@@ -563,6 +573,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.library.getOnDeck();
--- a/docs/sdks/log/README.md
+++ b/docs/sdks/log/README.md
@@ -26,6 +26,7 @@ import { Level } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const level = Level.Three;
@@ -95,6 +96,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.log.logMultiLine("level=4&message=Test%20message%201&source=postman
@@ -140,6 +142,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.log.enablePaperTrail();
--- a/docs/sdks/media/README.md
+++ b/docs/sdks/media/README.md
@@ -24,6 +24,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const key = 59398;
@@ -68,6 +69,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const key = 59398;
@@ -113,6 +115,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const key = "<value>";
--- a/docs/sdks/playlists/README.md
+++ b/docs/sdks/playlists/README.md
@@ -37,6 +37,7 @@ import { QueryParamType, Smart } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.playlists.createPlaylist({
@@ -85,6 +86,7 @@ import { PlaylistType, QueryParamSmart } from "@lukehagar/plexjs/models/operatio
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const playlistType = PlaylistType.Audio;
@@ -133,6 +135,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const playlistID = 4109.48;
@@ -178,6 +181,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const playlistID = 216.22;
@@ -223,6 +227,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const playlistID = 3915;
@@ -275,6 +280,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const playlistID = 5004.46;
@@ -322,6 +328,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const playlistID = 1893.18;
@@ -368,6 +375,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const playlistID = 8502.01;
@@ -418,6 +426,7 @@ import { Force } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const path = "/home/barkley/playlist.m3u";
--- a/docs/sdks/plex/README.md
+++ b/docs/sdks/plex/README.md
@@ -21,12 +21,14 @@ Retrieve a Pin from Plex.tv for authentication flows
 import { PlexAPI } from "@lukehagar/plexjs";

 async function run() {
-  const sdk = new PlexAPI();
+  const sdk = new PlexAPI({
+    xPlexClientIdentifier: "<value>",
+  });

-  const xPlexClientIdentifier = "<value>";
  const strong = false;
+  const xPlexClientIdentifier = "<value>";
  
-  const result = await sdk.plex.getPin(xPlexClientIdentifier, strong);
+  const result = await sdk.plex.getPin(strong, xPlexClientIdentifier);

  // Handle the result
  console.log(result)
@@ -39,8 +41,8 @@ run();

 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `xPlexClientIdentifier`                                                                                                                                                        | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | 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/> |
 | `strong`                                                                                                                                                                       | *boolean*                                                                                                                                                                      | :heavy_minus_sign:                                                                                                                                                             | Determines the kind of code returned by the API call<br/>Strong codes are used for Pin authentication flows<br/>Non-Strong codes are used for `Plex.tv/link`<br/>              |
+| `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/> |
 | `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.                                                                                                                                                 |
@@ -66,7 +68,9 @@ Retrieve an Access Token from Plex.tv after the Pin has already been authenticat
 import { PlexAPI } from "@lukehagar/plexjs";

 async function run() {
-  const sdk = new PlexAPI();
+  const sdk = new PlexAPI({
+    xPlexClientIdentifier: "<value>",
+  });

  const pinID = "<value>";
  const xPlexClientIdentifier = "<value>";
@@ -85,7 +89,7 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `pinID`                                                                                                                                                                        | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The PinID to retrieve an access token for                                                                                                                                      |
-| `xPlexClientIdentifier`                                                                                                                                                        | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | 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/> |
+| `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/> |
 | `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.                                                                                                                                                 |
--- a/docs/sdks/search/README.md
+++ b/docs/sdks/search/README.md
@@ -36,6 +36,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const query = "dylan";
@@ -88,6 +89,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const query = "dead+poop";
@@ -136,6 +138,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const query = "110";
--- a/docs/sdks/server/README.md
+++ b/docs/sdks/server/README.md
@@ -29,6 +29,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.server.getServerCapabilities();
@@ -70,6 +71,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.server.getServerPreferences();
@@ -111,6 +113,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.server.getAvailableClients();
@@ -152,6 +155,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.server.getDevices();
@@ -193,6 +197,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.server.getServerIdentity();
@@ -234,6 +239,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.server.getMyPlexAccount();
@@ -277,6 +283,7 @@ import { MinSize, Upscale } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.server.getResizedPhoto({
@@ -327,6 +334,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.server.getServerList();
--- a/docs/sdks/sessions/README.md
+++ b/docs/sdks/sessions/README.md
@@ -25,6 +25,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.sessions.getSessions();
@@ -66,6 +67,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.sessions.getSessionHistory();
@@ -107,6 +109,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.sessions.getTranscodeSessions();
@@ -148,6 +151,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const sessionKey = "zz7llzqlx8w9vnrsbnwhbmep";
--- a/docs/sdks/statistics/README.md
+++ b/docs/sdks/statistics/README.md
@@ -22,6 +22,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const timespan = 411769;
--- a/docs/sdks/updater/README.md
+++ b/docs/sdks/updater/README.md
@@ -25,6 +25,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.updater.getUpdateStatus();
@@ -67,6 +68,7 @@ import { Download } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const download = Download.One;
@@ -113,6 +115,7 @@ import { Skip, Tonight } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const tonight = Tonight.One;
--- a/docs/sdks/video/README.md
+++ b/docs/sdks/video/README.md
@@ -24,6 +24,7 @@ import { State } from "@lukehagar/plexjs/models/operations";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.video.getTimeline({
@@ -77,6 +78,7 @@ import { PlexAPI } from "@lukehagar/plexjs";
 async function run() {
  const sdk = new PlexAPI({
    accessToken: "<YOUR_API_KEY_HERE>",
+    xPlexClientIdentifier: "<value>",
  });

  const result = await sdk.video.startUniversalTranscode({
--- a/gen.yaml
+++ b/gen.yaml
@@ -12,7 +12,7 @@ generation:
  auth:
    oAuth2ClientCredentialsEnabled: false
 typescript:
-  version: 0.10.4
+  version: 0.12.0
  additionalDependencies:
    dependencies: {}
    devDependencies: {}
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
  "name": "@lukehagar/plexjs",
-  "version": "0.10.4",
+  "version": "0.12.0",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "@lukehagar/plexjs",
-      "version": "0.10.4",
+      "version": "0.12.0",
      "devDependencies": {
        "@types/jsonpath": "^0.2.4",
        "@typescript-eslint/eslint-plugin": "^6.13.2",
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@lukehagar/plexjs",
-  "version": "0.10.4",
+  "version": "0.12.0",
  "author": "LukeHagar",
  "main": "./index.js",
  "sideEffects": false,
--- a/src/lib/config.ts
+++ b/src/lib/config.ts
@@ -27,6 +27,11 @@ export enum ServerProtocol {
 export type SDKOptions = {
    accessToken?: string | (() => Promise<string>);

+    /**
+     * Allows setting the xPlexClientIdentifier parameter for all supported operations
+     */
+    xPlexClientIdentifier?: string;
+
    httpClient?: HTTPClient;
    /**
     * Allows overriding the default server used by the SDK
@@ -82,7 +87,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = Object.freeze({
    language: "typescript",
    openapiDocVersion: "0.0.3",
-    sdkVersion: "0.10.4",
-    genVersion: "2.283.1",
-    userAgent: "speakeasy-sdk/typescript 0.10.4 2.283.1 0.0.3 @lukehagar/plexjs",
+    sdkVersion: "0.12.0",
+    genVersion: "2.292.0",
+    userAgent: "speakeasy-sdk/typescript 0.12.0 2.292.0 0.0.3 @lukehagar/plexjs",
 });
--- a/src/lib/http.ts
+++ b/src/lib/http.ts
@@ -7,15 +7,17 @@ export type Fetcher = (
  init?: RequestInit,
 ) => Promise<Response>;

+type Awaitable<T> = T | Promise<T>;
+
 const DEFAULT_FETCHER: Fetcher = (input, init) => fetch(input, init);

 export interface HTTPClientOptions {
  fetcher?: Fetcher;
 }

-type BeforeRequestHook = (req: Request) => Request | void;
-type RequestErrorHook = (err: unknown, req: Request) => void;
-type ResponseHook = (res: Response, req: Request) => void;
+type BeforeRequestHook = (req: Request) => Awaitable<Request | void>;
+type RequestErrorHook = (err: unknown, req: Request) => Awaitable<void>;
+type ResponseHook = (res: Response, req: Request) => Awaitable<void>;

 export class HTTPClient {
  private fetcher: Fetcher;
@@ -28,17 +30,27 @@ export class HTTPClient {
  }

  async request(request: Request): Promise<Response> {
-    const req = this.requestHooks.reduce((currentReq, fn) => {
-      const nextRequest = fn(currentReq);
-      return nextRequest || currentReq;
-    }, request);
+    let req = request;
+    for (const hook of this.requestHooks) {
+      const nextRequest = await hook(req);
+      if (nextRequest) {
+        req = nextRequest;
+      }
+    }

    try {
      const res = await this.fetcher(req);
-      this.responseHooks.forEach((fn) => fn(res, req));
+
+      for (const hook of this.responseHooks) {
+        await hook(res, req);
+      }
+
      return res;
    } catch (err) {
-      this.requestErrorHooks.forEach((fn) => fn(err, req));
+      for (const hook of this.requestErrorHooks) {
+        await hook(err, req);
+      }
+
      throw err;
    }
  }
--- a/src/models/operations/getpin.ts
+++ b/src/models/operations/getpin.ts
@@ -7,15 +7,6 @@ import * as z from "zod";
 export const GetPinServerList = ["https://plex.tv/api/v2"] as const;

 export type GetPinRequest = {
-    /**
-     * The unique identifier for the client application
-     *
-     * @remarks
-     * This is used to track the client application and its usage
-     * (UUID, serial number, or other number unique per device)
-     *
-     */
-    xPlexClientIdentifier: string;
    /**
     * Determines the kind of code returned by the API call
     *
@@ -25,6 +16,15 @@ export type GetPinRequest = {
     *
     */
    strong?: boolean | undefined;
+    /**
+     * The unique identifier for the client application
+     *
+     * @remarks
+     * This is used to track the client application and its usage
+     * (UUID, serial number, or other number unique per device)
+     *
+     */
+    xPlexClientIdentifier?: string | undefined;
 };

 export type Location = {
@@ -91,36 +91,40 @@ export type GetPinResponse = {
 /** @internal */
 export namespace GetPinRequest$ {
    export type Inbound = {
-        "X-Plex-Client-Identifier": string;
        strong?: boolean | undefined;
+        "X-Plex-Client-Identifier"?: string | undefined;
    };

    export const inboundSchema: z.ZodType<GetPinRequest, z.ZodTypeDef, Inbound> = z
        .object({
-            "X-Plex-Client-Identifier": z.string(),
            strong: z.boolean().default(false),
+            "X-Plex-Client-Identifier": z.string().optional(),
        })
        .transform((v) => {
            return {
-                xPlexClientIdentifier: v["X-Plex-Client-Identifier"],
                strong: v.strong,
+                ...(v["X-Plex-Client-Identifier"] === undefined
+                    ? null
+                    : { xPlexClientIdentifier: v["X-Plex-Client-Identifier"] }),
            };
        });

    export type Outbound = {
-        "X-Plex-Client-Identifier": string;
        strong: boolean;
+        "X-Plex-Client-Identifier"?: string | undefined;
    };

    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetPinRequest> = z
        .object({
-            xPlexClientIdentifier: z.string(),
            strong: z.boolean().default(false),
+            xPlexClientIdentifier: z.string().optional(),
        })
        .transform((v) => {
            return {
-                "X-Plex-Client-Identifier": v.xPlexClientIdentifier,
                strong: v.strong,
+                ...(v.xPlexClientIdentifier === undefined
+                    ? null
+                    : { "X-Plex-Client-Identifier": v.xPlexClientIdentifier }),
            };
        });
 }
--- a/src/models/operations/gettoken.ts
+++ b/src/models/operations/gettoken.ts
@@ -19,7 +19,7 @@ export type GetTokenRequest = {
     * (UUID, serial number, or other number unique per device)
     *
     */
-    xPlexClientIdentifier: string;
+    xPlexClientIdentifier?: string | undefined;
 };

 export type GetTokenResponse = {
@@ -41,35 +41,39 @@ export type GetTokenResponse = {
 export namespace GetTokenRequest$ {
    export type Inbound = {
        pinID: string;
-        "X-Plex-Client-Identifier": string;
+        "X-Plex-Client-Identifier"?: string | undefined;
    };

    export const inboundSchema: z.ZodType<GetTokenRequest, z.ZodTypeDef, Inbound> = z
        .object({
            pinID: z.string(),
-            "X-Plex-Client-Identifier": z.string(),
+            "X-Plex-Client-Identifier": z.string().optional(),
        })
        .transform((v) => {
            return {
                pinID: v.pinID,
-                xPlexClientIdentifier: v["X-Plex-Client-Identifier"],
+                ...(v["X-Plex-Client-Identifier"] === undefined
+                    ? null
+                    : { xPlexClientIdentifier: v["X-Plex-Client-Identifier"] }),
            };
        });

    export type Outbound = {
        pinID: string;
-        "X-Plex-Client-Identifier": string;
+        "X-Plex-Client-Identifier"?: string | undefined;
    };

    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTokenRequest> = z
        .object({
            pinID: z.string(),
-            xPlexClientIdentifier: z.string(),
+            xPlexClientIdentifier: z.string().optional(),
        })
        .transform((v) => {
            return {
                pinID: v.pinID,
-                "X-Plex-Client-Identifier": v.xPlexClientIdentifier,
+                ...(v.xPlexClientIdentifier === undefined
+                    ? null
+                    : { "X-Plex-Client-Identifier": v.xPlexClientIdentifier }),
            };
        });
 }
--- a/src/sdk/plex.ts
+++ b/src/sdk/plex.ts
@@ -45,13 +45,13 @@ export class Plex extends ClientSDK {
     * Retrieve a Pin from Plex.tv for authentication flows
     */
    async getPin(
-        xPlexClientIdentifier: string,
        strong?: boolean | undefined,
+        xPlexClientIdentifier?: string | undefined,
        options?: RequestOptions & { serverURL?: string }
    ): Promise<operations.GetPinResponse> {
        const input$: operations.GetPinRequest = {
-            xPlexClientIdentifier: xPlexClientIdentifier,
            strong: strong,
+            xPlexClientIdentifier: xPlexClientIdentifier,
        };
        const headers$ = new Headers();
        headers$.set("user-agent", SDK_METADATA.userAgent);
@@ -79,10 +79,11 @@ export class Plex extends ClientSDK {

        headers$.set(
            "X-Plex-Client-Identifier",
-            enc$.encodeSimple("X-Plex-Client-Identifier", payload$["X-Plex-Client-Identifier"], {
-                explode: false,
-                charEncoding: "none",
-            })
+            enc$.encodeSimple(
+                "X-Plex-Client-Identifier",
+                payload$["X-Plex-Client-Identifier"] ?? this.options$.xPlexClientIdentifier,
+                { explode: false, charEncoding: "none" }
+            )
        );
        const context = { operationID: "getPin", oAuth2Scopes: [], securitySource: null };

@@ -147,7 +148,7 @@ export class Plex extends ClientSDK {
     */
    async getToken(
        pinID: string,
-        xPlexClientIdentifier: string,
+        xPlexClientIdentifier?: string | undefined,
        options?: RequestOptions & { serverURL?: string }
    ): Promise<operations.GetTokenResponse> {
        const input$: operations.GetTokenRequest = {
@@ -182,10 +183,11 @@ export class Plex extends ClientSDK {

        headers$.set(
            "X-Plex-Client-Identifier",
-            enc$.encodeSimple("X-Plex-Client-Identifier", payload$["X-Plex-Client-Identifier"], {
-                explode: false,
-                charEncoding: "none",
-            })
+            enc$.encodeSimple(
+                "X-Plex-Client-Identifier",
+                payload$["X-Plex-Client-Identifier"] ?? this.options$.xPlexClientIdentifier,
+                { explode: false, charEncoding: "none" }
+            )
        );
        const context = { operationID: "getToken", oAuth2Scopes: [], securitySource: null };
Author	SHA1	Message	Date
speakeasybot	eeadc8c329	ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.228.1	2024-03-29 16:38:38 +00:00
speakeasybot	dbe2e37bba	ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.227.0	2024-03-27 00:27:27 +00:00