orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/debug.rb

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

data/lib/api_reference/models/decrement_ledger_entry.rb

@@ -0,0 +1,342 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # DecrementLedgerEntry Model.
+  class DecrementLedgerEntry < 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 [Integer]
+    attr_accessor :ledger_sequence_number
+
+    # 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 [EntryStatus]
+    attr_accessor :entry_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 [CustomerMinified]
+    attr_accessor :customer
+
+    # 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 :starting_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 [Float]
+    attr_accessor :ending_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 [Float]
+    attr_accessor :amount
+
+    # 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 :currency
+
+    # 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 :created_at
+
+    # 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 :description
+
+    # 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 [AffectedBlock]
+    attr_accessor :credit_block
+
+    # 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_reader :entry_type
+
+    # 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 :price_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 [String]
+    attr_accessor :invoice_id
+
+    # This field is deprecated and will always be null. Decrements are not
+    # associated with individual events.
+    # @return [String]
+    attr_accessor :event_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['id'] = 'id'
+      @_hash['ledger_sequence_number'] = 'ledger_sequence_number'
+      @_hash['entry_status'] = 'entry_status'
+      @_hash['customer'] = 'customer'
+      @_hash['starting_balance'] = 'starting_balance'
+      @_hash['ending_balance'] = 'ending_balance'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['created_at'] = 'created_at'
+      @_hash['description'] = 'description'
+      @_hash['credit_block'] = 'credit_block'
+      @_hash['entry_type'] = 'entry_type'
+      @_hash['price_id'] = 'price_id'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['event_id'] = 'event_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        price_id
+        invoice_id
+        event_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        price_id
+        invoice_id
+        event_id
+      ]
+    end
+
+    def initialize(metadata:, id:, ledger_sequence_number:, entry_status:,
+                   customer:, starting_balance:, ending_balance:, amount:,
+                   currency:, created_at:, description:, credit_block:,
+                   price_id: SKIP, invoice_id: SKIP, event_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @id = id
+      @ledger_sequence_number = ledger_sequence_number
+      @entry_status = entry_status
+      @customer = customer
+      @starting_balance = starting_balance
+      @ending_balance = ending_balance
+      @amount = amount
+      @currency = currency
+      @created_at = created_at
+      @description = description
+      @credit_block = credit_block
+      @entry_type = 'decrement'
+      @price_id = price_id unless price_id == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @event_id = event_id unless event_id == 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
+      ledger_sequence_number =
+        hash.key?('ledger_sequence_number') ? hash['ledger_sequence_number'] : nil
+      entry_status = hash.key?('entry_status') ? hash['entry_status'] : nil
+      customer = CustomerMinified.from_hash(hash['customer']) if hash['customer']
+      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
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      description = hash.key?('description') ? hash['description'] : nil
+      credit_block = AffectedBlock.from_hash(hash['credit_block']) if hash['credit_block']
+      price_id = hash.key?('price_id') ? hash['price_id'] : SKIP
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      event_id = hash.key?('event_id') ? hash['event_id'] : 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.
+      DecrementLedgerEntry.new(metadata: metadata,
+                               id: id,
+                               ledger_sequence_number: ledger_sequence_number,
+                               entry_status: entry_status,
+                               customer: customer,
+                               starting_balance: starting_balance,
+                               ending_balance: ending_balance,
+                               amount: amount,
+                               currency: currency,
+                               created_at: created_at,
+                               description: description,
+                               credit_block: credit_block,
+                               price_id: price_id,
+                               invoice_id: invoice_id,
+                               event_id: event_id,
+                               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 [DecrementLedgerEntry | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.metadata,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.ledger_sequence_number,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.entry_status,
+                                  ->(val) { EntryStatus.validate(val) }) and
+            APIHelper.valid_type?(value.customer,
+                                  ->(val) { CustomerMinified.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.starting_balance,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.ending_balance,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.description,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.credit_block,
+                                  ->(val) { AffectedBlock.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.entry_type,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['metadata'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['ledger_sequence_number'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['entry_status'],
+                                ->(val) { EntryStatus.validate(val) }) and
+          APIHelper.valid_type?(value['customer'],
+                                ->(val) { CustomerMinified.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['starting_balance'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['ending_balance'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['description'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['credit_block'],
+                                ->(val) { AffectedBlock.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['entry_type'],
+                                ->(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} metadata: #{@metadata}, id: #{@id}, ledger_sequence_number:"\
+      " #{@ledger_sequence_number}, entry_status: #{@entry_status}, customer: #{@customer},"\
+      " starting_balance: #{@starting_balance}, ending_balance: #{@ending_balance}, amount:"\
+      " #{@amount}, currency: #{@currency}, created_at: #{@created_at}, description:"\
+      " #{@description}, credit_block: #{@credit_block}, entry_type: #{@entry_type}, price_id:"\
+      " #{@price_id}, invoice_id: #{@invoice_id}, event_id: #{@event_id}, 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}, ledger_sequence_number:"\
+      " #{@ledger_sequence_number.inspect}, entry_status: #{@entry_status.inspect}, customer:"\
+      " #{@customer.inspect}, starting_balance: #{@starting_balance.inspect}, ending_balance:"\
+      " #{@ending_balance.inspect}, amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
+      " created_at: #{@created_at.inspect}, description: #{@description.inspect}, credit_block:"\
+      " #{@credit_block.inspect}, entry_type: #{@entry_type.inspect}, price_id:"\
+      " #{@price_id.inspect}, invoice_id: #{@invoice_id.inspect}, event_id: #{@event_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/deprecated_event_result.rb

@@ -0,0 +1,74 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # DeprecatedEventResult Model.
+  class DeprecatedEventResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # event_id of the deprecated event, if successfully updated
+    # @return [String]
+    attr_accessor :deprecated
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['deprecated'] = 'deprecated'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(deprecated:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @deprecated = deprecated
+      @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.
+      deprecated = hash.key?('deprecated') ? hash['deprecated'] : 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.
+      DeprecatedEventResult.new(deprecated: deprecated,
+                                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} deprecated: #{@deprecated}, 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} deprecated: #{@deprecated.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/dimensional_price_configuration.rb

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