LukeParke/plexswift
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexswift.git synced 2025-12-06 04:20:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.404.5

Browse Source
This commit is contained in:
speakeasybot
2024-09-28 00:08:47 +00:00
parent 3cf973b8f6
commit 3c69645d41
16 changed files with 1180 additions and 1106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
.speakeasy/gen.lock
View File

@@ -1,16 +1,16 @@
lockVersion: 2.0.0
id: 5d77204e-e413-4fd0-a14a-bad3aee2247a
management:
docChecksum: 5e039359563b41bbe118fc6701ba22dc
docChecksum: e7673f3f46e5b0bf495c378378aa7ad6
docVersion: 0.0.3
speakeasyVersion: 1.403.3
generationVersion: 2.424.0
releaseVersion: 0.8.1
configChecksum: be96c47580761fceed9e17bd650c14fe
speakeasyVersion: 1.404.5
generationVersion: 2.426.2
releaseVersion: 0.8.2
configChecksum: c0385fa3ce563806154ec26c3205928f
repoURL: https://github.com/LukeHagar/plexswift.git
features:
swift:
core: 3.2.15
core: 3.2.16
deprecations: 2.81.2
enums: 2.81.1
globalSecurity: 2.81.6
@@ -3399,6 +3399,10 @@ examples:
pinID: 408895
query:
X-Plex-Client-Identifier: gcgzw5rz2xovp84b4vha3a40
X-Plex-Device: Linux
X-Plex-Platform: Chrome
X-Plex-Product: Plex Web
X-Plex-Version: 4.133.0
responses:
"404":
application/json:
@@ -3434,7 +3438,7 @@ examples:
joinedAt: 1556281940
locale: null
mailingListActive: false
mailingListStatus: unsubscribed
mailingListStatus: active
maxHomeSize: 15
pin: string
profile:

2
.speakeasy/gen.yaml
View File

@@ -12,7 +12,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: true
swift:
version: 0.8.1
version: 0.8.2
author: LukeHagar
description: Swift Client SDK Generated by Speakeasy
imports:

2
.speakeasy/workflow.lock
View File

@@ -11,7 +11,7 @@ targets:
plexswift:
source: plexapi
codeSamplesNamespace: code-samples-swift-plexswift
codeSamplesRevisionDigest: sha256:f31f386633b1da51ab2c7882dfc67e9bf031e8c2d0efb1c52bd3db29279d54a0
codeSamplesRevisionDigest: sha256:d03dc67137e373ed808fb4596bea01b62d30185cae48431155bed989eb71339a
outLocation: /github/workspace/repo
workflow:
workflowVersion: 1.0.0

27
README.md
View File

@@ -17,6 +17,31 @@ 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](https://speakeasyapi.dev/)
## Documentation
[API Documentation](https://plexapi.dev)
## 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 respective repository.
| Language | Repository | Releases | Other |
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
<!-- End Summary [summary] -->
<!-- Start Table of Contents [toc] -->
@@ -38,7 +63,7 @@ You can add `plexswift` to your project directly in Xcode `(File > Add Packages.
```bash
dependencies: [
.package(url: "https://github.com/LukeHagar/plexswift.git", .upToNextMajor(from: "0.8.1"))
.package(url: "https://github.com/LukeHagar/plexswift.git", .upToNextMajor(from: "0.8.2"))
]
```
<!-- End SDK Installation [installation] -->

12
RELEASES.md
View File

@@ -692,4 +692,14 @@ Based on:
### Generated
- [swift v0.8.1] .
### Releases
- [Swift Package Manager v0.8.1] https://github.com/LukeHagar/plexswift/releases/tag/v0.8.1 - .
- [Swift Package Manager v0.8.1] https://github.com/LukeHagar/plexswift/releases/tag/v0.8.1 - .
## 2024-09-28 00:07:52
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.404.5 (2.426.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [swift v0.8.2] .
### Releases
- [Swift Package Manager v0.8.2] https://github.com/LukeHagar/plexswift/releases/tag/v0.8.2 - .

25
Sources/Plexswift/Plexswift.docc/Plexswift.md
View File

@@ -1,6 +1,29 @@
# ``plexswift``
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](https://speakeasyapi.dev/)
## Documentation
[API Documentation](https://plexapi.dev)
## 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 respective repository.
| Language | Repository | Releases | Other |
| --------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| Python | [GitHub](https://github.com/LukeHagar/plexpy) | [PyPI](https://pypi.org/project/plex-api-client/) | - |
| JavaScript/TypeScript | [GitHub](https://github.com/LukeHagar/plexjs) | [NPM](https://www.npmjs.com/package/@lukehagar/plexjs) \ [JSR](https://jsr.io/@lukehagar/plexjs) | - |
| Go | [GitHub](https://github.com/LukeHagar/plexgo) | [Releases](https://github.com/LukeHagar/plexgo/releases) | [GoDoc](https://pkg.go.dev/github.com/LukeHagar/plexgo) |
| Ruby | [GitHub](https://github.com/LukeHagar/plexruby) | [Releases](https://github.com/LukeHagar/plexruby/releases) | - |
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
`plexswift` is a Swift library which provides functionality for making requests to the API using a modern, easy-to-use Swift API:

1
Sources/Plexswift/internal/api/_PlexAPI.swift
View File

@@ -125,6 +125,7 @@ private func configureGetTokenByPinIdRequest(with configuration: URLRequestConfi
configuration.path = "/pins/{pinID}"
configuration.method = .get
configuration.pathParameterSerializable = request
configuration.queryParameterSerializable = request
configuration.telemetryHeader = .userAgent
}

20
Sources/Plexswift/internal/models/GetTokenByPinIdRequest+Serialization.swift
View File

@@ -8,10 +8,16 @@ extension Operations.GetTokenByPinIdRequest: Serializable {
switch format {
case .path:
return try serializePathParameterSerializable(self, with: format)
case .query, .header, .multipart, .form:
case .query:
return try serializeQueryParameterSerializable(self, with: format)
case .header, .multipart, .form:
throw SerializationError.invalidSerializationParameter(type: "Operations.GetTokenByPinIdRequest", format: format.formatDescription)
}
}
func serializeQueryParameters(with format: SerializableFormat) throws -> [QueryParameter] {
return try serializedQueryParameters(with: nil, formatOverride: format)
}
}
extension Operations.GetTokenByPinIdRequest: PathParameterSerializable {
@@ -21,3 +27,15 @@ extension Operations.GetTokenByPinIdRequest: PathParameterSerializable {
].compactMapValues { $0 }
}
}
extension Operations.GetTokenByPinIdRequest: QueryParameterSerializable {
func serializedQueryParameters(with parameterDefaults: ParameterDefaults?, formatOverride: SerializableFormat?) throws -> [QueryParameter] {
let builder = QueryParameterBuilder()
try builder.addQueryParameters(from: clientID, named: "X-Plex-Client-Identifier", format: formatOverride ?? .query(style: .form, explode: true), parameterDefaults: parameterDefaults)
try builder.addQueryParameters(from: clientName, named: "X-Plex-Product", format: formatOverride ?? .query(style: .form, explode: true), parameterDefaults: parameterDefaults)
try builder.addQueryParameters(from: clientPlatform, named: "X-Plex-Platform", format: formatOverride ?? .query(style: .form, explode: true), parameterDefaults: parameterDefaults)
try builder.addQueryParameters(from: clientVersion, named: "X-Plex-Version", format: formatOverride ?? .query(style: .form, explode: true), parameterDefaults: parameterDefaults)
try builder.addQueryParameters(from: deviceName, named: "X-Plex-Device", format: formatOverride ?? .query(style: .form, explode: true), parameterDefaults: parameterDefaults)
return builder.build()
}
}

20
Sources/Plexswift/models/operations/GetTokenByPinIdRequest.swift
View File

@@ -7,12 +7,30 @@ extension Operations {
public struct GetTokenByPinIdRequest: APIValue {
/// The PinID to retrieve an access token for
public let pinID: Int
/// 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)
///
public let clientID: String?
public let clientName: String?
public let clientPlatform: String?
public let clientVersion: String?
public let deviceName: String?
/// Creates an object with the specified parameters
///
/// - Parameter pinID: The PinID to retrieve an access token for
/// - Parameter clientID: 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)
///
///
public init(pinID: Int) {
public init(pinID: Int, clientID: String? = nil, clientName: String? = nil, clientPlatform: String? = nil, clientVersion: String? = nil, deviceName: String? = nil) {
self.pinID = pinID
self.clientID = clientID
self.clientName = clientName
self.clientPlatform = clientPlatform
self.clientVersion = clientVersion
self.deviceName = deviceName
}
}}

4
Sources/Plexswift/models/operations/GetTokenDetailsUserPlexAccount.swift
View File

@@ -52,7 +52,7 @@ extension Operations {
public let locale: String
/// If you are subscribed to the Plex newsletter
public let mailingListActive: Bool
/// Your current mailing list status
/// Your current mailing list status (active or unsubscribed)
public let mailingListStatus: Operations.MailingListStatus
/// The maximum number of accounts allowed in the Plex Home
public let maxHomeSize: Int
@@ -111,7 +111,7 @@ extension Operations {
/// - Parameter joinedAt: Unix epoch datetime in seconds
/// - Parameter locale: The account locale
/// - Parameter mailingListActive: If you are subscribed to the Plex newsletter
/// - Parameter mailingListStatus: Your current mailing list status
/// - Parameter mailingListStatus: Your current mailing list status (active or unsubscribed)
/// - Parameter maxHomeSize: The maximum number of accounts allowed in the Plex Home
/// - Parameter protected: If the account has a Plex Home PIN enabled
/// - Parameter rememberExpiresAt: Unix epoch datetime in seconds

2
Sources/Plexswift/models/operations/MailingListStatus.swift
View File

@@ -3,7 +3,7 @@
import Foundation
extension Operations {
/// Your current mailing list status
/// Your current mailing list status (active or unsubscribed)
public enum MailingListStatus: String, Codable, APIValue {
case active = "active"
case unsubscribed = "unsubscribed"

2
Sources/Plexswift/models/operations/PostUsersSignInDataMailingListStatus.swift
View File

@@ -3,7 +3,7 @@
import Foundation
extension Operations {
/// Your current mailing list status
/// Your current mailing list status (active or unsubscribed)
public enum PostUsersSignInDataMailingListStatus: String, Codable, APIValue {
case active = "active"
case unsubscribed = "unsubscribed"

4
Sources/Plexswift/models/operations/PostUsersSignInDataUserPlexAccount.swift
View File

@@ -52,7 +52,7 @@ extension Operations {
public let locale: String
/// If you are subscribed to the Plex newsletter
public let mailingListActive: Bool
/// Your current mailing list status
/// Your current mailing list status (active or unsubscribed)
public let mailingListStatus: Operations.PostUsersSignInDataMailingListStatus
/// The maximum number of accounts allowed in the Plex Home
public let maxHomeSize: Int
@@ -113,7 +113,7 @@ extension Operations {
/// - Parameter joinedAt: Unix epoch datetime in seconds
/// - Parameter locale: The account locale
/// - Parameter mailingListActive: If you are subscribed to the Plex newsletter
/// - Parameter mailingListStatus: Your current mailing list status
/// - Parameter mailingListStatus: Your current mailing list status (active or unsubscribed)
/// - Parameter maxHomeSize: The maximum number of accounts allowed in the Plex Home
/// - Parameter protected: If the account has a Plex Home PIN enabled
/// - Parameter rememberExpiresAt: Unix epoch datetime in seconds

48
Sources/plexswift/PlexswiftAPI.swift
View File

@@ -359,7 +359,7 @@ public enum PlexServers {
public enum GetCompanionsData: Servers, ServerConvertible {
/// Supported server value.
///
/// Corresponds to `https://plex.tv/api/v2/`
/// Corresponds to `https://plex.tv/api/v2`
case server1
/// Defines the raw URL strings for each server option.
@@ -369,11 +369,11 @@ public enum PlexServers {
/// The available URL strings are defined as:
/// ```swift
/// public static let urlStrings = [
/// "https://plex.tv/api/v2/"
/// "https://plex.tv/api/v2"
/// ]
/// ```
public static let urlStrings = [
"https://plex.tv/api/v2/"
"https://plex.tv/api/v2"
]
static func `default`() throws -> Server {
@@ -394,7 +394,7 @@ public enum PlexServers {
public enum GetUserFriends: Servers, ServerConvertible {
/// Supported server value.
///
/// Corresponds to `https://plex.tv/api/v2/`
/// Corresponds to `https://plex.tv/api/v2`
case server1
/// Defines the raw URL strings for each server option.
@@ -404,11 +404,11 @@ public enum PlexServers {
/// The available URL strings are defined as:
/// ```swift
/// public static let urlStrings = [
/// "https://plex.tv/api/v2/"
/// "https://plex.tv/api/v2"
/// ]
/// ```
public static let urlStrings = [
"https://plex.tv/api/v2/"
"https://plex.tv/api/v2"
]
static func `default`() throws -> Server {
@@ -429,7 +429,7 @@ public enum PlexServers {
public enum GetGeoData: Servers, ServerConvertible {
/// Supported server value.
///
/// Corresponds to `https://plex.tv/api/v2/`
/// Corresponds to `https://plex.tv/api/v2`
case server1
/// Defines the raw URL strings for each server option.
@@ -439,11 +439,11 @@ public enum PlexServers {
/// The available URL strings are defined as:
/// ```swift
/// public static let urlStrings = [
/// "https://plex.tv/api/v2/"
/// "https://plex.tv/api/v2"
/// ]
/// ```
public static let urlStrings = [
"https://plex.tv/api/v2/"
"https://plex.tv/api/v2"
]
static func `default`() throws -> Server {
@@ -464,7 +464,7 @@ public enum PlexServers {
public enum GetServerResources: Servers, ServerConvertible {
/// Supported server value.
///
/// Corresponds to `https://plex.tv/api/v2/`
/// Corresponds to `https://plex.tv/api/v2`
case server1
/// Defines the raw URL strings for each server option.
@@ -474,11 +474,11 @@ public enum PlexServers {
/// The available URL strings are defined as:
/// ```swift
/// public static let urlStrings = [
/// "https://plex.tv/api/v2/"
/// "https://plex.tv/api/v2"
/// ]
/// ```
public static let urlStrings = [
"https://plex.tv/api/v2/"
"https://plex.tv/api/v2"
]
static func `default`() throws -> Server {
@@ -499,7 +499,7 @@ public enum PlexServers {
public enum GetPin: Servers, ServerConvertible {
/// Supported server value.
///
/// Corresponds to `https://plex.tv/api/v2/`
/// Corresponds to `https://plex.tv/api/v2`
case server1
/// Defines the raw URL strings for each server option.
@@ -509,11 +509,11 @@ public enum PlexServers {
/// The available URL strings are defined as:
/// ```swift
/// public static let urlStrings = [
/// "https://plex.tv/api/v2/"
/// "https://plex.tv/api/v2"
/// ]
/// ```
public static let urlStrings = [
"https://plex.tv/api/v2/"
"https://plex.tv/api/v2"
]
static func `default`() throws -> Server {
@@ -534,7 +534,7 @@ public enum PlexServers {
public enum GetTokenByPinId: Servers, ServerConvertible {
/// Supported server value.
///
/// Corresponds to `https://plex.tv/api/v2/`
/// Corresponds to `https://plex.tv/api/v2`
case server1
/// Defines the raw URL strings for each server option.
@@ -544,11 +544,11 @@ public enum PlexServers {
/// The available URL strings are defined as:
/// ```swift
/// public static let urlStrings = [
/// "https://plex.tv/api/v2/"
/// "https://plex.tv/api/v2"
/// ]
/// ```
public static let urlStrings = [
"https://plex.tv/api/v2/"
"https://plex.tv/api/v2"
]
static func `default`() throws -> Server {
@@ -1144,7 +1144,7 @@ public enum AuthenticationServers {
public enum GetTokenDetails: Servers, ServerConvertible {
/// Supported server value.
///
/// Corresponds to `https://plex.tv/api/v2/`
/// Corresponds to `https://plex.tv/api/v2`
case server1
/// Defines the raw URL strings for each server option.
@@ -1154,11 +1154,11 @@ public enum AuthenticationServers {
/// The available URL strings are defined as:
/// ```swift
/// public static let urlStrings = [
/// "https://plex.tv/api/v2/"
/// "https://plex.tv/api/v2"
/// ]
/// ```
public static let urlStrings = [
"https://plex.tv/api/v2/"
"https://plex.tv/api/v2"
]
static func `default`() throws -> Server {
@@ -1179,7 +1179,7 @@ public enum AuthenticationServers {
public enum PostUsersSignInData: Servers, ServerConvertible {
/// Supported server value.
///
/// Corresponds to `https://plex.tv/api/v2/`
/// Corresponds to `https://plex.tv/api/v2`
case server1
/// Defines the raw URL strings for each server option.
@@ -1189,11 +1189,11 @@ public enum AuthenticationServers {
/// The available URL strings are defined as:
/// ```swift
/// public static let urlStrings = [
/// "https://plex.tv/api/v2/"
/// "https://plex.tv/api/v2"
/// ]
/// ```
public static let urlStrings = [
"https://plex.tv/api/v2/"
"https://plex.tv/api/v2"
]
static func `default`() throws -> Server {

2
Sources/plexswift/internal/client/URLRequestBuilder.swift
View File

@@ -62,7 +62,7 @@ final class URLRequestBuilder: URLRequestConfiguration {
urlRequest.setValue(contentType, forHTTPHeaderField: "Content-Type")
}
urlRequest.setValue("speakeasy-sdk/swift 0.8.1 2.424.0 0.0.3 plexswift", forHTTPHeaderField: telemetryHeader.headerName)
urlRequest.setValue("speakeasy-sdk/swift 0.8.2 2.426.2 0.0.3 plexswift", forHTTPHeaderField: telemetryHeader.headerName)
addSecurityParameters(to: &urlRequest)

2097
codeSamples.yaml
View File

File diff suppressed because it is too large Load Diff