plex_ruby_sdk 0.3.4

data/lib/plex_ruby_sdk/plex.rb

@@ -0,0 +1,367 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+require 'sorbet-runtime'
+
+module PlexRubySDK
+  extend T::Sig
+  class Plex
+    extend T::Sig
+    
+    # GET_COMPANIONS_DATA_SERVERS contains the list of server urls available to the SDK.
+    GET_COMPANIONS_DATA_SERVERS = [
+      'https://plex.tv/api/v2/', 
+    ].freeze
+    
+    # GET_USER_FRIENDS_SERVERS contains the list of server urls available to the SDK.
+    GET_USER_FRIENDS_SERVERS = [
+      'https://plex.tv/api/v2/', 
+    ].freeze
+    
+    # GET_GEO_DATA_SERVERS contains the list of server urls available to the SDK.
+    GET_GEO_DATA_SERVERS = [
+      'https://plex.tv/api/v2/', 
+    ].freeze
+    
+    # GET_SERVER_RESOURCES_SERVERS contains the list of server urls available to the SDK.
+    GET_SERVER_RESOURCES_SERVERS = [
+      'https://plex.tv/api/v2/', 
+    ].freeze
+    
+    # GET_PIN_SERVERS contains the list of server urls available to the SDK.
+    GET_PIN_SERVERS = [
+      'https://plex.tv/api/v2/', 
+    ].freeze
+    
+    # GET_TOKEN_BY_PIN_ID_SERVERS contains the list of server urls available to the SDK.
+    GET_TOKEN_BY_PIN_ID_SERVERS = [
+      'https://plex.tv/api/v2/', 
+    ].freeze
+    # API Calls that perform operations directly against https://Plex.tv
+    # 
+
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
+    end
+
+
+    sig { params(server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetCompanionsDataResponse) }
+    def get_companions_data(server_url = nil)
+      # get_companions_data - Get Companions Data
+      # Get Companions Data
+      base_url = Utils.template_url(GET_COMPANIONS_DATA_SERVERS[0], {
+      })
+      base_url = server_url if !server_url.nil?
+      url = "#{base_url}/companions"
+      headers = {}
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.get(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = ::PlexRubySDK::Operations::GetCompanionsDataResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[::PlexRubySDK::Operations::ResponseBody])
+          res.response_bodies = out
+        end
+      elsif r.status == 400
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetCompanionsDataBadRequest)
+          res.bad_request = out
+        end
+      elsif r.status == 401
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetCompanionsDataUnauthorized)
+          res.unauthorized = out
+        end
+      end
+      res
+    end
+
+
+    sig { params(server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetUserFriendsResponse) }
+    def get_user_friends(server_url = nil)
+      # get_user_friends - Get list of friends of the user logged in
+      # Get friends of provided auth token.
+      base_url = Utils.template_url(GET_USER_FRIENDS_SERVERS[0], {
+      })
+      base_url = server_url if !server_url.nil?
+      url = "#{base_url}/friends"
+      headers = {}
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.get(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = ::PlexRubySDK::Operations::GetUserFriendsResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[::PlexRubySDK::Operations::Friend])
+          res.friends = out
+        end
+      elsif r.status == 400
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetUserFriendsBadRequest)
+          res.bad_request = out
+        end
+      elsif r.status == 401
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetUserFriendsUnauthorized)
+          res.unauthorized = out
+        end
+      end
+      res
+    end
+
+
+    sig { params(server_url: T.nilable(String)).returns(::PlexRubySDK::Operations::GetGeoDataResponse) }
+    def get_geo_data(server_url = nil)
+      # get_geo_data - Get Geo Data
+      # Returns the geolocation and locale data of the caller
+      base_url = Utils.template_url(GET_GEO_DATA_SERVERS[0], {
+      })
+      base_url = server_url if !server_url.nil?
+      url = "#{base_url}/geoip"
+      headers = {}
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.get(url) do |req|
+        req.headers = headers
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = ::PlexRubySDK::Operations::GetGeoDataResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetGeoDataGeoData)
+          res.geo_data = out
+        end
+      elsif r.status == 400
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetGeoDataBadRequest)
+          res.bad_request = out
+        end
+      elsif r.status == 401
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetGeoDataUnauthorized)
+          res.unauthorized = out
+        end
+      end
+      res
+    end
+
+
+    sig { returns(::PlexRubySDK::Operations::GetHomeDataResponse) }
+    def get_home_data
+      # get_home_data - Get Plex Home Data
+      # Retrieves the home data for the authenticated user, including details like home ID, name, guest access information, and subscription status.
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/home"
+      headers = {}
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.get(url) do |req|
+        req.headers = headers
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = ::PlexRubySDK::Operations::GetHomeDataResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetHomeDataResponseBody)
+          res.object = out
+        end
+      elsif r.status == 400
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetHomeDataBadRequest)
+          res.bad_request = out
+        end
+      elsif r.status == 401
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetHomeDataUnauthorized)
+          res.unauthorized = out
+        end
+      end
+      res
+    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)
+      # 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,
+        include_https: include_https,
+        include_relay: include_relay,
+        include_i_pv6: include_i_pv6
+      )
+      base_url = Utils.template_url(GET_SERVER_RESOURCES_SERVERS[0], {
+      })
+      base_url = server_url if !server_url.nil?
+      url = "#{base_url}/resources"
+      headers = {}
+      query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetServerResourcesRequest, request, @sdk_configuration.globals)
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.get(url) do |req|
+        req.headers = headers
+        req.params = query_params
+        Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = ::PlexRubySDK::Operations::GetServerResourcesResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, T::Array[::PlexRubySDK::Operations::PlexDevice])
+          res.plex_devices = out
+        end
+      elsif r.status == 400
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetServerResourcesBadRequest)
+          res.bad_request = out
+        end
+      elsif r.status == 401
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetServerResourcesUnauthorized)
+          res.unauthorized = out
+        end
+      end
+      res
+    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)
+      # 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
+      )
+      base_url = Utils.template_url(GET_PIN_SERVERS[0], {
+      })
+      base_url = server_url if !server_url.nil?
+      url = "#{base_url}/pins"
+      headers = {}
+      query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetPinRequest, request, @sdk_configuration.globals)
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.post(url) do |req|
+        req.headers = headers
+        req.params = query_params
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = ::PlexRubySDK::Operations::GetPinResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        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
+        end
+      elsif r.status == 400
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetPinBadRequest)
+          res.bad_request = out
+        end
+      end
+      res
+    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)
+      # 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
+      )
+      base_url = Utils.template_url(GET_TOKEN_BY_PIN_ID_SERVERS[0], {
+      })
+      base_url = server_url if !server_url.nil?
+      url = Utils.generate_url(
+        ::PlexRubySDK::Operations::GetTokenByPinIdRequest,
+        base_url,
+        '/pins/{pinID}',
+        request,
+        @sdk_configuration.globals
+      )
+      headers = {}
+      query_params = Utils.get_query_params(::PlexRubySDK::Operations::GetTokenByPinIdRequest, request, @sdk_configuration.globals)
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      r = @sdk_configuration.client.get(url) do |req|
+        req.headers = headers
+        req.params = query_params
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = ::PlexRubySDK::Operations::GetTokenByPinIdResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetTokenByPinIdAuthPinContainer)
+          res.auth_pin_container = out
+        end
+      elsif r.status == 400
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetTokenByPinIdBadRequest)
+          res.bad_request = out
+        end
+      elsif r.status == 404
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Utils.unmarshal_complex(r.env.response_body, ::PlexRubySDK::Operations::GetTokenByPinIdResponseBody)
+          res.object = out
+        end
+      end
+      res
+    end
+  end
+end

data/lib/plex_ruby_sdk/plex_api.rb

@@ -0,0 +1,134 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+require 'sorbet-runtime'
+
+module PlexRubySDK
+  extend T::Sig
+
+  class PlexAPI
+    extend T::Sig
+
+    attr_accessor :server, :media, :video, :activities, :butler, :plex, :hubs, :search, :library, :watchlist, :log, :playlists, :authentication, :statistics, :sessions, :updater
+
+    sig do
+      params(client: Faraday::Request,
+             security: T.nilable(Shared::Security),
+             x_plex_client_identifier: ::String,
+             protocol: T.nilable(::PlexRubySDK::ServerVariables::ServerProtocol),
+             ip: T.nilable(::String),
+             port: T.nilable(::String),
+             server_idx: Integer,
+             server_url: String,
+             url_params: T::Hash[Symbol, String]).void
+    end
+    def initialize(client: nil,
+                   security: nil,
+                   x_plex_client_identifier: nil,
+                   protocol: nil,
+                   ip: nil,
+                   port: nil,
+                   server_idx: nil,
+                   server_url: nil,
+                   url_params: nil)
+
+      ## 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 [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
+      # @param [::Integer] server_idx The index of the server to use for all operations
+      # @param [::String] server_url The server URL to use for all operations
+      # @param [::Hash<::Symbol, ::String>] url_params Parameters to optionally template the server URL with
+
+      if client.nil?
+        client = Faraday.new(request: {
+                          params_encoder: Faraday::FlatParamsEncoder
+                        }) do |f|
+          f.request :multipart, {}
+          # f.response :logger
+        end
+      end
+
+      if !server_url.nil?
+        if !url_params.nil?
+          server_url = Utils.template_url(server_url, url_params)
+        end
+      end
+      server_idx = 0 if server_idx.nil?
+
+      server_params = [
+        {
+            protocol: protocol || 'https',
+            ip: ip || '10.10.10.47',
+            port: port || '32400',
+        },
+      ]
+
+      globals = {
+        'parameters': {
+          'queryParam': {
+            'x_plex_client_identifier': x_plex_client_identifier,
+          },
+          'pathParam': {
+          },
+          'header': {
+          }
+        }
+      }
+
+      @sdk_configuration = SDKConfiguration.new(client, security, server_url, server_idx, server_params, globals)
+      init_sdks
+    end
+
+    sig { params(server_url: String, params: T.nilable(T::Hash[Symbol, String])).void }
+    def config_server_url(server_url, params)
+      if !params.nil?
+        server_url = Utils.template_url(server_url, params)
+      end
+      @sdk_configuration.server_url = server_url
+      init_sdks
+    end
+
+    sig { params(server_idx: Integer, params: T.nilable(T::Hash[Symbol, String])).void }
+    def config_server(server_idx, params)
+      raise StandardError, "Invalid server index #{server_idx}" if server_idx.negative? || server_idx >= SERVERS.length
+      @sdk_configuration.server_idx = server_idx
+      if !params.nil?
+        @sdk_configuration.server_params[server_idx] = params
+      end
+      init_sdks
+    end
+
+    sig { params(security: ::PlexRubySDK::Shared::Security).void }
+    def config_security(security)
+      @sdk_configuration.security = security
+    end
+
+    sig { void }
+    def init_sdks
+      @server = Server.new(@sdk_configuration)
+      @media = Media.new(@sdk_configuration)
+      @video = Video.new(@sdk_configuration)
+      @activities = Activities.new(@sdk_configuration)
+      @butler = Butler.new(@sdk_configuration)
+      @plex = Plex.new(@sdk_configuration)
+      @hubs = Hubs.new(@sdk_configuration)
+      @search = Search.new(@sdk_configuration)
+      @library = Library.new(@sdk_configuration)
+      @watchlist = Watchlist.new(@sdk_configuration)
+      @log = Log.new(@sdk_configuration)
+      @playlists = Playlists.new(@sdk_configuration)
+      @authentication = Authentication.new(@sdk_configuration)
+      @statistics = Statistics.new(@sdk_configuration)
+      @sessions = Sessions.new(@sdk_configuration)
+      @updater = Updater.new(@sdk_configuration)
+    end
+  end
+end

data/lib/plex_ruby_sdk/sdkconfiguration.rb

@@ -0,0 +1,56 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+require 'sorbet-runtime'
+
+module PlexRubySDK
+  extend T::Sig
+
+  SERVERS = [
+    '{protocol}://{ip}:{port}', # 1 - The full address of your Plex Server
+  ].freeze
+  # Contains the list of servers available to the SDK
+
+  class SDKConfiguration < ::PlexRubySDK::Utils::FieldAugmented
+    extend T::Sig
+
+    field :client, T.nilable(Faraday::Connection)
+    field :security, T.nilable(::PlexRubySDK::Shared::Security)
+    field :server_url, T.nilable(String)
+    field :server_idx, T.nilable(Integer)
+    field :server_params, Array[Hash[Symbol, String]], { 'default_factory': Array}
+    field :globals, Hash[Symbol, Hash[Symbol, Hash[Symbol, Object]]]
+    field :language, String
+    field :openapi_doc_version, String
+    field :sdk_version, String
+    field :gen_version, String
+    field :user_agent, String
+
+
+    sig { params(client: Faraday::Connection, security: T.nilable(::PlexRubySDK::Shared::Security), server_url: T.nilable(String), server_idx: T.nilable(Integer), server_params: T::Array[String], globals: T::Hash[Symbol, T::Hash[Symbol, T::Hash[Symbol, Object]]]).void }
+    def initialize(client, security, server_url, server_idx, server_params, globals)
+      @client = client
+      @server_url = server_url
+      @server_idx = server_idx.nil? ? 0 : server_idx
+      raise StandardError, "Invalid server index #{server_idx}" if @server_idx.negative? || @server_idx >= SERVERS.length
+      @server_params = server_params
+      @security = security
+      @globals = globals.nil? ? {} : globals
+      @language = 'ruby'
+      @openapi_doc_version = '0.0.3'
+      @sdk_version = '0.3.4'
+      @gen_version = '2.415.8'
+      @user_agent = 'speakeasy-sdk/ruby 0.3.4 2.415.8 0.0.3 plex_ruby_sdk'
+    end
+
+    sig { returns([String, T::Hash[Symbol, String]]) }
+    def get_server_details
+      return [@server_url.delete_suffix('/'), {}] if !@server_url.nil?
+      [SERVERS[@server_idx], @server_params[@server_idx]]
+    end
+  end
+end