fastpixapi 1.0.0 → 1.1.0

data/lib/crystalline/t.rb

@@ -1,77 +0,0 @@
-
-# typed: true
-# frozen_string_literal: true
-
-module T
-  def self.arr?(t)
-    if t.respond_to? :underlying_class
-      return t.underlying_class == ::Array
-    end
-    false
-  end
-
-  def self.arr_of(t)
-    get_raw_type(t.type)
-  end
-
-  def self.hash?(t)
-    if t.respond_to? :underlying_class
-      return t.underlying_class == ::Hash
-    end
-    false
-  end
-
-  def self.hash_of(t)
-    get_raw_type(t.values)
-  end
-
-  def self.nilable?(t)
-    # in sorbet all `T.any` types provide unwrap_nilable for some reason
-    # So, in order to make this check more robust, we check if the type responds to the `types` method, and if so, whether
-    # one of those types is NilClass.  For non-nilable unions, `types` will return a valid list that does not include NilClass
-    return false unless t.respond_to?(:unwrap_nilable)
-    return true unless t.respond_to?(:types)
-    t.types.map { |tt| simplify_type(tt) }.include?(NilClass)
-  end
-
-  def self.nilable_of(t)
-    
-    if nilable t
-      return simplify_type t.unwrap_nilable
-    end
-    nil
-  end
-
-  def self.simplifiable?(t)
-    return t.is_a? T::Types::Simple
-  end
-
-  def self.simplify_type(t)
-    if t.is_a? T::Types::Simple
-      return t.raw_type
-    end
-    t
-  end
-
-    
-  def self.union?(t)
-    return false unless t.respond_to? :types
-    return false if t.types.any? { |tt| get_raw_type(tt) == TrueClass }
-    return false if t.types.length == 2 && t.types.any? { |tt| get_raw_type(tt) == NilClass }
-    t.types.length > 1
-  end
-
-  def self.get_union_types(t)
-    t.types.map { |tt| get_raw_type(tt) }
-  end
-
-
-  def self.get_raw_type(t)
-    if t.respond_to? :raw_type
-      return t.raw_type
-    elsif t.respond_to? :raw_a
-      return T::Boolean if [TrueClass, FalseClass].include?(t.raw_a)
-    end
-    t
-  end
-end

data/lib/fastpix_api_sdk/dimensions.rb

@@ -1,394 +0,0 @@
-
-# typed: true
-# frozen_string_literal: true
-
-require 'faraday'
-require 'faraday/multipart'
-require 'faraday/retry'
-require 'sorbet-runtime'
-require_relative 'sdk_hooks/hooks'
-require_relative 'utils/retries'
-
-module FastpixApiSDK
-  extend T::Sig
-  class Dimensions
-    extend T::Sig
-    
-
-
-    sig { params(sdk_config: SDKConfiguration).void }
-    def initialize(sdk_config)
-      @sdk_configuration = sdk_config
-      
-    end
-
-    sig { params(base_url: String, url_variables: T.nilable(T::Hash[Symbol, T.any(String, T::Enum)])).returns(String) }
-    def get_url(base_url:, url_variables: nil)
-      sd_base_url, sd_options = @sdk_configuration.get_server_details
-
-      if base_url.nil?
-        base_url = sd_base_url
-      end
-
-      if url_variables.nil?
-        url_variables = sd_options
-      end
-
-      return Utils.template_url base_url, url_variables
-    end
-
-
-    sig { params(retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::ListDimensionsResponse) }
-    def list_dimensions(retries: nil, timeout_ms: nil)
-      # list_dimensions - List the dimensions
-      # Retrieves a list of dimensions that can be used as query parameters across various data endpoints. Each dimension has a unique id that can be used to filter data effectively. 
-      # 
-      # The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://docs.fastpix.io/reference/list_video_views">list video views</a> and <a href="https://docs.fastpix.io/reference/list_by_top_content">list by top content</a> endpoints to filter results based on specific criteria. For example, you can filter views by `browser_name`, `os_name`, `device_type`, and more.
-      # 
-      # Related guides: <a href="https://docs.fastpix.io/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a> ,   <a href="https://docs.fastpix.io/docs/user-passable-metadata-1">Use passable dimensions</a>
-      # 
-      url, params = @sdk_configuration.get_server_details
-      base_url = Utils.template_url(url, params)
-      url = "#{base_url}/data/dimensions"
-      headers = {}
-      headers = T.cast(headers, T::Hash[String, String])
-      headers['Accept'] = 'application/json'
-      headers['user-agent'] = @sdk_configuration.user_agent
-      retries ||= @sdk_configuration.retry_config
-      retries ||= Utils::RetryConfig.new(
-        backoff: Utils::BackoffStrategy.new(
-          exponent: 1.5,
-          initial_interval: 1000,
-          max_elapsed_time: 3_600_000,
-          max_interval: 10_000
-        ),
-        retry_connection_errors: true,
-        strategy: 'backoff'
-      )
-      retry_options = retries.to_faraday_retry_options(initial_time: Time.now)
-      retry_options[:retry_statuses] = [408, 429, 500, 502, 503, 504]
-
-      security = @sdk_configuration.security_source&.call
-
-      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
-      timeout ||= @sdk_configuration.timeout
-      
-
-      connection = @sdk_configuration.client.dup
-      connection.request :retry, retry_options
-
-      hook_ctx = SDKHooks::HookContext.new(
-        config: @sdk_configuration,
-        base_url: base_url,
-        oauth2_scopes: nil,
-        operation_id: 'list_dimensions',
-        security_source: @sdk_configuration.security_source
-      )
-
-      error = T.let(nil, T.nilable(StandardError))
-      http_response = T.let(nil, T.nilable(Faraday::Response))
-      
-      
-      begin
-        http_response = T.must(connection).get(url) do |req|
-          req.headers.merge!(headers)
-          req.options.timeout = timeout unless timeout.nil?
-          Utils.configure_request_security(req, security)
-
-          @sdk_configuration.hooks.before_request(
-            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            request: req
-          )
-        end
-      rescue StandardError => e
-        error = e
-      ensure
-        if http_response.nil? || Utils.error_status?(http_response.status)
-          http_response = @sdk_configuration.hooks.after_error(
-            error: error,
-            hook_ctx: SDKHooks::AfterErrorHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-        else
-          http_response = @sdk_configuration.hooks.after_success(
-            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-        end
-        
-        if http_response.nil?
-          raise error if !error.nil?
-          raise 'no response'
-        end
-      end
-      
-      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
-      if Utils.match_status_code(http_response.status, ['200'])
-        if Utils.match_content_type(content_type, 'application/json')
-          http_response = @sdk_configuration.hooks.after_success(
-            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-          response_data = http_response.env.response_body
-          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Operations::ListDimensionsResponseBody)
-          response = Models::Operations::ListDimensionsResponse.new(
-            status_code: http_response.status,
-            content_type: content_type,
-            raw_response: http_response,
-            object: T.unsafe(obj)
-          )
-
-          return response
-        else
-          raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
-        end
-      elsif Utils.match_status_code(http_response.status, ['400'])
-        if Utils.match_content_type(content_type, 'application/json')
-          http_response = @sdk_configuration.hooks.after_success(
-            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-          response_data = http_response.env.response_body
-          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::BadRequestError)
-          obj.raw_response = http_response
-          raise obj
-        else
-          raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
-        end
-      elsif Utils.match_status_code(http_response.status, ['401'])
-        if Utils.match_content_type(content_type, 'application/json')
-          http_response = @sdk_configuration.hooks.after_success(
-            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-          response_data = http_response.env.response_body
-          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::InvalidPermissionError)
-          obj.raw_response = http_response
-          raise obj
-        else
-          raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
-        end
-      elsif Utils.match_status_code(http_response.status, ['422'])
-        if Utils.match_content_type(content_type, 'application/json')
-          http_response = @sdk_configuration.hooks.after_success(
-            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-          response_data = http_response.env.response_body
-          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ValidationErrorResponse)
-          obj.raw_response = http_response
-          raise obj
-        else
-          raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
-        end
-      elsif Utils.match_status_code(http_response.status, ['4XX'])
-        raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
-      elsif Utils.match_status_code(http_response.status, ['5XX'])
-        raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
-      else
-        raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
-
-      end
-    end
-
-
-    sig { params(dimensions_id: Models::Operations::DimensionsId, timespan: Models::Operations::ListFilterValuesForDimensionTimespan, filterby: T.nilable(::String), retries: T.nilable(Utils::RetryConfig), timeout_ms: T.nilable(Integer)).returns(Models::Operations::ListFilterValuesForDimensionResponse) }
-    def list_filter_values_for_dimension(dimensions_id:, timespan:, filterby: nil, retries: nil, timeout_ms: nil)
-      # list_filter_values_for_dimension - List the filter values for a dimension
-      # This endpoint returns the filter values associated with a specific dimension, along with the total number of video views for each value. For example, it can list all `browser_name` (dimension) and show how many views occurred for all available browsers like Chrome, Safari (filter values). 
-      # 
-      # 
-      # In order to use the <a href="https://docs.fastpix.io/docs/custom-business-metadata">Custom Dimensions</a>, you must enable them in the dashboard under settings option based on the plan you have opted for.
-      # 
-      # #### Example
-      # 
-      # A developer wants to know how their video content performs across different browsers. By calling this endpoint for the `device_type` dimension, they can retrieve a breakdown of video views by each device (e.g., Desktop, Mobile, Tablet). This data will help the developer understand where optimizations or troubleshooting may be necessary.
-      # 
-      # 
-      # Related guide: <a href="https://docs.fastpix.io/docs/understand-dashboard-ui#filters-and-timeframes">Filters and timeframes</a>
-      # 
-      request = Models::Operations::ListFilterValuesForDimensionRequest.new(
-        dimensions_id: dimensions_id,
-        timespan: timespan,
-        filterby: filterby
-      )
-      url, params = @sdk_configuration.get_server_details
-      base_url = Utils.template_url(url, params)
-      url = Utils.generate_url(
-        Models::Operations::ListFilterValuesForDimensionRequest,
-        base_url,
-        '/data/dimensions/{dimensionsId}',
-        request
-      )
-      headers = {}
-      headers = T.cast(headers, T::Hash[String, String])
-      query_params = Utils.get_query_params(Models::Operations::ListFilterValuesForDimensionRequest, request, nil)
-      headers['Accept'] = 'application/json'
-      headers['user-agent'] = @sdk_configuration.user_agent
-      retries ||= @sdk_configuration.retry_config
-      retries ||= Utils::RetryConfig.new(
-        backoff: Utils::BackoffStrategy.new(
-          exponent: 1.5,
-          initial_interval: 1000,
-          max_elapsed_time: 3_600_000,
-          max_interval: 10_000
-        ),
-        retry_connection_errors: true,
-        strategy: 'backoff'
-      )
-      retry_options = retries.to_faraday_retry_options(initial_time: Time.now)
-      retry_options[:retry_statuses] = [408, 429, 500, 502, 503, 504]
-
-      security = @sdk_configuration.security_source&.call
-
-      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
-      timeout ||= @sdk_configuration.timeout
-      
-
-      connection = @sdk_configuration.client.dup
-      connection.request :retry, retry_options
-
-      hook_ctx = SDKHooks::HookContext.new(
-        config: @sdk_configuration,
-        base_url: base_url,
-        oauth2_scopes: nil,
-        operation_id: 'list_filter_values_for_dimension',
-        security_source: @sdk_configuration.security_source
-      )
-
-      error = T.let(nil, T.nilable(StandardError))
-      http_response = T.let(nil, T.nilable(Faraday::Response))
-      
-      
-      begin
-        http_response = T.must(connection).get(url) do |req|
-          req.headers.merge!(headers)
-          req.options.timeout = timeout unless timeout.nil?
-          req.params = query_params
-          Utils.configure_request_security(req, security)
-
-          @sdk_configuration.hooks.before_request(
-            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            request: req
-          )
-        end
-      rescue StandardError => e
-        error = e
-      ensure
-        if http_response.nil? || Utils.error_status?(http_response.status)
-          http_response = @sdk_configuration.hooks.after_error(
-            error: error,
-            hook_ctx: SDKHooks::AfterErrorHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-        else
-          http_response = @sdk_configuration.hooks.after_success(
-            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-        end
-        
-        if http_response.nil?
-          raise error if !error.nil?
-          raise 'no response'
-        end
-      end
-      
-      content_type = http_response.headers.fetch('Content-Type', 'application/octet-stream')
-      if Utils.match_status_code(http_response.status, ['200'])
-        if Utils.match_content_type(content_type, 'application/json')
-          http_response = @sdk_configuration.hooks.after_success(
-            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-          response_data = http_response.env.response_body
-          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Operations::ListFilterValuesForDimensionResponseBody)
-          response = Models::Operations::ListFilterValuesForDimensionResponse.new(
-            status_code: http_response.status,
-            content_type: content_type,
-            raw_response: http_response,
-            object: T.unsafe(obj)
-          )
-
-          return response
-        else
-          raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
-        end
-      elsif Utils.match_status_code(http_response.status, ['401'])
-        if Utils.match_content_type(content_type, 'application/json')
-          http_response = @sdk_configuration.hooks.after_success(
-            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-          response_data = http_response.env.response_body
-          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::InvalidPermissionError)
-          obj.raw_response = http_response
-          raise obj
-        else
-          raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
-        end
-      elsif Utils.match_status_code(http_response.status, ['404'])
-        if Utils.match_content_type(content_type, 'application/json')
-          http_response = @sdk_configuration.hooks.after_success(
-            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-          response_data = http_response.env.response_body
-          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ViewNotFoundError)
-          obj.raw_response = http_response
-          raise obj
-        else
-          raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
-        end
-      elsif Utils.match_status_code(http_response.status, ['422'])
-        if Utils.match_content_type(content_type, 'application/json')
-          http_response = @sdk_configuration.hooks.after_success(
-            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
-              hook_ctx: hook_ctx
-            ),
-            response: http_response
-          )
-          response_data = http_response.env.response_body
-          obj = Crystalline.unmarshal_json(JSON.parse(response_data), Models::Errors::ValidationErrorResponse)
-          obj.raw_response = http_response
-          raise obj
-        else
-          raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown content type received'
-        end
-      elsif Utils.match_status_code(http_response.status, ['4XX'])
-        raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
-      elsif Utils.match_status_code(http_response.status, ['5XX'])
-        raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'API error occurred'
-      else
-        raise ::FastpixApiSDK::Models::Errors::APIError.new(status_code: http_response.status, body: http_response.env.response_body, raw_response: http_response), 'Unknown status code received'
-
-      end
-    end
-  end
-end