orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/add_void_credit_ledger_entry_request_params.rb

@@ -0,0 +1,169 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AddVoidCreditLedgerEntryRequestParams Model.
+  class AddVoidCreditLedgerEntryRequestParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User-specified key/value pairs for the resource. 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
+
+    # The currency or custom pricing unit to use for this ledger entry. If this
+    # is a real-world currency, it must match the customer's invoicing currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # Optional metadata that can be specified when adding ledger results via the
+    # API. For example, this can be used to note an increment refers to trial
+    # credits, or for noting corrections as a result of an incident, etc.
+    # @return [String]
+    attr_accessor :description
+
+    # Optional metadata that can be specified when adding ledger results via the
+    # API. For example, this can be used to note an increment refers to trial
+    # credits, or for noting corrections as a result of an incident, etc.
+    # @return [String]
+    attr_reader :entry_type
+
+    # The ID of the block to void.
+    # @return [String]
+    attr_accessor :block_id
+
+    # Can only be specified when `entry_type=void`. The reason for the void.
+    # @return [VoidReason]
+    attr_accessor :void_reason
+
+    # The number of credits to effect. Note that this is required for increment,
+    # decrement, void, or undo operations.
+    # @return [Float]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['currency'] = 'currency'
+      @_hash['description'] = 'description'
+      @_hash['entry_type'] = 'entry_type'
+      @_hash['block_id'] = 'block_id'
+      @_hash['void_reason'] = 'void_reason'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        currency
+        description
+        void_reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        currency
+        description
+        void_reason
+      ]
+    end
+
+    def initialize(block_id:, amount:, metadata: SKIP, currency: SKIP,
+                   description: SKIP, void_reason: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata unless metadata == SKIP
+      @currency = currency unless currency == SKIP
+      @description = description unless description == SKIP
+      @entry_type = 'void'
+      @block_id = block_id
+      @void_reason = void_reason unless void_reason == SKIP
+      @amount = amount
+      @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.
+      block_id = hash.key?('block_id') ? hash['block_id'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      void_reason = hash.key?('void_reason') ? hash['void_reason'] : 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.
+      AddVoidCreditLedgerEntryRequestParams.new(block_id: block_id,
+                                                amount: amount,
+                                                metadata: metadata,
+                                                currency: currency,
+                                                description: description,
+                                                void_reason: void_reason,
+                                                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AddVoidCreditLedgerEntryRequestParams | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.entry_type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.block_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['entry_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['block_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? Float })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, currency: #{@currency}, description:"\
+      " #{@description}, entry_type: #{@entry_type}, block_id: #{@block_id}, void_reason:"\
+      " #{@void_reason}, amount: #{@amount}, 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}, currency: #{@currency.inspect},"\
+      " description: #{@description.inspect}, entry_type: #{@entry_type.inspect}, block_id:"\
+      " #{@block_id.inspect}, void_reason: #{@void_reason.inspect}, amount: #{@amount.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/address.rb

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

data/lib/api_reference/models/address_input.rb

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

data/lib/api_reference/models/adjustment_interval.rb

@@ -0,0 +1,163 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # AdjustmentInterval Model.
+  class AdjustmentInterval < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :adjustment
+
+    # The start date of the adjustment interval.
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The end date of the adjustment interval.
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # The price interval IDs that this adjustment applies to.
+    # @return [Array[String]]
+    attr_accessor :applies_to_price_interval_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['adjustment'] = 'adjustment'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['applies_to_price_interval_ids'] =
+        'applies_to_price_interval_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+      ]
+    end
+
+    def initialize(id:, adjustment:, start_date:, end_date:,
+                   applies_to_price_interval_ids:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @adjustment = adjustment
+      @start_date = start_date
+      @end_date = end_date
+      @applies_to_price_interval_ids = applies_to_price_interval_ids
+      @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
+      adjustment = hash.key?('adjustment') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:Adjustment), hash['adjustment']
+      ) : nil
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   end
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 end
+      applies_to_price_interval_ids =
+        hash.key?('applies_to_price_interval_ids') ? hash['applies_to_price_interval_ids'] : 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.
+      AdjustmentInterval.new(id: id,
+                             adjustment: adjustment,
+                             start_date: start_date,
+                             end_date: end_date,
+                             applies_to_price_interval_ids: applies_to_price_interval_ids,
+                             additional_properties: additional_properties)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AdjustmentInterval | 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
+            UnionTypeLookUp.get(:Adjustment)
+                           .validate(value.adjustment) and
+            APIHelper.valid_type?(value.start_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.end_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.applies_to_price_interval_ids,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:Adjustment)
+                         .validate(value['adjustment']) and
+          APIHelper.valid_type?(value['start_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['end_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['applies_to_price_interval_ids'],
+                                ->(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} id: #{@id}, adjustment: #{@adjustment}, start_date: #{@start_date},"\
+      " end_date: #{@end_date}, applies_to_price_interval_ids: #{@applies_to_price_interval_ids},"\
+      " 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}, adjustment: #{@adjustment.inspect}, start_date:"\
+      " #{@start_date.inspect}, end_date: #{@end_date.inspect}, applies_to_price_interval_ids:"\
+      " #{@applies_to_price_interval_ids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end