ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6

This commit is contained in:
speakeasybot
2024-12-21 00:08:57 +00:00
parent ec06ec9a84
commit 0e54599d71
35 changed files with 174 additions and 186 deletions

View File

@@ -52,7 +52,7 @@ import FoundationNetworking
///
/// ### Initializers
///
/// - ``init(globalParameters:security:)``
/// - ``init(security:)``
///
/// ### API calls
///
@@ -91,14 +91,12 @@ public final class Client {
// Underscore-prefix properties so these do not potentially conflict with any operation namespaces.
private lazy var _session = URLSession(configuration: .default)
private var _globalParameters: GlobalParameters?
private var _security: Shared.Security?
private var _selectedServer: GlobalServers?
/// Creates an API client object with the specified parameters.
public init(globalParameters: GlobalParameters? = nil, security: Shared.Security? = nil) {
self._globalParameters = globalParameters
public init(security: Shared.Security? = nil) {
self._security = security
}
@@ -168,7 +166,7 @@ public final class Client {
do {
let builder = URLRequestBuilder(
baseURL: try baseURL(serverOverride: server),
parameterDefaults: _globalParameters,
parameterDefaults: nil,
defaultSecurityParameterProviding: _security
)
try configureRequest(builder)

View File

@@ -66,7 +66,6 @@ case .empty:
### Connecting to the API
- ``Client``
- ``GlobalParameters``
- ``Shared/Security``
- ``Response``
- ``ResponseWithHeaders``

View File

@@ -1,50 +0,0 @@
// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
import Foundation
/// Describes common parameters which can be used when making API requests.
///
/// > Note: These parameters may be overridden by individual API operations
public struct GlobalParameters {
public let clientID: String?
public let clientName: String?
public let clientVersion: String?
public let platform: String?
public let deviceNickname: String?
/// Creates an object with the given parameters
///
/// - Parameter clientID: An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
/// - Parameter clientName: The name of the client application. (Plex Web, Plex Media Server, etc.)
/// - Parameter clientVersion: The version of the client application.
/// - Parameter deviceNickname: A relatively friendly name for the client device
/// - Parameter platform: The platform of the client application.
///
public init(
clientID: String? = nil,
clientName: String? = nil,
clientVersion: String? = nil,
platform: String? = nil,
deviceNickname: String? = nil
) {
self.clientID = clientID
self.clientName = clientName
self.clientVersion = clientVersion
self.platform = platform
self.deviceNickname = deviceNickname
}
}
extension GlobalParameters: ParameterDefaults {
public func defaultSerializedPathParameter(for key: String) throws -> String? {
switch key {
default: return nil
}
}
public func defaultQueryParameter(for key: String) -> AnyValue? {
switch key {
default: return nil
}
}
}

View File

@@ -31,7 +31,7 @@ extension Operations.GetPinRequest: QueryParameterSerializable {
extension Operations.GetPinRequest: HeaderParameterSerializable {
func serializedHeaderParameters() throws -> [SerializedParameter] {
return [
SerializedParameter(name: "X-Plex-Client-Identifier", serialized: try clientID?.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Client-Identifier", serialized: try clientID.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Product", serialized: try clientName?.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Version", serialized: try clientVersion?.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Device", serialized: try deviceNickname?.serialize(with: .header(explode: false))),

View File

@@ -35,7 +35,7 @@ extension Operations.GetSearchAllLibrariesRequest: QueryParameterSerializable {
extension Operations.GetSearchAllLibrariesRequest: HeaderParameterSerializable {
func serializedHeaderParameters() throws -> [SerializedParameter] {
return [
SerializedParameter(name: "X-Plex-Client-Identifier", serialized: try clientID?.serialize(with: .header(explode: false)))
SerializedParameter(name: "X-Plex-Client-Identifier", serialized: try clientID.serialize(with: .header(explode: false)))
]
}
}

View File

@@ -33,7 +33,7 @@ extension Operations.GetServerResourcesRequest: QueryParameterSerializable {
extension Operations.GetServerResourcesRequest: HeaderParameterSerializable {
func serializedHeaderParameters() throws -> [SerializedParameter] {
return [
SerializedParameter(name: "X-Plex-Client-Identifier", serialized: try clientID?.serialize(with: .header(explode: false)))
SerializedParameter(name: "X-Plex-Client-Identifier", serialized: try clientID.serialize(with: .header(explode: false)))
]
}
}

View File

@@ -27,7 +27,7 @@ extension Operations.GetTokenByPinIdRequest: PathParameterSerializable {
extension Operations.GetTokenByPinIdRequest: HeaderParameterSerializable {
func serializedHeaderParameters() throws -> [SerializedParameter] {
return [
SerializedParameter(name: "X-Plex-Client-Identifier", serialized: try clientID?.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Client-Identifier", serialized: try clientID.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Product", serialized: try clientName?.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Version", serialized: try clientVersion?.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Device", serialized: try deviceNickname?.serialize(with: .header(explode: false))),

View File

@@ -17,7 +17,7 @@ extension Operations.PostUsersSignInDataRequest: Serializable {
extension Operations.PostUsersSignInDataRequest: HeaderParameterSerializable {
func serializedHeaderParameters() throws -> [SerializedParameter] {
return [
SerializedParameter(name: "X-Plex-Client-Identifier", serialized: try clientID?.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Client-Identifier", serialized: try clientID.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Product", serialized: try clientName?.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Version", serialized: try clientVersion?.serialize(with: .header(explode: false))),
SerializedParameter(name: "X-Plex-Device", serialized: try deviceNickname?.serialize(with: .header(explode: false))),

View File

@@ -78,12 +78,12 @@ extension Operations {
public let ratingImage: String?
public let role: [Operations.GetLibraryItemsRole]?
public let seasonCount: Int?
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// aired = TheTVDB (Aired),
/// dvd = TheTVDB (DVD),
/// absolute = TheTVDB (Absolute)).
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// tvdbAiring = TheTVDB (Aired),
/// tvdbDvd = TheTVDB (DVD),
/// tvdbAbsolute = TheTVDB (Absolute)).
///
public let showOrdering: Operations.GetLibraryItemsShowOrdering?
public let skipChildren: Bool?
@@ -117,12 +117,12 @@ extension Operations {
///
/// - Parameter parentRatingKey: The rating key of the parent item.
///
/// - Parameter showOrdering: Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// aired = TheTVDB (Aired),
/// dvd = TheTVDB (DVD),
/// absolute = TheTVDB (Absolute)).
/// - Parameter showOrdering: Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// tvdbAiring = TheTVDB (Aired),
/// tvdbDvd = TheTVDB (DVD),
/// tvdbAbsolute = TheTVDB (Absolute)).
///
/// - Parameter updatedAt: Unix epoch datetime in seconds
///

View File

@@ -16,4 +16,6 @@ extension Operations {
case season = 3
case episode = 4
case audio = 8
case album = 9
case track = 10
}}

View File

@@ -3,17 +3,17 @@
import Foundation
extension Operations {
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// aired = TheTVDB (Aired),
/// dvd = TheTVDB (DVD),
/// absolute = TheTVDB (Absolute)).
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// tvdbAiring = TheTVDB (Aired),
/// tvdbDvd = TheTVDB (DVD),
/// tvdbAbsolute = TheTVDB (Absolute)).
///
public enum GetLibraryItemsShowOrdering: String, Codable, APIValue {
case `none` = "None"
case tmdbAiring = "tmdbAiring"
case aired = "aired"
case dvd = "dvd"
case absolute = "absolute"
case tvdbAiring = "tvdbAiring"
case tvdbDvd = "tvdbDvd"
case tvdbAbsolute = "tvdbAbsolute"
}}

View File

@@ -15,9 +15,13 @@ extension Operations {
public let director: [Operations.GetMetaDataByRatingKeyDirector]?
public let duration: Int?
public let genre: [Operations.GetMetaDataByRatingKeyGenre]?
/// The name of the album artist for the track when audio, and the name of the TV show for the episode when video.
public let grandparentTitle: String?
public let guid: String?
public let guids: [Operations.Guids]?
public let hasPremiumPrimaryExtra: String?
/// The index starting from 0 of this media item in the MetaData array.
public let index: Int?
public let key: String?
public let librarySectionID: Int?
public let librarySectionKey: String?
@@ -25,6 +29,12 @@ extension Operations {
public let media: [Operations.GetMetaDataByRatingKeyMedia]?
@DateOnly
public private(set) var originallyAvailableAt: Date?
/// The orginal untranslated name of the media item when non-english.
public let originalTitle: String?
/// The parent index starting from 0 of this media item in the parent MetaData array.
public let parentIndex: Int?
/// The name of the album for the track when audio, and the name of the season for the episode when TV show.
public let parentTitle: String?
public let producer: [Operations.Producer]?
@DecimalSerialized
public private(set) var rating: Double?
@@ -44,8 +54,13 @@ extension Operations {
/// Creates an object with the specified parameters
///
/// - Parameter grandparentTitle: The name of the album artist for the track when audio, and the name of the TV show for the episode when video.
/// - Parameter index: The index starting from 0 of this media item in the MetaData array.
/// - Parameter originalTitle: The orginal untranslated name of the media item when non-english.
/// - Parameter parentIndex: The parent index starting from 0 of this media item in the parent MetaData array.
/// - Parameter parentTitle: The name of the album for the track when audio, and the name of the season for the episode when TV show.
///
public init(addedAt: Int? = nil, art: String? = nil, audienceRating: Double? = nil, audienceRatingImage: String? = nil, contentRating: String? = nil, country: [Operations.GetMetaDataByRatingKeyCountry]? = nil, director: [Operations.GetMetaDataByRatingKeyDirector]? = nil, duration: Int? = nil, genre: [Operations.GetMetaDataByRatingKeyGenre]? = nil, guid: String? = nil, guids: [Operations.Guids]? = nil, hasPremiumPrimaryExtra: String? = nil, key: String? = nil, librarySectionID: Int? = nil, librarySectionKey: String? = nil, librarySectionTitle: String? = nil, media: [Operations.GetMetaDataByRatingKeyMedia]? = nil, originallyAvailableAt: Date? = nil, producer: [Operations.Producer]? = nil, rating: Double? = nil, ratingImage: String? = nil, ratingKey: String? = nil, ratings: [Operations.Ratings]? = nil, role: [Operations.GetMetaDataByRatingKeyRole]? = nil, studio: String? = nil, summary: String? = nil, tagline: String? = nil, thumb: String? = nil, title: String? = nil, type: String? = nil, updatedAt: Int? = nil, writer: [Operations.GetMetaDataByRatingKeyWriter]? = nil, year: Int? = nil) {
public init(addedAt: Int? = nil, art: String? = nil, audienceRating: Double? = nil, audienceRatingImage: String? = nil, contentRating: String? = nil, country: [Operations.GetMetaDataByRatingKeyCountry]? = nil, director: [Operations.GetMetaDataByRatingKeyDirector]? = nil, duration: Int? = nil, genre: [Operations.GetMetaDataByRatingKeyGenre]? = nil, grandparentTitle: String? = nil, guid: String? = nil, guids: [Operations.Guids]? = nil, hasPremiumPrimaryExtra: String? = nil, index: Int? = nil, key: String? = nil, librarySectionID: Int? = nil, librarySectionKey: String? = nil, librarySectionTitle: String? = nil, media: [Operations.GetMetaDataByRatingKeyMedia]? = nil, originallyAvailableAt: Date? = nil, originalTitle: String? = nil, parentIndex: Int? = nil, parentTitle: String? = nil, producer: [Operations.Producer]? = nil, rating: Double? = nil, ratingImage: String? = nil, ratingKey: String? = nil, ratings: [Operations.Ratings]? = nil, role: [Operations.GetMetaDataByRatingKeyRole]? = nil, studio: String? = nil, summary: String? = nil, tagline: String? = nil, thumb: String? = nil, title: String? = nil, type: String? = nil, updatedAt: Int? = nil, writer: [Operations.GetMetaDataByRatingKeyWriter]? = nil, year: Int? = nil) {
self.addedAt = addedAt
self.art = art
self._audienceRating = DecimalSerialized<Double?>(wrappedValue: audienceRating)
@@ -55,15 +70,20 @@ extension Operations {
self.director = director
self.duration = duration
self.genre = genre
self.grandparentTitle = grandparentTitle
self.guid = guid
self.guids = guids
self.hasPremiumPrimaryExtra = hasPremiumPrimaryExtra
self.index = index
self.key = key
self.librarySectionID = librarySectionID
self.librarySectionKey = librarySectionKey
self.librarySectionTitle = librarySectionTitle
self.media = media
self._originallyAvailableAt = DateOnly<Date?>(wrappedValue: originallyAvailableAt)
self.originalTitle = originalTitle
self.parentIndex = parentIndex
self.parentTitle = parentTitle
self.producer = producer
self._rating = DecimalSerialized<Double?>(wrappedValue: rating)
self.ratingImage = ratingImage
@@ -93,15 +113,20 @@ extension Operations.GetMetaDataByRatingKeyMetadata: Codable {
case director = "Director"
case duration
case genre = "Genre"
case grandparentTitle
case guid
case guids = "Guid"
case hasPremiumPrimaryExtra
case index
case key
case librarySectionID
case librarySectionKey
case librarySectionTitle
case media = "Media"
case originallyAvailableAt
case originalTitle
case parentIndex
case parentTitle
case producer = "Producer"
case rating
case ratingImage
@@ -130,15 +155,20 @@ extension Operations.GetMetaDataByRatingKeyMetadata: Codable {
self.director = try container.decodeIfPresent([Operations.GetMetaDataByRatingKeyDirector].self, forKey: .director)
self.duration = try container.decodeIfPresent(Int.self, forKey: .duration)
self.genre = try container.decodeIfPresent([Operations.GetMetaDataByRatingKeyGenre].self, forKey: .genre)
self.grandparentTitle = try container.decodeIfPresent(String.self, forKey: .grandparentTitle)
self.guid = try container.decodeIfPresent(String.self, forKey: .guid)
self.guids = try container.decodeIfPresent([Operations.Guids].self, forKey: .guids)
self.hasPremiumPrimaryExtra = try container.decodeIfPresent(String.self, forKey: .hasPremiumPrimaryExtra)
self.index = try container.decodeIfPresent(Int.self, forKey: .index)
self.key = try container.decodeIfPresent(String.self, forKey: .key)
self.librarySectionID = try container.decodeIfPresent(Int.self, forKey: .librarySectionID)
self.librarySectionKey = try container.decodeIfPresent(String.self, forKey: .librarySectionKey)
self.librarySectionTitle = try container.decodeIfPresent(String.self, forKey: .librarySectionTitle)
self.media = try container.decodeIfPresent([Operations.GetMetaDataByRatingKeyMedia].self, forKey: .media)
self._originallyAvailableAt = try container.decodeIfPresent(DateOnly<Date?>.self, forKey: .originallyAvailableAt) ?? DateOnly<Date?>(wrappedValue: nil)
self.originalTitle = try container.decodeIfPresent(String.self, forKey: .originalTitle)
self.parentIndex = try container.decodeIfPresent(Int.self, forKey: .parentIndex)
self.parentTitle = try container.decodeIfPresent(String.self, forKey: .parentTitle)
self.producer = try container.decodeIfPresent([Operations.Producer].self, forKey: .producer)
self._rating = try container.decodeIfPresent(DecimalSerialized<Double?>.self, forKey: .rating) ?? DecimalSerialized<Double?>(wrappedValue: nil)
self.ratingImage = try container.decodeIfPresent(String.self, forKey: .ratingImage)
@@ -169,9 +199,11 @@ extension Operations.GetMetaDataByRatingKeyMetadata: Codable {
try container.encodeIfPresent(self.director, forKey: .director)
try container.encodeIfPresent(self.duration, forKey: .duration)
try container.encodeIfPresent(self.genre, forKey: .genre)
try container.encodeIfPresent(self.grandparentTitle, forKey: .grandparentTitle)
try container.encodeIfPresent(self.guid, forKey: .guid)
try container.encodeIfPresent(self.guids, forKey: .guids)
try container.encodeIfPresent(self.hasPremiumPrimaryExtra, forKey: .hasPremiumPrimaryExtra)
try container.encodeIfPresent(self.index, forKey: .index)
try container.encodeIfPresent(self.key, forKey: .key)
try container.encodeIfPresent(self.librarySectionID, forKey: .librarySectionID)
try container.encodeIfPresent(self.librarySectionKey, forKey: .librarySectionKey)
@@ -180,6 +212,9 @@ extension Operations.GetMetaDataByRatingKeyMetadata: Codable {
if self.originallyAvailableAt != nil {
try container.encode(self._originallyAvailableAt, forKey: .originallyAvailableAt)
}
try container.encodeIfPresent(self.originalTitle, forKey: .originalTitle)
try container.encodeIfPresent(self.parentIndex, forKey: .parentIndex)
try container.encodeIfPresent(self.parentTitle, forKey: .parentTitle)
try container.encodeIfPresent(self.producer, forKey: .producer)
if self.rating != nil {
try container.encode(self._rating, forKey: .rating)

View File

@@ -6,7 +6,7 @@ extension Operations {
/// A model object
public struct GetPinRequest: APIValue {
/// An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
public let clientID: String?
public let clientID: String
/// The name of the client application. (Plex Web, Plex Media Server, etc.)
public let clientName: String?
/// The version of the client application.
@@ -33,7 +33,7 @@ extension Operations {
/// Non-Strong codes are used for `Plex.tv/link`
///
///
public init(clientID: String? = nil, clientName: String? = nil, clientVersion: String? = nil, deviceNickname: String? = nil, platform: String? = nil, strong: Bool? = nil) {
public init(clientID: String, clientName: String? = nil, clientVersion: String? = nil, deviceNickname: String? = nil, platform: String? = nil, strong: Bool? = nil) {
self.clientID = clientID
self.clientName = clientName
self.clientVersion = clientVersion

View File

@@ -16,4 +16,6 @@ extension Operations {
case season = 3
case episode = 4
case audio = 8
case album = 9
case track = 10
}}

View File

@@ -78,12 +78,12 @@ extension Operations {
public let ratingImage: String?
public let role: [Operations.Role]?
public let seasonCount: Int?
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// aired = TheTVDB (Aired),
/// dvd = TheTVDB (DVD),
/// absolute = TheTVDB (Absolute)).
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// tvdbAiring = TheTVDB (Aired),
/// tvdbDvd = TheTVDB (DVD),
/// tvdbAbsolute = TheTVDB (Absolute)).
///
public let showOrdering: Operations.ShowOrdering?
public let skipChildren: Bool?
@@ -117,12 +117,12 @@ extension Operations {
///
/// - Parameter parentRatingKey: The rating key of the parent item.
///
/// - Parameter showOrdering: Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// aired = TheTVDB (Aired),
/// dvd = TheTVDB (DVD),
/// absolute = TheTVDB (Absolute)).
/// - Parameter showOrdering: Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// tvdbAiring = TheTVDB (Aired),
/// tvdbDvd = TheTVDB (DVD),
/// tvdbAbsolute = TheTVDB (Absolute)).
///
/// - Parameter updatedAt: Unix epoch datetime in seconds
///

View File

@@ -78,12 +78,12 @@ extension Operations {
public let ratingImage: String?
public let role: [Operations.GetSearchAllLibrariesRole]?
public let seasonCount: Int?
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// aired = TheTVDB (Aired),
/// dvd = TheTVDB (DVD),
/// absolute = TheTVDB (Absolute)).
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// tvdbAiring = TheTVDB (Aired),
/// tvdbDvd = TheTVDB (DVD),
/// tvdbAbsolute = TheTVDB (Absolute)).
///
public let showOrdering: Operations.GetSearchAllLibrariesShowOrdering?
public let skipChildren: Bool?
@@ -117,12 +117,12 @@ extension Operations {
///
/// - Parameter parentRatingKey: The rating key of the parent item.
///
/// - Parameter showOrdering: Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// aired = TheTVDB (Aired),
/// dvd = TheTVDB (DVD),
/// absolute = TheTVDB (Absolute)).
/// - Parameter showOrdering: Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// tvdbAiring = TheTVDB (Aired),
/// tvdbDvd = TheTVDB (DVD),
/// tvdbAbsolute = TheTVDB (Absolute)).
///
/// - Parameter updatedAt: Unix epoch datetime in seconds
///

View File

@@ -5,10 +5,10 @@ import Foundation
extension Operations {
/// A model object
public struct GetSearchAllLibrariesRequest: APIValue {
/// An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
public let clientID: String
/// The search query term.
public let query: String
/// An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
public let clientID: String?
/// Whether to include collections in the search results.
public let includeCollections: Operations.QueryParamIncludeCollections?
/// Whether to include external media in the search results.
@@ -21,17 +21,17 @@ extension Operations {
/// Creates an object with the specified parameters
///
/// - Parameter query: The search query term.
/// - Parameter clientID: An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
/// - Parameter query: The search query term.
/// - Parameter includeCollections: Whether to include collections in the search results.
/// - Parameter includeExternalMedia: Whether to include external media in the search results.
/// - Parameter limit: Limit the number of results returned.
/// - Parameter searchTypes: A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.
///
///
public init(query: String, clientID: String? = nil, includeCollections: Operations.QueryParamIncludeCollections? = nil, includeExternalMedia: Operations.QueryParamIncludeExternalMedia? = nil, limit: Int? = nil, searchTypes: [Operations.SearchTypes]? = nil) {
self.query = query
public init(clientID: String, query: String, includeCollections: Operations.QueryParamIncludeCollections? = nil, includeExternalMedia: Operations.QueryParamIncludeExternalMedia? = nil, limit: Int? = nil, searchTypes: [Operations.SearchTypes]? = nil) {
self.clientID = clientID
self.query = query
self.includeCollections = includeCollections
self.includeExternalMedia = includeExternalMedia
self.limit = limit

View File

@@ -3,17 +3,17 @@
import Foundation
extension Operations {
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// aired = TheTVDB (Aired),
/// dvd = TheTVDB (DVD),
/// absolute = TheTVDB (Absolute)).
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// tvdbAiring = TheTVDB (Aired),
/// tvdbDvd = TheTVDB (DVD),
/// tvdbAbsolute = TheTVDB (Absolute)).
///
public enum GetSearchAllLibrariesShowOrdering: String, Codable, APIValue {
case `none` = "None"
case tmdbAiring = "tmdbAiring"
case aired = "aired"
case dvd = "dvd"
case absolute = "absolute"
case tvdbAiring = "tvdbAiring"
case tvdbDvd = "tvdbDvd"
case tvdbAbsolute = "tvdbAbsolute"
}}

View File

@@ -16,4 +16,6 @@ extension Operations {
case season = 3
case episode = 4
case audio = 8
case album = 9
case track = 10
}}

View File

@@ -6,7 +6,7 @@ extension Operations {
/// A model object
public struct GetServerResourcesRequest: APIValue {
/// An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
public let clientID: String?
public let clientID: String
/// Include Https entries in the results
public let includeHttps: Operations.IncludeHttps?
/// Include IPv6 entries in the results
@@ -25,7 +25,7 @@ extension Operations {
/// E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
///
///
public init(clientID: String? = nil, includeHttps: Operations.IncludeHttps? = nil, includeIPv6: Operations.IncludeIPv6? = nil, includeRelay: Operations.IncludeRelay? = nil) {
public init(clientID: String, includeHttps: Operations.IncludeHttps? = nil, includeIPv6: Operations.IncludeIPv6? = nil, includeRelay: Operations.IncludeRelay? = nil) {
self.clientID = clientID
self.includeHttps = includeHttps
self.includeIPv6 = includeIPv6

View File

@@ -5,10 +5,10 @@ import Foundation
extension Operations {
/// A model object
public struct GetTokenByPinIdRequest: APIValue {
/// An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
public let clientID: String
/// The PinID to retrieve an access token for
public let pinID: Int
/// An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
public let clientID: String?
/// The name of the client application. (Plex Web, Plex Media Server, etc.)
public let clientName: String?
/// The version of the client application.
@@ -20,16 +20,16 @@ extension Operations {
/// Creates an object with the specified parameters
///
/// - Parameter pinID: The PinID to retrieve an access token for
/// - Parameter clientID: An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
/// - Parameter pinID: The PinID to retrieve an access token for
/// - Parameter clientName: The name of the client application. (Plex Web, Plex Media Server, etc.)
/// - Parameter clientVersion: The version of the client application.
/// - Parameter deviceNickname: A relatively friendly name for the client device
/// - Parameter platform: The platform of the client application.
///
public init(pinID: Int, clientID: String? = nil, clientName: String? = nil, clientVersion: String? = nil, deviceNickname: String? = nil, platform: String? = nil) {
self.pinID = pinID
public init(clientID: String, pinID: Int, clientName: String? = nil, clientVersion: String? = nil, deviceNickname: String? = nil, platform: String? = nil) {
self.clientID = clientID
self.pinID = pinID
self.clientName = clientName
self.clientVersion = clientVersion
self.deviceNickname = deviceNickname

View File

@@ -16,4 +16,6 @@ extension Operations {
case season = 3
case episode = 4
case audio = 8
case album = 9
case track = 10
}}

View File

@@ -6,7 +6,7 @@ extension Operations {
/// A model object
public struct PostUsersSignInDataRequest: APIValue {
/// An opaque identifier unique to the client (UUID, serial number, or other unique device ID)
public let clientID: String?
public let clientID: String
/// The name of the client application. (Plex Web, Plex Media Server, etc.)
public let clientName: String?
/// The version of the client application.
@@ -27,7 +27,7 @@ extension Operations {
/// - Parameter platform: The platform of the client application.
/// - Parameter requestBody: Login credentials
///
public init(clientID: String? = nil, clientName: String? = nil, clientVersion: String? = nil, deviceNickname: String? = nil, platform: String? = nil, requestBody: Operations.PostUsersSignInDataRequestBody? = nil) {
public init(clientID: String, clientName: String? = nil, clientVersion: String? = nil, deviceNickname: String? = nil, platform: String? = nil, requestBody: Operations.PostUsersSignInDataRequestBody? = nil) {
self.clientID = clientID
self.clientName = clientName
self.clientVersion = clientVersion

View File

@@ -16,4 +16,6 @@ extension Operations {
case season = 3
case episode = 4
case audio = 8
case album = 9
case track = 10
}}

View File

@@ -3,17 +3,17 @@
import Foundation
extension Operations {
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// aired = TheTVDB (Aired),
/// dvd = TheTVDB (DVD),
/// absolute = TheTVDB (Absolute)).
/// Setting that indicates the episode ordering for the show
/// None = Library default,
/// tmdbAiring = The Movie Database (Aired),
/// tvdbAiring = TheTVDB (Aired),
/// tvdbDvd = TheTVDB (DVD),
/// tvdbAbsolute = TheTVDB (Absolute)).
///
public enum ShowOrdering: String, Codable, APIValue {
case `none` = "None"
case tmdbAiring = "tmdbAiring"
case aired = "aired"
case dvd = "dvd"
case absolute = "absolute"
case tvdbAiring = "tvdbAiring"
case tvdbDvd = "tvdbDvd"
case tvdbAbsolute = "tvdbAbsolute"
}}

View File

@@ -24,4 +24,5 @@ extension Operations {
case resolution = "resolution"
case firstCharacter = "firstCharacter"
case folder = "folder"
case albums = "albums"
}}

View File

@@ -16,4 +16,6 @@ extension Operations {
case season = 3
case episode = 4
case audio = 8
case album = 9
case track = 10
}}