orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/new_tax_jar_configuration.rb

@@ -0,0 +1,100 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewTaxJarConfiguration Model.
+  class NewTaxJarConfiguration < 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 = 'taxjar'
+      @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.
+      NewTaxJarConfiguration.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

data/lib/api_reference/models/new_tiered_percentage_discount.rb

@@ -0,0 +1,214 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewTieredPercentageDiscount Model.
+  class NewTieredPercentageDiscount < 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 [Array[NewTieredPercentageDiscountTier]]
+    attr_accessor :tiers
+
+    # 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['tiers'] = 'tiers'
+      @_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(tiers:, 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 = 'tiered_percentage_discount'
+      @tiers = tiers
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      tiers = nil
+      unless hash['tiers'].nil?
+        tiers = []
+        hash['tiers'].each do |structure|
+          tiers << (NewTieredPercentageDiscountTier.from_hash(structure) if structure)
+        end
+      end
+
+      tiers = nil unless hash.key?('tiers')
+      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.
+      NewTieredPercentageDiscount.new(tiers: tiers,
+                                      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 [NewTieredPercentageDiscount | 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.tiers,
+                                  ->(val) { NewTieredPercentageDiscountTier.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['adjustment_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['tiers'],
+                                ->(val) { NewTieredPercentageDiscountTier.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} 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}, tiers: #{@tiers},"\
+      " 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}, tiers: #{@tiers.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_tiered_percentage_discount_tier.rb

@@ -0,0 +1,118 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewTieredPercentageDiscountTier Model.
+  class NewTieredPercentageDiscountTier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Exclusive lower bound of cumulative spend for this tier.
+    # @return [Float]
+    attr_accessor :lower_bound
+
+    # Inclusive upper bound of cumulative spend; null for the final open-ended
+    # tier.
+    # @return [Float]
+    attr_accessor :upper_bound
+
+    # The percentage (0-1) discounted from spend in this tier.
+    # @return [Float]
+    attr_accessor :percentage
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['lower_bound'] = 'lower_bound'
+      @_hash['upper_bound'] = 'upper_bound'
+      @_hash['percentage'] = 'percentage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        upper_bound
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        upper_bound
+      ]
+    end
+
+    def initialize(lower_bound:, percentage:, upper_bound: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @lower_bound = lower_bound
+      @upper_bound = upper_bound unless upper_bound == SKIP
+      @percentage = percentage
+      @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.
+      lower_bound = hash.key?('lower_bound') ? hash['lower_bound'] : nil
+      percentage = hash.key?('percentage') ? hash['percentage'] : nil
+      upper_bound = hash.key?('upper_bound') ? hash['upper_bound'] : 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.
+      NewTieredPercentageDiscountTier.new(lower_bound: lower_bound,
+                                          percentage: percentage,
+                                          upper_bound: upper_bound,
+                                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [NewTieredPercentageDiscountTier | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.lower_bound,
+                                ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.percentage,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['lower_bound'],
+                              ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['percentage'],
+                                ->(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} lower_bound: #{@lower_bound}, upper_bound: #{@upper_bound}, percentage:"\
+      " #{@percentage}, 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} lower_bound: #{@lower_bound.inspect}, upper_bound: #{@upper_bound.inspect},"\
+      " percentage: #{@percentage.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_top_up_invoice_settings.rb

@@ -0,0 +1,117 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewTopUpInvoiceSettings Model.
+  class NewTopUpInvoiceSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Whether the credits purchase invoice should auto collect with the
+    # customer's saved payment method.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_collection
+
+    # The net terms determines the difference between the invoice date and the
+    # issue date for the invoice. If you intend the invoice to be due on issue,
+    # set this to 0.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # An optional memo to display on the invoice.
+    # @return [String]
+    attr_accessor :memo
+
+    # When true, credit blocks created by this top-up will require that the
+    # corresponding invoice is paid before they are drawn down from. If any
+    # topup block is pending payment, further automatic top-ups will be paused
+    # until the invoice is paid or voided.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :require_successful_payment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['memo'] = 'memo'
+      @_hash['require_successful_payment'] = 'require_successful_payment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        memo
+        require_successful_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        memo
+      ]
+    end
+
+    def initialize(auto_collection:, net_terms:, memo: SKIP,
+                   require_successful_payment: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @auto_collection = auto_collection
+      @net_terms = net_terms
+      @memo = memo unless memo == SKIP
+      unless require_successful_payment == SKIP
+        @require_successful_payment =
+          require_successful_payment
+      end
+      @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.
+      auto_collection =
+        hash.key?('auto_collection') ? hash['auto_collection'] : nil
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      require_successful_payment = hash['require_successful_payment'] ||= false
+
+      # 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.
+      NewTopUpInvoiceSettings.new(auto_collection: auto_collection,
+                                  net_terms: net_terms,
+                                  memo: memo,
+                                  require_successful_payment: require_successful_payment,
+                                  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} auto_collection: #{@auto_collection}, net_terms: #{@net_terms}, memo:"\
+      " #{@memo}, require_successful_payment: #{@require_successful_payment},"\
+      " 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} auto_collection: #{@auto_collection.inspect}, net_terms:"\
+      " #{@net_terms.inspect}, memo: #{@memo.inspect}, require_successful_payment:"\
+      " #{@require_successful_payment.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_top_up_invoice_settings2.rb

@@ -0,0 +1,117 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Settings for invoices generated by triggered top-ups.
+  class NewTopUpInvoiceSettings2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Whether the credits purchase invoice should auto collect with the
+    # customer's saved payment method.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_collection
+
+    # The net terms determines the difference between the invoice date and the
+    # issue date for the invoice. If you intend the invoice to be due on issue,
+    # set this to 0.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # An optional memo to display on the invoice.
+    # @return [String]
+    attr_accessor :memo
+
+    # When true, credit blocks created by this top-up will require that the
+    # corresponding invoice is paid before they are drawn down from. If any
+    # topup block is pending payment, further automatic top-ups will be paused
+    # until the invoice is paid or voided.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :require_successful_payment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['memo'] = 'memo'
+      @_hash['require_successful_payment'] = 'require_successful_payment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        memo
+        require_successful_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        memo
+      ]
+    end
+
+    def initialize(auto_collection:, net_terms:, memo: SKIP,
+                   require_successful_payment: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @auto_collection = auto_collection
+      @net_terms = net_terms
+      @memo = memo unless memo == SKIP
+      unless require_successful_payment == SKIP
+        @require_successful_payment =
+          require_successful_payment
+      end
+      @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.
+      auto_collection =
+        hash.key?('auto_collection') ? hash['auto_collection'] : nil
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : nil
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      require_successful_payment = hash['require_successful_payment'] ||= false
+
+      # 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.
+      NewTopUpInvoiceSettings2.new(auto_collection: auto_collection,
+                                   net_terms: net_terms,
+                                   memo: memo,
+                                   require_successful_payment: require_successful_payment,
+                                   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} auto_collection: #{@auto_collection}, net_terms: #{@net_terms}, memo:"\
+      " #{@memo}, require_successful_payment: #{@require_successful_payment},"\
+      " 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} auto_collection: #{@auto_collection.inspect}, net_terms:"\
+      " #{@net_terms.inspect}, memo: #{@memo.inspect}, require_successful_payment:"\
+      " #{@require_successful_payment.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end