orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/new_accounting_sync_configuration.rb

@@ -0,0 +1,98 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewAccountingSyncConfiguration Model.
+  class NewAccountingSyncConfiguration < 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[AccountingProviderConfig]]
+    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
+      %w[
+        excluded
+        accounting_providers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        excluded
+        accounting_providers
+      ]
+    end
+
+    def initialize(excluded: SKIP, accounting_providers: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @excluded = excluded unless excluded == SKIP
+      @accounting_providers = accounting_providers unless accounting_providers == 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.
+      excluded = hash.key?('excluded') ? hash['excluded'] : SKIP
+      # 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 << (AccountingProviderConfig.from_hash(structure) if structure)
+        end
+      end
+
+      accounting_providers = SKIP 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.
+      NewAccountingSyncConfiguration.new(excluded: excluded,
+                                         accounting_providers: accounting_providers,
+                                         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} 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/new_allocation_price.rb

@@ -0,0 +1,221 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewAllocationPrice Model.
+  class NewAllocationPrice < 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
+
+    # An ISO 4217 currency string or a custom pricing unit identifier in which
+    # to bill this price.
+    # @return [String]
+    attr_accessor :currency
+
+    # An amount of the currency to allocate to the customer at the specified
+    # cadence.
+    # @return [String]
+    attr_accessor :amount
+
+    # The cadence at which to allocate the amount to the customer.
+    # @return [Cadence34]
+    attr_accessor :cadence
+
+    # Whether the allocated amount should expire at the end of the cadence or
+    # roll over to the next period. Set to null if using custom_expiration.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :expires_at_end_of_cadence
+
+    # The custom expiration for the allocation.
+    # @return [CustomExpiration]
+    attr_accessor :custom_expiration
+
+    # The filters that determine which items the allocation applies to.
+    # @return [Array[BlockPriceFilter]]
+    attr_accessor :filters
+
+    # The (per-unit) cost basis of each created block. If non-zero, a customer
+    # will be invoiced according to the quantity and per unit cost basis
+    # specified for the allocation each cadence.
+    # @return [String]
+    attr_accessor :per_unit_cost_basis
+
+    # The item ID that line items representing charges for this allocation will
+    # be associated with. If not provided, the default allocation item for the
+    # currency will be used (e.g. 'Included Allocation (USD)').
+    # @return [String]
+    attr_accessor :item_id
+
+    # The license type ID to associate the price with license allocation.
+    # @return [String]
+    attr_accessor :license_type_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['amount'] = 'amount'
+      @_hash['cadence'] = 'cadence'
+      @_hash['expires_at_end_of_cadence'] = 'expires_at_end_of_cadence'
+      @_hash['custom_expiration'] = 'custom_expiration'
+      @_hash['filters'] = 'filters'
+      @_hash['per_unit_cost_basis'] = 'per_unit_cost_basis'
+      @_hash['item_id'] = 'item_id'
+      @_hash['license_type_id'] = 'license_type_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        expires_at_end_of_cadence
+        custom_expiration
+        filters
+        per_unit_cost_basis
+        item_id
+        license_type_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        expires_at_end_of_cadence
+        custom_expiration
+        filters
+        item_id
+        license_type_id
+      ]
+    end
+
+    def initialize(currency:, amount:, cadence:, metadata: SKIP,
+                   expires_at_end_of_cadence: SKIP, custom_expiration: SKIP,
+                   filters: SKIP, per_unit_cost_basis: '0.00', item_id: SKIP,
+                   license_type_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
+      @amount = amount
+      @cadence = cadence
+      unless expires_at_end_of_cadence == SKIP
+        @expires_at_end_of_cadence =
+          expires_at_end_of_cadence
+      end
+      @custom_expiration = custom_expiration unless custom_expiration == SKIP
+      @filters = filters unless filters == SKIP
+      @per_unit_cost_basis = per_unit_cost_basis unless per_unit_cost_basis == SKIP
+      @item_id = item_id unless item_id == SKIP
+      @license_type_id = license_type_id unless license_type_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.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      cadence = hash.key?('cadence') ? hash['cadence'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      expires_at_end_of_cadence =
+        hash.key?('expires_at_end_of_cadence') ? hash['expires_at_end_of_cadence'] : SKIP
+      custom_expiration = CustomExpiration.from_hash(hash['custom_expiration']) if
+        hash['custom_expiration']
+      # Parameter is an array, so we need to iterate through it
+      filters = nil
+      unless hash['filters'].nil?
+        filters = []
+        hash['filters'].each do |structure|
+          filters << (BlockPriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      filters = SKIP unless hash.key?('filters')
+      per_unit_cost_basis = hash['per_unit_cost_basis'] ||= '0.00'
+      item_id = hash.key?('item_id') ? hash['item_id'] : SKIP
+      license_type_id =
+        hash.key?('license_type_id') ? hash['license_type_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.
+      NewAllocationPrice.new(currency: currency,
+                             amount: amount,
+                             cadence: cadence,
+                             metadata: metadata,
+                             expires_at_end_of_cadence: expires_at_end_of_cadence,
+                             custom_expiration: custom_expiration,
+                             filters: filters,
+                             per_unit_cost_basis: per_unit_cost_basis,
+                             item_id: item_id,
+                             license_type_id: license_type_id,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [NewAllocationPrice | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.currency,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.cadence,
+                                  ->(val) { Cadence34.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['currency'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['cadence'],
+                                ->(val) { Cadence34.validate(val) })
+      )
+    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}, amount: #{@amount},"\
+      " cadence: #{@cadence}, expires_at_end_of_cadence: #{@expires_at_end_of_cadence},"\
+      " custom_expiration: #{@custom_expiration}, filters: #{@filters}, per_unit_cost_basis:"\
+      " #{@per_unit_cost_basis}, item_id: #{@item_id}, license_type_id: #{@license_type_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}, currency: #{@currency.inspect}, amount:"\
+      " #{@amount.inspect}, cadence: #{@cadence.inspect}, expires_at_end_of_cadence:"\
+      " #{@expires_at_end_of_cadence.inspect}, custom_expiration: #{@custom_expiration.inspect},"\
+      " filters: #{@filters.inspect}, per_unit_cost_basis: #{@per_unit_cost_basis.inspect},"\
+      " item_id: #{@item_id.inspect}, license_type_id: #{@license_type_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_amount_discount.rb

@@ -0,0 +1,202 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewAmountDiscount Model.
+  class NewAmountDiscount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The set of price IDs to which this adjustment applies.
+    # @return [Array[String]]
+    attr_accessor :applies_to_price_ids
+
+    # The set of item IDs to which this adjustment applies.
+    # @return [Array[String]]
+    attr_accessor :applies_to_item_ids
+
+    # If set, the adjustment will apply to every price on the subscription.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :applies_to_all
+
+    # A list of filters that determine which prices this adjustment will apply
+    # to.
+    # @return [Array[PriceFilter]]
+    attr_accessor :filters
+
+    # If set, only prices in the specified currency will have the adjustment
+    # applied.
+    # @return [String]
+    attr_accessor :currency
+
+    # If set, only prices of the specified type will have the adjustment
+    # applied.
+    # @return [PriceType]
+    attr_accessor :price_type
+
+    # When false, this adjustment will be applied to a single price. Otherwise,
+    # it will be applied at the invoice level, possibly to multiple prices.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_invoice_level
+
+    # When false, this adjustment will be applied to a single price. Otherwise,
+    # it will be applied at the invoice level, possibly to multiple prices.
+    # @return [String]
+    attr_reader :adjustment_type
+
+    # When false, this adjustment will be applied to a single price. Otherwise,
+    # it will be applied at the invoice level, possibly to multiple prices.
+    # @return [String]
+    attr_accessor :amount_discount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['applies_to_price_ids'] = 'applies_to_price_ids'
+      @_hash['applies_to_item_ids'] = 'applies_to_item_ids'
+      @_hash['applies_to_all'] = 'applies_to_all'
+      @_hash['filters'] = 'filters'
+      @_hash['currency'] = 'currency'
+      @_hash['price_type'] = 'price_type'
+      @_hash['is_invoice_level'] = 'is_invoice_level'
+      @_hash['adjustment_type'] = 'adjustment_type'
+      @_hash['amount_discount'] = 'amount_discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        applies_to_price_ids
+        applies_to_item_ids
+        applies_to_all
+        filters
+        currency
+        price_type
+        is_invoice_level
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        applies_to_price_ids
+        applies_to_item_ids
+        applies_to_all
+        filters
+        currency
+        price_type
+      ]
+    end
+
+    def initialize(amount_discount:, applies_to_price_ids: SKIP,
+                   applies_to_item_ids: SKIP, applies_to_all: SKIP,
+                   filters: SKIP, currency: SKIP, price_type: SKIP,
+                   is_invoice_level: true, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @applies_to_price_ids = applies_to_price_ids unless applies_to_price_ids == SKIP
+      @applies_to_item_ids = applies_to_item_ids unless applies_to_item_ids == SKIP
+      @applies_to_all = applies_to_all unless applies_to_all == SKIP
+      @filters = filters unless filters == SKIP
+      @currency = currency unless currency == SKIP
+      @price_type = price_type unless price_type == SKIP
+      @is_invoice_level = is_invoice_level unless is_invoice_level == SKIP
+      @adjustment_type = 'amount_discount'
+      @amount_discount = amount_discount
+      @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_discount =
+        hash.key?('amount_discount') ? hash['amount_discount'] : nil
+      applies_to_price_ids =
+        hash.key?('applies_to_price_ids') ? hash['applies_to_price_ids'] : SKIP
+      applies_to_item_ids =
+        hash.key?('applies_to_item_ids') ? hash['applies_to_item_ids'] : SKIP
+      applies_to_all =
+        hash.key?('applies_to_all') ? hash['applies_to_all'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      filters = nil
+      unless hash['filters'].nil?
+        filters = []
+        hash['filters'].each do |structure|
+          filters << (PriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      filters = SKIP unless hash.key?('filters')
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      price_type = hash.key?('price_type') ? hash['price_type'] : SKIP
+      is_invoice_level = hash['is_invoice_level'] ||= true
+
+      # 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.
+      NewAmountDiscount.new(amount_discount: amount_discount,
+                            applies_to_price_ids: applies_to_price_ids,
+                            applies_to_item_ids: applies_to_item_ids,
+                            applies_to_all: applies_to_all,
+                            filters: filters,
+                            currency: currency,
+                            price_type: price_type,
+                            is_invoice_level: is_invoice_level,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [NewAmountDiscount | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.adjustment_type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount_discount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['adjustment_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount_discount'],
+                                ->(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} applies_to_price_ids: #{@applies_to_price_ids}, applies_to_item_ids:"\
+      " #{@applies_to_item_ids}, applies_to_all: #{@applies_to_all}, filters: #{@filters},"\
+      " currency: #{@currency}, price_type: #{@price_type}, is_invoice_level:"\
+      " #{@is_invoice_level}, adjustment_type: #{@adjustment_type}, amount_discount:"\
+      " #{@amount_discount}, 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} applies_to_price_ids: #{@applies_to_price_ids.inspect},"\
+      " applies_to_item_ids: #{@applies_to_item_ids.inspect}, applies_to_all:"\
+      " #{@applies_to_all.inspect}, filters: #{@filters.inspect}, currency: #{@currency.inspect},"\
+      " price_type: #{@price_type.inspect}, is_invoice_level: #{@is_invoice_level.inspect},"\
+      " adjustment_type: #{@adjustment_type.inspect}, amount_discount:"\
+      " #{@amount_discount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_anrok_configuration.rb

@@ -0,0 +1,100 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewAnrokConfiguration Model.
+  class NewAnrokConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_exempt
+
+    # Whether to automatically calculate tax for this customer. When null,
+    # inherits from account-level setting. When true or false, overrides the
+    # account setting.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :automatic_tax_enabled
+
+    # Whether to automatically calculate tax for this customer. When null,
+    # inherits from account-level setting. When true or false, overrides the
+    # account setting.
+    # @return [String]
+    attr_reader :tax_provider
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_exempt'] = 'tax_exempt'
+      @_hash['automatic_tax_enabled'] = 'automatic_tax_enabled'
+      @_hash['tax_provider'] = 'tax_provider'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        automatic_tax_enabled
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        automatic_tax_enabled
+      ]
+    end
+
+    def initialize(tax_exempt:, automatic_tax_enabled: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_exempt = tax_exempt
+      @automatic_tax_enabled = automatic_tax_enabled unless automatic_tax_enabled == SKIP
+      @tax_provider = 'anrok'
+      @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.
+      tax_exempt = hash.key?('tax_exempt') ? hash['tax_exempt'] : nil
+      automatic_tax_enabled =
+        hash.key?('automatic_tax_enabled') ? hash['automatic_tax_enabled'] : 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.
+      NewAnrokConfiguration.new(tax_exempt: tax_exempt,
+                                automatic_tax_enabled: automatic_tax_enabled,
+                                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} tax_exempt: #{@tax_exempt}, automatic_tax_enabled:"\
+      " #{@automatic_tax_enabled}, tax_provider: #{@tax_provider}, 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} tax_exempt: #{@tax_exempt.inspect}, automatic_tax_enabled:"\
+      " #{@automatic_tax_enabled.inspect}, tax_provider: #{@tax_provider.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end