ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1

LukeHagar · Dec 25, 2023 · 2d0192c · 2d0192c
1 parent 9dbcd51
commit 2d0192c
Show file tree

Hide file tree

Showing 628 changed files with 25,014 additions and 3 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+# This allows generated code to be indexed correctly
+*.php linguist-generated=false
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+composer.lock
+vendor
+.DS_Store
diff --git a/README.md b/README.md
@@ -0,0 +1,225 @@
+# lukehagar/plex-api
+
+<div align="left">
+    <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
+    <a href="https://opensource.org/licenses/MIT">
+        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
+    </a>
+</div>
+
+
+## 🏗 **Welcome to your new SDK!** 🏗
+
+It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
+- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
+- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
+- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
+- [ ] ✨ When ready to productionize, delete this section from the README
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+### Composer
+
+To install the SDK first add the below to your `composer.json` file:
+
+```json
+{
+    "repositories": [
+        {
+            "type": "github",
+            "url": "https://github.com/LukeHagar/plexphp.git"
+        }
+    ],
+    "require": {
+        "lukehagar/plex-api": "*"
+    }
+}
+```
+
+Then run the following command:
+
+```bash
+composer update
+```
+<!-- End SDK Installation [installation] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
+
+### Example
+
+```php
+<?php
+
+declare(strict_types=1);
+require_once 'vendor/autoload.php';
+
+use LukeHagar\Plex_API;
+use LukeHagar\Plex_API\Models\Components;
+
+$security = new Components\Security();
+$security->accessToken = '<YOUR_API_KEY_HERE>';
+
+$sdk = Plex_API\PlexAPI::builder()
+    ->setSecurity($security)
+    ->build();
+
+try {
+    $response = $sdk->server->getServerCapabilities();
+
+    if ($response->twoHundredApplicationJsonObject !== null) {
+        // handle response
+    }
+} catch (Exception $e) {
+    // handle exception
+}
+
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+### [Server](docs/sdks/server/README.md)
+
+* [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Server Capabilities
+* [getServerPreferences](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
+* [getAvailableClients](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
+* [getDevices](docs/sdks/server/README.md#getdevices) - Get Devices
+* [getServerIdentity](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
+* [getMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
+* [getResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
+* [getServerList](docs/sdks/server/README.md#getserverlist) - Get Server List
+
+### [Media](docs/sdks/media/README.md)
+
+* [markPlayed](docs/sdks/media/README.md#markplayed) - Mark Media Played
+* [markUnplayed](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
+* [updatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
+
+### [Activities](docs/sdks/activities/README.md)
+
+* [getServerActivities](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
+* [cancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
+
+### [Butler](docs/sdks/butler/README.md)
+
+* [getButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
+* [startAllTasks](docs/sdks/butler/README.md#startalltasks) - Start all Butler tasks
+* [stopAllTasks](docs/sdks/butler/README.md#stopalltasks) - Stop all Butler tasks
+* [startTask](docs/sdks/butler/README.md#starttask) - Start a single Butler task
+* [stopTask](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
+
+### [Hubs](docs/sdks/hubs/README.md)
+
+* [getGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
+* [getLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
+
+### [Search](docs/sdks/search/README.md)
+
+* [performSearch](docs/sdks/search/README.md#performsearch) - Perform a search
+* [performVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
+* [getSearchResults](docs/sdks/search/README.md#getsearchresults) - Get Search Results
+
+### [Library](docs/sdks/library/README.md)
+
+* [getFileHash](docs/sdks/library/README.md#getfilehash) - Get Hash Value
+* [getRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - Get Recently Added
+* [getLibraries](docs/sdks/library/README.md#getlibraries) - Get All Libraries
+* [getLibrary](docs/sdks/library/README.md#getlibrary) - Get Library Details
+* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
+* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
+* [refreshLibrary](docs/sdks/library/README.md#refreshlibrary) - Refresh Library
+* [getLatestLibraryItems](docs/sdks/library/README.md#getlatestlibraryitems) - Get Latest Library Items
+* [getCommonLibraryItems](docs/sdks/library/README.md#getcommonlibraryitems) - Get Common Library Items
+* [getMetadata](docs/sdks/library/README.md#getmetadata) - Get Items Metadata
+* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
+* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
+
+### [Log](docs/sdks/log/README.md)
+
+* [logLine](docs/sdks/log/README.md#logline) - Logging a single line message.
+* [logMultiLine](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
+* [enablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
+
+### [Playlists](docs/sdks/playlists/README.md)
+
+* [createPlaylist](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
+* [getPlaylists](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists
+* [getPlaylist](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
+* [deletePlaylist](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
+* [updatePlaylist](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist
+* [getPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
+* [clearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
+* [addPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
+* [uploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
+
+### [Security](docs/sdks/security/README.md)
+
+* [getTransientToken](docs/sdks/security/README.md#gettransienttoken) - Get a Transient Token.
+* [getSourceConnectionInformation](docs/sdks/security/README.md#getsourceconnectioninformation) - Get Source Connection Information
+
+### [Sessions](docs/sdks/sessions/README.md)
+
+* [getSessions](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions
+* [getSessionHistory](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
+* [getTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
+* [stopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
+
+### [Updater](docs/sdks/updater/README.md)
+
+* [getUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
+* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
+* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
+
+### [Video](docs/sdks/video/README.md)
+
+* [startUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
+* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Server Selection [server] -->
+## Server Selection
+
+## Server Selection
+
+### Select Server by Index
+
+You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
+
+| # | Server | Variables |
+| - | ------ | --------- |
+| 0 | `http://10.10.10.47:32400` | None |
+| 1 | `{protocol}://{ip}:{port}` | `protocol` (default is `http`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
+
+
+
+#### Variables
+
+Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
+ * `protocol: ServerProtocol`
+ * `ip: string`
+ * `port: string`
+
+### Override Server URL Per-Client
+
+The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
+<!-- End Server Selection [server] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version.
+
+## Contributions
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
+
+### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
diff --git a/RELEASES.md b/RELEASES.md
@@ -0,0 +1,9 @@
+
+
+## 2023-12-25 00:55:36
+### Changes
+Based on:
+- OpenAPI Doc 0.0.3 
+- Speakeasy CLI 1.129.1 (2.223.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [php v0.1.0] .
diff --git a/USAGE.md b/USAGE.md
@@ -0,0 +1,29 @@
+<!-- Start SDK Example Usage [usage] -->
+```php
+<?php
+
+declare(strict_types=1);
+require_once 'vendor/autoload.php';
+
+use LukeHagar\Plex_API;
+use LukeHagar\Plex_API\Models\Components;
+
+$security = new Components\Security();
+$security->accessToken = '<YOUR_API_KEY_HERE>';
+
+$sdk = Plex_API\PlexAPI::builder()
+    ->setSecurity($security)
+    ->build();
+
+try {
+    $response = $sdk->server->getServerCapabilities();
+
+    if ($response->twoHundredApplicationJsonObject !== null) {
+        // handle response
+    }
+} catch (Exception $e) {
+    // handle exception
+}
+
+```
+<!-- End SDK Example Usage [usage] -->
diff --git a/composer.json b/composer.json
@@ -0,0 +1,19 @@
+{
+  "name": "lukehagar/plex-api",
+  "type": "library",
+  "autoload": {
+    "psr-4": {
+      "LukeHagar\\Plex_API\\": "src/"
+    }
+  },
+  "license": "MIT",
+  "require": {
+    "php": ">=8.1.0",
+    "guzzlehttp/guzzle": "^7.0",
+    "jms/serializer": "^3.22"
+  },
+  "require-dev": {
+    "phpstan/phpstan": "^1.9",
+    "phpunit/phpunit": "^10"
+  }
+}
diff --git a/docs/Models/Components/Security.md b/docs/Models/Components/Security.md
@@ -0,0 +1,8 @@
+# Security
+
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `accessToken`      | *string*           | :heavy_check_mark: | N/A                |
diff --git a/docs/Models/Operations/Activity.md b/docs/Models/Operations/Activity.md
@@ -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`                                                                        | *?bool*                                                                              | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `userID`                                                                             | *?float*                                                                             | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `title`                                                                              | *?string*                                                                            | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `subtitle`                                                                           | *?string*                                                                            | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `progress`                                                                           | *?float*                                                                             | :heavy_minus_sign:                                                                   | N/A                                                                                  |
+| `context`                                                                            | [?\LukeHagar\Plex_API\Models\Operations\Context](../../Models/Operations/Context.md) | :heavy_minus_sign:                                                                   | N/A                                                                                  |
diff --git a/docs/Models/Operations/AddPlaylistContentsErrors.md b/docs/Models/Operations/AddPlaylistContentsErrors.md
@@ -0,0 +1,10 @@
+# AddPlaylistContentsErrors
+
+
+## Fields
+
+| Field                           | Type                            | Required                        | Description                     | Example                         |
+| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
+| `code`                          | *?float*                        | :heavy_minus_sign:              | N/A                             | 1001                            |
+| `message`                       | *?string*                       | :heavy_minus_sign:              | N/A                             | User could not be authenticated |
+| `status`                        | *?float*                        | :heavy_minus_sign:              | N/A                             | 401                             |
diff --git a/docs/Models/Operations/AddPlaylistContentsRequest.md b/docs/Models/Operations/AddPlaylistContentsRequest.md
@@ -0,0 +1,10 @@
+# AddPlaylistContentsRequest
+
+
+## Fields
+
+| Field                               | Type                                | Required                            | Description                         | Example                             |
+| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
+| `playlistID`                        | *float*                             | :heavy_check_mark:                  | the ID of the playlist              |                                     |
+| `uri`                               | *string*                            | :heavy_check_mark:                  | the content URI for the playlist    | library://..                        |
+| `playQueueID`                       | *float*                             | :heavy_check_mark:                  | the play queue to add to a playlist | 123                                 |
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# This allows generated code to be indexed correctly
		*.php linguist-generated=false