orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/reporting_configuration.rb

@@ -0,0 +1,87 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ReportingConfiguration Model.
+  class ReportingConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exempt
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['exempt'] = 'exempt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(exempt:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @exempt = exempt
+      @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.
+      exempt = hash.key?('exempt') ? hash['exempt'] : nil
+
+      # 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.
+      ReportingConfiguration.new(exempt: exempt,
+                                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ReportingConfiguration | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.exempt,
+                                     ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['exempt'],
+                            ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} exempt: #{@exempt}, 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} exempt: #{@exempt.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/request_too_large_error.rb

@@ -0,0 +1,101 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # RequestTooLargeError Model.
+  class RequestTooLargeError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_reader :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['status'] = 'status'
+      @_hash['detail'] = 'detail'
+      @_hash['title'] = 'title'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        detail
+        title
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        detail
+        title
+      ]
+    end
+
+    def initialize(detail: SKIP, title: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'https://docs.withorb.com/reference/error-responses#413-request-too-large'
+      @status = 413
+      @detail = detail unless detail == SKIP
+      @title = title unless title == 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.
+      detail = hash.key?('detail') ? hash['detail'] : SKIP
+      title = hash.key?('title') ? hash['title'] : 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.
+      RequestTooLargeError.new(detail: detail,
+                               title: title,
+                               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} type: #{@type}, status: #{@status}, detail: #{@detail}, title: #{@title},"\
+      " 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} type: #{@type.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, title: #{@title.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/request_validation_error.rb

@@ -0,0 +1,112 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # RequestValidationError Model.
+  class RequestValidationError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_reader :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :validation_errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['status'] = 'status'
+      @_hash['detail'] = 'detail'
+      @_hash['title'] = 'title'
+      @_hash['validation_errors'] = 'validation_errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        detail
+        title
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        detail
+        title
+      ]
+    end
+
+    def initialize(validation_errors:, detail: SKIP, title: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'https://docs.withorb.com/reference/error-responses#400-request-validation-errors'
+      @status = 400
+      @detail = detail unless detail == SKIP
+      @title = title unless title == SKIP
+      @validation_errors = validation_errors
+      @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.
+      validation_errors =
+        hash.key?('validation_errors') ? hash['validation_errors'] : nil
+      detail = hash.key?('detail') ? hash['detail'] : SKIP
+      title = hash.key?('title') ? hash['title'] : 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.
+      RequestValidationError.new(validation_errors: validation_errors,
+                                 detail: detail,
+                                 title: title,
+                                 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} type: #{@type}, status: #{@status}, detail: #{@detail}, title: #{@title},"\
+      " validation_errors: #{@validation_errors}, 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} type: #{@type.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, title: #{@title.inspect}, validation_errors:"\
+      " #{@validation_errors.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/resource_not_found_error.rb

@@ -0,0 +1,99 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ResourceNotFoundError Model.
+  class ResourceNotFoundError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_reader :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['status'] = 'status'
+      @_hash['detail'] = 'detail'
+      @_hash['title'] = 'title'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        detail
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        detail
+      ]
+    end
+
+    def initialize(title:, detail: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'https://docs.withorb.com/reference/error-responses#404-resource-not-found'
+      @status = 404
+      @detail = detail unless detail == SKIP
+      @title = title
+      @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.
+      title = hash.key?('title') ? hash['title'] : nil
+      detail = hash.key?('detail') ? hash['detail'] : 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.
+      ResourceNotFoundError.new(title: title,
+                                detail: detail,
+                                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} type: #{@type}, status: #{@status}, detail: #{@detail}, title: #{@title},"\
+      " 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} type: #{@type.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, title: #{@title.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/resource_too_large_error.rb

@@ -0,0 +1,101 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ResourceTooLargeError Model.
+  class ResourceTooLargeError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_reader :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['status'] = 'status'
+      @_hash['detail'] = 'detail'
+      @_hash['title'] = 'title'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        detail
+        title
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        detail
+        title
+      ]
+    end
+
+    def initialize(detail: SKIP, title: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = 'https://docs.withorb.com/reference/error-responses#413-resource-too-large'
+      @status = 413
+      @detail = detail unless detail == SKIP
+      @title = title unless title == 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.
+      detail = hash.key?('detail') ? hash['detail'] : SKIP
+      title = hash.key?('title') ? hash['title'] : 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.
+      ResourceTooLargeError.new(detail: detail,
+                                title: title,
+                                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} type: #{@type}, status: #{@status}, detail: #{@detail}, title: #{@title},"\
+      " 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} type: #{@type.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, title: #{@title.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/scalable_matrix_with_tiered_pricing_config.rb

@@ -0,0 +1,112 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for scalable matrix with tiered pricing
+  class ScalableMatrixWithTieredPricingConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ScalableMatrixWithTieredTierEntry]]
+    attr_accessor :tiers
+
+    # Used for the scalable matrix first dimension
+    # @return [String]
+    attr_accessor :first_dimension
+
+    # Used for the scalable matrix second dimension (optional)
+    # @return [String]
+    attr_accessor :second_dimension
+
+    # Apply a scaling factor to each dimension
+    # @return [Array[ScalableMatrixWithTieredScalingFactor]]
+    attr_accessor :matrix_scaling_factors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tiers'] = 'tiers'
+      @_hash['first_dimension'] = 'first_dimension'
+      @_hash['second_dimension'] = 'second_dimension'
+      @_hash['matrix_scaling_factors'] = 'matrix_scaling_factors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        second_dimension
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        second_dimension
+      ]
+    end
+
+    def initialize(tiers:, first_dimension:, matrix_scaling_factors:,
+                   second_dimension: SKIP)
+      @tiers = tiers
+      @first_dimension = first_dimension
+      @second_dimension = second_dimension unless second_dimension == SKIP
+      @matrix_scaling_factors = matrix_scaling_factors
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      tiers = nil
+      unless hash['tiers'].nil?
+        tiers = []
+        hash['tiers'].each do |structure|
+          tiers << (ScalableMatrixWithTieredTierEntry.from_hash(structure) if structure)
+        end
+      end
+
+      tiers = nil unless hash.key?('tiers')
+      first_dimension =
+        hash.key?('first_dimension') ? hash['first_dimension'] : nil
+      # Parameter is an array, so we need to iterate through it
+      matrix_scaling_factors = nil
+      unless hash['matrix_scaling_factors'].nil?
+        matrix_scaling_factors = []
+        hash['matrix_scaling_factors'].each do |structure|
+          matrix_scaling_factors << (ScalableMatrixWithTieredScalingFactor.from_hash(structure) if structure)
+        end
+      end
+
+      matrix_scaling_factors = nil unless hash.key?('matrix_scaling_factors')
+      second_dimension =
+        hash.key?('second_dimension') ? hash['second_dimension'] : SKIP
+
+      # Create object from extracted values.
+      ScalableMatrixWithTieredPricingConfig.new(tiers: tiers,
+                                                first_dimension: first_dimension,
+                                                matrix_scaling_factors: matrix_scaling_factors,
+                                                second_dimension: second_dimension)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tiers: #{@tiers}, first_dimension: #{@first_dimension}, second_dimension:"\
+      " #{@second_dimension}, matrix_scaling_factors: #{@matrix_scaling_factors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tiers: #{@tiers.inspect}, first_dimension: #{@first_dimension.inspect},"\
+      " second_dimension: #{@second_dimension.inspect}, matrix_scaling_factors:"\
+      " #{@matrix_scaling_factors.inspect}>"
+    end
+  end
+end