orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/customer_balance_transaction.rb

@@ -0,0 +1,226 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # CustomerBalanceTransaction Model.
+  class CustomerBalanceTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique id for this transaction.
+    # @return [String]
+    attr_accessor :id
+
+    # The creation time of this transaction.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # The original value of the customer's balance prior to the transaction, in
+    # the customer's currency.
+    # @return [String]
+    attr_accessor :starting_balance
+
+    # The new value of the customer's balance prior to the transaction, in the
+    # customer's currency.
+    # @return [String]
+    attr_accessor :ending_balance
+
+    # The value of the amount changed in the transaction.
+    # @return [String]
+    attr_accessor :amount
+
+    # The value of the amount changed in the transaction.
+    # @return [Action]
+    attr_accessor :action
+
+    # An optional description provided for manual customer balance adjustments.
+    # @return [String]
+    attr_accessor :description
+
+    # An optional description provided for manual customer balance adjustments.
+    # @return [InvoiceTiny]
+    attr_accessor :invoice
+
+    # An optional description provided for manual customer balance adjustments.
+    # @return [Type4]
+    attr_accessor :type
+
+    # An optional description provided for manual customer balance adjustments.
+    # @return [CreditNoteTiny]
+    attr_accessor :credit_note
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created_at'] = 'created_at'
+      @_hash['starting_balance'] = 'starting_balance'
+      @_hash['ending_balance'] = 'ending_balance'
+      @_hash['amount'] = 'amount'
+      @_hash['action'] = 'action'
+      @_hash['description'] = 'description'
+      @_hash['invoice'] = 'invoice'
+      @_hash['type'] = 'type'
+      @_hash['credit_note'] = 'credit_note'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        invoice
+        credit_note
+      ]
+    end
+
+    def initialize(id:, created_at:, starting_balance:, ending_balance:,
+                   amount:, action:, description:, invoice:, type:,
+                   credit_note:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @created_at = created_at
+      @starting_balance = starting_balance
+      @ending_balance = ending_balance
+      @amount = amount
+      @action = action
+      @description = description
+      @invoice = invoice
+      @type = type
+      @credit_note = credit_note
+      @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
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      starting_balance =
+        hash.key?('starting_balance') ? hash['starting_balance'] : nil
+      ending_balance =
+        hash.key?('ending_balance') ? hash['ending_balance'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      action = hash.key?('action') ? hash['action'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      invoice = InvoiceTiny.from_hash(hash['invoice']) if hash['invoice']
+      type = hash.key?('type') ? hash['type'] : nil
+      credit_note = CreditNoteTiny.from_hash(hash['credit_note']) if hash['credit_note']
+
+      # 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.
+      CustomerBalanceTransaction.new(id: id,
+                                     created_at: created_at,
+                                     starting_balance: starting_balance,
+                                     ending_balance: ending_balance,
+                                     amount: amount,
+                                     action: action,
+                                     description: description,
+                                     invoice: invoice,
+                                     type: type,
+                                     credit_note: credit_note,
+                                     additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomerBalanceTransaction | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.starting_balance,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.ending_balance,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.action,
+                                  ->(val) { Action.validate(val) }) and
+            APIHelper.valid_type?(value.description,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.invoice,
+                                  ->(val) { InvoiceTiny.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { Type4.validate(val) }) and
+            APIHelper.valid_type?(value.credit_note,
+                                  ->(val) { CreditNoteTiny.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['starting_balance'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['ending_balance'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['action'],
+                                ->(val) { Action.validate(val) }) and
+          APIHelper.valid_type?(value['description'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoice'],
+                                ->(val) { InvoiceTiny.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['type'],
+                                ->(val) { Type4.validate(val) }) and
+          APIHelper.valid_type?(value['credit_note'],
+                                ->(val) { CreditNoteTiny.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, created_at: #{@created_at}, starting_balance:"\
+      " #{@starting_balance}, ending_balance: #{@ending_balance}, amount: #{@amount}, action:"\
+      " #{@action}, description: #{@description}, invoice: #{@invoice}, type: #{@type},"\
+      " credit_note: #{@credit_note}, 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}, created_at: #{@created_at.inspect}, starting_balance:"\
+      " #{@starting_balance.inspect}, ending_balance: #{@ending_balance.inspect}, amount:"\
+      " #{@amount.inspect}, action: #{@action.inspect}, description: #{@description.inspect},"\
+      " invoice: #{@invoice.inspect}, type: #{@type.inspect}, credit_note:"\
+      " #{@credit_note.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/customer_balance_transactions.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CustomerBalanceTransactions Model.
+  class CustomerBalanceTransactions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CustomerBalanceTransaction]]
+    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 << (CustomerBalanceTransaction.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.
+      CustomerBalanceTransactions.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

data/lib/api_reference/models/customer_costs.rb

@@ -0,0 +1,81 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CustomerCosts Model.
+  class CustomerCosts < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AggregatedCost]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @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 << (AggregatedCost.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil 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.
+      CustomerCosts.new(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} 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} data: #{@data.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/customer_credit_balance.rb

@@ -0,0 +1,231 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # CustomerCreditBalance Model.
+  class CustomerCreditBalance < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_accessor :id
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Float]
+    attr_accessor :balance
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [DateTime]
+    attr_accessor :effective_date
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [DateTime]
+    attr_accessor :expiry_date
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_accessor :per_unit_cost_basis
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Status3]
+    attr_accessor :status
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Float]
+    attr_accessor :maximum_initial_balance
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Array[BlockPriceFilter]]
+    attr_accessor :filters
+
+    # How this credit block was created: `allocation` (a subscription's
+    # recurring credit allocation), `top_up` (an automatic balance-threshold
+    # top-up), or `manual` (a manual credit ledger increment, including credits
+    # voided or expired off another block).
+    # @return [CreditBlockSource]
+    attr_accessor :credit_block_source
+
+    # The credit allocation this block was created from, including the catalog
+    # item it was allocated for. Null for blocks not created via an allocation.
+    # @return [CreditBlockAllocation]
+    attr_accessor :credit_allocation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['id'] = 'id'
+      @_hash['balance'] = 'balance'
+      @_hash['effective_date'] = 'effective_date'
+      @_hash['expiry_date'] = 'expiry_date'
+      @_hash['per_unit_cost_basis'] = 'per_unit_cost_basis'
+      @_hash['status'] = 'status'
+      @_hash['maximum_initial_balance'] = 'maximum_initial_balance'
+      @_hash['filters'] = 'filters'
+      @_hash['credit_block_source'] = 'credit_block_source'
+      @_hash['credit_allocation'] = 'credit_allocation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        credit_allocation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        effective_date
+        expiry_date
+        per_unit_cost_basis
+        maximum_initial_balance
+        credit_allocation
+      ]
+    end
+
+    def initialize(metadata:, id:, balance:, effective_date:, expiry_date:,
+                   per_unit_cost_basis:, status:, maximum_initial_balance:,
+                   filters:, credit_block_source:, credit_allocation: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @id = id
+      @balance = balance
+      @effective_date = effective_date
+      @expiry_date = expiry_date
+      @per_unit_cost_basis = per_unit_cost_basis
+      @status = status
+      @maximum_initial_balance = maximum_initial_balance
+      @filters = filters
+      @credit_block_source = credit_block_source
+      @credit_allocation = credit_allocation unless credit_allocation == 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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      balance = hash.key?('balance') ? hash['balance'] : nil
+      effective_date = if hash.key?('effective_date')
+                         (DateTimeHelper.from_rfc3339(hash['effective_date']) if hash['effective_date'])
+                       end
+      expiry_date = if hash.key?('expiry_date')
+                      (DateTimeHelper.from_rfc3339(hash['expiry_date']) if hash['expiry_date'])
+                    end
+      per_unit_cost_basis =
+        hash.key?('per_unit_cost_basis') ? hash['per_unit_cost_basis'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      maximum_initial_balance =
+        hash.key?('maximum_initial_balance') ? hash['maximum_initial_balance'] : nil
+      # Parameter is an array, so we need to iterate through it
+      filters = nil
+      unless hash['filters'].nil?
+        filters = []
+        hash['filters'].each do |structure|
+          filters << (BlockPriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      filters = nil unless hash.key?('filters')
+      credit_block_source =
+        hash.key?('credit_block_source') ? hash['credit_block_source'] : nil
+      credit_allocation = CreditBlockAllocation.from_hash(hash['credit_allocation']) if
+        hash['credit_allocation']
+
+      # 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.
+      CustomerCreditBalance.new(metadata: metadata,
+                                id: id,
+                                balance: balance,
+                                effective_date: effective_date,
+                                expiry_date: expiry_date,
+                                per_unit_cost_basis: per_unit_cost_basis,
+                                status: status,
+                                maximum_initial_balance: maximum_initial_balance,
+                                filters: filters,
+                                credit_block_source: credit_block_source,
+                                credit_allocation: credit_allocation,
+                                additional_properties: additional_properties)
+    end
+
+    def to_custom_effective_date
+      DateTimeHelper.to_rfc3339(effective_date)
+    end
+
+    def to_custom_expiry_date
+      DateTimeHelper.to_rfc3339(expiry_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, id: #{@id}, balance: #{@balance}, effective_date:"\
+      " #{@effective_date}, expiry_date: #{@expiry_date}, per_unit_cost_basis:"\
+      " #{@per_unit_cost_basis}, status: #{@status}, maximum_initial_balance:"\
+      " #{@maximum_initial_balance}, filters: #{@filters}, credit_block_source:"\
+      " #{@credit_block_source}, credit_allocation: #{@credit_allocation}, 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} metadata: #{@metadata.inspect}, id: #{@id.inspect}, balance:"\
+      " #{@balance.inspect}, effective_date: #{@effective_date.inspect}, expiry_date:"\
+      " #{@expiry_date.inspect}, per_unit_cost_basis: #{@per_unit_cost_basis.inspect}, status:"\
+      " #{@status.inspect}, maximum_initial_balance: #{@maximum_initial_balance.inspect}, filters:"\
+      " #{@filters.inspect}, credit_block_source: #{@credit_block_source.inspect},"\
+      " credit_allocation: #{@credit_allocation.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end