newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/tenant_config_create_dto.rb

@@ -0,0 +1,168 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TenantConfigCreateDto Model.
+  class TenantConfigCreateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Avalara configuration.
+    # * Required if the `tax_calculation_strategy` is set to `avalara`.
+    # * If the tax calculation strategy is set to `avalara`, the given
+    # configuration will be used.
+    # * If the Avalara configuration is defined, the configuration will be
+    # validated through a ping request to Avalara, which will validate the
+    # authenticity of Avalara credentials.
+    # @return [AvalaraConfigCreateDto]
+    attr_accessor :avalara
+
+    # Custom provider configuration.
+    # * Required if the `tax_calculation_strategy` is set to `custom`.
+    # * If the tax calculation strategy is set to `custom`, the given
+    # configuration will be used.
+    # @return [CustomConfigCreateDto]
+    attr_accessor :custom
+
+    # Fixed rate configuration.
+    # * If the tax calculation strategy is set to `fixedrate`, the specified tax
+    # rate will be used.
+    # * For the other tax calculation strategies, the specified rate will be
+    # used as a fallback if the tax calculation fails (e.g. if the tax provider
+    # is not reachable).
+    # * The specified rate will be used as a fallback by the Associate App in
+    # offline-mode.
+    # @return [FixedRateConfigCreateDto]
+    attr_accessor :fixed_rate
+
+    # Fixed rate configuration per country.
+    # * Uses ISO 3166 Alpha-2 format as the key in upper-case.
+    # * Fixed rate specification can be defined under each country key for the
+    # desired countries.
+    # * If the tax calculation strategy is set to `fixed_rate_per_country`:
+    #   * Fixed rate configuration must be configured.
+    #   * The specified tax rate will be used if the country code of the store
+    # has a fixed rate configuration.
+    #   * The tax calculation will fail if the country code of the store does
+    # not have a fixed rate configuration.
+    # @return [Hash[String, FixedRateConfigCreateDto]]
+    attr_accessor :fixed_rate_per_country
+
+    # Fixed rate configuration per country.
+    # * Uses ISO 3166 Alpha-2 format as the key in upper-case.
+    # * Fixed rate specification can be defined under each country key for the
+    # desired countries.
+    # * If the tax calculation strategy is set to `fixed_rate_per_country`:
+    #   * Fixed rate configuration must be configured.
+    #   * The specified tax rate will be used if the country code of the store
+    # has a fixed rate configuration.
+    #   * The tax calculation will fail if the country code of the store does
+    # not have a fixed rate configuration.
+    # @return [TaxCalculationStrategyEnum]
+    attr_accessor :tax_calculation_strategy
+
+    # Enable tax committing to the selected tax calculation strategy. The tax
+    # committing feature is only supported for in-store orders.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_committing_enabled
+
+    # Vertex configuration.
+    # * Required if the `tax_calculation_strategy` is set to `vertex`.
+    # * If the tax calculation strategy is set to `vertex`, the given
+    # configuration will be used.
+    # * If the Vertex configuration is defined, the configuration will be
+    # validated through a ping request to Vertex, which will validate the
+    # authenticity of Vertex credentials.
+    # @return [VertexConfigCreateDto]
+    attr_accessor :vertex
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['avalara'] = 'avalara'
+      @_hash['custom'] = 'custom'
+      @_hash['fixed_rate'] = 'fixed_rate'
+      @_hash['fixed_rate_per_country'] = 'fixed_rate_per_country'
+      @_hash['tax_calculation_strategy'] = 'tax_calculation_strategy'
+      @_hash['tax_committing_enabled'] = 'tax_committing_enabled'
+      @_hash['vertex'] = 'vertex'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        avalara
+        custom
+        fixed_rate_per_country
+        tax_committing_enabled
+        vertex
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fixed_rate = nil, tax_calculation_strategy = nil,
+                   avalara = SKIP, custom = SKIP, fixed_rate_per_country = SKIP,
+                   tax_committing_enabled = SKIP, vertex = SKIP)
+      @avalara = avalara unless avalara == SKIP
+      @custom = custom unless custom == SKIP
+      @fixed_rate = fixed_rate
+      @fixed_rate_per_country = fixed_rate_per_country unless fixed_rate_per_country == SKIP
+      @tax_calculation_strategy = tax_calculation_strategy
+      @tax_committing_enabled = tax_committing_enabled unless tax_committing_enabled == SKIP
+      @vertex = vertex unless vertex == 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.
+      fixed_rate = FixedRateConfigCreateDto.from_hash(hash['fixed_rate']) if hash['fixed_rate']
+      tax_calculation_strategy =
+        hash.key?('tax_calculation_strategy') ? hash['tax_calculation_strategy'] : nil
+      avalara = AvalaraConfigCreateDto.from_hash(hash['avalara']) if hash['avalara']
+      custom = CustomConfigCreateDto.from_hash(hash['custom']) if hash['custom']
+      fixed_rate_per_country = FixedRateConfigCreateDto.from_hash(hash['fixed_rate_per_country']) if
+        hash['fixed_rate_per_country']
+
+      fixed_rate_per_country = SKIP unless hash.key?('fixed_rate_per_country')
+      tax_committing_enabled =
+        hash.key?('tax_committing_enabled') ? hash['tax_committing_enabled'] : SKIP
+      vertex = VertexConfigCreateDto.from_hash(hash['vertex']) if hash['vertex']
+
+      # Create object from extracted values.
+      TenantConfigCreateDto.new(fixed_rate,
+                                tax_calculation_strategy,
+                                avalara,
+                                custom,
+                                fixed_rate_per_country,
+                                tax_committing_enabled,
+                                vertex)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avalara: #{@avalara}, custom: #{@custom}, fixed_rate: #{@fixed_rate},"\
+      " fixed_rate_per_country: #{@fixed_rate_per_country}, tax_calculation_strategy:"\
+      " #{@tax_calculation_strategy}, tax_committing_enabled: #{@tax_committing_enabled}, vertex:"\
+      " #{@vertex}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avalara: #{@avalara.inspect}, custom: #{@custom.inspect}, fixed_rate:"\
+      " #{@fixed_rate.inspect}, fixed_rate_per_country: #{@fixed_rate_per_country.inspect},"\
+      " tax_calculation_strategy: #{@tax_calculation_strategy.inspect}, tax_committing_enabled:"\
+      " #{@tax_committing_enabled.inspect}, vertex: #{@vertex.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/tenant_config_dto.rb

@@ -0,0 +1,230 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # TenantConfigDto Model.
+  class TenantConfigDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Avalara configuration.
+    # * Required if the `tax_calculation_strategy` is set to `avalara`.
+    # * If the tax calculation strategy is set to `avalara`, the given
+    # configuration will be used.
+    # * If the Avalara configuration is defined, the configuration will be
+    # validated through a ping request to Avalara, which will validate the
+    # authenticity of Avalara credentials.
+    # @return [AvalaraConfigDto]
+    attr_accessor :avalara
+
+    # Creation date of the configuration.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Custom provider configuration.
+    # * Required if the `tax_calculation_strategy` is set to `custom`.
+    # * If the tax calculation strategy is set to `custom`, the given
+    # configuration will be used.
+    # @return [CustomConfigDto]
+    attr_accessor :custom
+
+    # Fixed rate configuration.
+    # * If the tax calculation strategy is set to `fixedrate`, the specified tax
+    # rate will be used.
+    # * For the other tax calculation strategies, the specified rate will be
+    # used as a fallback if the tax calculation fails (e.g. if the tax provider
+    # is not reachable).
+    # * The specified rate will be used as a fallback by the Associate App in
+    # offline-mode.
+    # @return [FixedRateConfigDto]
+    attr_accessor :fixed_rate
+
+    # Fixed rate configuration per country.
+    # * Uses ISO 3166 Alpha-2 format as the key in upper-case.
+    # * Fixed rate specification can be defined under each country key for the
+    # desired countries.
+    # * If the tax calculation strategy is set to `fixed_rate_per_country`:
+    #   * Fixed rate configuration must be configured.
+    #   * The specified tax rate will be used if the country code of the store
+    # has a fixed rate configuration.
+    #   * The tax calculation will fail if the country code of the store does
+    # not have a fixed rate configuration.
+    # @return [Hash[String, FixedRateConfigCreateDto]]
+    attr_accessor :fixed_rate_per_country
+
+    # Flag that indicates if the configuration was deleted.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_deleted
+
+    # Flag that indicates if the configuration was deleted.
+    # @return [TaxCalculationStrategyEnum]
+    attr_accessor :tax_calculation_strategy
+
+    # Enable tax committing to the selected tax calculation strategy. The tax
+    # committing feature is only supported for in-store orders.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_committing_enabled
+
+    # Tenant identifier.
+    # @return [String]
+    attr_accessor :tenant
+
+    # Latest update date of the configuration.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # Identifier of the user who updated the current version of the
+    # configuration.
+    # @return [String]
+    attr_accessor :updated_by
+
+    # Version number of the config.
+    # * Version number 0 represents the system defaults.
+    # @return [Integer]
+    attr_accessor :version
+
+    # Vertex configuration.
+    # * Required if the `tax_calculation_strategy` is set to `vertex`.
+    # * If the tax calculation strategy is set to `vertex`, the given
+    # configuration will be used.
+    # * If the Vertex configuration is defined, the configuration will be
+    # validated through a ping request to Vertex, which will validate the
+    # authenticity of Vertex credentials.
+    # @return [VertexConfigDto]
+    attr_accessor :vertex
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['avalara'] = 'avalara'
+      @_hash['created_at'] = 'created_at'
+      @_hash['custom'] = 'custom'
+      @_hash['fixed_rate'] = 'fixed_rate'
+      @_hash['fixed_rate_per_country'] = 'fixed_rate_per_country'
+      @_hash['is_deleted'] = 'is_deleted'
+      @_hash['tax_calculation_strategy'] = 'tax_calculation_strategy'
+      @_hash['tax_committing_enabled'] = 'tax_committing_enabled'
+      @_hash['tenant'] = 'tenant'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['updated_by'] = 'updated_by'
+      @_hash['version'] = 'version'
+      @_hash['vertex'] = 'vertex'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        avalara
+        custom
+        fixed_rate_per_country
+        is_deleted
+        tax_committing_enabled
+        vertex
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_at = nil, fixed_rate = nil,
+                   tax_calculation_strategy = nil, tenant = nil,
+                   updated_at = nil, updated_by = nil, version = nil,
+                   avalara = SKIP, custom = SKIP, fixed_rate_per_country = SKIP,
+                   is_deleted = SKIP, tax_committing_enabled = SKIP,
+                   vertex = SKIP)
+      @avalara = avalara unless avalara == SKIP
+      @created_at = created_at
+      @custom = custom unless custom == SKIP
+      @fixed_rate = fixed_rate
+      @fixed_rate_per_country = fixed_rate_per_country unless fixed_rate_per_country == SKIP
+      @is_deleted = is_deleted unless is_deleted == SKIP
+      @tax_calculation_strategy = tax_calculation_strategy
+      @tax_committing_enabled = tax_committing_enabled unless tax_committing_enabled == SKIP
+      @tenant = tenant
+      @updated_at = updated_at
+      @updated_by = updated_by
+      @version = version
+      @vertex = vertex unless vertex == 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.
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      fixed_rate = FixedRateConfigDto.from_hash(hash['fixed_rate']) if hash['fixed_rate']
+      tax_calculation_strategy =
+        hash.key?('tax_calculation_strategy') ? hash['tax_calculation_strategy'] : nil
+      tenant = hash.key?('tenant') ? hash['tenant'] : nil
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+      updated_by = hash.key?('updated_by') ? hash['updated_by'] : nil
+      version = hash.key?('version') ? hash['version'] : nil
+      avalara = AvalaraConfigDto.from_hash(hash['avalara']) if hash['avalara']
+      custom = CustomConfigDto.from_hash(hash['custom']) if hash['custom']
+      fixed_rate_per_country = FixedRateConfigCreateDto.from_hash(hash['fixed_rate_per_country']) if
+        hash['fixed_rate_per_country']
+
+      fixed_rate_per_country = SKIP unless hash.key?('fixed_rate_per_country')
+      is_deleted = hash.key?('is_deleted') ? hash['is_deleted'] : SKIP
+      tax_committing_enabled =
+        hash.key?('tax_committing_enabled') ? hash['tax_committing_enabled'] : SKIP
+      vertex = VertexConfigDto.from_hash(hash['vertex']) if hash['vertex']
+
+      # Create object from extracted values.
+      TenantConfigDto.new(created_at,
+                          fixed_rate,
+                          tax_calculation_strategy,
+                          tenant,
+                          updated_at,
+                          updated_by,
+                          version,
+                          avalara,
+                          custom,
+                          fixed_rate_per_country,
+                          is_deleted,
+                          tax_committing_enabled,
+                          vertex)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avalara: #{@avalara}, created_at: #{@created_at}, custom: #{@custom},"\
+      " fixed_rate: #{@fixed_rate}, fixed_rate_per_country: #{@fixed_rate_per_country},"\
+      " is_deleted: #{@is_deleted}, tax_calculation_strategy: #{@tax_calculation_strategy},"\
+      " tax_committing_enabled: #{@tax_committing_enabled}, tenant: #{@tenant}, updated_at:"\
+      " #{@updated_at}, updated_by: #{@updated_by}, version: #{@version}, vertex: #{@vertex}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avalara: #{@avalara.inspect}, created_at: #{@created_at.inspect}, custom:"\
+      " #{@custom.inspect}, fixed_rate: #{@fixed_rate.inspect}, fixed_rate_per_country:"\
+      " #{@fixed_rate_per_country.inspect}, is_deleted: #{@is_deleted.inspect},"\
+      " tax_calculation_strategy: #{@tax_calculation_strategy.inspect}, tax_committing_enabled:"\
+      " #{@tax_committing_enabled.inspect}, tenant: #{@tenant.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, updated_by: #{@updated_by.inspect}, version: #{@version.inspect},"\
+      " vertex: #{@vertex.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/tenant_config_update_dto.rb

@@ -0,0 +1,171 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # TenantConfigUpdateDto Model.
+  class TenantConfigUpdateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Avalara configuration.
+    # * Required if the `tax_calculation_strategy` is set to `avalara`.
+    # * If the tax calculation strategy is set to `avalara`, the given
+    # configuration will be used.
+    # * If the Avalara configuration is defined, the configuration will be
+    # validated through a ping request to Avalara, which will validate the
+    # authenticity of Avalara credentials.
+    # @return [AvalaraConfigUpdateDto]
+    attr_accessor :avalara
+
+    # Custom provider configuration.
+    # * Required if the `tax_calculation_strategy` is set to `custom`.
+    # * If the tax calculation strategy is set to `custom`, the given
+    # configuration will be used.
+    # @return [CustomConfigUpdateDto]
+    attr_accessor :custom
+
+    # Fixed rate configuration.
+    # * If the tax calculation strategy is set to `fixedrate`, the specified tax
+    # rate will be used.
+    # * For the other tax calculation strategies, the specified rate will be
+    # used as a fallback if the tax calculation fails (e.g. if the tax provider
+    # is not reachable).
+    # * The specified rate will be used as a fallback by the Associate App in
+    # offline-mode.
+    # @return [FixedRateConfigUpdateDto]
+    attr_accessor :fixed_rate
+
+    # Fixed rate configuration per country.
+    # * Uses ISO 3166 Alpha-2 format as the key in upper-case.
+    # * Fixed rate specification can be defined under each country key for the
+    # desired countries.
+    # * If the tax calculation strategy is set to `fixed_rate_per_country`:
+    #   * Fixed rate configuration must be configured.
+    #   * The specified tax rate will be used if the country code of the store
+    # has a fixed rate configuration.
+    #   * The tax calculation will fail if the country code of the store does
+    # not have a fixed rate configuration.
+    # @return [Hash[String, FixedRateConfigCreateDto]]
+    attr_accessor :fixed_rate_per_country
+
+    # Fixed rate configuration per country.
+    # * Uses ISO 3166 Alpha-2 format as the key in upper-case.
+    # * Fixed rate specification can be defined under each country key for the
+    # desired countries.
+    # * If the tax calculation strategy is set to `fixed_rate_per_country`:
+    #   * Fixed rate configuration must be configured.
+    #   * The specified tax rate will be used if the country code of the store
+    # has a fixed rate configuration.
+    #   * The tax calculation will fail if the country code of the store does
+    # not have a fixed rate configuration.
+    # @return [TaxCalculationStrategyEnum]
+    attr_accessor :tax_calculation_strategy
+
+    # Enable tax committing to the selected tax calculation strategy. The tax
+    # committing feature is only supported for in-store orders.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_committing_enabled
+
+    # Vertex configuration.
+    # * Required if the `tax_calculation_strategy` is set to `vertex`.
+    # * If the tax calculation strategy is set to `vertex`, the given
+    # configuration will be used.
+    # * If the Vertex configuration is defined, the configuration will be
+    # validated through a ping request to Vertex, which will validate the
+    # authenticity of Vertex credentials.
+    # @return [VertexConfigUpdateDto]
+    attr_accessor :vertex
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['avalara'] = 'avalara'
+      @_hash['custom'] = 'custom'
+      @_hash['fixed_rate'] = 'fixed_rate'
+      @_hash['fixed_rate_per_country'] = 'fixed_rate_per_country'
+      @_hash['tax_calculation_strategy'] = 'tax_calculation_strategy'
+      @_hash['tax_committing_enabled'] = 'tax_committing_enabled'
+      @_hash['vertex'] = 'vertex'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        avalara
+        custom
+        fixed_rate
+        fixed_rate_per_country
+        tax_calculation_strategy
+        tax_committing_enabled
+        vertex
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(avalara = SKIP, custom = SKIP, fixed_rate = SKIP,
+                   fixed_rate_per_country = SKIP,
+                   tax_calculation_strategy = SKIP,
+                   tax_committing_enabled = SKIP, vertex = SKIP)
+      @avalara = avalara unless avalara == SKIP
+      @custom = custom unless custom == SKIP
+      @fixed_rate = fixed_rate unless fixed_rate == SKIP
+      @fixed_rate_per_country = fixed_rate_per_country unless fixed_rate_per_country == SKIP
+      @tax_calculation_strategy = tax_calculation_strategy unless tax_calculation_strategy == SKIP
+      @tax_committing_enabled = tax_committing_enabled unless tax_committing_enabled == SKIP
+      @vertex = vertex unless vertex == 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.
+      avalara = AvalaraConfigUpdateDto.from_hash(hash['avalara']) if hash['avalara']
+      custom = CustomConfigUpdateDto.from_hash(hash['custom']) if hash['custom']
+      fixed_rate = FixedRateConfigUpdateDto.from_hash(hash['fixed_rate']) if hash['fixed_rate']
+      fixed_rate_per_country = FixedRateConfigCreateDto.from_hash(hash['fixed_rate_per_country']) if
+        hash['fixed_rate_per_country']
+
+      fixed_rate_per_country = SKIP unless hash.key?('fixed_rate_per_country')
+      tax_calculation_strategy =
+        hash.key?('tax_calculation_strategy') ? hash['tax_calculation_strategy'] : SKIP
+      tax_committing_enabled =
+        hash.key?('tax_committing_enabled') ? hash['tax_committing_enabled'] : SKIP
+      vertex = VertexConfigUpdateDto.from_hash(hash['vertex']) if hash['vertex']
+
+      # Create object from extracted values.
+      TenantConfigUpdateDto.new(avalara,
+                                custom,
+                                fixed_rate,
+                                fixed_rate_per_country,
+                                tax_calculation_strategy,
+                                tax_committing_enabled,
+                                vertex)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avalara: #{@avalara}, custom: #{@custom}, fixed_rate: #{@fixed_rate},"\
+      " fixed_rate_per_country: #{@fixed_rate_per_country}, tax_calculation_strategy:"\
+      " #{@tax_calculation_strategy}, tax_committing_enabled: #{@tax_committing_enabled}, vertex:"\
+      " #{@vertex}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avalara: #{@avalara.inspect}, custom: #{@custom.inspect}, fixed_rate:"\
+      " #{@fixed_rate.inspect}, fixed_rate_per_country: #{@fixed_rate_per_country.inspect},"\
+      " tax_calculation_strategy: #{@tax_calculation_strategy.inspect}, tax_committing_enabled:"\
+      " #{@tax_committing_enabled.inspect}, vertex: #{@vertex.inspect}>"
+    end
+  end
+end