Compare commits

...

145 Commits

Author SHA1 Message Date
speakeasybot
b48aa356a7 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.308.1 2024-06-14 16:24:40 +00:00
Luke Hagar
f918b86b8c Update gen.yaml 2024-06-14 11:02:27 -05:00
speakeasybot
d241fca800 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.307.2 2024-06-14 00:02:53 +00:00
speakeasybot
dafab7ed9d ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.306.0 2024-06-13 00:01:43 +00:00
speakeasybot
18817ccbc0 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.305.0 2024-06-12 00:30:39 +00:00
speakeasybot
241fc555f6 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.300.1 2024-06-10 00:30:44 +00:00
speakeasybot
60385aec49 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.300.1 2024-06-09 00:33:06 +00:00
speakeasybot
502660742d ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.300.1 2024-06-08 00:29:35 +00:00
speakeasybot
796edd7174 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.300.1 2024-06-07 00:30:12 +00:00
speakeasybot
738f7c347d ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.300.0 2024-06-06 00:30:16 +00:00
speakeasybot
5a3c016a7f ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.299.7 2024-06-05 00:28:41 +00:00
speakeasybot
bb1b355abf ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.299.6 2024-06-04 00:30:37 +00:00
speakeasybot
78522ed5bf ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.299.4 2024-06-03 00:29:55 +00:00
speakeasybot
8a524cf9e6 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.299.4 2024-06-02 00:31:30 +00:00
speakeasybot
7e8aef026b ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.299.4 2024-06-01 00:31:12 +00:00
speakeasybot
886f24cade ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.299.3 2024-05-31 00:28:19 +00:00
speakeasybot
9c33aaa04f ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.299.1 2024-05-30 00:30:52 +00:00
speakeasybot
fc2f619cff ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.296.1 2024-05-29 00:29:45 +00:00
speakeasybot
2344b8fb5e ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.296.1 2024-05-28 00:28:43 +00:00
speakeasybot
2d0e878983 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.296.1 2024-05-27 00:29:26 +00:00
speakeasybot
a96e359e00 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.296.1 2024-05-26 00:31:31 +00:00
speakeasybot
d616464526 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.296.1 2024-05-25 00:29:11 +00:00
speakeasybot
933b3708db ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.295.2 2024-05-24 00:28:48 +00:00
speakeasybot
ddc4f916f2 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.295.1 2024-05-23 15:59:09 +00:00
speakeasybot
e418c55013 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.285.1 2024-05-09 04:25:01 +00:00
speakeasybot
b593c2c54b ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.285.1 2024-05-09 04:16:24 +00:00
speakeasybot
a449d25ac4 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.285.1 2024-05-09 03:47:33 +00:00
speakeasybot
6af375d524 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.285.1 2024-05-09 03:32:46 +00:00
speakeasybot
fc838e8ebf ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.285.1 2024-05-09 00:27:26 +00:00
speakeasybot
162b3b3d13 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.285.0 2024-05-08 18:17:06 +00:00
speakeasybot
3dff2b9225 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.283.1 2024-05-08 00:22:37 +00:00
speakeasybot
d6d9c46f51 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.280.1 2024-05-07 00:27:35 +00:00
speakeasybot
f79b24ee0e ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.279.0 2024-05-06 00:28:31 +00:00
speakeasybot
78c540ebf4 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.279.0 2024-05-05 00:29:51 +00:00
speakeasybot
3fc9856c81 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.279.0 2024-05-04 00:26:43 +00:00
speakeasybot
bc1fa68557 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.277.8 2024-05-03 00:29:29 +00:00
speakeasybot
182d88f7f1 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.277.4 2024-05-02 00:27:06 +00:00
speakeasybot
300cbb21cd ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.277.4 2024-05-01 00:29:38 +00:00
speakeasybot
53f3bfd615 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.277.0 2024-04-30 00:28:14 +00:00
speakeasybot
92b22220f1 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.276.0 2024-04-29 00:28:07 +00:00
speakeasybot
a42f887042 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.276.0 2024-04-28 00:30:12 +00:00
speakeasybot
8b9c5c6e41 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.276.0 2024-04-27 00:26:39 +00:00
speakeasybot
eab41f5f41 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.274.1 2024-04-26 00:27:29 +00:00
speakeasybot
e038f1fdcf ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.274.1 2024-04-25 00:31:21 +00:00
Luke Hagar
835f4244ec regenerated 2024-04-24 15:51:11 -05:00
speakeasybot
287c5cb9ad ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.269.1 2024-04-23 00:27:12 +00:00
Luke Hagar
521174faf5 Update jsr.json 2024-04-22 11:37:36 -05:00
Luke Hagar
6fe948fa1e Update publish-jsr.yaml 2024-04-22 11:35:59 -05:00
Luke Hagar
4abb238f51 Update publish-jsr.yaml 2024-04-22 11:35:41 -05:00
Luke Hagar
c10b6af7de Merge branch 'main' of https://github.com/LukeHagar/plexjs 2024-04-22 11:34:22 -05:00
Luke Hagar
6bec4430ff Separated publish action 2024-04-22 11:34:20 -05:00
Luke Hagar
3fe4aee2ea Update speakeasy_sdk_generation.yml 2024-04-22 11:31:20 -05:00
speakeasybot
5b4a51bee7 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.267.2 2024-04-22 16:28:00 +00:00
Luke Hagar
b0cc884d46 Merge branch 'main' of https://github.com/LukeHagar/plexjs 2024-04-22 11:23:11 -05:00
Luke Hagar
a1dc07ae78 Updated generation to also publish to JSR 2024-04-22 11:22:58 -05:00
Luke Hagar
d100297e1d CodeSee is gone 2024-04-22 11:20:58 -05:00
Luke Hagar
14f7d530ec Updated workflow artifacts 2024-04-22 11:20:16 -05:00
Luke Hagar
622219b018 Removed legacy artifacts 2024-04-22 11:20:01 -05:00
speakeasybot
c4dd496e24 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.267.2 2024-04-22 16:16:50 +00:00
speakeasybot
cdda7f840f ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.267.0 2024-04-20 00:26:17 +00:00
speakeasybot
2c04752d88 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.260.6 2024-04-19 00:28:46 +00:00
speakeasybot
242d7d78f2 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.257.1 2024-04-18 00:28:19 +00:00
speakeasybot
779aa2dc9e ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.252.0 2024-04-13 00:26:21 +00:00
speakeasybot
0d73a769fb ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.231.1 2024-04-02 00:28:18 +00:00
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
speakeasybot
6c314bea48 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.213.0 2024-03-20 00:27:47 +00:00
speakeasybot
9e28d57f15 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.209.3 2024-03-15 15:04:11 +00:00
Luke Hagar
9da9389549 migrated speakeasy to v15 2024-03-15 09:56:46 -05:00
speakeasy-github
fd886229c2 chore: update dependencies 2024-03-14 00:27:53 +00:00
speakeasybot
8a8615f241 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.209.2 2024-03-14 00:26:50 +00:00
speakeasy-github
29b8ad88d9 chore: update dependencies 2024-03-13 00:28:02 +00:00
speakeasybot
fd13b3d892 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.207.1 2024-03-13 00:27:03 +00:00
speakeasy-github
fc0ebfe782 chore: update dependencies 2024-03-08 00:28:37 +00:00
speakeasybot
9503c9033d ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.204.1 2024-03-08 00:27:35 +00:00
speakeasy-github
1c5fa25562 chore: update dependencies 2024-03-02 00:27:04 +00:00
speakeasybot
3020866795 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.200.0 2024-03-02 00:26:02 +00:00
speakeasy-github
b0f89ba7d4 chore: update dependencies 2024-03-01 00:32:01 +00:00
speakeasybot
d7d14f28e8 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.198.1 2024-03-01 00:30:57 +00:00
speakeasy-github
e3e80f1dd8 chore: update dependencies 2024-02-24 00:26:46 +00:00
speakeasybot
4819145e93 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.193.4 2024-02-24 00:25:51 +00:00
speakeasy-bot
23c20be9e3 🐝 Add license. 2024-02-23 15:37:29 +00:00
speakeasy-bot
2c76c6640a 🐝 Update gen.yaml 2024-02-23 15:37:28 +00:00
speakeasy-bot
4332937cdc 🐝 Update workflow file 2024-02-23 15:37:27 +00:00
speakeasy-github[bot]
17d56a96d6 chore: update dependencies 2024-02-23 14:48:53 +00:00
speakeasybot
1d4f25475d ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.193.0 2024-02-23 14:47:48 +00:00
speakeasybot
a1f6c6f515 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.166.1 2024-02-05 14:25:14 +00:00
speakeasy-bot
022d345196 🐝 Add license. 2024-02-01 16:30:24 +00:00
speakeasy-bot
6cec42bef1 🐝 Update gen.yaml 2024-02-01 16:30:23 +00:00
speakeasy-bot
eaa84306f6 🐝 Update workflow file 2024-02-01 16:30:22 +00:00
speakeasybot
45ee7680a7 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.161.0 2024-02-01 00:28:42 +00:00
speakeasybot
8668cc2ca6 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.158.0 2024-01-31 15:07:20 +00:00
speakeasybot
9fb5c21c03 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.150.0 2024-01-23 21:56:43 +00:00
speakeasybot
e9cfd11a9c ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.150.0 2024-01-23 20:48:45 +00:00
speakeasybot
7543285c95 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.148.0 2024-01-22 17:17:47 +00:00
speakeasybot
fa999ea454 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.148.0 2024-01-20 03:11:21 +00:00
speakeasybot
b562d2a68e ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.147.0 2024-01-19 17:28:20 +00:00
speakeasybot
09060624f9 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.147.0 2024-01-18 23:38:07 +00:00
speakeasybot
a6620dfce9 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.142.1 2024-01-17 00:28:54 +00:00
speakeasybot
100d1e093b ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.141.1 2024-01-16 00:28:40 +00:00
speakeasybot
ff9f3dc489 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.134.1 2024-01-10 00:28:53 +00:00
speakeasybot
b9629abe33 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.134.0 2024-01-09 00:29:03 +00:00
speakeasybot
f306faa1ff ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.133.1 2024-01-05 19:51:55 +00:00
speakeasy-bot
e5abca0f3c 🐝 Add license. 2024-01-05 19:37:02 +00:00
speakeasy-bot
78acc1880a 🐝 Update gen.yaml 2024-01-05 19:37:01 +00:00
speakeasy-bot
a31aae3cd8 🐝 Update workflow file 2024-01-05 19:37:00 +00:00
speakeasybot
bc64130459 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.130.1 2024-01-05 00:28:28 +00:00
Luke Hagar
b553c6204c Update README.md 2024-01-01 09:24:42 -06:00
speakeasybot
9b02d27d5e ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1 2024-01-01 15:12:41 +00:00
Luke Hagar
f200bc563f Delete README.md 2024-01-01 09:10:23 -06:00
speakeasy-bot
5c4b98300b 🐝 Add license. 2024-01-01 15:09:39 +00:00
speakeasy-bot
1e46343716 🐝 Update gen.yaml 2024-01-01 15:09:39 +00:00
speakeasy-bot
c34f35ba3d 🐝 Update workflow file 2024-01-01 15:09:38 +00:00
speakeasybot
b77c4d818f ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1 2024-01-01 15:06:15 +00:00
Luke Hagar
ea6e427d7b Delete README.md 2024-01-01 09:01:36 -06:00
speakeasy-bot
4ed36cd1a2 🐝 Add license. 2024-01-01 14:36:24 +00:00
speakeasy-bot
1b0b5c218c 🐝 Update gen.yaml 2024-01-01 14:36:24 +00:00
speakeasy-bot
e92eb2ba92 🐝 Update workflow file 2024-01-01 14:36:23 +00:00
speakeasybot
02c32497a7 ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1 2023-12-24 06:38:56 +00:00
Luke Hagar
312e0ecc12 Merge pull request #14 from LukeHagar/speakesy-cleanup
Delete .devcontainer directory
2023-12-24 00:36:56 -06:00
Luke Hagar
fa815de1ba Delete tsconfig.json 2023-12-24 00:35:03 -06:00
Luke Hagar
1bb02c1f94 Delete tsconfig.eslint.json 2023-12-24 00:34:53 -06:00
Luke Hagar
142cc517be Delete package.json 2023-12-24 00:34:33 -06:00
Luke Hagar
b1e60ce405 Delete install.sh 2023-12-24 00:34:25 -06:00
Luke Hagar
a4b62177c6 Delete package-lock.json 2023-12-24 00:34:15 -06:00
Luke Hagar
44dc94ca33 Delete jest.config.json 2023-12-24 00:34:05 -06:00
Luke Hagar
f5b88fc34b Delete README.md 2023-12-24 00:32:10 -06:00
Luke Hagar
058ae4b07a Delete LICENSE 2023-12-24 00:20:20 -06:00
Luke Hagar
1d3fc77b50 Delete .prettierrc.json 2023-12-24 00:20:08 -06:00
Luke Hagar
d725039636 Delete .gitignore 2023-12-24 00:19:48 -06:00
Luke Hagar
1b6e3c7539 Delete .eslintrc.json 2023-12-24 00:19:37 -06:00
Luke Hagar
514ca98c19 Delete test/services directory 2023-12-24 00:19:28 -06:00
Luke Hagar
65d485477d Delete src directory 2023-12-24 00:18:48 -06:00
Luke Hagar
47ed721c66 Delete examples directory 2023-12-24 00:18:39 -06:00
Luke Hagar
3fa96ba701 Delete .github/workflows/test-oag-ver.yml 2023-12-24 00:14:01 -06:00
Luke Hagar
6a98b22eb9 Delete .github/workflows/release-checks.yml 2023-12-24 00:12:05 -06:00
Luke Hagar
cedd748d27 Delete .github/workflows/pr-checks.yml 2023-12-24 00:10:57 -06:00
Luke Hagar
1c08bcb10b Delete .github/workflows/bump_version.yml 2023-12-24 00:09:39 -06:00
Luke Hagar
c6ea30019e Delete .github/workflows/build_pr.yml 2023-12-24 00:08:42 -06:00
Luke Hagar
bace1e6304 Delete .github/workflows/build-checks.yml 2023-12-24 00:07:01 -06:00
Luke Hagar
ac331abdb4 Delete .devcontainer directory 2023-12-24 00:00:45 -06:00
speakeasy-bot
73ffa5bff9 🐝 Add license. 2023-12-24 05:08:22 +00:00
speakeasy-bot
41e670542a 🐝 Update workflow file 2023-12-24 05:08:21 +00:00
speakeasy-bot
db845112c4 🐝 Write repo Makefile 2023-12-24 05:08:21 +00:00
codesee-maps[bot]
88c6825688 Install the CodeSee workflow. Learn more at https://docs.codesee.io 2023-11-30 00:06:04 +00:00
704 changed files with 45416 additions and 35911 deletions

View File

@@ -1,12 +0,0 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
{
"name": "TypeScript SDK",
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
"postCreateCommand": "cd examples && npm run setup",
"customizations": {
"codespaces":{
"openFiles": ["examples/src/index.ts", "README.md"]
}
}
}

28
.eslintrc.js Normal file
View File

@@ -0,0 +1,28 @@
/* eslint-env node */
module.exports = {
root: true,
extends: [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:import/recommended",
"plugin:import/typescript",
],
parser: "@typescript-eslint/parser",
plugins: ["@typescript-eslint"],
settings: {
"import/resolver": {
typescript: true,
node: true,
},
},
rules: {
// Handled by typescript compiler
"@typescript-eslint/no-unused-vars": "off",
"@typescript-eslint/ban-types": "off",
"@typescript-eslint/no-namespace": "off",
"@typescript-eslint/no-explicit-any": "off",
"import/no-named-as-default-member": "off",
"import/no-default-export": "error",
},
};

View File

@@ -1,50 +0,0 @@
{
"env": {
"browser": true,
"commonjs": true,
"es2021": true
},
"extends": [
"airbnb-base",
"airbnb-typescript/base",
"prettier"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module",
"project": "./tsconfig.eslint.json"
},
"plugins": [
"@typescript-eslint",
"prettier"
],
"rules": {
"no-console": "off",
"max-len": [
"error",
{
"code": 150,
"ignoreComments": true,
"ignoreRegExpLiterals": true,
"ignoreStrings": true,
"ignoreTemplateLiterals": true
}
],
"prettier/prettier": "error",
"@typescript-eslint/dot-notation": "off",
"import/prefer-default-export": "off"
},
"settings": {
"import/resolver": {
"node": {
"extensions": [
".js",
".jsx",
".ts",
".tsx"
]
}
}
}
}

2
.gitattributes vendored Normal file
View File

@@ -0,0 +1,2 @@
# This allows generated code to be indexed correctly
*.ts linguist-generated=false

View File

@@ -1,35 +0,0 @@
name: Release Checks
on:
push:
branches:
- main
jobs:
github-publish:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository & Submo
uses: actions/checkout@v2
with:
submodules: recursive
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '16'
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
- name: Install dependencies
run: npm install
# TODO: Finish fixing eslint issues
# - name: Run ESLint check
# run: npm run lint:ci
- name: Run Test & Coverage check
run: npm run test

View File

@@ -1,56 +0,0 @@
name: "Build TypeScript SDK"
on:
workflow_dispatch:
jobs:
push_spec_workflow:
name: Build TypeScript SDK
runs-on: ubuntu-latest
steps:
# Checkout the master branch request to run rsync
- name: Checkout PR branch
uses: actions/checkout@v3
with:
ref: ${{ github.ref }}
# Checkout the main branch of api-specs
- name: Checkout API Specs Repo
uses: actions/checkout@v3
with:
repository: lukehagar/plex-api-spec
path: api-specs
ref: main
- name: Set up Node
uses: actions/setup-node@v3
with:
node-version: "16"
- name: Build PMS SDK
id: buildPMS
run: |
rm -rf plexjs/pms
java -jar openapi-generator-cli.jar generate -i api-specs/pms/pms-spec.yaml -g typescript-axios -o plexjs/pms --global-property skipFormModel=false --config sdk-resources/pms-config.yaml
- name: Build PTV SDK
id: buildPTV
if: steps.buildPMS.outcome == 'success'
run: |
rm -rf plexjs/plextv
java -jar openapi-generator-cli.jar generate -i api-specs/plextv/plextv-spec.yaml -g typescript-axios -o plexjs/plextv --global-property skipFormModel=false --config sdk-resources/plextv-config.yaml
- name: Run npm install and build Typescript SDK
id: buildSDK
if: steps.buildPTV.outcome == 'success'
run: |
cd plexjs
npm install
npm run build
- name: Archive test build
uses: actions/upload-artifact@v3
with:
name: PR-Build-${{ github.ref }}
path: |
plexjs

View File

@@ -1,114 +0,0 @@
name: "Update Typescript SDK Version"
run-name: Update Typescript SDK Version to ${{ github.event.inputs.version }}
on:
workflow_dispatch:
inputs:
version:
description: The version to bump to
jobs:
update_typescript_version:
name: Update Typescript Version
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v3
with:
ref: ${{ github.ref }}
fetch-depth: 0
- name: Checkout API Specs Repo
uses: actions/checkout@v3
with:
repository: lukehagar/plex-api-spec
path: api-specs
ref: main
- name: Set up Node
uses: actions/setup-node@v3
with:
node-version: "16"
# Install yq for working with yaml files
- name: Set up yq
uses: frenck/action-setup-yq@v1
# Check input version is greater than the current tag
- name: Check valid version
run: |
function ver { printf "%03d%03d%03d%03d" $(echo "$1" | tr '.' ' '); }
LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
echo $LATEST_TAG
if [ $(ver $LATEST_TAG) -lt $(ver ${{ github.event.inputs.version}}) ]
then
echo "Input version ${{ github.event.inputs.version }} valid"
else
echo "Current tagged version $LATEST_TAG is greater than input version ${{ github.event.inputs.version }}"
exit 1
fi
## Update configuration files to new version
- name: Update config files with new version
id: updateVersion
run: |
yq -i '.npmVersion = "${{ github.event.inputs.version }}"' sdk-resources/pms-config.yaml
yq -i '.npmVersion = "${{ github.event.inputs.version }}"' sdk-resources/plextv-config.yaml
## Update package.json file with new version
- name: Update package.json version
id: updatePackageJsonVersion
if: steps.updateVersion.outcome == 'success'
run: |
LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
cd plexjs
jq '.version = "${{ github.event.inputs.version }}"' package.json > package.json.tmp && mv package.json.tmp package.json
- name: Build PMS SDK
id: buildPMS
run: |
rm -rf plexjs/pms
java -jar openapi-generator-cli.jar generate -i api-specs/pms/pms-spec.yaml -g typescript-axios -o plexjs/pms --global-property skipFormModel=false --config sdk-resources/pms-config.yaml
- name: Build PTV SDK
id: buildPTV
if: steps.buildPMS.outcome == 'success'
run: |
rm -rf plexjs/plextv
java -jar openapi-generator-cli.jar generate -i api-specs/plextv/plextv-spec.yaml -g typescript-axios -o plexjs/plextv --global-property skipFormModel=false --config sdk-resources/plextv-config.yaml
- name: After SDK Build
id: buildSDK
if: steps.buildPTV.outcome == 'success'
run: |
cd plexjs
npm install
npm run build
- name: Publish to NPM
id: publish
uses: JS-DevTools/npm-publish@v1
with:
token: ${{ secrets.NPM_TOKEN }}
package: ./plexjs/package.json
- name: Commit changes and create new version tag
if: steps.buildSDK.outcome == 'success'
uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Bump version to ${{ github.event.inputs.version }}
tagging_message: ${{ github.event.inputs.version }}
- name: Create Release
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
with:
tag_name: ${{ github.event.inputs.version }}
release_name: ${{ github.event.inputs.version }}
draft: false
prerelease: false

View File

@@ -1,28 +0,0 @@
name: Pull Request Checks
on: [pull_request]
jobs:
linting-and-testing:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '16'
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
- name: Install dependencies
run: npm install
# TODO: Finish fixing eslint issues
# - name: Run ESLint check
# run: npm run lint:ci
- name: Run Test & Coverage check
run: npm run test

33
.github/workflows/publish-jsr.yaml vendored Normal file
View File

@@ -0,0 +1,33 @@
name: Publish to JSR
permissions:
checks: write
contents: write
pull-requests: write
statuses: write
on:
workflow_dispatch:
push:
branches:
- main
jobs:
publish:
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
steps:
- uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 18
- name: Install dependencies
run: npm install
- name: Publish package
run: npx jsr publish

View File

@@ -1,32 +0,0 @@
name: Release Checks
on:
release:
types: [created]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: '16'
cache: 'npm'
- run: npm ci
- run: npm run test
npm-publish:
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: '16'
registry-url: https://registry.npmjs.org/
- run: npm ci
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

View File

@@ -0,0 +1,28 @@
name: Generate
permissions:
checks: write
contents: write
pull-requests: write
statuses: write
on:
workflow_dispatch:
inputs:
force:
description: Force generation of SDKs
type: boolean
default: false
schedule:
- cron: 0 0 * * *
jobs:
generate:
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
with:
force: ${{ github.event.inputs.force }}
mode: direct
speakeasy_version: latest
secrets:
github_access_token: ${{ secrets.GITHUB_TOKEN }}
npm_token: ${{ secrets.NPM_TOKEN }}
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

View File

@@ -1,73 +0,0 @@
name: "Test open api generator version"
run-name: "Test open api generator version ${{ github.event.inputs.version }}"
on:
workflow_dispatch:
inputs:
version:
description: The version of the OpenAPI Generator to test
jobs:
push_spec_workflow:
name: Build TypeScript SDK
runs-on: ubuntu-latest
steps:
# Checkout the master branch request to run rsync
- name: Checkout PR branch
uses: actions/checkout@v3
with:
ref: ${{ github.ref }}
# Checkout the main branch of api-specs
- name: Checkout API Specs Repo
uses: actions/checkout@v3
with:
repository: lukehagar/plex-api-spec
path: api-specs
ref: main
- name: Set up Node
uses: actions/setup-node@v3
with:
node-version: "16"
- name: Install OpenAPI Generator
run: |
wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/${{ github.event.inputs.version }}/openapi-generator-cli-${{ github.event.inputs.version }}.jar -O openapi-generator-cli.jar
- name: Build PMS SDK
id: buildPMS
run: |
rm -rf plexjs/pms
java -jar openapi-generator-cli.jar generate -i api-specs/pms/pms-spec.yaml -g typescript-axios -o plexjs/pms --config sdk-resources/pms-config-test.yaml
- name: Build PTV SDK
id: buildPTV
run: |
rm -rf plexjs/plextv
java -jar openapi-generator-cli.jar generate -i api-specs/plextv/plextv-spec.yaml -g typescript-axios -o plexjs/plextv --config sdk-resources/plextv-config-test.yaml
- name: Archive test build
uses: actions/upload-artifact@v3
with:
name: OAG-${{ github.event.inputs.version }}-test-build
path: |
plexjs/pms
plexjs/plextv
- name: Run npm install and build Typescript SDK
id: testPMS
if: steps.buildPMS.outcome == 'success'
run: |
cd plexjs/pms
npm install
npm run build
- name: Run npm install and build Typescript SDK
id: testPTV
if: steps.buildPTV.outcome == 'success'
run: |
cd plexjs/plextv
npm install
npm run build

142
.gitignore vendored
View File

@@ -1,132 +1,10 @@
# Logs /hooks
logs /models
*.log /models/errors
npm-debug.log* /types
yarn-debug.log* /lib
yarn-error.log* /sdk
lerna-debug.log* /index.*
.pnpm-debug.log* /cjs
/node_modules
# Diagnostic reports (https://nodejs.org/api/report.html) /.tsbuildinfo
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# Snowpack dependency directory (https://snowpack.dev/)
web_modules/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional stylelint cache
.stylelintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache
# Next.js build output
.next
out
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# vuepress v2.x temp and cache directory
.temp
.cache
# Docusaurus cache and generated files
.docusaurus
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
.parcel-cache

7
.npmignore Normal file
View File

@@ -0,0 +1,7 @@
**/*
!/**/*.ts
!/**/*.js
!/**/*.map
/.eslintrc.js
/cjs

View File

@@ -1,26 +0,0 @@
{
"printWidth": 100,
"tabWidth": 2,
"useTabs": false,
"semi": true,
"singleQuote": true,
"quoteProps": "as-needed",
"jsxSingleQuote": false,
"trailingComma": "all",
"bracketSpacing": true,
"arrowParens": "always",
"overrides": [
{
"files": ".editorconfig",
"options": {
"parser": "yaml"
}
},
{
"files": "LICENSE",
"options": {
"parser": "markdown"
}
}
]
}

581
.speakeasy/gen.lock Executable file
View File

@@ -0,0 +1,581 @@
lockVersion: 2.0.0
id: 16f22cbf-f23f-4419-8924-3a4b06381947
management:
docChecksum: 37654ea0982ab5e87a9a9576014c9d19
docVersion: 0.0.3
speakeasyVersion: 1.308.1
generationVersion: 2.342.6
releaseVersion: 0.17.0
configChecksum: 91cb964c770722eba5f69c04d32554eb
repoURL: https://github.com/LukeHagar/plexjs.git
repoSubDirectory: .
installationURL: https://github.com/LukeHagar/plexjs
published: true
features:
typescript:
additionalDependencies: 0.1.0
constsAndDefaults: 0.1.5
core: 3.9.14
flattening: 2.81.1
globalSecurity: 2.82.9
globalSecurityCallbacks: 0.1.0
globalSecurityFlattening: 0.1.0
globalServerURLs: 2.82.4
globals: 2.82.1
methodServerURLs: 2.82.1
nameOverrides: 2.81.2
responseFormat: 0.2.3
sdkHooks: 0.1.0
typeOverrides: 2.81.1
generatedFiles:
- src/sdk/server.ts
- src/sdk/media.ts
- src/sdk/video.ts
- src/sdk/activities.ts
- src/sdk/butler.ts
- src/sdk/plex.ts
- src/sdk/hubs.ts
- src/sdk/search.ts
- src/sdk/library.ts
- src/sdk/log.ts
- src/sdk/playlists.ts
- src/sdk/authentication.ts
- src/sdk/statistics.ts
- src/sdk/sessions.ts
- src/sdk/updater.ts
- src/sdk/watchlist.ts
- src/sdk/sdk.ts
- .eslintrc.js
- .npmignore
- RUNTIMES.md
- jsr.json
- package.json
- src/index.ts
- src/lib/base64.ts
- src/lib/config.ts
- src/lib/encodings.ts
- src/lib/http.ts
- src/lib/is-plain-object.ts
- src/lib/primitives.ts
- src/lib/retries.ts
- src/lib/schemas.ts
- src/lib/sdks.ts
- src/lib/security.ts
- src/lib/url.ts
- src/sdk/index.ts
- src/models/sdkerror.ts
- src/models/sdkvalidationerror.ts
- src/types/blobs.ts
- src/types/enums.ts
- src/types/index.ts
- src/types/operations.ts
- src/types/rfcdate.ts
- tsconfig.json
- src/models/getservercapabilitiesop.ts
- src/models/getserverpreferencesop.ts
- src/models/getavailableclientsop.ts
- src/models/getdevicesop.ts
- src/models/getserveridentityop.ts
- src/models/getmyplexaccountop.ts
- src/models/getresizedphotoop.ts
- src/models/getserverlistop.ts
- src/models/markplayedop.ts
- src/models/markunplayedop.ts
- src/models/updateplayprogressop.ts
- src/models/gettimelineop.ts
- src/models/startuniversaltranscodeop.ts
- src/models/getserveractivitiesop.ts
- src/models/cancelserveractivitiesop.ts
- src/models/getbutlertasksop.ts
- src/models/startalltasksop.ts
- src/models/stopalltasksop.ts
- src/models/starttaskop.ts
- src/models/stoptaskop.ts
- src/models/gethomedataop.ts
- src/models/getpinop.ts
- src/models/gettokenop.ts
- src/models/getglobalhubsop.ts
- src/models/getlibraryhubsop.ts
- src/models/performsearchop.ts
- src/models/performvoicesearchop.ts
- src/models/getsearchresultsop.ts
- src/models/getfilehashop.ts
- src/models/getrecentlyaddedop.ts
- src/models/getlibrariesop.ts
- src/models/getlibraryop.ts
- src/models/deletelibraryop.ts
- src/models/getlibraryitemsop.ts
- src/models/refreshlibraryop.ts
- src/models/searchlibraryop.ts
- src/models/getmetadataop.ts
- src/models/getmetadatachildrenop.ts
- src/models/getondeckop.ts
- src/models/loglineop.ts
- src/models/logmultilineop.ts
- src/models/enablepapertrailop.ts
- src/models/createplaylistop.ts
- src/models/getplaylistsop.ts
- src/models/getplaylistop.ts
- src/models/deleteplaylistop.ts
- src/models/updateplaylistop.ts
- src/models/getplaylistcontentsop.ts
- src/models/clearplaylistcontentsop.ts
- src/models/addplaylistcontentsop.ts
- src/models/uploadplaylistop.ts
- src/models/gettransienttokenop.ts
- src/models/getsourceconnectioninformationop.ts
- src/models/getstatisticsop.ts
- src/models/getsessionsop.ts
- src/models/getsessionhistoryop.ts
- src/models/gettranscodesessionsop.ts
- src/models/stoptranscodesessionop.ts
- src/models/getupdatestatusop.ts
- src/models/checkforupdatesop.ts
- src/models/applyupdatesop.ts
- src/models/getwatchlistop.ts
- src/models/security.ts
- src/models/index.ts
- docs/models/errors.md
- docs/models/getservercapabilitiesserverresponsebody.md
- docs/models/directory.md
- docs/models/mediacontainer.md
- docs/models/getservercapabilitiesresponsebody.md
- docs/models/getservercapabilitiesresponse.md
- docs/models/getserverpreferenceserrors.md
- docs/models/getserverpreferencesserverresponsebody.md
- docs/models/setting.md
- docs/models/getserverpreferencesmediacontainer.md
- docs/models/getserverpreferencesresponsebody.md
- docs/models/getserverpreferencesresponse.md
- docs/models/getavailableclientserrors.md
- docs/models/getavailableclientsserverresponsebody.md
- docs/models/getavailableclientsserver.md
- docs/models/getavailableclientsmediacontainer.md
- docs/models/getavailableclientsresponsebody.md
- docs/models/getavailableclientsresponse.md
- docs/models/getdeviceserrors.md
- docs/models/getdevicesserverresponsebody.md
- docs/models/device.md
- docs/models/getdevicesmediacontainer.md
- docs/models/getdevicesresponsebody.md
- docs/models/getdevicesresponse.md
- docs/models/getserveridentityerrors.md
- docs/models/getserveridentityserverresponsebody.md
- docs/models/getserveridentitymediacontainer.md
- docs/models/getserveridentityresponsebody.md
- docs/models/getserveridentityresponse.md
- docs/models/getmyplexaccounterrors.md
- docs/models/getmyplexaccountserverresponsebody.md
- docs/models/myplex.md
- docs/models/getmyplexaccountresponsebody.md
- docs/models/getmyplexaccountresponse.md
- docs/models/minsize.md
- docs/models/upscale.md
- docs/models/getresizedphotorequest.md
- docs/models/getresizedphotoerrors.md
- docs/models/getresizedphotoresponsebody.md
- docs/models/getresizedphotoresponse.md
- docs/models/getserverlisterrors.md
- docs/models/getserverlistserverresponsebody.md
- docs/models/getserverlistserver.md
- docs/models/getserverlistmediacontainer.md
- docs/models/getserverlistresponsebody.md
- docs/models/getserverlistresponse.md
- docs/models/markplayedrequest.md
- docs/models/markplayederrors.md
- docs/models/markplayedresponsebody.md
- docs/models/markplayedresponse.md
- docs/models/markunplayedrequest.md
- docs/models/markunplayederrors.md
- docs/models/markunplayedresponsebody.md
- docs/models/markunplayedresponse.md
- docs/models/updateplayprogressrequest.md
- docs/models/updateplayprogresserrors.md
- docs/models/updateplayprogressresponsebody.md
- docs/models/updateplayprogressresponse.md
- docs/models/state.md
- docs/models/gettimelinerequest.md
- docs/models/gettimelineerrors.md
- docs/models/gettimelineresponsebody.md
- docs/models/gettimelineresponse.md
- docs/models/startuniversaltranscoderequest.md
- docs/models/startuniversaltranscodeerrors.md
- docs/models/startuniversaltranscoderesponsebody.md
- docs/models/startuniversaltranscoderesponse.md
- docs/models/getserveractivitieserrors.md
- docs/models/getserveractivitiesactivitiesresponsebody.md
- docs/models/context.md
- docs/models/activity.md
- docs/models/getserveractivitiesmediacontainer.md
- docs/models/getserveractivitiesresponsebody.md
- docs/models/getserveractivitiesresponse.md
- docs/models/cancelserveractivitiesrequest.md
- docs/models/cancelserveractivitieserrors.md
- docs/models/cancelserveractivitiesresponsebody.md
- docs/models/cancelserveractivitiesresponse.md
- docs/models/getbutlertaskserrors.md
- docs/models/getbutlertasksbutlerresponsebody.md
- docs/models/butlertask.md
- docs/models/butlertasks.md
- docs/models/getbutlertasksresponsebody.md
- docs/models/getbutlertasksresponse.md
- docs/models/startalltaskserrors.md
- docs/models/startalltasksresponsebody.md
- docs/models/startalltasksresponse.md
- docs/models/stopalltaskserrors.md
- docs/models/stopalltasksresponsebody.md
- docs/models/stopalltasksresponse.md
- docs/models/taskname.md
- docs/models/starttaskrequest.md
- docs/models/starttaskerrors.md
- docs/models/starttaskresponsebody.md
- docs/models/starttaskresponse.md
- docs/models/pathparamtaskname.md
- docs/models/stoptaskrequest.md
- docs/models/stoptaskerrors.md
- docs/models/stoptaskresponsebody.md
- docs/models/stoptaskresponse.md
- docs/models/gethomedataerrors.md
- docs/models/gethomedataplexresponsebody.md
- docs/models/gethomedataresponsebody.md
- docs/models/gethomedataresponse.md
- docs/models/getpinglobals.md
- docs/models/getpinrequest.md
- docs/models/getpinerrors.md
- docs/models/getpinplexresponsebody.md
- docs/models/location.md
- docs/models/getpinresponsebody.md
- docs/models/getpinresponse.md
- docs/models/gettokenglobals.md
- docs/models/gettokenrequest.md
- docs/models/gettokenerrors.md
- docs/models/gettokenplexresponsebody.md
- docs/models/gettokenlocation.md
- docs/models/gettokenresponsebody.md
- docs/models/gettokenresponse.md
- docs/models/onlytransient.md
- docs/models/getglobalhubsrequest.md
- docs/models/getglobalhubserrors.md
- docs/models/getglobalhubshubsresponsebody.md
- docs/models/getglobalhubsmetadata.md
- docs/models/hub.md
- docs/models/getglobalhubsmediacontainer.md
- docs/models/getglobalhubsresponsebody.md
- docs/models/getglobalhubsresponse.md
- docs/models/queryparamonlytransient.md
- docs/models/getlibraryhubsrequest.md
- docs/models/getlibraryhubserrors.md
- docs/models/getlibraryhubshubsresponsebody.md
- docs/models/getlibraryhubspart.md
- docs/models/getlibraryhubsmedia.md
- docs/models/getlibraryhubsgenre.md
- docs/models/getlibraryhubscountry.md
- docs/models/getlibraryhubsdirector.md
- docs/models/getlibraryhubsrole.md
- docs/models/getlibraryhubswriter.md
- docs/types/rfcdate.md
- docs/models/getlibraryhubsmetadata.md
- docs/models/getlibraryhubshub.md
- docs/models/getlibraryhubsmediacontainer.md
- docs/models/getlibraryhubsresponsebody.md
- docs/models/getlibraryhubsresponse.md
- docs/models/performsearchrequest.md
- docs/models/performsearcherrors.md
- docs/models/performsearchresponsebody.md
- docs/models/performsearchresponse.md
- docs/models/performvoicesearchrequest.md
- docs/models/performvoicesearcherrors.md
- docs/models/performvoicesearchresponsebody.md
- docs/models/performvoicesearchresponse.md
- docs/models/getsearchresultsrequest.md
- docs/models/getsearchresultserrors.md
- docs/models/getsearchresultssearchresponsebody.md
- docs/models/getsearchresultspart.md
- docs/models/getsearchresultsmedia.md
- docs/models/getsearchresultsgenre.md
- docs/models/getsearchresultsdirector.md
- docs/models/getsearchresultswriter.md
- docs/models/getsearchresultscountry.md
- docs/models/getsearchresultsrole.md
- docs/models/getsearchresultsmetadata.md
- docs/models/provider.md
- docs/models/getsearchresultsmediacontainer.md
- docs/models/getsearchresultsresponsebody.md
- docs/models/getsearchresultsresponse.md
- docs/models/getfilehashrequest.md
- docs/models/getfilehasherrors.md
- docs/models/getfilehashresponsebody.md
- docs/models/getfilehashresponse.md
- docs/models/getrecentlyaddederrors.md
- docs/models/getrecentlyaddedlibraryresponsebody.md
- docs/models/part.md
- docs/models/getrecentlyaddedmedia.md
- docs/models/genre.md
- docs/models/director.md
- docs/models/writer.md
- docs/models/country.md
- docs/models/role.md
- docs/models/getrecentlyaddedmetadata.md
- docs/models/getrecentlyaddedmediacontainer.md
- docs/models/getrecentlyaddedresponsebody.md
- docs/models/getrecentlyaddedresponse.md
- docs/models/getlibrarieserrors.md
- docs/models/getlibrarieslibraryresponsebody.md
- docs/models/getlibrarieslocation.md
- docs/models/getlibrariesdirectory.md
- docs/models/getlibrariesmediacontainer.md
- docs/models/getlibrariesresponsebody.md
- docs/models/getlibrariesresponse.md
- docs/models/includedetails.md
- docs/models/getlibraryrequest.md
- docs/models/getlibraryerrors.md
- docs/models/getlibrarylibraryresponsebody.md
- docs/models/getlibrarydirectory.md
- docs/models/getlibraryfilter.md
- docs/models/sort.md
- docs/models/field.md
- docs/models/getlibrarytype.md
- docs/models/operator.md
- docs/models/fieldtype.md
- docs/models/getlibrarymediacontainer.md
- docs/models/getlibraryresponsebody.md
- docs/models/getlibraryresponse.md
- docs/models/deletelibraryrequest.md
- docs/models/deletelibraryerrors.md
- docs/models/deletelibraryresponsebody.md
- docs/models/deletelibraryresponse.md
- docs/models/tag.md
- docs/models/getlibraryitemsrequest.md
- docs/models/getlibraryitemserrors.md
- docs/models/getlibraryitemslibraryresponsebody.md
- docs/models/getlibraryitemspart.md
- docs/models/getlibraryitemsmedia.md
- docs/models/getlibraryitemsgenre.md
- docs/models/getlibraryitemscountry.md
- docs/models/getlibraryitemsdirector.md
- docs/models/getlibraryitemswriter.md
- docs/models/getlibraryitemsrole.md
- docs/models/getlibraryitemsmetadata.md
- docs/models/getlibraryitemsmediacontainer.md
- docs/models/getlibraryitemsresponsebody.md
- docs/models/getlibraryitemsresponse.md
- docs/models/refreshlibraryrequest.md
- docs/models/refreshlibraryerrors.md
- docs/models/refreshlibraryresponsebody.md
- docs/models/refreshlibraryresponse.md
- docs/models/type.md
- docs/models/searchlibraryrequest.md
- docs/models/searchlibraryerrors.md
- docs/models/searchlibrarylibraryresponsebody.md
- docs/models/searchlibrarymetadata.md
- docs/models/searchlibrarymediacontainer.md
- docs/models/searchlibraryresponsebody.md
- docs/models/searchlibraryresponse.md
- docs/models/getmetadatarequest.md
- docs/models/getmetadataerrors.md
- docs/models/getmetadatalibraryresponsebody.md
- docs/models/stream.md
- docs/models/getmetadatapart.md
- docs/models/getmetadatamedia.md
- docs/models/getmetadatagenre.md
- docs/models/getmetadatacountry.md
- docs/models/guids.md
- docs/models/ratings.md
- docs/models/getmetadatadirector.md
- docs/models/getmetadatawriter.md
- docs/models/getmetadatarole.md
- docs/models/producer.md
- docs/models/getmetadatametadata.md
- docs/models/getmetadatamediacontainer.md
- docs/models/getmetadataresponsebody.md
- docs/models/getmetadataresponse.md
- docs/models/getmetadatachildrenrequest.md
- docs/models/getmetadatachildrenerrors.md
- docs/models/getmetadatachildrenlibraryresponsebody.md
- docs/models/getmetadatachildrendirectory.md
- docs/models/getmetadatachildrenmetadata.md
- docs/models/getmetadatachildrenmediacontainer.md
- docs/models/getmetadatachildrenresponsebody.md
- docs/models/getmetadatachildrenresponse.md
- docs/models/getondeckerrors.md
- docs/models/getondecklibraryresponsebody.md
- docs/models/getondeckstream.md
- docs/models/getondeckpart.md
- docs/models/getondeckmedia.md
- docs/models/getondeckguids.md
- docs/models/getondeckmetadata.md
- docs/models/getondeckmediacontainer.md
- docs/models/getondeckresponsebody.md
- docs/models/getondeckresponse.md
- docs/models/level.md
- docs/models/loglinerequest.md
- docs/models/loglineerrors.md
- docs/models/loglineresponsebody.md
- docs/models/loglineresponse.md
- docs/models/logmultilineerrors.md
- docs/models/logmultilineresponsebody.md
- docs/models/logmultilineresponse.md
- docs/models/enablepapertrailerrors.md
- docs/models/enablepapertrailresponsebody.md
- docs/models/enablepapertrailresponse.md
- docs/models/queryparamtype.md
- docs/models/smart.md
- docs/models/createplaylistrequest.md
- docs/models/createplaylisterrors.md
- docs/models/createplaylistplaylistsresponsebody.md
- docs/models/createplaylistmetadata.md
- docs/models/createplaylistmediacontainer.md
- docs/models/createplaylistresponsebody.md
- docs/models/createplaylistresponse.md
- docs/models/playlisttype.md
- docs/models/queryparamsmart.md
- docs/models/getplaylistsrequest.md
- docs/models/getplaylistserrors.md
- docs/models/getplaylistsplaylistsresponsebody.md
- docs/models/getplaylistsmetadata.md
- docs/models/getplaylistsmediacontainer.md
- docs/models/getplaylistsresponsebody.md
- docs/models/getplaylistsresponse.md
- docs/models/getplaylistrequest.md
- docs/models/getplaylisterrors.md
- docs/models/getplaylistplaylistsresponsebody.md
- docs/models/getplaylistmetadata.md
- docs/models/getplaylistmediacontainer.md
- docs/models/getplaylistresponsebody.md
- docs/models/getplaylistresponse.md
- docs/models/deleteplaylistrequest.md
- docs/models/deleteplaylisterrors.md
- docs/models/deleteplaylistresponsebody.md
- docs/models/deleteplaylistresponse.md
- docs/models/updateplaylistrequest.md
- docs/models/updateplaylisterrors.md
- docs/models/updateplaylistresponsebody.md
- docs/models/updateplaylistresponse.md
- docs/models/getplaylistcontentsrequest.md
- docs/models/getplaylistcontentserrors.md
- docs/models/getplaylistcontentsplaylistsresponsebody.md
- docs/models/getplaylistcontentspart.md
- docs/models/getplaylistcontentsmedia.md
- docs/models/getplaylistcontentsgenre.md
- docs/models/getplaylistcontentscountry.md
- docs/models/getplaylistcontentsdirector.md
- docs/models/getplaylistcontentswriter.md
- docs/models/getplaylistcontentsrole.md
- docs/models/getplaylistcontentsmetadata.md
- docs/models/getplaylistcontentsmediacontainer.md
- docs/models/getplaylistcontentsresponsebody.md
- docs/models/getplaylistcontentsresponse.md
- docs/models/clearplaylistcontentsrequest.md
- docs/models/clearplaylistcontentserrors.md
- docs/models/clearplaylistcontentsresponsebody.md
- docs/models/clearplaylistcontentsresponse.md
- docs/models/addplaylistcontentsrequest.md
- docs/models/addplaylistcontentserrors.md
- docs/models/addplaylistcontentsplaylistsresponsebody.md
- docs/models/addplaylistcontentsmetadata.md
- docs/models/addplaylistcontentsmediacontainer.md
- docs/models/addplaylistcontentsresponsebody.md
- docs/models/addplaylistcontentsresponse.md
- docs/models/force.md
- docs/models/uploadplaylistrequest.md
- docs/models/uploadplaylisterrors.md
- docs/models/uploadplaylistresponsebody.md
- docs/models/uploadplaylistresponse.md
- docs/models/gettransienttokenqueryparamtype.md
- docs/models/scope.md
- docs/models/gettransienttokenrequest.md
- docs/models/gettransienttokenerrors.md
- docs/models/gettransienttokenresponsebody.md
- docs/models/gettransienttokenresponse.md
- docs/models/getsourceconnectioninformationrequest.md
- docs/models/getsourceconnectioninformationerrors.md
- docs/models/getsourceconnectioninformationresponsebody.md
- docs/models/getsourceconnectioninformationresponse.md
- docs/models/getstatisticsrequest.md
- docs/models/getstatisticserrors.md
- docs/models/getstatisticsstatisticsresponsebody.md
- docs/models/getstatisticsdevice.md
- docs/models/account.md
- docs/models/statisticsmedia.md
- docs/models/getstatisticsmediacontainer.md
- docs/models/getstatisticsresponsebody.md
- docs/models/getstatisticsresponse.md
- docs/models/getsessionserrors.md
- docs/models/getsessionssessionsresponsebody.md
- docs/models/getsessionsstream.md
- docs/models/getsessionspart.md
- docs/models/getsessionsmedia.md
- docs/models/user.md
- docs/models/player.md
- docs/models/session.md
- docs/models/getsessionsmetadata.md
- docs/models/getsessionsmediacontainer.md
- docs/models/getsessionsresponsebody.md
- docs/models/getsessionsresponse.md
- docs/models/getsessionhistoryerrors.md
- docs/models/getsessionhistorysessionsresponsebody.md
- docs/models/getsessionhistorymetadata.md
- docs/models/getsessionhistorymediacontainer.md
- docs/models/getsessionhistoryresponsebody.md
- docs/models/getsessionhistoryresponse.md
- docs/models/gettranscodesessionserrors.md
- docs/models/gettranscodesessionssessionsresponsebody.md
- docs/models/transcodesession.md
- docs/models/gettranscodesessionsmediacontainer.md
- docs/models/gettranscodesessionsresponsebody.md
- docs/models/gettranscodesessionsresponse.md
- docs/models/stoptranscodesessionrequest.md
- docs/models/stoptranscodesessionerrors.md
- docs/models/stoptranscodesessionresponsebody.md
- docs/models/stoptranscodesessionresponse.md
- docs/models/getupdatestatuserrors.md
- docs/models/getupdatestatusupdaterresponsebody.md
- docs/models/release.md
- docs/models/getupdatestatusmediacontainer.md
- docs/models/getupdatestatusresponsebody.md
- docs/models/getupdatestatusresponse.md
- docs/models/download.md
- docs/models/checkforupdatesrequest.md
- docs/models/checkforupdateserrors.md
- docs/models/checkforupdatesresponsebody.md
- docs/models/checkforupdatesresponse.md
- docs/models/tonight.md
- docs/models/skip.md
- docs/models/applyupdatesrequest.md
- docs/models/applyupdateserrors.md
- docs/models/applyupdatesresponsebody.md
- docs/models/applyupdatesresponse.md
- docs/models/filter.md
- docs/models/libtype.md
- docs/models/includecollections.md
- docs/models/includeexternalmedia.md
- docs/models/getwatchlistrequest.md
- docs/models/getwatchlisterrors.md
- docs/models/getwatchlistwatchlistresponsebody.md
- docs/models/image.md
- docs/models/metadata.md
- docs/models/getwatchlistresponsebody.md
- docs/models/getwatchlistresponse.md
- docs/models/security.md
- docs/sdks/plexapi/README.md
- docs/sdks/server/README.md
- docs/sdks/media/README.md
- docs/sdks/video/README.md
- docs/sdks/activities/README.md
- docs/sdks/butler/README.md
- docs/sdks/plex/README.md
- docs/sdks/hubs/README.md
- docs/sdks/search/README.md
- docs/sdks/library/README.md
- docs/sdks/log/README.md
- docs/sdks/playlists/README.md
- docs/sdks/authentication/README.md
- docs/sdks/statistics/README.md
- docs/sdks/sessions/README.md
- docs/sdks/updater/README.md
- docs/sdks/watchlist/README.md
- USAGE.md
- .gitattributes
- src/hooks/hooks.ts
- src/hooks/types.ts
- src/hooks/index.ts

39
.speakeasy/gen.yaml Executable file
View File

@@ -0,0 +1,39 @@
configVersion: 2.0.0
generation:
sdkClassName: Plex-API
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
auth:
oAuth2ClientCredentialsEnabled: true
typescript:
version: 0.17.0
additionalDependencies:
dependencies: {}
devDependencies: {}
peerDependencies: {}
additionalPackageJSON: {}
author: LukeHagar
clientServerStatusCodesAsErrors: true
enumFormat: enum
flattenGlobalSecurity: true
imports:
option: openapi
paths:
callbacks: ""
errors: ""
operations: ""
shared: ""
webhooks: ""
inputModelSuffix: input
maxMethodParams: 4
methodArguments: require-security-and-request
outputModelSuffix: output
packageName: '@lukehagar/plexjs'
responseFormat: envelope
templateVersion: v2

34
.speakeasy/workflow.lock Normal file
View File

@@ -0,0 +1,34 @@
speakeasyVersion: 1.308.1
sources:
my-source:
sourceNamespace: my-source
sourceRevisionDigest: sha256:198d823e211be755c34a2d6278a47f7a1cc8b088b19325166154580320b23059
sourceBlobDigest: sha256:fff27d488b00db9ddc88441f5da4f1ede865e6bf23af2f98b75ef31075aac5b1
tags:
- latest
- main
targets:
plexjs:
source: my-source
sourceNamespace: my-source
sourceRevisionDigest: sha256:198d823e211be755c34a2d6278a47f7a1cc8b088b19325166154580320b23059
sourceBlobDigest: sha256:fff27d488b00db9ddc88441f5da4f1ede865e6bf23af2f98b75ef31075aac5b1
outLocation: /github/workspace/repo
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
sources:
my-source:
inputs:
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
registry:
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
targets:
plexjs:
target: typescript
source: my-source
publish:
npm:
token: $NPM_TOKEN
codeSamples:
output: codeSamples.yaml

17
.speakeasy/workflow.yaml Normal file
View File

@@ -0,0 +1,17 @@
workflowVersion: 1.0.0
speakeasyVersion: latest
sources:
my-source:
inputs:
- location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml
registry:
location: registry.speakeasyapi.dev/lukehagar/lukehagar/my-source
targets:
plexjs:
target: typescript
source: my-source
publish:
npm:
token: $NPM_TOKEN
codeSamples:
output: codeSamples.yaml

View File

@@ -1,4 +1,6 @@
Copyright (c) 2023 MIT License
Copyright (c) 2023 LukeHagar
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal
@@ -10,10 +12,10 @@ furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
OR OTHER DEALINGS IN THE SOFTWARE. SOFTWARE.

2427
README.md

File diff suppressed because it is too large Load Diff

801
RELEASES.md Normal file
View File

@@ -0,0 +1,801 @@
## 2023-12-24 06:37:52
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.129.1 (2.223.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.1.0] .
### Releases
- [NPM v0.1.0] https://www.npmjs.com/package/openapi/v/0.1.0 - .
## 2024-01-01 15:05:18
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.129.1 (2.223.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.2.0] .
### Releases
- [NPM v0.2.0] https://www.npmjs.com/package/plexjs/v/0.2.0 - .
## 2024-01-01 15:11:44
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.129.1 (2.223.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.0] .
### Releases
- [NPM v0.3.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.0 - .
## 2024-01-05 00:27:32
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.130.1 (2.225.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.0] .
### Releases
- [NPM v0.3.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.0 - .
## 2024-01-05 19:51:02
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.133.1 (2.228.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.1] .
### Releases
- [NPM v0.3.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.1 - .
## 2024-01-09 00:28:08
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.134.0 (2.230.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.2] .
### Releases
- [NPM v0.3.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.2 - .
## 2024-01-10 00:27:58
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.134.1 (2.230.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.3.3] .
### Releases
- [NPM v0.3.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.3.3 - .
## 2024-01-16 00:27:43
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.141.1 (2.233.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.4.0] .
### Releases
- [NPM v0.4.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.0 - .
## 2024-01-17 00:27:57
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.142.1 (2.234.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.4.0] .
### Releases
- [NPM v0.4.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.0 - .
## 2024-01-18 23:37:12
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.147.0 (2.237.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.4.1] .
### Releases
- [NPM v0.4.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.1 - .
## 2024-01-19 17:27:25
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.147.0 (2.237.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.4.2] .
### Releases
- [NPM v0.4.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.4.2 - .
## 2024-01-20 03:10:24
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.5.0] .
### Releases
- [NPM v0.5.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.5.0 - .
## 2024-01-22 17:16:30
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.148.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.5.1] .
### Releases
- [NPM v0.5.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.5.1 - .
## 2024-01-23 20:47:26
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.150.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.5.2] .
### Releases
- [NPM v0.5.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.5.2 - .
## 2024-01-23 21:55:23
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.150.0 (2.237.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.5.3] .
### Releases
- [NPM v0.5.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.5.3 - .
## 2024-01-31 15:05:58
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.158.0 (2.239.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.6.0] .
### Releases
- [NPM v0.6.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.6.0 - .
## 2024-02-01 00:27:20
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.161.0 (2.245.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.6.1] .
### Releases
- [NPM v0.6.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.6.1 - .
## 2024-02-05 14:23:50
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.166.1 (2.249.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.7.0] .
### Releases
- [NPM v0.7.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.7.0 - .
## 2024-02-23 14:46:22
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.193.0 (2.269.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.8.0] .
### Releases
- [NPM v0.8.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.8.0 - .
## 2024-02-24 00:24:27
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.193.4 (2.272.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.9.0] .
### Releases
- [NPM v0.9.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.9.0 - .
## 2024-03-01 00:29:35
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.198.1 (2.275.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.9.1] .
### Releases
- [NPM v0.9.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.9.1 - .
## 2024-03-02 00:24:38
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.200.0 (2.277.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.9.2] .
### Releases
- [NPM v0.9.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.9.2 - .
## 2024-03-08 00:26:13
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.204.1 (2.279.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.10.0] .
### Releases
- [NPM v0.10.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.0 - .
## 2024-03-13 00:25:35
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.207.1 (2.280.6) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.10.1] .
### Releases
- [NPM v0.10.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.1 - .
## 2024-03-14 00:25:24
### Changes
Based on:
- OpenAPI Doc 0.0.3
- Speakeasy CLI 1.209.2 (2.281.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.10.2] .
### Releases
- [NPM v0.10.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.2 - .
## 2024-03-15 15:02:11
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.209.3 (2.281.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.10.3] .
### Releases
- [NPM v0.10.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.10.3 - .
## 2024-03-20 00:25:49
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.213.0 (2.283.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.10.4] .
### Releases
- [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 - .
## 2024-04-02 00:26:20
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.231.1 (2.295.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.12.1] .
### Releases
- [NPM v0.12.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.1 - .
## 2024-04-13 00:23:00
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.252.0 (2.306.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.12.2] .
### Releases
- [NPM v0.12.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.2 - .
## 2024-04-18 00:26:16
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.257.1 (2.308.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.12.3] .
### Releases
- [NPM v0.12.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.12.3 - .
## 2024-04-19 00:26:47
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.260.6 (2.311.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.13.0] .
### Releases
- [NPM v0.13.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.0 - .
## 2024-04-20 00:26:02
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.267.0 (2.312.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.13.0] .
### Releases
- [NPM v0.13.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.0 - .
## 2024-04-22 16:14:48
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.267.2 (2.312.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.13.1] .
### Releases
- [NPM v0.13.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.1 - .
## 2024-04-22 16:25:57
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.267.2 (2.312.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.13.2] .
### Releases
- [NPM v0.13.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.2 - .
## 2024-04-23 00:26:56
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.269.1 (2.312.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.13.2] .
### Releases
- [NPM v0.13.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.13.2 - .
## 2024-04-25 00:28:39
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.274.1 (2.314.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.0] .
### Releases
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
## 2024-04-26 00:27:03
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.274.1 (2.314.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.0] .
### Releases
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
## 2024-04-27 00:26:14
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.276.0 (2.314.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.0] .
### Releases
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
## 2024-04-28 00:29:48
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.276.0 (2.314.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.0] .
### Releases
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
## 2024-04-29 00:27:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.276.0 (2.314.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.0] .
### Releases
- [NPM v0.14.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.0 - .
## 2024-04-30 00:26:07
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.277.0 (2.317.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.1] .
### Releases
- [NPM v0.14.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.1 - .
## 2024-05-01 00:29:15
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.277.4 (2.318.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.1] .
### Releases
- [NPM v0.14.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.1 - .
## 2024-05-02 00:26:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.277.4 (2.318.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.1] .
### Releases
- [NPM v0.14.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.1 - .
## 2024-05-03 00:27:14
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.277.8 (2.319.10) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.2] .
### Releases
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
## 2024-05-04 00:26:20
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.279.0 (2.322.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.2] .
### Releases
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
## 2024-05-05 00:29:26
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.279.0 (2.322.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.2] .
### Releases
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
## 2024-05-06 00:28:07
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.279.0 (2.322.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.2] .
### Releases
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
## 2024-05-07 00:27:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.280.1 (2.322.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.2] .
### Releases
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
## 2024-05-08 00:22:14
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.283.1 (2.324.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.14.2] .
### Releases
- [NPM v0.14.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.14.2 - .
## 2024-05-08 18:14:57
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.285.0 (2.326.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.15.0] .
### Releases
- [NPM v0.15.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.0 - .
## 2024-05-09 00:26:57
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.15.0] .
### Releases
- [NPM v0.15.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.0 - .
## 2024-05-09 03:30:33
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.15.1] .
### Releases
- [NPM v0.15.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.1 - .
## 2024-05-09 03:45:22
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.15.2] .
### Releases
- [NPM v0.15.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.2 - .
## 2024-05-09 04:14:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.15.3] .
### Releases
- [NPM v0.15.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.3 - .
## 2024-05-09 04:22:48
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.285.1 (2.326.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.15.4] .
### Releases
- [NPM v0.15.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.15.4 - .
## 2024-05-23 15:56:57
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.295.1 (2.335.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.0] .
### Releases
- [NPM v0.16.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.0 - .
## 2024-05-24 00:28:19
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.295.2 (2.335.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.0] .
### Releases
- [NPM v0.16.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.0 - .
## 2024-05-25 00:26:58
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.1] .
### Releases
- [NPM v0.16.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.1 - .
## 2024-05-26 00:31:02
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.1] .
### Releases
- [NPM v0.16.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.1 - .
## 2024-05-27 00:28:56
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.1] .
### Releases
- [NPM v0.16.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.1 - .
## 2024-05-28 00:28:13
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.1] .
### Releases
- [NPM v0.16.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.1 - .
## 2024-05-29 00:29:15
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.296.1 (2.338.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.1] .
### Releases
- [NPM v0.16.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.1 - .
## 2024-05-30 00:28:36
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.299.1 (2.338.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.2] .
### Releases
- [NPM v0.16.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.2 - .
## 2024-05-31 00:27:50
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.299.3 (2.338.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.2] .
### Releases
- [NPM v0.16.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.2 - .
## 2024-06-01 00:30:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.299.4 (2.338.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.2] .
### Releases
- [NPM v0.16.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.2 - .
## 2024-06-02 00:31:00
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.299.4 (2.338.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.2] .
### Releases
- [NPM v0.16.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.2 - .
## 2024-06-03 00:29:24
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.299.4 (2.338.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.2] .
### Releases
- [NPM v0.16.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.2 - .
## 2024-06-04 00:28:27
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.299.6 (2.338.12) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.3] .
### Releases
- [NPM v0.16.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.3 - .
## 2024-06-05 00:28:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.299.7 (2.338.12) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.3] .
### Releases
- [NPM v0.16.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.3 - .
## 2024-06-06 00:28:24
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.300.0 (2.338.14) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.4] .
### Releases
- [NPM v0.16.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.4 - .
## 2024-06-07 00:29:43
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.300.1 (2.339.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.4] .
### Releases
- [NPM v0.16.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.4 - .
## 2024-06-08 00:29:06
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.300.1 (2.339.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.4] .
### Releases
- [NPM v0.16.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.4 - .
## 2024-06-09 00:32:36
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.300.1 (2.339.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.4] .
### Releases
- [NPM v0.16.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.4 - .
## 2024-06-10 00:30:14
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.300.1 (2.339.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.4] .
### Releases
- [NPM v0.16.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.4 - .
## 2024-06-12 00:28:55
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.305.0 (2.340.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.5] .
### Releases
- [NPM v0.16.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.5 - .
## 2024-06-13 00:01:20
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.306.0 (2.340.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.5] .
### Releases
- [NPM v0.16.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.5 - .
## 2024-06-14 00:01:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.307.2 (2.342.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.16.6] .
### Releases
- [NPM v0.16.6] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.16.6 - .
## 2024-06-14 16:22:55
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.308.1 (2.342.6) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.17.0] .
### Releases
- [NPM v0.17.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.17.0 - .

22
RUNTIMES.md Normal file
View File

@@ -0,0 +1,22 @@
# Supported JavaScript runtimes
This SDK is intended to be used in JavaScript runtimes that support the following features:
* [Web Fetch API][web-fetch]
* [Web Streams API](web-streams) and in particular `ReadableStream`
* [Async iterables][async-iter] using `Symbol.asyncIterator`
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
Runtime environments that are explicitly supported are:
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
- Node.js active and maintenance LTS releases
- Currently, this is v18 and v20
- Bun v1 and above
- Deno v1.39
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018

20
USAGE.md Normal file
View File

@@ -0,0 +1,20 @@
<!-- Start SDK Example Usage [usage] -->
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
xPlexClientIdentifier: "Postman",
});
async function run() {
const result = await plexAPI.server.getServerCapabilities();
// Handle the result
console.log(result);
}
run();
```
<!-- End SDK Example Usage [usage] -->

1351
codeSamples.yaml Normal file

File diff suppressed because it is too large Load Diff

15
docs/models/account.md Normal file
View File

@@ -0,0 +1,15 @@
# Account
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 238960586 |
| `key` | *string* | :heavy_minus_sign: | N/A | /accounts/238960586 |
| `name` | *string* | :heavy_minus_sign: | N/A | Diane |
| `defaultAudioLanguage` | *string* | :heavy_minus_sign: | N/A | en |
| `autoSelectAudio` | *boolean* | :heavy_minus_sign: | N/A | true |
| `defaultSubtitleLanguage` | *string* | :heavy_minus_sign: | N/A | en |
| `subtitleMode` | *number* | :heavy_minus_sign: | N/A | 1 |
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://plex.tv/users/50d83634246da1de/avatar?c=1707110967 |

15
docs/models/activity.md Normal file
View File

@@ -0,0 +1,15 @@
# Activity
## Fields
| Field | Type | Required | Description |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| `uuid` | *string* | :heavy_minus_sign: | N/A |
| `type` | *string* | :heavy_minus_sign: | N/A |
| `cancellable` | *boolean* | :heavy_minus_sign: | N/A |
| `userID` | *number* | :heavy_minus_sign: | N/A |
| `title` | *string* | :heavy_minus_sign: | N/A |
| `subtitle` | *string* | :heavy_minus_sign: | N/A |
| `progress` | *number* | :heavy_minus_sign: | N/A |
| `context` | [models.Context](../models/context.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,10 @@
# AddPlaylistContentsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,11 @@
# AddPlaylistContentsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
| `leafCountAdded` | *number* | :heavy_minus_sign: | N/A | 1 |
| `leafCountRequested` | *number* | :heavy_minus_sign: | N/A | 1 |
| `metadata` | [models.AddPlaylistContentsMetadata](../models/addplaylistcontentsmetadata.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,20 @@
# AddPlaylistContentsMetadata
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 94 |
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/94/items |
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2 |
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
| `title` | *string* | :heavy_minus_sign: | N/A | A great playlist |
| `summary` | *string* | :heavy_minus_sign: | N/A | One of my great playlists |
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/94/composite/1705800070 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 423000 |
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 3 |
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705716458 |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705800070 |

View File

@@ -0,0 +1,11 @@
# AddPlaylistContentsPlaylistsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `errors` | [models.AddPlaylistContentsErrors](../models/addplaylistcontentserrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,10 @@
# AddPlaylistContentsRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist | |
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist | server://12345/com.plexapp.plugins.library/library/metadata/1 |
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to add to a playlist | 123 |

View File

@@ -0,0 +1,11 @@
# AddPlaylistContentsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [models.AddPlaylistContentsResponseBody](../models/addplaylistcontentsresponsebody.md) | :heavy_minus_sign: | Playlist Updated |

View File

@@ -0,0 +1,10 @@
# AddPlaylistContentsResponseBody
Playlist Updated
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `mediaContainer` | [models.AddPlaylistContentsMediaContainer](../models/addplaylistcontentsmediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,10 @@
# ApplyUpdatesErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,9 @@
# ApplyUpdatesRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tonight` | [models.Tonight](../models/tonight.md) | :heavy_minus_sign: | Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install | 1 |
| `skip` | [models.Skip](../models/skip.md) | :heavy_minus_sign: | Indicate that the latest version should be marked as skipped. The <Release> entry for this version will have the `state` set to `skipped`. | 1 |

View File

@@ -0,0 +1,10 @@
# ApplyUpdatesResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,11 @@
# ApplyUpdatesResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.ApplyUpdatesErrors](../models/applyupdateserrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

13
docs/models/butlertask.md Normal file
View File

@@ -0,0 +1,13 @@
# ButlerTask
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `name` | *string* | :heavy_minus_sign: | N/A | BackupDatabase |
| `interval` | *number* | :heavy_minus_sign: | N/A | 3 |
| `scheduleRandomized` | *boolean* | :heavy_minus_sign: | N/A | |
| `enabled` | *boolean* | :heavy_minus_sign: | N/A | |
| `title` | *string* | :heavy_minus_sign: | N/A | Backup Database |
| `description` | *string* | :heavy_minus_sign: | N/A | Create a backup copy of the server's database in the configured backup directory |

View File

@@ -0,0 +1,8 @@
# ButlerTasks
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `butlerTask` | [models.ButlerTask](../models/butlertask.md)[] | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,10 @@
# CancelServerActivitiesErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,8 @@
# CancelServerActivitiesRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `activityUUID` | *string* | :heavy_check_mark: | The UUID of the activity to cancel. | 25b71ed5-0f9d-461c-baa7-d404e9e10d3e |

View File

@@ -0,0 +1,10 @@
# CancelServerActivitiesResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,11 @@
# CancelServerActivitiesResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `errors` | [models.CancelServerActivitiesErrors](../models/cancelserveractivitieserrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,10 @@
# CheckForUpdatesErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,8 @@
# CheckForUpdatesRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `download` | [models.Download](../models/download.md) | :heavy_minus_sign: | Indicate that you want to start download any updates found. | 1 |

View File

@@ -0,0 +1,10 @@
# CheckForUpdatesResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,11 @@
# CheckForUpdatesResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.CheckForUpdatesErrors](../models/checkforupdateserrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,10 @@
# ClearPlaylistContentsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,8 @@
# ClearPlaylistContentsRequest
## Fields
| Field | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist |

View File

@@ -0,0 +1,10 @@
# ClearPlaylistContentsResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,11 @@
# ClearPlaylistContentsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `errors` | [models.ClearPlaylistContentsErrors](../models/clearplaylistcontentserrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

8
docs/models/context.md Normal file
View File

@@ -0,0 +1,8 @@
# Context
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `librarySectionID` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/country.md Normal file
View File

@@ -0,0 +1,8 @@
# Country
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |

View File

@@ -0,0 +1,10 @@
# CreatePlaylistErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,9 @@
# CreatePlaylistMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 7 |
| `metadata` | [models.CreatePlaylistMetadata](../models/createplaylistmetadata.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,23 @@
# CreatePlaylistMetadata
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 96 |
| `key` | *string* | :heavy_minus_sign: | N/A | /playlists/96/items |
| `guid` | *string* | :heavy_minus_sign: | N/A | com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55 |
| `type` | *string* | :heavy_minus_sign: | N/A | playlist |
| `title` | *string* | :heavy_minus_sign: | N/A | A Great Playlist |
| `summary` | *string* | :heavy_minus_sign: | N/A | What a great playlist |
| `smart` | *boolean* | :heavy_minus_sign: | N/A | false |
| `playlistType` | *string* | :heavy_minus_sign: | N/A | video |
| `icon` | *string* | :heavy_minus_sign: | N/A | playlist://image.smart |
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1705719589 |
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 1 |
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705719589 |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705724593 |
| `composite` | *string* | :heavy_minus_sign: | N/A | /playlists/96/composite/1705724593 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 141000 |

View File

@@ -0,0 +1,11 @@
# CreatePlaylistPlaylistsResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.CreatePlaylistErrors](../models/createplaylisterrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,12 @@
# CreatePlaylistRequest
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `title` | *string* | :heavy_check_mark: | name of the playlist |
| `type` | [models.QueryParamType](../models/queryparamtype.md) | :heavy_check_mark: | type of playlist to create |
| `smart` | [models.Smart](../models/smart.md) | :heavy_check_mark: | whether the playlist is smart or not |
| `uri` | *string* | :heavy_check_mark: | the content URI for the playlist |
| `playQueueID` | *number* | :heavy_minus_sign: | the play queue to copy to a playlist |

View File

@@ -0,0 +1,11 @@
# CreatePlaylistResponse
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [models.CreatePlaylistResponseBody](../models/createplaylistresponsebody.md) | :heavy_minus_sign: | returns all playlists |

View File

@@ -0,0 +1,10 @@
# CreatePlaylistResponseBody
returns all playlists
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `mediaContainer` | [models.CreatePlaylistMediaContainer](../models/createplaylistmediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,10 @@
# DeleteLibraryErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,8 @@
# DeleteLibraryRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `sectionId` | *number* | :heavy_check_mark: | the Id of the library to query | 1000 |

View File

@@ -0,0 +1,10 @@
# DeleteLibraryResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,11 @@
# DeleteLibraryResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.DeleteLibraryErrors](../models/deletelibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,10 @@
# DeletePlaylistErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,8 @@
# DeletePlaylistRequest
## Fields
| Field | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `playlistID` | *number* | :heavy_check_mark: | the ID of the playlist |

View File

@@ -0,0 +1,10 @@
# DeletePlaylistResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,11 @@
# DeletePlaylistResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.DeletePlaylistErrors](../models/deleteplaylisterrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

12
docs/models/device.md Normal file
View File

@@ -0,0 +1,12 @@
# Device
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `id` | *number* | :heavy_minus_sign: | N/A | 1 |
| `name` | *string* | :heavy_minus_sign: | N/A | iPhone |
| `platform` | *string* | :heavy_minus_sign: | N/A | iOS |
| `clientIdentifier` | *string* | :heavy_minus_sign: | N/A | |
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1654131230 |

8
docs/models/director.md Normal file
View File

@@ -0,0 +1,8 @@
# Director
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *string* | :heavy_minus_sign: | N/A | Peyton Reed |

10
docs/models/directory.md Normal file
View File

@@ -0,0 +1,10 @@
# Directory
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `count` | *number* | :heavy_minus_sign: | N/A |
| `key` | *string* | :heavy_minus_sign: | N/A |
| `title` | *string* | :heavy_minus_sign: | N/A |

11
docs/models/download.md Normal file
View File

@@ -0,0 +1,11 @@
# Download
Indicate that you want to start download any updates found.
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

View File

@@ -0,0 +1,10 @@
# EnablePaperTrailErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,10 @@
# EnablePaperTrailResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,11 @@
# EnablePaperTrailResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `errors` | [models.EnablePaperTrailErrors](../models/enablepapertrailerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

10
docs/models/errors.md Normal file
View File

@@ -0,0 +1,10 @@
# Errors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

11
docs/models/field.md Normal file
View File

@@ -0,0 +1,11 @@
# Field
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `key` | *string* | :heavy_minus_sign: | N/A | label |
| `title` | *string* | :heavy_minus_sign: | N/A | Label |
| `type` | *string* | :heavy_minus_sign: | N/A | tag |
| `subType` | *string* | :heavy_minus_sign: | N/A | bitrate |

9
docs/models/fieldtype.md Normal file
View File

@@ -0,0 +1,9 @@
# FieldType
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| `type` | *string* | :heavy_minus_sign: | N/A | resolution |
| `operator` | [models.Operator](../models/operator.md)[] | :heavy_minus_sign: | N/A | |

12
docs/models/filter.md Normal file
View File

@@ -0,0 +1,12 @@
# Filter
Filter
## Values
| Name | Value |
| ----------- | ----------- |
| `All` | all |
| `Available` | available |
| `Released` | released |

15
docs/models/force.md Normal file
View File

@@ -0,0 +1,15 @@
# Force
Force overwriting of duplicate playlists.
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
The `force` argument is used to disable overwriting.
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

8
docs/models/genre.md Normal file
View File

@@ -0,0 +1,8 @@
# Genre
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *string* | :heavy_minus_sign: | N/A | Comedy |

View File

@@ -0,0 +1,10 @@
# GetAvailableClientsErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,9 @@
# GetAvailableClientsMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 1 |
| `server` | [models.GetAvailableClientsServer](../models/getavailableclientsserver.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,11 @@
# GetAvailableClientsResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [models.GetAvailableClientsResponseBody](../models/getavailableclientsresponsebody.md) | :heavy_minus_sign: | Available Clients |

View File

@@ -0,0 +1,10 @@
# GetAvailableClientsResponseBody
Available Clients
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `mediaContainer` | [models.GetAvailableClientsMediaContainer](../models/getavailableclientsmediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,18 @@
# GetAvailableClientsServer
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `name` | *string* | :heavy_minus_sign: | N/A | iPad |
| `host` | *string* | :heavy_minus_sign: | N/A | 10.10.10.102 |
| `address` | *string* | :heavy_minus_sign: | N/A | 10.10.10.102 |
| `port` | *number* | :heavy_minus_sign: | N/A | 32500 |
| `machineIdentifier` | *string* | :heavy_minus_sign: | N/A | A2E901F8-E016-43A7-ADFB-EF8CA8A4AC05 |
| `version` | *string* | :heavy_minus_sign: | N/A | 8.17 |
| `protocol` | *string* | :heavy_minus_sign: | N/A | plex |
| `product` | *string* | :heavy_minus_sign: | N/A | Plex for iOS |
| `deviceClass` | *string* | :heavy_minus_sign: | N/A | tablet |
| `protocolVersion` | *number* | :heavy_minus_sign: | N/A | 2 |
| `protocolCapabilities` | *string* | :heavy_minus_sign: | N/A | playback,playqueues,timeline,provider-playback |

View File

@@ -0,0 +1,11 @@
# GetAvailableClientsServerResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `errors` | [models.GetAvailableClientsErrors](../models/getavailableclientserrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,11 @@
# GetButlerTasksButlerResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetButlerTasksErrors](../models/getbutlertaskserrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,10 @@
# GetButlerTasksErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,11 @@
# GetButlerTasksResponse
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [models.GetButlerTasksResponseBody](../models/getbutlertasksresponsebody.md) | :heavy_minus_sign: | All butler tasks |

View File

@@ -0,0 +1,10 @@
# GetButlerTasksResponseBody
All butler tasks
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `butlerTasks` | [models.ButlerTasks](../models/butlertasks.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,10 @@
# GetDevicesErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,10 @@
# GetDevicesMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
| `size` | *number* | :heavy_minus_sign: | N/A | 151 |
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.system.devices |
| `device` | [models.Device](../models/device.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,11 @@
# GetDevicesResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [models.GetDevicesResponseBody](../models/getdevicesresponsebody.md) | :heavy_minus_sign: | Devices |

View File

@@ -0,0 +1,10 @@
# GetDevicesResponseBody
Devices
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `mediaContainer` | [models.GetDevicesMediaContainer](../models/getdevicesmediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,11 @@
# GetDevicesServerResponseBody
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `errors` | [models.GetDevicesErrors](../models/getdeviceserrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,10 @@
# GetFileHashErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,9 @@
# GetFileHashRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `url` | *string* | :heavy_check_mark: | This is the path to the local file, must be prefixed by `file://` | file://C:\Image.png&type=13 |
| `type` | *number* | :heavy_minus_sign: | Item type | |

View File

@@ -0,0 +1,10 @@
# GetFileHashResponse
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

Some files were not shown because too many files have changed in this diff Show More