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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.308.1

Browse Source
This commit is contained in:
speakeasybot
2024-06-14 16:24:40 +00:00
parent f918b86b8c
commit b48aa356a7
709 changed files with 12120 additions and 10823 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -19,8 +19,7 @@ This endpoint provides the caller with a temporary token with the same access le
### Example Usage
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/models/operations";
import { GetTransientTokenQueryParamType, PlexAPI, Scope } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
@@ -41,21 +40,21 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | [operations.GetTransientTokenQueryParamType](../../models/operations/gettransienttokenqueryparamtype.md) | :heavy_check_mark: | `delegation` - This is the only supported `type` parameter. |
| `scope` | [operations.Scope](../../models/operations/scope.md) | :heavy_check_mark: | `all` - This is the only supported `scope` parameter. |
| `type` | [models.GetTransientTokenQueryParamType](../../models/gettransienttokenqueryparamtype.md) | :heavy_check_mark: | `delegation` - This is the only supported `type` parameter. |
| `scope` | [models.Scope](../../models/scope.md) | :heavy_check_mark: | `all` - This is the only supported `scope` parameter. |
| `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. |
### Response
**Promise\<[operations.GetTransientTokenResponse](../../models/operations/gettransienttokenresponse.md)\>**
**Promise\<[models.GetTransientTokenResponse](../../models/gettransienttokenresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| errors.GetTransientTokenResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| models.GetTransientTokenResponseBody | 401 | application/json |
| models.SDKError | 4xx-5xx | */* |
## getSourceConnectionInformation
@@ -94,10 +93,10 @@ run();
### Response
**Promise\<[operations.GetSourceConnectionInformationResponse](../../models/operations/getsourceconnectioninformationresponse.md)\>**
**Promise\<[models.GetSourceConnectionInformationResponse](../../models/getsourceconnectioninformationresponse.md)\>**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
| errors.GetSourceConnectionInformationResponseBody | 401 | application/json |
| errors.SDKError | 4xx-5xx | */* |
| models.GetSourceConnectionInformationResponseBody | 401 | application/json |
| models.SDKError | 4xx-5xx | */* |