orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/tiered_with_proration_tier.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for a single tiered with proration tier
+  class TieredWithProrationTier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Inclusive tier starting value
+    # @return [String]
+    attr_accessor :tier_lower_bound
+
+    # Amount per unit
+    # @return [String]
+    attr_accessor :unit_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tier_lower_bound'] = 'tier_lower_bound'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tier_lower_bound:, unit_amount:)
+      @tier_lower_bound = tier_lower_bound
+      @unit_amount = unit_amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      tier_lower_bound =
+        hash.key?('tier_lower_bound') ? hash['tier_lower_bound'] : nil
+      unit_amount = hash.key?('unit_amount') ? hash['unit_amount'] : nil
+
+      # Create object from extracted values.
+      TieredWithProrationTier.new(tier_lower_bound: tier_lower_bound,
+                                  unit_amount: unit_amount)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TieredWithProrationTier | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.tier_lower_bound,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.unit_amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['tier_lower_bound'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['unit_amount'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tier_lower_bound: #{@tier_lower_bound}, unit_amount: #{@unit_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tier_lower_bound: #{@tier_lower_bound.inspect}, unit_amount:"\
+      " #{@unit_amount.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/too_many_results_error.rb

@@ -0,0 +1,101 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # TooManyResultsError Model.
+  class TooManyResultsError < 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-too-many-results'
+      @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.
+      TooManyResultsError.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/top_up.rb

@@ -0,0 +1,149 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # TopUp Model.
+  class TopUp < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # The currency or custom pricing unit to use for this top-up. If this is a
+    # real-world currency, it must match the customer's invoicing currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # The threshold at which to trigger the top-up. If the balance is at or
+    # below this threshold, the top-up will be triggered.
+    # @return [String]
+    attr_accessor :threshold
+
+    # The amount to increment when the threshold is reached.
+    # @return [String]
+    attr_accessor :amount
+
+    # How much, in the customer's currency, to charge for each unit.
+    # @return [String]
+    attr_accessor :per_unit_cost_basis
+
+    # Settings for invoices generated by triggered top-ups.
+    # @return [TopUpInvoiceSettings2]
+    attr_accessor :invoice_settings
+
+    # The number of days or months after which the top-up expires. If
+    # unspecified, it does not expire.
+    # @return [Integer]
+    attr_accessor :expires_after
+
+    # The unit of expires_after.
+    # @return [ExpiresAfterUnit]
+    attr_accessor :expires_after_unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['currency'] = 'currency'
+      @_hash['threshold'] = 'threshold'
+      @_hash['amount'] = 'amount'
+      @_hash['per_unit_cost_basis'] = 'per_unit_cost_basis'
+      @_hash['invoice_settings'] = 'invoice_settings'
+      @_hash['expires_after'] = 'expires_after'
+      @_hash['expires_after_unit'] = 'expires_after_unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_after
+        expires_after_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        expires_after
+        expires_after_unit
+      ]
+    end
+
+    def initialize(id:, currency:, threshold:, amount:, per_unit_cost_basis:,
+                   invoice_settings:, expires_after: SKIP,
+                   expires_after_unit: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @currency = currency
+      @threshold = threshold
+      @amount = amount
+      @per_unit_cost_basis = per_unit_cost_basis
+      @invoice_settings = invoice_settings
+      @expires_after = expires_after unless expires_after == SKIP
+      @expires_after_unit = expires_after_unit unless expires_after_unit == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      threshold = hash.key?('threshold') ? hash['threshold'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      per_unit_cost_basis =
+        hash.key?('per_unit_cost_basis') ? hash['per_unit_cost_basis'] : nil
+      invoice_settings = TopUpInvoiceSettings2.from_hash(hash['invoice_settings']) if
+        hash['invoice_settings']
+      expires_after = hash.key?('expires_after') ? hash['expires_after'] : SKIP
+      expires_after_unit =
+        hash.key?('expires_after_unit') ? hash['expires_after_unit'] : 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.
+      TopUp.new(id: id,
+                currency: currency,
+                threshold: threshold,
+                amount: amount,
+                per_unit_cost_basis: per_unit_cost_basis,
+                invoice_settings: invoice_settings,
+                expires_after: expires_after,
+                expires_after_unit: expires_after_unit,
+                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} id: #{@id}, currency: #{@currency}, threshold: #{@threshold}, amount:"\
+      " #{@amount}, per_unit_cost_basis: #{@per_unit_cost_basis}, invoice_settings:"\
+      " #{@invoice_settings}, expires_after: #{@expires_after}, expires_after_unit:"\
+      " #{@expires_after_unit}, 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}, currency: #{@currency.inspect}, threshold:"\
+      " #{@threshold.inspect}, amount: #{@amount.inspect}, per_unit_cost_basis:"\
+      " #{@per_unit_cost_basis.inspect}, invoice_settings: #{@invoice_settings.inspect},"\
+      " expires_after: #{@expires_after.inspect}, expires_after_unit:"\
+      " #{@expires_after_unit.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/top_up_invoice_settings.rb

@@ -0,0 +1,117 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # TopUpInvoiceSettings Model.
+  class TopUpInvoiceSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Whether the credits purchase invoice should auto collect with the
+    # customer's saved payment method.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_collection
+
+    # The net terms determines the difference between the invoice date and the
+    # issue date for the invoice. If you intend the invoice to be due on issue,
+    # set this to 0.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # An optional memo to display on the invoice.
+    # @return [String]
+    attr_accessor :memo
+
+    # When true, credit blocks created by this top-up will require that the
+    # corresponding invoice is paid before they are drawn down from. If any
+    # topup block is pending payment, further automatic top-ups will be paused
+    # until the invoice is paid or voided.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :require_successful_payment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['memo'] = 'memo'
+      @_hash['require_successful_payment'] = 'require_successful_payment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        memo
+        require_successful_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        memo
+      ]
+    end
+
+    def initialize(auto_collection:, net_terms:, memo: SKIP,
+                   require_successful_payment: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @auto_collection = auto_collection
+      @net_terms = net_terms
+      @memo = memo unless memo == SKIP
+      unless require_successful_payment == SKIP
+        @require_successful_payment =
+          require_successful_payment
+      end
+      @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.
+      auto_collection =
+        hash.key?('auto_collection') ? hash['auto_collection'] : nil
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      require_successful_payment = hash['require_successful_payment'] ||= false
+
+      # 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.
+      TopUpInvoiceSettings.new(auto_collection: auto_collection,
+                               net_terms: net_terms,
+                               memo: memo,
+                               require_successful_payment: require_successful_payment,
+                               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} auto_collection: #{@auto_collection}, net_terms: #{@net_terms}, memo:"\
+      " #{@memo}, require_successful_payment: #{@require_successful_payment},"\
+      " 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} auto_collection: #{@auto_collection.inspect}, net_terms:"\
+      " #{@net_terms.inspect}, memo: #{@memo.inspect}, require_successful_payment:"\
+      " #{@require_successful_payment.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/top_up_invoice_settings2.rb

@@ -0,0 +1,117 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Settings for invoices generated by triggered top-ups.
+  class TopUpInvoiceSettings2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Whether the credits purchase invoice should auto collect with the
+    # customer's saved payment method.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_collection
+
+    # The net terms determines the difference between the invoice date and the
+    # issue date for the invoice. If you intend the invoice to be due on issue,
+    # set this to 0.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # An optional memo to display on the invoice.
+    # @return [String]
+    attr_accessor :memo
+
+    # When true, credit blocks created by this top-up will require that the
+    # corresponding invoice is paid before they are drawn down from. If any
+    # topup block is pending payment, further automatic top-ups will be paused
+    # until the invoice is paid or voided.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :require_successful_payment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['memo'] = 'memo'
+      @_hash['require_successful_payment'] = 'require_successful_payment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        memo
+        require_successful_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        memo
+      ]
+    end
+
+    def initialize(auto_collection:, net_terms:, memo: SKIP,
+                   require_successful_payment: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @auto_collection = auto_collection
+      @net_terms = net_terms
+      @memo = memo unless memo == SKIP
+      unless require_successful_payment == SKIP
+        @require_successful_payment =
+          require_successful_payment
+      end
+      @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.
+      auto_collection =
+        hash.key?('auto_collection') ? hash['auto_collection'] : nil
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      require_successful_payment = hash['require_successful_payment'] ||= false
+
+      # 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.
+      TopUpInvoiceSettings2.new(auto_collection: auto_collection,
+                                net_terms: net_terms,
+                                memo: memo,
+                                require_successful_payment: require_successful_payment,
+                                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} auto_collection: #{@auto_collection}, net_terms: #{@net_terms}, memo:"\
+      " #{@memo}, require_successful_payment: #{@require_successful_payment},"\
+      " 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} auto_collection: #{@auto_collection.inspect}, net_terms:"\
+      " #{@net_terms.inspect}, memo: #{@memo.inspect}, require_successful_payment:"\
+      " #{@require_successful_payment.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/top_ups.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # TopUps Model.
+  class TopUps < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[TopUp]]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [PaginationMetadata]
+    attr_accessor :pagination_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['pagination_metadata'] = 'pagination_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, pagination_metadata:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @pagination_metadata = pagination_metadata
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (TopUp.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+      pagination_metadata = PaginationMetadata.from_hash(hash['pagination_metadata']) if
+        hash['pagination_metadata']
+
+      # 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.
+      TopUps.new(data: data,
+                 pagination_metadata: pagination_metadata,
+                 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} data: #{@data}, pagination_metadata: #{@pagination_metadata},"\
+      " 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} data: #{@data.inspect}, pagination_metadata:"\
+      " #{@pagination_metadata.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end