diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index faa2c76..d2dacef 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 3eeea668-4ef4-464e-a888-bdfa023bedf5 management: - docChecksum: afed3802b7464cc21bb376d0f1d86fed + docChecksum: f12b653820ae77ca3b2820bc9459d866 docVersion: 0.0.3 - speakeasyVersion: 1.405.4 + speakeasyVersion: 1.405.6 generationVersion: 2.428.1 - releaseVersion: 0.17.0 - configChecksum: b1c3933e3a65d25daedb93f39f38ffeb + releaseVersion: 0.17.1 + configChecksum: ead5543bde6053af00ea28c71281c2a3 repoURL: https://github.com/LukeHagar/plexpy.git repoSubDirectory: . installationURL: https://github.com/LukeHagar/plexpy.git diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 16550e8..57624dd 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: true python: - version: 0.17.0 + version: 0.17.1 additionalDependencies: dev: {} main: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 46ccddf..9cd0cfc 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.405.4 +speakeasyVersion: 1.405.6 sources: my-source: sourceNamespace: my-source @@ -8,8 +8,8 @@ sources: - latest plexapi: sourceNamespace: plexapi - sourceRevisionDigest: sha256:79dca9232c55c6829ffc5f89a9eeb957e6273213be222d012238da40d5086df1 - sourceBlobDigest: sha256:91b080122ff1fe0c86a02f3c39accc03dbad569b4324503941523d1d29c51b7e + sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57 + sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361 tags: - latest - main @@ -17,10 +17,10 @@ targets: plexpy: source: plexapi sourceNamespace: plexapi - sourceRevisionDigest: sha256:79dca9232c55c6829ffc5f89a9eeb957e6273213be222d012238da40d5086df1 - sourceBlobDigest: sha256:91b080122ff1fe0c86a02f3c39accc03dbad569b4324503941523d1d29c51b7e + sourceRevisionDigest: sha256:c52cde0b8d51e160f7b9f1a3d3ea4dbb1aca6d5caad714e549201fb757fadd57 + sourceBlobDigest: sha256:f417b03ff71356808554313f24c3d06d670474bf51bc9a0631de1ad49c13a361 codeSamplesNamespace: code-samples-python-plexpy - codeSamplesRevisionDigest: sha256:63c7d9f051f6fa45b2fe3fdcf8151db3248a5dd113f6d7054b86007c381d3500 + codeSamplesRevisionDigest: sha256:4bd63bb65e2a00ee23f7799c4c14d38629318b0d107761d9d29c888d9f88b9c0 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index db339b1..611d1f9 100644 --- a/README.md +++ b/README.md @@ -596,10 +596,7 @@ The following global parameters are available. | Name | Type | Required | Description | | ---- | ---- |:--------:| ----------- | -| client_id | str | | 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) - | +| client_id | str | | 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) | | client_name | str | | The client_name parameter. | | client_version | str | | The client_version parameter. | | client_platform | str | | The client_platform parameter. | diff --git a/RELEASES.md b/RELEASES.md index eb606d5..8ff3eef 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -818,4 +818,14 @@ Based on: ### Generated - [python v0.17.0] . ### Releases -- [PyPI v0.17.0] https://pypi.org/project/plex-api-client/0.17.0 - . \ No newline at end of file +- [PyPI v0.17.0] https://pypi.org/project/plex-api-client/0.17.0 - . + +## 2024-10-01 00:01:20 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.17.1] . +### Releases +- [PyPI v0.17.1] https://pypi.org/project/plex-api-client/0.17.1 - . \ No newline at end of file diff --git a/docs/models/internal/globals.md b/docs/models/internal/globals.md index 8337f8a..3c91b50 100644 --- a/docs/models/internal/globals.md +++ b/docs/models/internal/globals.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | *Optional[str]* | :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)
| gcgzw5rz2xovp84b4vha3a40 | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | -| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | -| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | -| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `client_id` | *Optional[str]* | :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) | gcgzw5rz2xovp84b4vha3a40 | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | +| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | +| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | +| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | \ No newline at end of file diff --git a/docs/models/operations/getpinglobals.md b/docs/models/operations/getpinglobals.md index eebe01e..cff34df 100644 --- a/docs/models/operations/getpinglobals.md +++ b/docs/models/operations/getpinglobals.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | *Optional[str]* | :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)
| gcgzw5rz2xovp84b4vha3a40 | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | -| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | -| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | -| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `client_id` | *Optional[str]* | :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) | gcgzw5rz2xovp84b4vha3a40 | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | +| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | +| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | +| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/getpinrequest.md b/docs/models/operations/getpinrequest.md index 8a0b004..81d6607 100644 --- a/docs/models/operations/getpinrequest.md +++ b/docs/models/operations/getpinrequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `strong` | *Optional[bool]* | :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`
| | -| `client_id` | *Optional[str]* | :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)
| gcgzw5rz2xovp84b4vha3a40 | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | -| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | -| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | -| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `strong` | *Optional[bool]* | :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`
| | +| `client_id` | *Optional[str]* | :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) | gcgzw5rz2xovp84b4vha3a40 | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | +| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | +| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | +| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/getserverresourcesglobals.md b/docs/models/operations/getserverresourcesglobals.md index 10585ba..927515a 100644 --- a/docs/models/operations/getserverresourcesglobals.md +++ b/docs/models/operations/getserverresourcesglobals.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | *Optional[str]* | :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)
| gcgzw5rz2xovp84b4vha3a40 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `client_id` | *Optional[str]* | :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) | gcgzw5rz2xovp84b4vha3a40 | \ No newline at end of file diff --git a/docs/models/operations/getserverresourcesrequest.md b/docs/models/operations/getserverresourcesrequest.md index 9ca7d8d..d4fc0cf 100644 --- a/docs/models/operations/getserverresourcesrequest.md +++ b/docs/models/operations/getserverresourcesrequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | -| `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | -| `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | -| `client_id` | *Optional[str]* | :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)
| gcgzw5rz2xovp84b4vha3a40 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | +| `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | +| `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | +| `client_id` | *Optional[str]* | :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) | gcgzw5rz2xovp84b4vha3a40 | \ No newline at end of file diff --git a/docs/models/operations/gettokenbypinidglobals.md b/docs/models/operations/gettokenbypinidglobals.md index 21ef3e4..f3b9a7e 100644 --- a/docs/models/operations/gettokenbypinidglobals.md +++ b/docs/models/operations/gettokenbypinidglobals.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | *Optional[str]* | :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)
| gcgzw5rz2xovp84b4vha3a40 | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | -| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | -| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | -| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `client_id` | *Optional[str]* | :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) | gcgzw5rz2xovp84b4vha3a40 | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | +| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | +| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | +| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/gettokenbypinidrequest.md b/docs/models/operations/gettokenbypinidrequest.md index 425b75c..72d48cb 100644 --- a/docs/models/operations/gettokenbypinidrequest.md +++ b/docs/models/operations/gettokenbypinidrequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | | -| `client_id` | *Optional[str]* | :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)
| gcgzw5rz2xovp84b4vha3a40 | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | -| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | -| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | -| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `pin_id` | *int* | :heavy_check_mark: | The PinID to retrieve an access token for | | +| `client_id` | *Optional[str]* | :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) | gcgzw5rz2xovp84b4vha3a40 | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | +| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | +| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | +| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/postuserssignindataglobals.md b/docs/models/operations/postuserssignindataglobals.md index 90b221c..14e2631 100644 --- a/docs/models/operations/postuserssignindataglobals.md +++ b/docs/models/operations/postuserssignindataglobals.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | *Optional[str]* | :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)
| gcgzw5rz2xovp84b4vha3a40 | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | -| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | -| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | -| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `client_id` | *Optional[str]* | :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) | gcgzw5rz2xovp84b4vha3a40 | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | +| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | +| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | +| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | \ No newline at end of file diff --git a/docs/models/operations/postuserssignindatarequest.md b/docs/models/operations/postuserssignindatarequest.md index ebbb85b..b4fe58e 100644 --- a/docs/models/operations/postuserssignindatarequest.md +++ b/docs/models/operations/postuserssignindatarequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client_id` | *Optional[str]* | :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)
| gcgzw5rz2xovp84b4vha3a40 | -| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | -| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | -| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | -| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | -| `request_body` | [Optional[operations.PostUsersSignInDataRequestBody]](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `client_id` | *Optional[str]* | :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) | gcgzw5rz2xovp84b4vha3a40 | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Plex Web | +| `device_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Linux | +| `client_version` | *Optional[str]* | :heavy_minus_sign: | N/A | 4.133.0 | +| `client_platform` | *Optional[str]* | :heavy_minus_sign: | N/A | Chrome | +| `request_body` | [Optional[operations.PostUsersSignInDataRequestBody]](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | | \ No newline at end of file diff --git a/docs/sdks/plex/README.md b/docs/sdks/plex/README.md index 2cae6fe..7eba97e 100644 --- a/docs/sdks/plex/README.md +++ b/docs/sdks/plex/README.md @@ -223,14 +223,14 @@ if res.plex_devices is not None: ### Parameters -| Parameter | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | -| `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | -| `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | -| `client_id` | *Optional[str]* | :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)
| gcgzw5rz2xovp84b4vha3a40 | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | -| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | +| Parameter | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `include_https` | [Optional[operations.IncludeHTTPS]](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 | +| `include_relay` | [Optional[operations.IncludeRelay]](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results
E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
| 1 | +| `include_i_pv6` | [Optional[operations.IncludeIPv6]](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 | +| `client_id` | *Optional[str]* | :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) | gcgzw5rz2xovp84b4vha3a40 | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| `server_url` | *Optional[str]* | :heavy_minus_sign: | An optional server URL to use. | http://localhost:8080 | ### Response diff --git a/pyproject.toml b/pyproject.toml index 7357d87..f4c99f0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "plex-api-client" -version = "0.17.0" +version = "0.17.1" description = "Python Client SDK Generated by Speakeasy" authors = ["Speakeasy",] readme = "README-PYPI.md" diff --git a/src/plex_api_client/models/internal/globals.py b/src/plex_api_client/models/internal/globals.py index b6ffc94..eaea0b1 100644 --- a/src/plex_api_client/models/internal/globals.py +++ b/src/plex_api_client/models/internal/globals.py @@ -10,11 +10,7 @@ from typing_extensions import Annotated, NotRequired class GlobalsTypedDict(TypedDict): client_id: NotRequired[str] - r"""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) - - """ + r"""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)""" client_name: NotRequired[str] client_version: NotRequired[str] client_platform: NotRequired[str] @@ -27,11 +23,7 @@ class Globals(BaseModel): pydantic.Field(alias="X-Plex-Client-Identifier"), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), ] = None - r"""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) - - """ + r"""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)""" client_name: Annotated[ Optional[str], diff --git a/src/plex_api_client/models/operations/get_server_resources.py b/src/plex_api_client/models/operations/get_server_resources.py index dec3bff..6b3141a 100644 --- a/src/plex_api_client/models/operations/get_server_resources.py +++ b/src/plex_api_client/models/operations/get_server_resources.py @@ -18,11 +18,7 @@ GET_SERVER_RESOURCES_SERVERS = [ class GetServerResourcesGlobalsTypedDict(TypedDict): client_id: NotRequired[str] - r"""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) - - """ + r"""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)""" class GetServerResourcesGlobals(BaseModel): @@ -31,11 +27,7 @@ class GetServerResourcesGlobals(BaseModel): pydantic.Field(alias="X-Plex-Client-Identifier"), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), ] = None - r"""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) - - """ + r"""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)""" class IncludeHTTPS(int, Enum): @@ -73,11 +65,7 @@ class GetServerResourcesRequestTypedDict(TypedDict): include_i_pv6: NotRequired[IncludeIPv6] r"""Include IPv6 entries in the results""" client_id: NotRequired[str] - r"""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) - - """ + r"""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)""" class GetServerResourcesRequest(BaseModel): @@ -110,11 +98,7 @@ class GetServerResourcesRequest(BaseModel): pydantic.Field(alias="X-Plex-Client-Identifier"), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), ] = None - r"""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) - - """ + r"""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)""" class Protocol(str, Enum): diff --git a/src/plex_api_client/models/operations/getpin.py b/src/plex_api_client/models/operations/getpin.py index 5005b9e..878271c 100644 --- a/src/plex_api_client/models/operations/getpin.py +++ b/src/plex_api_client/models/operations/getpin.py @@ -23,11 +23,7 @@ GET_PIN_SERVERS = [ class GetPinGlobalsTypedDict(TypedDict): client_id: NotRequired[str] - r"""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) - - """ + r"""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)""" client_name: NotRequired[str] device_name: NotRequired[str] client_version: NotRequired[str] @@ -40,11 +36,7 @@ class GetPinGlobals(BaseModel): pydantic.Field(alias="X-Plex-Client-Identifier"), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), ] = None - r"""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) - - """ + r"""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)""" client_name: Annotated[ Optional[str], @@ -79,11 +71,7 @@ class GetPinRequestTypedDict(TypedDict): """ client_id: NotRequired[str] - r"""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) - - """ + r"""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)""" client_name: NotRequired[str] device_name: NotRequired[str] client_version: NotRequired[str] @@ -106,11 +94,7 @@ class GetPinRequest(BaseModel): pydantic.Field(alias="X-Plex-Client-Identifier"), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), ] = None - r"""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) - - """ + r"""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)""" client_name: Annotated[ Optional[str], diff --git a/src/plex_api_client/models/operations/gettokenbypinid.py b/src/plex_api_client/models/operations/gettokenbypinid.py index c53f08e..0025158 100644 --- a/src/plex_api_client/models/operations/gettokenbypinid.py +++ b/src/plex_api_client/models/operations/gettokenbypinid.py @@ -23,11 +23,7 @@ GET_TOKEN_BY_PIN_ID_SERVERS = [ class GetTokenByPinIDGlobalsTypedDict(TypedDict): client_id: NotRequired[str] - r"""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) - - """ + r"""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)""" client_name: NotRequired[str] device_name: NotRequired[str] client_version: NotRequired[str] @@ -40,11 +36,7 @@ class GetTokenByPinIDGlobals(BaseModel): pydantic.Field(alias="X-Plex-Client-Identifier"), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), ] = None - r"""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) - - """ + r"""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)""" client_name: Annotated[ Optional[str], @@ -75,11 +67,7 @@ class GetTokenByPinIDRequestTypedDict(TypedDict): pin_id: int r"""The PinID to retrieve an access token for""" client_id: NotRequired[str] - r"""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) - - """ + r"""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)""" client_name: NotRequired[str] device_name: NotRequired[str] client_version: NotRequired[str] @@ -99,11 +87,7 @@ class GetTokenByPinIDRequest(BaseModel): pydantic.Field(alias="X-Plex-Client-Identifier"), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), ] = None - r"""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) - - """ + r"""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)""" client_name: Annotated[ Optional[str], diff --git a/src/plex_api_client/models/operations/post_users_sign_in_data.py b/src/plex_api_client/models/operations/post_users_sign_in_data.py index cdc55bd..fe53994 100644 --- a/src/plex_api_client/models/operations/post_users_sign_in_data.py +++ b/src/plex_api_client/models/operations/post_users_sign_in_data.py @@ -31,11 +31,7 @@ POST_USERS_SIGN_IN_DATA_SERVERS = [ class PostUsersSignInDataGlobalsTypedDict(TypedDict): client_id: NotRequired[str] - r"""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) - - """ + r"""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)""" client_name: NotRequired[str] device_name: NotRequired[str] client_version: NotRequired[str] @@ -48,11 +44,7 @@ class PostUsersSignInDataGlobals(BaseModel): pydantic.Field(alias="X-Plex-Client-Identifier"), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), ] = None - r"""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) - - """ + r"""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)""" client_name: Annotated[ Optional[str], @@ -108,11 +100,7 @@ class PostUsersSignInDataRequestBody(BaseModel): class PostUsersSignInDataRequestTypedDict(TypedDict): client_id: NotRequired[str] - r"""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) - - """ + r"""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)""" client_name: NotRequired[str] device_name: NotRequired[str] client_version: NotRequired[str] @@ -127,11 +115,7 @@ class PostUsersSignInDataRequest(BaseModel): pydantic.Field(alias="X-Plex-Client-Identifier"), FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), ] = None - r"""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) - - """ + r"""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)""" client_name: Annotated[ Optional[str], diff --git a/src/plex_api_client/plex.py b/src/plex_api_client/plex.py index 17ff8cd..d336c5f 100644 --- a/src/plex_api_client/plex.py +++ b/src/plex_api_client/plex.py @@ -761,7 +761,7 @@ class Plex(BaseSDK): :param include_https: Include Https entries in the results :param include_relay: Include Relay addresses in the results E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400 :param include_i_pv6: Include IPv6 entries in the results - :param client_id: 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) + :param client_id: 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) :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds @@ -879,7 +879,7 @@ class Plex(BaseSDK): :param include_https: Include Https entries in the results :param include_relay: Include Relay addresses in the results E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400 :param include_i_pv6: Include IPv6 entries in the results - :param client_id: 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) + :param client_id: 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) :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds diff --git a/src/plex_api_client/sdkconfiguration.py b/src/plex_api_client/sdkconfiguration.py index d38d1bf..1a3f3bd 100644 --- a/src/plex_api_client/sdkconfiguration.py +++ b/src/plex_api_client/sdkconfiguration.py @@ -39,9 +39,9 @@ class SDKConfiguration: server_defaults: List[Dict[str, str]] = field(default_factory=List) language: str = "python" openapi_doc_version: str = "0.0.3" - sdk_version: str = "0.17.0" + sdk_version: str = "0.17.1" gen_version: str = "2.428.1" - user_agent: str = "speakeasy-sdk/python 0.17.0 2.428.1 0.0.3 plex-api-client" + user_agent: str = "speakeasy-sdk/python 0.17.1 2.428.1 0.0.3 plex-api-client" retry_config: OptionalNullable[RetryConfig] = Field(default_factory=lambda: UNSET) timeout_ms: Optional[int] = None