cuadra-ai-sdk 1.0.1

data/lib/cuadra_ai/models/model_ex.rb

@@ -0,0 +1,169 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module CuadraAi
+  # ModelEx Model.
+  class ModelEx < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Model Id
+    # @return [String]
+    attr_accessor :id
+
+    # Model name
+    # @return [String]
+    attr_accessor :name
+
+    # Model type of content generation and processing
+    # @return [String]
+    attr_accessor :type
+
+    # Brief description of the model
+    # @return [String]
+    attr_accessor :description
+
+    # Indicates whether is a custom model created by you or not
+    # @return [TrueClass | FalseClass]
+    attr_accessor :proprietary
+
+    # Base model name, if it was created from another model
+    # @return [String]
+    attr_accessor :base_model
+
+    # Base model id, if it was created from another model
+    # @return [String]
+    attr_accessor :base_model_id
+
+    # Creation date
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Last time it was updated
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['type'] = 'type'
+      @_hash['description'] = 'description'
+      @_hash['proprietary'] = 'proprietary'
+      @_hash['base_model'] = 'baseModel'
+      @_hash['base_model_id'] = 'baseModelId'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['updated_at'] = 'updatedAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        proprietary
+        base_model
+        base_model_id
+        created_at
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, type:, description:, id: SKIP, proprietary: SKIP,
+                   base_model: SKIP, base_model_id: SKIP, created_at: SKIP,
+                   updated_at: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @name = name
+      @type = type
+      @description = description
+      @proprietary = proprietary unless proprietary == SKIP
+      @base_model = base_model unless base_model == SKIP
+      @base_model_id = base_model_id unless base_model_id == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      id = hash.key?('id') ? hash['id'] : SKIP
+      proprietary = hash.key?('proprietary') ? hash['proprietary'] : SKIP
+      base_model = hash.key?('baseModel') ? hash['baseModel'] : SKIP
+      base_model_id = hash.key?('baseModelId') ? hash['baseModelId'] : SKIP
+      created_at = if hash.key?('createdAt')
+                     (DateTimeHelper.from_rfc3339(hash['createdAt']) if hash['createdAt'])
+                   else
+                     SKIP
+                   end
+      updated_at = if hash.key?('updatedAt')
+                     (DateTimeHelper.from_rfc3339(hash['updatedAt']) if hash['updatedAt'])
+                   else
+                     SKIP
+                   end
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ModelEx.new(name: name,
+                  type: type,
+                  description: description,
+                  id: id,
+                  proprietary: proprietary,
+                  base_model: base_model,
+                  base_model_id: base_model_id,
+                  created_at: created_at,
+                  updated_at: updated_at,
+                  additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, name: #{@name}, type: #{@type}, description: #{@description},"\
+      " proprietary: #{@proprietary}, base_model: #{@base_model}, base_model_id:"\
+      " #{@base_model_id}, created_at: #{@created_at}, updated_at: #{@updated_at},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}, type: #{@type.inspect},"\
+      " description: #{@description.inspect}, proprietary: #{@proprietary.inspect}, base_model:"\
+      " #{@base_model.inspect}, base_model_id: #{@base_model_id.inspect}, created_at:"\
+      " #{@created_at.inspect}, updated_at: #{@updated_at.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cuadra_ai/models/oauth_provider_error.rb

@@ -0,0 +1,45 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # OAuth 2 Authorization error codes
+  class OauthProviderError
+    OAUTH_PROVIDER_ERROR = [
+      # The request is missing a required parameter, includes an unsupported
+      # parameter value (other than grant type), repeats a parameter, includes
+      # multiple credentials, utilizes more than one mechanism for
+      # authenticating the client, or is otherwise malformed.
+      INVALID_REQUEST = 'invalid_request'.freeze,
+
+      # Client authentication failed (e.g., unknown client, no client
+      # authentication included, or unsupported authentication method).
+      INVALID_CLIENT = 'invalid_client'.freeze,
+
+      # The provided authorization grant (e.g., authorization code, resource
+      # owner credentials) or refresh token is invalid, expired, revoked, does
+      # not match the redirection URI used in the authorization request, or was
+      # issued to another client.
+      INVALID_GRANT = 'invalid_grant'.freeze,
+
+      # The authenticated client is not authorized to use this authorization
+      # grant type.
+      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
+
+      # The authorization grant type is not supported by the authorization
+      # server.
+      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
+
+      # The requested scope is invalid, unknown, malformed, or exceeds the scope
+      # granted by the resource owner.
+      INVALID_SCOPE = 'invalid_scope'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OAUTH_PROVIDER_ERROR.include?(value)
+    end
+  end
+end

data/lib/cuadra_ai/models/oauth_token.rb

@@ -0,0 +1,96 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # OAuth 2 Authorization endpoint response
+  class OauthToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Access token
+    # @return [String]
+    attr_accessor :access_token
+
+    # Type of access token
+    # @return [String]
+    attr_accessor :token_type
+
+    # Time in seconds before the access token expires
+    # @return [Integer]
+    attr_accessor :expires_in
+
+    # List of scopes granted
+    # This is a space-delimited list of strings.
+    # @return [String]
+    attr_accessor :scope
+
+    # Time of token expiry as unix timestamp (UTC)
+    # @return [Integer]
+    attr_accessor :expiry
+
+    # Refresh token
+    # Used to get a new access token when it expires.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['access_token'] = 'access_token'
+      @_hash['token_type'] = 'token_type'
+      @_hash['expires_in'] = 'expires_in'
+      @_hash['scope'] = 'scope'
+      @_hash['expiry'] = 'expiry'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in
+        scope
+        expiry
+        refresh_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(access_token:, token_type:, expires_in: SKIP, scope: SKIP,
+                   expiry: SKIP, refresh_token: SKIP)
+      @access_token = access_token
+      @token_type = token_type
+      @expires_in = expires_in unless expires_in == SKIP
+      @scope = scope unless scope == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @refresh_token = refresh_token unless refresh_token == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      access_token = hash.key?('access_token') ? hash['access_token'] : nil
+      token_type = hash.key?('token_type') ? hash['token_type'] : nil
+      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+
+      # Create object from extracted values.
+      OauthToken.new(access_token: access_token,
+                     token_type: token_type,
+                     expires_in: expires_in,
+                     scope: scope,
+                     expiry: expiry,
+                     refresh_token: refresh_token)
+    end
+  end
+end

data/lib/cuadra_ai/models/paginated_response_ex_list_model_ex.rb

@@ -0,0 +1,104 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # PaginatedResponseExListModelEx Model.
+  class PaginatedResponseExListModelEx < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :page
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :size
+
+    # TODO: Write general description for this method
+    # @return [Array[ModelEx]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['size'] = 'size'
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        size
+        data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, size: SKIP, data: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @size = size unless size == SKIP
+      @data = data unless data == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      page = hash.key?('page') ? hash['page'] : SKIP
+      size = hash.key?('size') ? hash['size'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (ModelEx.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('data')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      PaginatedResponseExListModelEx.new(page: page,
+                                         size: size,
+                                         data: data,
+                                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page}, size: #{@size}, data: #{@data}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page.inspect}, size: #{@size.inspect}, data: #{@data.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cuadra_ai/models/tokens_ex.rb

@@ -0,0 +1,86 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # Tokens used
+  class TokensEx < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Number of tokens of the request input
+    # @return [Integer]
+    attr_accessor :input_tokens
+
+    # Number of tokens of the response output
+    # @return [Integer]
+    attr_accessor :output_tokens
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['input_tokens'] = 'inputTokens'
+      @_hash['output_tokens'] = 'outputTokens'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        input_tokens
+        output_tokens
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(input_tokens: SKIP, output_tokens: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @input_tokens = input_tokens unless input_tokens == SKIP
+      @output_tokens = output_tokens unless output_tokens == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      input_tokens = hash.key?('inputTokens') ? hash['inputTokens'] : SKIP
+      output_tokens = hash.key?('outputTokens') ? hash['outputTokens'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      TokensEx.new(input_tokens: input_tokens,
+                   output_tokens: output_tokens,
+                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} input_tokens: #{@input_tokens}, output_tokens: #{@output_tokens},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} input_tokens: #{@input_tokens.inspect}, output_tokens:"\
+      " #{@output_tokens.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cuadra_ai/models/total_usage_ex.rb

@@ -0,0 +1,86 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # TotalUsageEx Model.
+  class TotalUsageEx < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total Input Tokens used for this month
+    # @return [Integer]
+    attr_accessor :total_input
+
+    # Total Ouput Tokens used for this month
+    # @return [Integer]
+    attr_accessor :total_output
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_input'] = 'totalInput'
+      @_hash['total_output'] = 'totalOutput'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_input
+        total_output
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_input: SKIP, total_output: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total_input = total_input unless total_input == SKIP
+      @total_output = total_output unless total_output == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      total_input = hash.key?('totalInput') ? hash['totalInput'] : SKIP
+      total_output = hash.key?('totalOutput') ? hash['totalOutput'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      TotalUsageEx.new(total_input: total_input,
+                       total_output: total_output,
+                       additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_input: #{@total_input}, total_output: #{@total_output},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_input: #{@total_input.inspect}, total_output:"\
+      " #{@total_output.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cuadra_ai/models/usage_calculation_ex.rb

@@ -0,0 +1,77 @@
+# cuadra_ai
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module CuadraAi
+  # UsageCalculationEx Model.
+  class UsageCalculationEx < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Estimated tokens for your request
+    # @return [Integer]
+    attr_accessor :estimated_tokens
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['estimated_tokens'] = 'estimatedTokens'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        estimated_tokens
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(estimated_tokens: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @estimated_tokens = estimated_tokens unless estimated_tokens == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      estimated_tokens =
+        hash.key?('estimatedTokens') ? hash['estimatedTokens'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      UsageCalculationEx.new(estimated_tokens: estimated_tokens,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} estimated_tokens: #{@estimated_tokens}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} estimated_tokens: #{@estimated_tokens.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end