plexswift

An Open API Spec for interacting with Plex.tv and Plex Servers

Requirements

The SDK supports iOS 13 and later.

SDK Installation

Swift Package Manager

You can add plexswift to your project directly in Xcode (File > Add Packages...) or by adding it to your project's Package.swift file:

dependencies: [
    .package(url: "https://github.com/LukeHagar/plexswift.git", .upToNextMajor(from: "0.1.4"))
]

SDK Example Usage

Example

import Foundation
import Plexswift

let client = Client(security: .accessToken("<YOUR_API_KEY_HERE>"))

let response = try await client.server.getServerCapabilities()

switch response.data {
case .twoHundredApplicationJsonObject(let twoHundredApplicationJsonObject):
    // Handle response
    break
case .fourHundredAndOneApplicationJsonObject(let fourHundredAndOneApplicationJsonObject):
    // Handle response
    break
case .empty:
    // Handle empty response
    break
}

Available Resources and Operations

Authentication

Global Security Schemes

The SDK supports the following security scheme globally through the Shared.Security type:

Name	Type	Scheme
.accessToken	apiKey	API key

You can set the appropriate security parameters by passing a Shared.Security value for the security parameter when initializing the Client instance. For example:

import Foundation
import Plexswift

let client = Client(security: .accessToken("<YOUR_API_KEY_HERE>"))

let response = try await client.server.getServerCapabilities()

switch response.data {
case .twoHundredApplicationJsonObject(let twoHundredApplicationJsonObject):
    // Handle response
    break
case .fourHundredAndOneApplicationJsonObject(let fourHundredAndOneApplicationJsonObject):
    // Handle response
    break
case .empty:
    // Handle empty response
    break
}

Global Parameters

A parameter is configured globally. This parameter must 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 "Postman" at SDK initialization and then you do not have to pass the same value on calls to operations like getPin. 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. The required parameter must be set when you initialize the SDK client.

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

import Foundation
import Plexswift

let client = Client()

let response = try await client.plex.getPin(
    request: Operations.GetPinRequest(
        strong: false, 
    )
)

switch response.data {
case .twoHundredApplicationJsonObject(let twoHundredApplicationJsonObject):
    // Handle response
    break
case .fourHundredApplicationJsonObject(let fourHundredApplicationJsonObject):
    // Handle response
    break
case .empty:
    // Handle empty response
    break
}

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