ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.399.2

This commit is contained in:
speakeasybot
2024-09-19 00:10:03 +00:00
parent d840c663e4
commit 4b6c8310d2
47 changed files with 621 additions and 268 deletions

View File

@@ -162,13 +162,13 @@ module PlexRubySDK
end
sig { params(x_plex_client_identifier: T.nilable(::String), request_body: T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::PostUsersSignInDataResponse) }
def post_users_sign_in_data(x_plex_client_identifier = nil, request_body = nil, server_url = nil)
sig { params(client_id: T.nilable(::String), request_body: T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::PostUsersSignInDataResponse) }
def post_users_sign_in_data(client_id = nil, request_body = nil, server_url = nil)
# post_users_sign_in_data - Get User Sign In Data
# Sign in user with username and password and return user data with Plex authentication token
request = ::PlexRubySDK::Operations::PostUsersSignInDataRequest.new(
x_plex_client_identifier: x_plex_client_identifier,
client_id: client_id,
request_body: request_body
)
base_url = Utils.template_url(POST_USERS_SIGN_IN_DATA_SERVERS[0], {

View File

@@ -31,14 +31,14 @@ module PlexRubySDK
# Indicates if the region has privacy restrictions.
field :in_privacy_restricted_region, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('in_privacy_restricted_region') } }
# The postal code of the location.
field :postal_code, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } }
field :postal_code, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } }
# The name of the primary administrative subdivision.
field :subdivisions, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subdivisions') } }
# The time zone of the country.
field :time_zone, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('time_zone') } }
sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::Integer, subdivisions: ::String, time_zone: ::String).void }
sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::String, subdivisions: ::String, time_zone: ::String).void }
def initialize(city: nil, code: nil, continent_code: nil, coordinates: nil, country: nil, european_union_member: nil, in_privacy_restricted_country: nil, in_privacy_restricted_region: nil, postal_code: nil, subdivisions: nil, time_zone: nil)
@city = city
@code = code

View File

@@ -14,6 +14,11 @@ module PlexRubySDK
class GetServerResourcesRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# 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)
#
field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
# Include Https entries in the results
field :include_https, T.nilable(::PlexRubySDK::Operations::IncludeHttps), { 'query_param': { 'field_name': 'includeHttps', 'style': 'form', 'explode': true } }
# Include IPv6 entries in the results
@@ -22,19 +27,14 @@ module PlexRubySDK
# E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400
#
field :include_relay, T.nilable(::PlexRubySDK::Operations::IncludeRelay), { 'query_param': { 'field_name': 'includeRelay', 'style': 'form', 'explode': true } }
# 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)
#
field :x_plex_client_identifier, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
sig { params(include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay), x_plex_client_identifier: T.nilable(::String)).void }
def initialize(include_https: nil, include_i_pv6: nil, include_relay: nil, x_plex_client_identifier: nil)
sig { params(client_id: T.nilable(::String), include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay)).void }
def initialize(client_id: nil, include_https: nil, include_i_pv6: nil, include_relay: nil)
@client_id = client_id
@include_https = include_https
@include_i_pv6 = include_i_pv6
@include_relay = include_relay
@x_plex_client_identifier = x_plex_client_identifier
end
end
end

View File

@@ -31,14 +31,14 @@ module PlexRubySDK
# Indicates if the region has privacy restrictions.
field :in_privacy_restricted_region, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('in_privacy_restricted_region') } }
# The postal code of the location.
field :postal_code, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } }
field :postal_code, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } }
# The name of the primary administrative subdivision.
field :subdivisions, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subdivisions') } }
# The time zone of the country.
field :time_zone, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('time_zone') } }
sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::Integer, subdivisions: ::String, time_zone: ::String).void }
sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::String, subdivisions: ::String, time_zone: ::String).void }
def initialize(city: nil, code: nil, continent_code: nil, coordinates: nil, country: nil, european_union_member: nil, in_privacy_restricted_country: nil, in_privacy_restricted_region: nil, postal_code: nil, subdivisions: nil, time_zone: nil)
@city = city
@code = code

View File

@@ -35,12 +35,12 @@ module PlexRubySDK
field :trusted, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('trusted') } }
field :auth_token, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('authToken') } }
field :auth_token, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('authToken') } }
field :new_registration, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('newRegistration') } }
sig { params(client_identifier: ::String, code: ::String, created_at: ::DateTime, expires_at: ::DateTime, expires_in: ::Integer, id: ::Integer, location: ::PlexRubySDK::Operations::GeoData, product: ::String, qr: ::String, trusted: T::Boolean, auth_token: T.nilable(::Object), new_registration: T.nilable(::Object)).void }
sig { params(client_identifier: ::String, code: ::String, created_at: ::DateTime, expires_at: ::DateTime, expires_in: ::Integer, id: ::Integer, location: ::PlexRubySDK::Operations::GeoData, product: ::String, qr: ::String, trusted: T::Boolean, auth_token: T.nilable(::String), new_registration: T.nilable(::Object)).void }
def initialize(client_identifier: nil, code: nil, created_at: nil, expires_at: nil, expires_in: nil, id: nil, location: nil, product: nil, qr: nil, trusted: nil, auth_token: nil, new_registration: nil)
@client_identifier = client_identifier
@code = code

View File

@@ -14,25 +14,34 @@ module PlexRubySDK
class GetPinRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# 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)
#
field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
field :client_name, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Product', 'style': 'form', 'explode': true } }
field :client_platform, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Platform', 'style': 'form', 'explode': true } }
field :client_version, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Version', 'style': 'form', 'explode': true } }
field :device_name, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Device', 'style': 'form', 'explode': true } }
# Determines the kind of code returned by the API call
# Strong codes are used for Pin authentication flows
# Non-Strong codes are used for `Plex.tv/link`
#
field :strong, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'strong', 'style': 'form', 'explode': true } }
# 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)
#
field :x_plex_client_identifier, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
field :x_plex_product, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Product', 'style': 'form', 'explode': true } }
sig { params(strong: T.nilable(T::Boolean), x_plex_client_identifier: T.nilable(::String), x_plex_product: T.nilable(::String)).void }
def initialize(strong: nil, x_plex_client_identifier: nil, x_plex_product: nil)
sig { params(client_id: T.nilable(::String), client_name: T.nilable(::String), client_platform: T.nilable(::String), client_version: T.nilable(::String), device_name: T.nilable(::String), strong: T.nilable(T::Boolean)).void }
def initialize(client_id: nil, client_name: nil, client_platform: nil, client_version: nil, device_name: nil, strong: nil)
@client_id = client_id
@client_name = client_name
@client_platform = client_platform
@client_version = client_version
@device_name = device_name
@strong = strong
@x_plex_client_identifier = x_plex_client_identifier
@x_plex_product = x_plex_product
end
end
end

View File

@@ -35,12 +35,12 @@ module PlexRubySDK
field :trusted, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('trusted') } }
field :auth_token, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('authToken') } }
field :auth_token, T.nilable(::String), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('authToken') } }
field :new_registration, T.nilable(::Object), { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('newRegistration') } }
sig { params(client_identifier: ::String, code: ::String, created_at: ::DateTime, expires_at: ::DateTime, expires_in: ::Integer, id: ::Integer, location: ::PlexRubySDK::Operations::GetTokenByPinIdGeoData, product: ::String, qr: ::String, trusted: T::Boolean, auth_token: T.nilable(::Object), new_registration: T.nilable(::Object)).void }
sig { params(client_identifier: ::String, code: ::String, created_at: ::DateTime, expires_at: ::DateTime, expires_in: ::Integer, id: ::Integer, location: ::PlexRubySDK::Operations::GetTokenByPinIdGeoData, product: ::String, qr: ::String, trusted: T::Boolean, auth_token: T.nilable(::String), new_registration: T.nilable(::Object)).void }
def initialize(client_identifier: nil, code: nil, created_at: nil, expires_at: nil, expires_in: nil, id: nil, location: nil, product: nil, qr: nil, trusted: nil, auth_token: nil, new_registration: nil)
@client_identifier = client_identifier
@code = code

View File

@@ -31,14 +31,14 @@ module PlexRubySDK
# Indicates if the region has privacy restrictions.
field :in_privacy_restricted_region, T::Boolean, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('in_privacy_restricted_region') } }
# The postal code of the location.
field :postal_code, ::Integer, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } }
field :postal_code, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('postal_code') } }
# The name of the primary administrative subdivision.
field :subdivisions, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('subdivisions') } }
# The time zone of the country.
field :time_zone, ::String, { 'format_json': { 'letter_case': ::PlexRubySDK::Utils.field_name('time_zone') } }
sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::Integer, subdivisions: ::String, time_zone: ::String).void }
sig { params(city: ::String, code: ::String, continent_code: ::String, coordinates: ::String, country: ::String, european_union_member: T::Boolean, in_privacy_restricted_country: T::Boolean, in_privacy_restricted_region: T::Boolean, postal_code: ::String, subdivisions: ::String, time_zone: ::String).void }
def initialize(city: nil, code: nil, continent_code: nil, coordinates: nil, country: nil, european_union_member: nil, in_privacy_restricted_country: nil, in_privacy_restricted_region: nil, postal_code: nil, subdivisions: nil, time_zone: nil)
@city = city
@code = code

View File

@@ -20,13 +20,13 @@ module PlexRubySDK
# This is used to track the client application and its usage
# (UUID, serial number, or other number unique per device)
#
field :x_plex_client_identifier, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
sig { params(pin_id: ::Integer, x_plex_client_identifier: T.nilable(::String)).void }
def initialize(pin_id: nil, x_plex_client_identifier: nil)
sig { params(pin_id: ::Integer, client_id: T.nilable(::String)).void }
def initialize(pin_id: nil, client_id: nil)
@pin_id = pin_id
@x_plex_client_identifier = x_plex_client_identifier
@client_id = client_id
end
end
end

View File

@@ -14,19 +14,19 @@ module PlexRubySDK
class PostUsersSignInDataRequest < ::PlexRubySDK::Utils::FieldAugmented
extend T::Sig
# Login credentials
field :request_body, T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), { 'request': { 'media_type': 'application/x-www-form-urlencoded' } }
# 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)
#
field :x_plex_client_identifier, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
field :client_id, T.nilable(::String), { 'query_param': { 'field_name': 'X-Plex-Client-Identifier', 'style': 'form', 'explode': true } }
# Login credentials
field :request_body, T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), { 'request': { 'media_type': 'application/x-www-form-urlencoded' } }
sig { params(request_body: T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody), x_plex_client_identifier: T.nilable(::String)).void }
def initialize(request_body: nil, x_plex_client_identifier: nil)
sig { params(client_id: T.nilable(::String), request_body: T.nilable(::PlexRubySDK::Operations::PostUsersSignInDataRequestBody)).void }
def initialize(client_id: nil, request_body: nil)
@client_id = client_id
@request_body = request_body
@x_plex_client_identifier = x_plex_client_identifier
end
end
end

View File

@@ -216,13 +216,13 @@ module PlexRubySDK
end
sig { params(x_plex_client_identifier: T.nilable(::String), include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetServerResourcesResponse) }
def get_server_resources(x_plex_client_identifier = nil, include_https = nil, include_relay = nil, include_i_pv6 = nil, server_url = nil)
sig { params(client_id: T.nilable(::String), include_https: T.nilable(::PlexRubySDK::Operations::IncludeHttps), include_relay: T.nilable(::PlexRubySDK::Operations::IncludeRelay), include_i_pv6: T.nilable(::PlexRubySDK::Operations::IncludeIPv6), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetServerResourcesResponse) }
def get_server_resources(client_id = nil, include_https = nil, include_relay = nil, include_i_pv6 = nil, server_url = nil)
# get_server_resources - Get Server Resources
# Get Plex server access tokens and server connections
request = ::PlexRubySDK::Operations::GetServerResourcesRequest.new(
x_plex_client_identifier: x_plex_client_identifier,
client_id: client_id,
include_https: include_https,
include_relay: include_relay,
include_i_pv6: include_i_pv6
@@ -267,16 +267,10 @@ module PlexRubySDK
end
sig { params(strong: T.nilable(T::Boolean), x_plex_client_identifier: T.nilable(::String), x_plex_product: T.nilable(::String), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetPinResponse) }
def get_pin(strong = nil, x_plex_client_identifier = nil, x_plex_product = nil, server_url = nil)
sig { params(request: T.nilable(::PlexRubySDK::Operations::GetPinRequest), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetPinResponse) }
def get_pin(request, server_url = nil)
# get_pin - Get a Pin
# Retrieve a Pin from Plex.tv for authentication flows
request = ::PlexRubySDK::Operations::GetPinRequest.new(
strong: strong,
x_plex_client_identifier: x_plex_client_identifier,
x_plex_product: x_plex_product
)
# Retrieve a Pin ID from Plex.tv to use for authentication flows
base_url = Utils.template_url(GET_PIN_SERVERS[0], {
})
base_url = server_url if !server_url.nil?
@@ -296,7 +290,7 @@ module PlexRubySDK
res = ::PlexRubySDK::Operations::GetPinResponse.new(
status_code: r.status, content_type: content_type, raw_response: r
)
if r.status == 200
if r.status == 201
if Utils.match_content_type(content_type, 'application/json')
out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetPinAuthPinContainer)
res.auth_pin_container = out
@@ -311,14 +305,14 @@ module PlexRubySDK
end
sig { params(pin_id: ::Integer, x_plex_client_identifier: T.nilable(::String), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetTokenByPinIdResponse) }
def get_token_by_pin_id(pin_id, x_plex_client_identifier = nil, server_url = nil)
sig { params(pin_id: ::Integer, client_id: T.nilable(::String), server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetTokenByPinIdResponse) }
def get_token_by_pin_id(pin_id, client_id = nil, server_url = nil)
# get_token_by_pin_id - Get Access Token by PinId
# Retrieve an Access Token from Plex.tv after the Pin has been authenticated
request = ::PlexRubySDK::Operations::GetTokenByPinIdRequest.new(
pin_id: pin_id,
x_plex_client_identifier: x_plex_client_identifier
client_id: client_id
)
base_url = Utils.template_url(GET_TOKEN_BY_PIN_ID_SERVERS[0], {
})

View File

@@ -18,7 +18,11 @@ module PlexRubySDK
sig do
params(client: Faraday::Request,
security: T.nilable(Shared::Security),
x_plex_client_identifier: ::String,
client_id: ::String,
client_name: ::String,
client_version: ::String,
client_platform: ::String,
device_name: ::String,
protocol: T.nilable(::PlexRubySDK::ServerVariables::ServerProtocol),
ip: T.nilable(::String),
port: T.nilable(::String),
@@ -28,7 +32,11 @@ module PlexRubySDK
end
def initialize(client: nil,
security: nil,
x_plex_client_identifier: nil,
client_id: nil,
client_name: nil,
client_version: nil,
client_platform: nil,
device_name: nil,
protocol: nil,
ip: nil,
port: nil,
@@ -39,7 +47,11 @@ module PlexRubySDK
## Instantiates the SDK configuring it with the provided parameters.
# @param [Faraday::Request] client The faraday HTTP client to use for all operations
# @param [Shared::Security] security The security details required for authentication
# @param [::String] x_plex_client_identifier: Configures the x_plex_client_identifier parameter for all supported operations
# @param [::String] client_id: Configures the client_id parameter for all supported operations
# @param [::String] client_name: Configures the client_name parameter for all supported operations
# @param [::String] client_version: Configures the client_version parameter for all supported operations
# @param [::String] client_platform: Configures the client_platform parameter for all supported operations
# @param [::String] device_name: Configures the device_name parameter for all supported operations
# @param [T.nilable(::PlexRubySDK::ServerVariables::ServerProtocol)] protocol: Allows setting the protocol variable for url substitution
# @param [T.nilable(::String)] ip: Allows setting the ip variable for url substitution
# @param [T.nilable(::String)] port: Allows setting the port variable for url substitution
@@ -74,7 +86,11 @@ module PlexRubySDK
globals = {
'parameters': {
'queryParam': {
'x_plex_client_identifier': x_plex_client_identifier,
'client_id': client_id,
'client_name': client_name,
'client_version': client_version,
'client_platform': client_platform,
'device_name': device_name,
},
'pathParam': {
},

View File

@@ -42,9 +42,9 @@ module PlexRubySDK
@globals = globals.nil? ? {} : globals
@language = 'ruby'
@openapi_doc_version = '0.0.3'
@sdk_version = '0.3.5'
@gen_version = '2.415.8'
@user_agent = 'speakeasy-sdk/ruby 0.3.5 2.415.8 0.0.3 plex_ruby_sdk'
@sdk_version = '0.3.6'
@gen_version = '2.416.6'
@user_agent = 'speakeasy-sdk/ruby 0.3.6 2.416.6 0.0.3 plex_ruby_sdk'
end
sig { returns([String, T::Hash[Symbol, String]]) }