# @lukehagar/plexjs
## Summary Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server ## Table of Contents * [SDK Installation](#sdk-installation) * [Requirements](#requirements) * [SDK Example Usage](#sdk-example-usage) * [Available Resources and Operations](#available-resources-and-operations) * [Standalone functions](#standalone-functions) * [Global Parameters](#global-parameters) * [Retries](#retries) * [Error Handling](#error-handling) * [Server Selection](#server-selection) * [Custom HTTP Client](#custom-http-client) * [Authentication](#authentication) * [Debugging](#debugging) ## SDK Installation The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers. ### NPM ```bash npm add @lukehagar/plexjs ``` ### PNPM ```bash pnpm add @lukehagar/plexjs ``` ### Bun ```bash bun add @lukehagar/plexjs ``` ### Yarn ```bash yarn add @lukehagar/plexjs zod # Note that Yarn does not install peer dependencies automatically. You will need # to install zod as shown above. ``` ## SDK Example Usage ### Example ```typescript import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", }); async function run() { const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); } run(); ``` ## Available Resources and Operations
Available methods ### [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 ### [authentication](docs/sdks/authentication/README.md) * [getTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token * [getSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information * [getTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details * [postUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data ### [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 ### [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 * [getAllLibraries](docs/sdks/library/README.md#getalllibraries) - Get All Libraries * [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details * [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section * [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items * [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library * [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library * [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey * [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children * [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content * [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 ### [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 * [getBannerImage](docs/sdks/media/README.md#getbannerimage) - Get Banner Image * [getThumbImage](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image ### [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 ### [plex](docs/sdks/plex/README.md) * [getCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data * [getUserFriends](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in * [getGeoData](docs/sdks/plex/README.md#getgeodata) - Get Geo Data * [getHomeData](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data * [getServerResources](docs/sdks/plex/README.md#getserverresources) - Get Server Resources * [getPin](docs/sdks/plex/README.md#getpin) - Get a Pin * [getTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId ### [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 ### [server](docs/sdks/server/README.md) * [getServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - Get 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 * [getMediaProviders](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers * [getServerList](docs/sdks/server/README.md#getserverlist) - Get Server List ### [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 ### [statistics](docs/sdks/statistics/README.md) * [getStatistics](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics * [getResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics * [getBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics ### [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) * [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item * [startUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode ### [watchlist](docs/sdks/watchlist/README.md) * [getWatchList](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
## Error Handling All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type. | Error Object | Status Code | Content Type | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | | errors.GetServerCapabilitiesBadRequest | 400 | application/json | | errors.GetServerCapabilitiesUnauthorized | 401 | application/json | | errors.SDKError | 4xx-5xx | */* | Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging. ```typescript import { PlexAPI } from "@lukehagar/plexjs"; import { GetServerCapabilitiesBadRequest, GetServerCapabilitiesUnauthorized, SDKValidationError, } from "@lukehagar/plexjs/sdk/models/errors"; const plexAPI = new PlexAPI({ accessToken: "", xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", }); async function run() { let result; try { result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); } catch (err) { switch (true) { case (err instanceof SDKValidationError): { // Validation errors can be pretty-printed console.error(err.pretty()); // Raw value may also be inspected console.error(err.rawValue); return; } case (err instanceof GetServerCapabilitiesBadRequest): { // Handle err.data$: GetServerCapabilitiesBadRequestData console.error(err); return; } case (err instanceof GetServerCapabilitiesUnauthorized): { // Handle err.data$: GetServerCapabilitiesUnauthorizedData console.error(err); return; } default: { throw err; } } } } run(); ``` ## Server Selection ### Select Server by Index You can override the default server globally by passing a server index to the `serverIdx` 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 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) | ```typescript import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ serverIdx: 0, accessToken: "", xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", }); async function run() { const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); } run(); ``` #### 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: models.ServerProtocol` * `ip: string` * `port: string` ### Override Server URL Per-Client The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example: ```typescript import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ serverURL: "{protocol}://{ip}:{port}", accessToken: "", xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", }); async function run() { const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); } run(); ``` ### Override Server URL Per-Operation The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example: ```typescript import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", }); async function run() { const result = await plexAPI.plex.getCompanionsData({ serverURL: "https://plex.tv/api/v2/", }); // Handle the result console.log(result); } run(); ``` ## Custom HTTP Client The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This client is a thin wrapper around `fetch` and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response. The `HTTPClient` constructor takes an optional `fetcher` argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures. The following example shows how to use the `"beforeRequest"` hook to to add a custom header and a timeout to requests and how to use the `"requestError"` hook to log errors: ```typescript import { PlexAPI } from "@lukehagar/plexjs"; import { HTTPClient } from "@lukehagar/plexjs/lib/http"; const httpClient = new HTTPClient({ // fetcher takes a function that has the same signature as native `fetch`. fetcher: (request) => { return fetch(request); } }); httpClient.addHook("beforeRequest", (request) => { const nextRequest = new Request(request, { signal: request.signal || AbortSignal.timeout(5000) }); nextRequest.headers.set("x-custom-header", "custom value"); return nextRequest; }); httpClient.addHook("requestError", (error, request) => { console.group("Request Error"); console.log("Reason:", `${error}`); console.log("Endpoint:", `${request.method} ${request.url}`); console.groupEnd(); }); const sdk = new PlexAPI({ httpClient }); ``` ## Authentication ### Per-Client Security Schemes This SDK supports the following security scheme globally: | Name | Type | Scheme | | ------------- | ------------- | ------------- | | `accessToken` | apiKey | API key | To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example: ```typescript import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", }); async function run() { const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); } run(); ``` ## Requirements For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md). ## Standalone functions All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away. To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
Available standalone functions - [activitiesCancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities) - [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - [authenticationGetTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - [authenticationPostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks) - [butlerStartTask](docs/sdks/butler/README.md#starttask) - [butlerStopAllTasks](docs/sdks/butler/README.md#stopalltasks) - [butlerStopTask](docs/sdks/butler/README.md#stoptask) - [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary) - [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries) - [libraryGetFileHash](docs/sdks/library/README.md#getfilehash) - [libraryGetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - [libraryGetLibraryItems](docs/sdks/library/README.md#getlibraryitems) - [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - [libraryGetOnDeck](docs/sdks/library/README.md#getondeck) - [libraryGetRecentlyAdded](docs/sdks/library/README.md#getrecentlyadded) - [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - [logLogLine](docs/sdks/log/README.md#logline) - [logLogMultiLine](docs/sdks/log/README.md#logmultiline) - [mediaGetBannerImage](docs/sdks/media/README.md#getbannerimage) - [mediaGetThumbImage](docs/sdks/media/README.md#getthumbimage) - [mediaMarkPlayed](docs/sdks/media/README.md#markplayed) - [mediaMarkUnplayed](docs/sdks/media/README.md#markunplayed) - [mediaUpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - [playlistsAddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - [playlistsClearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents) - [playlistsCreatePlaylist](docs/sdks/playlists/README.md#createplaylist) - [playlistsDeletePlaylist](docs/sdks/playlists/README.md#deleteplaylist) - [playlistsGetPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents) - [playlistsGetPlaylist](docs/sdks/playlists/README.md#getplaylist) - [playlistsGetPlaylists](docs/sdks/playlists/README.md#getplaylists) - [playlistsUpdatePlaylist](docs/sdks/playlists/README.md#updateplaylist) - [playlistsUploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - [plexGetCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - [plexGetGeoData](docs/sdks/plex/README.md#getgeodata) - [plexGetHomeData](docs/sdks/plex/README.md#gethomedata) - [plexGetPin](docs/sdks/plex/README.md#getpin) - [plexGetServerResources](docs/sdks/plex/README.md#getserverresources) - [plexGetTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - [plexGetUserFriends](docs/sdks/plex/README.md#getuserfriends) - [searchGetSearchResults](docs/sdks/search/README.md#getsearchresults) - [searchPerformSearch](docs/sdks/search/README.md#performsearch) - [searchPerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - [serverGetAvailableClients](docs/sdks/server/README.md#getavailableclients) - [serverGetDevices](docs/sdks/server/README.md#getdevices) - [serverGetMediaProviders](docs/sdks/server/README.md#getmediaproviders) - [serverGetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - [serverGetResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - [serverGetServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - [serverGetServerIdentity](docs/sdks/server/README.md#getserveridentity) - [serverGetServerList](docs/sdks/server/README.md#getserverlist) - [serverGetServerPreferences](docs/sdks/server/README.md#getserverpreferences) - [sessionsGetSessionHistory](docs/sdks/sessions/README.md#getsessionhistory) - [sessionsGetSessions](docs/sdks/sessions/README.md#getsessions) - [sessionsGetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - [sessionsStopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - [statisticsGetBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - [statisticsGetResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - [statisticsGetStatistics](docs/sdks/statistics/README.md#getstatistics) - [updaterApplyUpdates](docs/sdks/updater/README.md#applyupdates) - [updaterCheckForUpdates](docs/sdks/updater/README.md#checkforupdates) - [updaterGetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - [videoGetTimeline](docs/sdks/video/README.md#gettimeline) - [videoStartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - [watchlistGetWatchList](docs/sdks/watchlist/README.md#getwatchlist)
## Global Parameters A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed. For example, you can set `X-Plex-Client-Identifier` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `getServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration. ### Available Globals The following global parameter is available. | Name | Type | Required | Description | | ---- | ---- |:--------:| ----------- | | xPlexClientIdentifier | string | | The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) | ### Example ```typescript import { PlexAPI } from "@lukehagar/plexjs"; import { IncludeHttps, IncludeIPv6, IncludeRelay, } from "@lukehagar/plexjs/sdk/models/operations"; const plexAPI = new PlexAPI({ accessToken: "", xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", }); async function run() { const result = await plexAPI.plex.getServerResources( "gcgzw5rz2xovp84b4vha3a40", IncludeHttps.One, IncludeRelay.One, IncludeIPv6.One, ); // Handle the result console.log(result); } run(); ``` ## Retries Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. To change the default retry strategy for a single API call, simply provide a retryConfig object to the call: ```typescript import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ accessToken: "", xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", }); async function run() { const result = await plexAPI.server.getServerCapabilities({ retries: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, }); // Handle the result console.log(result); } run(); ``` If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization: ```typescript import { PlexAPI } from "@lukehagar/plexjs"; const plexAPI = new PlexAPI({ retryConfig: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, accessToken: "", xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40", }); async function run() { const result = await plexAPI.server.getServerCapabilities(); // Handle the result console.log(result); } run(); ``` ## Debugging You can setup your SDK to emit debug logs for SDK requests and responses. You can pass a logger that matches `console`'s interface as an SDK option. > [!WARNING] > Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production. ```typescript import { PlexAPI } from "@lukehagar/plexjs"; const sdk = new PlexAPI({ debugLogger: console }); ``` # 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)