orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/add_credit_top_up_request_params.rb

@@ -0,0 +1,149 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # AddCreditTopUpRequestParams Model.
+  class AddCreditTopUpRequestParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 [NewTopUpInvoiceSettings2]
+    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
+
+    # The date from which the top-up is active. If unspecified, the top-up is
+    # active immediately.             This should not be more than 10 days in
+    # the past.
+    # @return [DateTime]
+    attr_accessor :active_from
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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['active_from'] = 'active_from'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_after
+        expires_after_unit
+        active_from
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        expires_after
+        expires_after_unit
+        active_from
+      ]
+    end
+
+    def initialize(currency:, threshold:, amount:, per_unit_cost_basis:,
+                   invoice_settings:, expires_after: SKIP,
+                   expires_after_unit: SKIP, active_from: SKIP)
+      @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
+      @active_from = active_from unless active_from == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      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 = NewTopUpInvoiceSettings2.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
+      active_from = if hash.key?('active_from')
+                      (DateTimeHelper.from_rfc3339(hash['active_from']) if hash['active_from'])
+                    else
+                      SKIP
+                    end
+
+      # Create object from extracted values.
+      AddCreditTopUpRequestParams.new(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,
+                                      active_from: active_from)
+    end
+
+    def to_custom_active_from
+      DateTimeHelper.to_rfc3339(active_from)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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}, active_from:"\
+      " #{@active_from}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} 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}, active_from: #{@active_from.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/add_decrement_credit_ledger_entry_request_params.rb

@@ -0,0 +1,145 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AddDecrementCreditLedgerEntryRequestParams Model.
+  class AddDecrementCreditLedgerEntryRequestParams < 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 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['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        currency
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        currency
+        description
+      ]
+    end
+
+    def initialize(amount:, metadata: SKIP, currency: SKIP, description: 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 = 'decrement'
+      @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.
+      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
+
+      # 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.
+      AddDecrementCreditLedgerEntryRequestParams.new(amount: amount,
+                                                     metadata: metadata,
+                                                     currency: currency,
+                                                     description: description,
+                                                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AddDecrementCreditLedgerEntryRequestParams | 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.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['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}, 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}, amount:"\
+      " #{@amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/add_edit_price_interval_params.rb

@@ -0,0 +1,161 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AddEditPriceIntervalParams Model.
+  class AddEditPriceIntervalParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of price intervals to add to the subscription.
+    # @return [Array[AddPriceIntervalParams]]
+    attr_accessor :add
+
+    # A list of price intervals to edit on the subscription.
+    # @return [Array[EditPriceIntervalParams]]
+    attr_accessor :edit
+
+    # A list of adjustments to add to the subscription.
+    # @return [Array[AddAdjustmentIntervalParams]]
+    attr_accessor :add_adjustments
+
+    # A list of adjustments to edit on the subscription.
+    # @return [Array[EditAdjustmentIntervalParams]]
+    attr_accessor :edit_adjustments
+
+    # If set, the default value to use for added/edited price intervals with an
+    # end_date set.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :can_defer_billing
+
+    # If false, this request will fail if it would void an issued invoice or
+    # create a credit note. Consider using this as a safety mechanism if you do
+    # not expect existing invoices to be changed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_invoice_credit_or_void
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['add'] = 'add'
+      @_hash['edit'] = 'edit'
+      @_hash['add_adjustments'] = 'add_adjustments'
+      @_hash['edit_adjustments'] = 'edit_adjustments'
+      @_hash['can_defer_billing'] = 'can_defer_billing'
+      @_hash['allow_invoice_credit_or_void'] = 'allow_invoice_credit_or_void'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        add
+        edit
+        add_adjustments
+        edit_adjustments
+        can_defer_billing
+        allow_invoice_credit_or_void
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        can_defer_billing
+        allow_invoice_credit_or_void
+      ]
+    end
+
+    def initialize(add: SKIP, edit: SKIP, add_adjustments: SKIP,
+                   edit_adjustments: SKIP, can_defer_billing: SKIP,
+                   allow_invoice_credit_or_void: true)
+      @add = add unless add == SKIP
+      @edit = edit unless edit == SKIP
+      @add_adjustments = add_adjustments unless add_adjustments == SKIP
+      @edit_adjustments = edit_adjustments unless edit_adjustments == SKIP
+      @can_defer_billing = can_defer_billing unless can_defer_billing == SKIP
+      unless allow_invoice_credit_or_void == SKIP
+        @allow_invoice_credit_or_void =
+          allow_invoice_credit_or_void
+      end
+    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
+      add = nil
+      unless hash['add'].nil?
+        add = []
+        hash['add'].each do |structure|
+          add << (AddPriceIntervalParams.from_hash(structure) if structure)
+        end
+      end
+
+      add = SKIP unless hash.key?('add')
+      # Parameter is an array, so we need to iterate through it
+      edit = nil
+      unless hash['edit'].nil?
+        edit = []
+        hash['edit'].each do |structure|
+          edit << (EditPriceIntervalParams.from_hash(structure) if structure)
+        end
+      end
+
+      edit = SKIP unless hash.key?('edit')
+      # Parameter is an array, so we need to iterate through it
+      add_adjustments = nil
+      unless hash['add_adjustments'].nil?
+        add_adjustments = []
+        hash['add_adjustments'].each do |structure|
+          add_adjustments << (AddAdjustmentIntervalParams.from_hash(structure) if structure)
+        end
+      end
+
+      add_adjustments = SKIP unless hash.key?('add_adjustments')
+      # Parameter is an array, so we need to iterate through it
+      edit_adjustments = nil
+      unless hash['edit_adjustments'].nil?
+        edit_adjustments = []
+        hash['edit_adjustments'].each do |structure|
+          edit_adjustments << (EditAdjustmentIntervalParams.from_hash(structure) if structure)
+        end
+      end
+
+      edit_adjustments = SKIP unless hash.key?('edit_adjustments')
+      can_defer_billing =
+        hash.key?('can_defer_billing') ? hash['can_defer_billing'] : SKIP
+      allow_invoice_credit_or_void =
+        hash['allow_invoice_credit_or_void'] ||= true
+
+      # Create object from extracted values.
+      AddEditPriceIntervalParams.new(add: add,
+                                     edit: edit,
+                                     add_adjustments: add_adjustments,
+                                     edit_adjustments: edit_adjustments,
+                                     can_defer_billing: can_defer_billing,
+                                     allow_invoice_credit_or_void: allow_invoice_credit_or_void)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} add: #{@add}, edit: #{@edit}, add_adjustments: #{@add_adjustments},"\
+      " edit_adjustments: #{@edit_adjustments}, can_defer_billing: #{@can_defer_billing},"\
+      " allow_invoice_credit_or_void: #{@allow_invoice_credit_or_void}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} add: #{@add.inspect}, edit: #{@edit.inspect}, add_adjustments:"\
+      " #{@add_adjustments.inspect}, edit_adjustments: #{@edit_adjustments.inspect},"\
+      " can_defer_billing: #{@can_defer_billing.inspect}, allow_invoice_credit_or_void:"\
+      " #{@allow_invoice_credit_or_void.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/add_expiration_change_credit_ledger_entry_request_params.rb

@@ -0,0 +1,193 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AddExpirationChangeCreditLedgerEntryRequestParams Model.
+  class AddExpirationChangeCreditLedgerEntryRequestParams < 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 number of credits to effect. Note that this is required for increment,
+    # decrement, void, or undo operations.
+    # @return [Float]
+    attr_accessor :amount
+
+    # An ISO 8601 format date that identifies the origination credit block to
+    # expire
+    # @return [Object]
+    attr_accessor :expiry_date
+
+    # The ID of the block affected by an expiration_change, used to
+    # differentiate between multiple blocks with the same `expiry_date`.
+    # @return [String]
+    attr_accessor :block_id
+
+    # A date (specified in YYYY-MM-DD format) used for expiration change,
+    # denoting when credits transferred (as part of a partial block expiration)
+    # should expire. This date must be on or after the effective date of the
+    # credit block.
+    # @return [Date]
+    attr_accessor :target_expiry_date
+
+    # 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['amount'] = 'amount'
+      @_hash['expiry_date'] = 'expiry_date'
+      @_hash['block_id'] = 'block_id'
+      @_hash['target_expiry_date'] = 'target_expiry_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        currency
+        description
+        amount
+        expiry_date
+        block_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        currency
+        description
+        amount
+        expiry_date
+        block_id
+      ]
+    end
+
+    def initialize(target_expiry_date:, metadata: SKIP, currency: SKIP,
+                   description: SKIP, amount: SKIP, expiry_date: SKIP,
+                   block_id: 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 = 'expiration_change'
+      @amount = amount unless amount == SKIP
+      @expiry_date = expiry_date unless expiry_date == SKIP
+      @block_id = block_id unless block_id == SKIP
+      @target_expiry_date = target_expiry_date
+      @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.
+      target_expiry_date =
+        hash.key?('target_expiry_date') ? hash['target_expiry_date'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      expiry_date = hash.key?('expiry_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AddExpirationChangeCreditLedgerEntryRequestParamsExpiryDate), hash['expiry_date']
+      ) : SKIP
+      block_id = hash.key?('block_id') ? hash['block_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.
+      AddExpirationChangeCreditLedgerEntryRequestParams.new(target_expiry_date: target_expiry_date,
+                                                            metadata: metadata,
+                                                            currency: currency,
+                                                            description: description,
+                                                            amount: amount,
+                                                            expiry_date: expiry_date,
+                                                            block_id: block_id,
+                                                            additional_properties: additional_properties)
+    end
+
+    def to_union_type_expiry_date
+      UnionTypeLookUp.get(:AddExpirationChangeCreditLedgerEntryRequestParamsExpiryDate)
+                     .validate(expiry_date)
+                     .serialize(expiry_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AddExpirationChangeCreditLedgerEntryRequestParams | 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.target_expiry_date,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['entry_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['target_expiry_date'],
+                                ->(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}, currency: #{@currency}, description:"\
+      " #{@description}, entry_type: #{@entry_type}, amount: #{@amount}, expiry_date:"\
+      " #{@expiry_date}, block_id: #{@block_id}, target_expiry_date: #{@target_expiry_date},"\
+      " 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}, amount:"\
+      " #{@amount.inspect}, expiry_date: #{@expiry_date.inspect}, block_id: #{@block_id.inspect},"\
+      " target_expiry_date: #{@target_expiry_date.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end