subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/subscription_state_change.rb

@@ -0,0 +1,81 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SubscriptionStateChange Model.
+  class SubscriptionStateChange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :previous_subscription_state
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :new_subscription_state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['previous_subscription_state'] = 'previous_subscription_state'
+      @_hash['new_subscription_state'] = 'new_subscription_state'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(previous_subscription_state = nil,
+                   new_subscription_state = nil)
+      @previous_subscription_state = previous_subscription_state
+      @new_subscription_state = new_subscription_state
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      previous_subscription_state =
+        hash.key?('previous_subscription_state') ? hash['previous_subscription_state'] : nil
+      new_subscription_state =
+        hash.key?('new_subscription_state') ? hash['new_subscription_state'] : nil
+
+      # Create object from extracted values.
+      SubscriptionStateChange.new(previous_subscription_state,
+                                  new_subscription_state)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubscriptionStateChange | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.previous_subscription_state,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.new_subscription_state,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['previous_subscription_state'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['new_subscription_state'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/tax_configuration.rb

@@ -0,0 +1,73 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # TaxConfiguration Model.
+  class TaxConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TaxConfigurationKind]
+    attr_accessor :kind
+
+    # TODO: Write general description for this method
+    # @return [TaxDestinationAddress]
+    attr_accessor :destination_address
+
+    # Returns `true` when Chargify has been properly configured to charge tax
+    # using the specified tax system. More details about taxes:
+    # https://maxio-chargify.zendesk.com/hc/en-us/articles/5405488905869-Taxes-I
+    # ntroduction
+    # @return [TrueClass | FalseClass]
+    attr_accessor :fully_configured
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['kind'] = 'kind'
+      @_hash['destination_address'] = 'destination_address'
+      @_hash['fully_configured'] = 'fully_configured'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        kind
+        destination_address
+        fully_configured
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(kind = TaxConfigurationKind::CUSTOM,
+                   destination_address = SKIP, fully_configured = false)
+      @kind = kind unless kind == SKIP
+      @destination_address = destination_address unless destination_address == SKIP
+      @fully_configured = fully_configured unless fully_configured == 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.
+      kind = hash['kind'] ||= TaxConfigurationKind::CUSTOM
+      destination_address =
+        hash.key?('destination_address') ? hash['destination_address'] : SKIP
+      fully_configured = hash['fully_configured'] ||= false
+
+      # Create object from extracted values.
+      TaxConfiguration.new(kind,
+                           destination_address,
+                           fully_configured)
+    end
+  end
+end

data/lib/advanced_billing/models/tax_configuration_kind.rb

@@ -0,0 +1,29 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Tax Configuration Kind.
+  class TaxConfigurationKind
+    TAX_CONFIGURATION_KIND = [
+      # TODO: Write general description for CUSTOM
+      CUSTOM = 'custom'.freeze,
+
+      # TODO: Write general description for ENUM_MANAGED_AVALARA
+      ENUM_MANAGED_AVALARA = 'managed avalara'.freeze,
+
+      # TODO: Write general description for ENUM_LINKED_AVALARA
+      ENUM_LINKED_AVALARA = 'linked avalara'.freeze,
+
+      # TODO: Write general description for ENUM_DIGITAL_RIVER
+      ENUM_DIGITAL_RIVER = 'digital river'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TAX_CONFIGURATION_KIND.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/tax_destination_address.rb

@@ -0,0 +1,29 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Tax Destination Address.
+  class TaxDestinationAddress
+    TAX_DESTINATION_ADDRESS = [
+      # TODO: Write general description for SHIPPING_THEN_BILLING
+      SHIPPING_THEN_BILLING = 'shipping_then_billing'.freeze,
+
+      # TODO: Write general description for BILLING_THEN_SHIPPING
+      BILLING_THEN_SHIPPING = 'billing_then_shipping'.freeze,
+
+      # TODO: Write general description for SHIPPING_ONLY
+      SHIPPING_ONLY = 'shipping_only'.freeze,
+
+      # TODO: Write general description for BILLING_ONLY
+      BILLING_ONLY = 'billing_only'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TAX_DESTINATION_ADDRESS.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/too_many_management_link_requests.rb

@@ -0,0 +1,63 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # TooManyManagementLinkRequests Model.
+  class TooManyManagementLinkRequests < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :new_link_available_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error'] = 'error'
+      @_hash['new_link_available_at'] = 'new_link_available_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error = nil, new_link_available_at = nil)
+      @error = error
+      @new_link_available_at = new_link_available_at
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      error = hash.key?('error') ? hash['error'] : nil
+      new_link_available_at = if hash.key?('new_link_available_at')
+                                (DateTimeHelper.from_rfc3339(hash['new_link_available_at']) if hash['new_link_available_at'])
+                              end
+
+      # Create object from extracted values.
+      TooManyManagementLinkRequests.new(error,
+                                        new_link_available_at)
+    end
+
+    def to_custom_new_link_available_at
+      DateTimeHelper.to_rfc3339(new_link_available_at)
+    end
+  end
+end

data/lib/advanced_billing/models/update_allocation_expiration_date.rb

@@ -0,0 +1,50 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateAllocationExpirationDate Model.
+  class UpdateAllocationExpirationDate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AllocationExpirationDate]
+    attr_accessor :allocation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['allocation'] = 'allocation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        allocation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(allocation = SKIP)
+      @allocation = allocation unless allocation == 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.
+      allocation = AllocationExpirationDate.from_hash(hash['allocation']) if hash['allocation']
+
+      # Create object from extracted values.
+      UpdateAllocationExpirationDate.new(allocation)
+    end
+  end
+end

data/lib/advanced_billing/models/update_component.rb

@@ -0,0 +1,137 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateComponent Model.
+  class UpdateComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handle
+
+    # The name of the Component, suitable for display on statements. i.e. Text
+    # Messages.
+    # @return [String]
+    attr_accessor :name
+
+    # The description of the component.
+    # @return [String]
+    attr_accessor :description
+
+    # The description of the component.
+    # @return [String]
+    attr_accessor :accounting_code
+
+    # Boolean flag describing whether a component is taxable or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :taxable
+
+    # A string representing the tax code related to the component type. This is
+    # especially important when using the Avalara service to tax based on
+    # locale. This attribute has a max length of 10 characters.
+    # @return [String]
+    attr_accessor :tax_code
+
+    # One of the following: Business Software, Consumer Software, Digital
+    # Services, Physical Goods, Other
+    # @return [ItemCategory]
+    attr_accessor :item_category
+
+    # One of the following: Business Software, Consumer Software, Digital
+    # Services, Physical Goods, Other
+    # @return [TrueClass | FalseClass]
+    attr_accessor :display_on_hosted_page
+
+    # The type of charge to be applied when a component is upgraded. Valid
+    # values are: `prorated`, `full`, `none`.
+    # @return [CreditType]
+    attr_accessor :upgrade_charge
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['handle'] = 'handle'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['accounting_code'] = 'accounting_code'
+      @_hash['taxable'] = 'taxable'
+      @_hash['tax_code'] = 'tax_code'
+      @_hash['item_category'] = 'item_category'
+      @_hash['display_on_hosted_page'] = 'display_on_hosted_page'
+      @_hash['upgrade_charge'] = 'upgrade_charge'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        handle
+        name
+        description
+        accounting_code
+        taxable
+        tax_code
+        item_category
+        display_on_hosted_page
+        upgrade_charge
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        tax_code
+      ]
+    end
+
+    def initialize(handle = SKIP, name = SKIP, description = SKIP,
+                   accounting_code = SKIP, taxable = SKIP, tax_code = SKIP,
+                   item_category = SKIP, display_on_hosted_page = SKIP,
+                   upgrade_charge = SKIP)
+      @handle = handle unless handle == SKIP
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @accounting_code = accounting_code unless accounting_code == SKIP
+      @taxable = taxable unless taxable == SKIP
+      @tax_code = tax_code unless tax_code == SKIP
+      @item_category = item_category unless item_category == SKIP
+      @display_on_hosted_page = display_on_hosted_page unless display_on_hosted_page == SKIP
+      @upgrade_charge = upgrade_charge unless upgrade_charge == 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.
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      accounting_code =
+        hash.key?('accounting_code') ? hash['accounting_code'] : SKIP
+      taxable = hash.key?('taxable') ? hash['taxable'] : SKIP
+      tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
+      item_category = hash.key?('item_category') ? hash['item_category'] : SKIP
+      display_on_hosted_page =
+        hash.key?('display_on_hosted_page') ? hash['display_on_hosted_page'] : SKIP
+      upgrade_charge =
+        hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
+
+      # Create object from extracted values.
+      UpdateComponent.new(handle,
+                          name,
+                          description,
+                          accounting_code,
+                          taxable,
+                          tax_code,
+                          item_category,
+                          display_on_hosted_page,
+                          upgrade_charge)
+    end
+  end
+end

data/lib/advanced_billing/models/update_component_price_point.rb

@@ -0,0 +1,68 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateComponentPricePoint Model.
+  class UpdateComponentPricePoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [Array[UpdatePrice]]
+    attr_accessor :prices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['prices'] = 'prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, prices = SKIP)
+      @name = name unless name == SKIP
+      @prices = prices unless prices == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (UpdatePrice.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+
+      # Create object from extracted values.
+      UpdateComponentPricePoint.new(name,
+                                    prices)
+    end
+  end
+end

data/lib/advanced_billing/models/update_component_price_point_request.rb

@@ -0,0 +1,51 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateComponentPricePointRequest Model.
+  class UpdateComponentPricePointRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UpdateComponentPricePoint]
+    attr_accessor :price_point
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price_point'] = 'price_point'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        price_point
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price_point = SKIP)
+      @price_point = price_point unless price_point == 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.
+      price_point = UpdateComponentPricePoint.from_hash(hash['price_point']) if
+        hash['price_point']
+
+      # Create object from extracted values.
+      UpdateComponentPricePointRequest.new(price_point)
+    end
+  end
+end

data/lib/advanced_billing/models/update_component_request.rb

@@ -0,0 +1,48 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateComponentRequest Model.
+  class UpdateComponentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UpdateComponent]
+    attr_accessor :component
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component'] = 'component'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(component = nil)
+      @component = component
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      component = UpdateComponent.from_hash(hash['component']) if hash['component']
+
+      # Create object from extracted values.
+      UpdateComponentRequest.new(component)
+    end
+  end
+end

data/lib/advanced_billing/models/update_coupon_currency.rb

@@ -0,0 +1,56 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # UpdateCouponCurrency Model.
+  class UpdateCouponCurrency < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO code for the site defined currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # Price for the given currency.
+    # @return [Integer]
+    attr_accessor :price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['price'] = 'price'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency = nil, price = nil)
+      @currency = currency
+      @price = price
+    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
+      price = hash.key?('price') ? hash['price'] : nil
+
+      # Create object from extracted values.
+      UpdateCouponCurrency.new(currency,
+                               price)
+    end
+  end
+end