orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/accounting_provider_config.rb

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

data/lib/api_reference/models/accounting_sync_configuration.rb

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

data/lib/api_reference/models/action.rb

@@ -0,0 +1,68 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Action.
+  class Action
+    ACTION = [
+      # TODO: Write general description for APPLIED_TO_INVOICE
+      APPLIED_TO_INVOICE = 'applied_to_invoice'.freeze,
+
+      # TODO: Write general description for MANUAL_ADJUSTMENT
+      MANUAL_ADJUSTMENT = 'manual_adjustment'.freeze,
+
+      # TODO: Write general description for PRORATED_REFUND
+      PRORATED_REFUND = 'prorated_refund'.freeze,
+
+      # TODO: Write general description for REVERT_PRORATED_REFUND
+      REVERT_PRORATED_REFUND = 'revert_prorated_refund'.freeze,
+
+      # TODO: Write general description for RETURN_FROM_VOIDING
+      RETURN_FROM_VOIDING = 'return_from_voiding'.freeze,
+
+      # TODO: Write general description for CREDIT_NOTE_APPLIED
+      CREDIT_NOTE_APPLIED = 'credit_note_applied'.freeze,
+
+      # TODO: Write general description for CREDIT_NOTE_VOIDED
+      CREDIT_NOTE_VOIDED = 'credit_note_voided'.freeze,
+
+      # TODO: Write general description for OVERPAYMENT_REFUND
+      OVERPAYMENT_REFUND = 'overpayment_refund'.freeze,
+
+      # TODO: Write general description for EXTERNAL_PAYMENT
+      EXTERNAL_PAYMENT = 'external_payment'.freeze,
+
+      # TODO: Write general description for SMALL_INVOICE_CARRYOVER
+      SMALL_INVOICE_CARRYOVER = 'small_invoice_carryover'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = APPLIED_TO_INVOICE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'applied_to_invoice' then APPLIED_TO_INVOICE
+      when 'manual_adjustment' then MANUAL_ADJUSTMENT
+      when 'prorated_refund' then PRORATED_REFUND
+      when 'revert_prorated_refund' then REVERT_PRORATED_REFUND
+      when 'return_from_voiding' then RETURN_FROM_VOIDING
+      when 'credit_note_applied' then CREDIT_NOTE_APPLIED
+      when 'credit_note_voided' then CREDIT_NOTE_VOIDED
+      when 'overpayment_refund' then OVERPAYMENT_REFUND
+      when 'external_payment' then EXTERNAL_PAYMENT
+      when 'small_invoice_carryover' then SMALL_INVOICE_CARRYOVER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/add_adjustment_interval_params.rb

@@ -0,0 +1,148 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AddAdjustmentIntervalParams Model.
+  class AddAdjustmentIntervalParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the adjustment to add to the subscription. Adjustment IDs can be
+    # re-used from existing subscriptions or plans, but adjustments associated
+    # with coupon redemptions cannot be re-used.
+    # @return [String]
+    attr_accessor :adjustment_id
+
+    # The definition of a new adjustment to create and add to the subscription.
+    # @return [Object]
+    attr_accessor :adjustment
+
+    # The start date of the adjustment interval. This is the date that the
+    # adjustment will start affecting prices on the subscription. The adjustment
+    # will apply to invoice dates that overlap with this `start_date`. This
+    # `start_date` is treated as inclusive for in-advance prices, and exclusive
+    # for in-arrears prices.
+    # @return [Object]
+    attr_accessor :start_date
+
+    # The end date of the adjustment interval. This is the date that the
+    # adjustment will stop affecting prices on the subscription. The adjustment
+    # will apply to invoice dates that overlap with this `end_date`.This
+    # `end_date` is treated as exclusive for in-advance prices, and inclusive
+    # for in-arrears prices.
+    # @return [Object]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['adjustment_id'] = 'adjustment_id'
+      @_hash['adjustment'] = 'adjustment'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        adjustment_id
+        adjustment
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        adjustment_id
+        adjustment
+        end_date
+      ]
+    end
+
+    def initialize(start_date:, adjustment_id: SKIP, adjustment: SKIP,
+                   end_date: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @adjustment_id = adjustment_id unless adjustment_id == SKIP
+      @adjustment = adjustment unless adjustment == SKIP
+      @start_date = start_date
+      @end_date = end_date unless end_date == 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.
+      start_date = hash.key?('start_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AddAdjustmentIntervalParamsStartDate), hash['start_date']
+      ) : nil
+      adjustment_id = hash.key?('adjustment_id') ? hash['adjustment_id'] : SKIP
+      adjustment = hash.key?('adjustment') ? hash['adjustment'] : SKIP
+      end_date = hash.key?('end_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AddAdjustmentIntervalParamsEndDate), hash['end_date']
+      ) : 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.
+      AddAdjustmentIntervalParams.new(start_date: start_date,
+                                      adjustment_id: adjustment_id,
+                                      adjustment: adjustment,
+                                      end_date: end_date,
+                                      additional_properties: additional_properties)
+    end
+
+    def to_union_type_start_date
+      UnionTypeLookUp.get(:AddAdjustmentIntervalParamsStartDate)
+                     .validate(start_date)
+                     .serialize(start_date)
+    end
+
+    def to_union_type_end_date
+      UnionTypeLookUp.get(:AddAdjustmentIntervalParamsEndDate)
+                     .validate(end_date)
+                     .serialize(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AddAdjustmentIntervalParams | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return UnionTypeLookUp.get(:AddAdjustmentIntervalParamsStartDate)
+                              .validate(value.start_date)
+      end
+
+      return false unless value.instance_of? Hash
+
+      UnionTypeLookUp.get(:AddAdjustmentIntervalParamsStartDate)
+                     .validate(value['start_date'])
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} adjustment_id: #{@adjustment_id}, adjustment: #{@adjustment}, start_date:"\
+      " #{@start_date}, end_date: #{@end_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} adjustment_id: #{@adjustment_id.inspect}, adjustment:"\
+      " #{@adjustment.inspect}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/add_amendment_credit_ledger_entry_request_params.rb

@@ -0,0 +1,144 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AddAmendmentCreditLedgerEntryRequestParams Model.
+  class AddAmendmentCreditLedgerEntryRequestParams < 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 or void operations.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The ID of the block to reverse a decrement from.
+    # @return [String]
+    attr_accessor :block_id
+
+    # 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['block_id'] = 'block_id'
+      @_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:, block_id:, metadata: SKIP, currency: SKIP,
+                   description: SKIP)
+      @metadata = metadata unless metadata == SKIP
+      @currency = currency unless currency == SKIP
+      @description = description unless description == SKIP
+      @entry_type = 'amendment'
+      @amount = amount
+      @block_id = block_id
+    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
+      block_id = hash.key?('block_id') ? hash['block_id'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      AddAmendmentCreditLedgerEntryRequestParams.new(amount: amount,
+                                                     block_id: block_id,
+                                                     metadata: metadata,
+                                                     currency: currency,
+                                                     description: description)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AddAmendmentCreditLedgerEntryRequestParams | 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 }) and
+            APIHelper.valid_type?(value.block_id,
+                                  ->(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['amount'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['block_id'],
+                                ->(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}, block_id: #{@block_id}>"
+    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}, block_id: #{@block_id.inspect}>"
+    end
+  end
+end