Giters

LukeHagar / plexswift

An open source Plex Media Server Swift SDK

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

plexswift

Platform Swift Version

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

Requirements

The SDK supports iOS 13 and later.

Summary

Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server

Plex Media Server OpenAPI Specification

An Open Source OpenAPI Specification for Plex Media Server

Automation and SDKs provided by Speakeasy

Documentation

API Documentation

SDKs

The following SDKs are generated from the OpenAPI Specification. They are automatically generated and may not be fully tested. If you find any issues, please open an issue on the main specification Repository.

Language Repository Releases Other
Python GitHub PyPI -
JavaScript/TypeScript GitHub NPM \ JSR -
Go GitHub Releases GoDoc
Ruby GitHub Releases -
Swift GitHub Releases -
PHP GitHub Releases -
Java GitHub Releases -
C# GitHub Releases -

Table of Contents

SDK Installation

The SDK uses the Swift Package Manager to handle dependencies, which is included in Swift 3.0 and above.

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.8.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 .object(let object):
    // Handle response
    break
case .badRequest(let badRequest):
    // Handle response
    break
case .unauthorized(let unauthorized):
    // Handle response
    break
case .empty:
    // Handle empty response
    break
}

Available Resources and Operations

Available methods

Activities

Authentication

Butler

Hubs

Library

Log

Media

Playlists

Plex

Search

Server

Sessions

Statistics

Updater

Video

Watchlist

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 .object(let object):
    // Handle response
    break
case .badRequest(let badRequest):
    // Handle response
    break
case .unauthorized(let unauthorized):
    // Handle response
    break
case .empty:
    // Handle empty response
    break
}

Global Parameters

Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set ClientID 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 parameters are available.

Name Type Required Description
clientID 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)

| | clientName | String | | The clientName parameter. | | clientVersion | String | | The clientVersion parameter. | | clientPlatform | String | | The clientPlatform parameter. | | deviceName | String | | The deviceName parameter. |

Example

import Foundation
import Plexswift

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

let response = try await client.plex.getServerResources(
    request: Operations.GetServerResourcesRequest(
        includeHttps: .enable, 
        includeIPv6: .enable, 
        includeRelay: .enable
    )
)

switch response.data {
case .plexDevices(let plexDevices):
    // Handle response
    break
case .badRequest(let badRequest):
    // Handle response
    break
case .unauthorized(let unauthorized):
    // 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

About

An open source Plex Media Server Swift SDK

License:MIT License

Languages

Language:Swift 100.0%