newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/exemption_class_enum.rb

@@ -0,0 +1,87 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The tax exemption class that identifies the customer's group/organization
+  # that accredited them with the tax exemption status. * For custom tax
+  # exemption classes, the `CUSTOM_` prefix with a UPPER_SNAKE_CASE key can be
+  # used. Example: `CUSTOM_CANADA`
+  class ExemptionClassEnum
+    EXEMPTION_CLASS_ENUM = [
+      # TODO: Write general description for FEDERAL_GOVERNMENT
+      FEDERAL_GOVERNMENT = 'FEDERAL_GOVERNMENT'.freeze,
+
+      # TODO: Write general description for STATE_GOVERNMENT
+      STATE_GOVERNMENT = 'STATE_GOVERNMENT'.freeze,
+
+      # TODO: Write general description for TRIBAL_GOVERNMENT
+      TRIBAL_GOVERNMENT = 'TRIBAL_GOVERNMENT'.freeze,
+
+      # TODO: Write general description for LOCAL_GOVERNMENT
+      LOCAL_GOVERNMENT = 'LOCAL_GOVERNMENT'.freeze,
+
+      # TODO: Write general description for FOREIGN_DIPLOMAT
+      FOREIGN_DIPLOMAT = 'FOREIGN_DIPLOMAT'.freeze,
+
+      # TODO: Write general description for CHARITY_ORGANIZATION
+      CHARITY_ORGANIZATION = 'CHARITY_ORGANIZATION'.freeze,
+
+      # TODO: Write general description for RELIGIOUS_ORGANIZATION
+      RELIGIOUS_ORGANIZATION = 'RELIGIOUS_ORGANIZATION'.freeze,
+
+      # TODO: Write general description for EDUCATIONAL_ORGANIZATION
+      EDUCATIONAL_ORGANIZATION = 'EDUCATIONAL_ORGANIZATION'.freeze,
+
+      # TODO: Write general description for RESALE
+      RESALE = 'RESALE'.freeze,
+
+      # TODO: Write general description for DIRECT_PAY_PERMIT
+      DIRECT_PAY_PERMIT = 'DIRECT_PAY_PERMIT'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for NON_RESIDENT
+      NON_RESIDENT = 'NON_RESIDENT'.freeze,
+
+      # TODO: Write general description for FIRST_NATION_CITIZEN
+      FIRST_NATION_CITIZEN = 'FIRST_NATION_CITIZEN'.freeze,
+
+      # TODO: Write general description for ENUM_CUSTOM_
+      ENUM_CUSTOM_ = 'CUSTOM_*'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXEMPTION_CLASS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = FEDERAL_GOVERNMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'federal_government' then FEDERAL_GOVERNMENT
+      when 'state_government' then STATE_GOVERNMENT
+      when 'tribal_government' then TRIBAL_GOVERNMENT
+      when 'local_government' then LOCAL_GOVERNMENT
+      when 'foreign_diplomat' then FOREIGN_DIPLOMAT
+      when 'charity_organization' then CHARITY_ORGANIZATION
+      when 'religious_organization' then RELIGIOUS_ORGANIZATION
+      when 'educational_organization' then EDUCATIONAL_ORGANIZATION
+      when 'resale' then RESALE
+      when 'direct_pay_permit' then DIRECT_PAY_PERMIT
+      when 'other' then OTHER
+      when 'non_resident' then NON_RESIDENT
+      when 'first_nation_citizen' then FIRST_NATION_CITIZEN
+      when 'enum_custom_' then ENUM_CUSTOM_
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/exemption_class_item_create_dto.rb

@@ -0,0 +1,115 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ExemptionClassItemCreateDto Model.
+  class ExemptionClassItemCreateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Display text to be used in Associate App while rendering the exemption
+    # class.
+    # * Required for custom tax exemption classes.
+    # * Optional for pre-defined tax exemption classes.
+    # * Keys must be a valid ISO 639-1 language code.
+    # * Must include English translation by default.
+    # @return [Hash[String, Object]]
+    attr_accessor :display_text
+
+    # Display text to be used in Associate App while rendering the exemption
+    # class.
+    # * Required for custom tax exemption classes.
+    # * Optional for pre-defined tax exemption classes.
+    # * Keys must be a valid ISO 639-1 language code.
+    # * Must include English translation by default.
+    # @return [ExemptionClassEnum]
+    attr_accessor :exemption_class
+
+    # The list of countries where this tax exemption class is valid.
+    # @return [Array[TaxExemptionCountryCodeEnum]]
+    attr_accessor :valid_countries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_text'] = 'display_text'
+      @_hash['exemption_class'] = 'exemption_class'
+      @_hash['valid_countries'] = 'valid_countries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(exemption_class = nil, valid_countries = nil,
+                   display_text = SKIP)
+      @display_text = display_text unless display_text == SKIP
+      @exemption_class = exemption_class
+      @valid_countries = valid_countries
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      exemption_class =
+        hash.key?('exemption_class') ? hash['exemption_class'] : nil
+      valid_countries =
+        hash.key?('valid_countries') ? hash['valid_countries'] : nil
+      display_text = hash.key?('display_text') ? hash['display_text'] : SKIP
+
+      # Create object from extracted values.
+      ExemptionClassItemCreateDto.new(exemption_class,
+                                      valid_countries,
+                                      display_text)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ExemptionClassItemCreateDto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.exemption_class,
+                                ->(val) { ExemptionClassEnum.validate(val) }) and
+            APIHelper.valid_type?(value.valid_countries,
+                                  ->(val) { TaxExemptionCountryCodeEnum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['exemption_class'],
+                              ->(val) { ExemptionClassEnum.validate(val) }) and
+          APIHelper.valid_type?(value['valid_countries'],
+                                ->(val) { TaxExemptionCountryCodeEnum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_text: #{@display_text}, exemption_class: #{@exemption_class},"\
+      " valid_countries: #{@valid_countries}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_text: #{@display_text.inspect}, exemption_class:"\
+      " #{@exemption_class.inspect}, valid_countries: #{@valid_countries.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/exemption_class_item_dto.rb

@@ -0,0 +1,115 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ExemptionClassItemDto Model.
+  class ExemptionClassItemDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Display text to be used in Associate App while rendering the exemption
+    # class.
+    # * Required for custom tax exemption classes.
+    # * Optional for pre-defined tax exemption classes.
+    # * Keys must be a valid ISO 639-1 language code.
+    # * Must include English translation by default.
+    # @return [Hash[String, Object]]
+    attr_accessor :display_text
+
+    # Display text to be used in Associate App while rendering the exemption
+    # class.
+    # * Required for custom tax exemption classes.
+    # * Optional for pre-defined tax exemption classes.
+    # * Keys must be a valid ISO 639-1 language code.
+    # * Must include English translation by default.
+    # @return [ExemptionClassEnum]
+    attr_accessor :exemption_class
+
+    # The list of countries where this tax exemption class is valid.
+    # @return [Array[TaxExemptionCountryCodeEnum]]
+    attr_accessor :valid_countries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_text'] = 'display_text'
+      @_hash['exemption_class'] = 'exemption_class'
+      @_hash['valid_countries'] = 'valid_countries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(exemption_class = nil, valid_countries = nil,
+                   display_text = SKIP)
+      @display_text = display_text unless display_text == SKIP
+      @exemption_class = exemption_class
+      @valid_countries = valid_countries
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      exemption_class =
+        hash.key?('exemption_class') ? hash['exemption_class'] : nil
+      valid_countries =
+        hash.key?('valid_countries') ? hash['valid_countries'] : nil
+      display_text = hash.key?('display_text') ? hash['display_text'] : SKIP
+
+      # Create object from extracted values.
+      ExemptionClassItemDto.new(exemption_class,
+                                valid_countries,
+                                display_text)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ExemptionClassItemDto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.exemption_class,
+                                ->(val) { ExemptionClassEnum.validate(val) }) and
+            APIHelper.valid_type?(value.valid_countries,
+                                  ->(val) { TaxExemptionCountryCodeEnum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['exemption_class'],
+                              ->(val) { ExemptionClassEnum.validate(val) }) and
+          APIHelper.valid_type?(value['valid_countries'],
+                                ->(val) { TaxExemptionCountryCodeEnum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_text: #{@display_text}, exemption_class: #{@exemption_class},"\
+      " valid_countries: #{@valid_countries}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_text: #{@display_text.inspect}, exemption_class:"\
+      " #{@exemption_class.inspect}, valid_countries: #{@valid_countries.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/exemption_class_item_extended_dto.rb

@@ -0,0 +1,104 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ExemptionClassItemExtendedDto Model.
+  class ExemptionClassItemExtendedDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Display text to be used in Associate App while rendering the exemption
+    # class.
+    # * Required for custom tax exemption classes.
+    # * Optional for pre-defined tax exemption classes.
+    # * Keys must be a valid ISO 639-1 language code.
+    # * Must include English translation by default.
+    # @return [Hash[String, Object]]
+    attr_accessor :display_text
+
+    # Display text to be used in Associate App while rendering the exemption
+    # class.
+    # * Required for custom tax exemption classes.
+    # * Optional for pre-defined tax exemption classes.
+    # * Keys must be a valid ISO 639-1 language code.
+    # * Must include English translation by default.
+    # @return [ExemptionClassEnum]
+    attr_accessor :exemption_class
+
+    # The code that will be sent to the underlying tax provider (Avalara or
+    # Vertex) during tax exempted requests if the the relevant `exemption_class`
+    # is selected
+    # @return [String]
+    attr_accessor :provider_code
+
+    # The list of countries where this tax exemption class is valid.
+    # @return [Array[TaxExemptionCountryCodeEnum]]
+    attr_accessor :valid_countries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_text'] = 'display_text'
+      @_hash['exemption_class'] = 'exemption_class'
+      @_hash['provider_code'] = 'provider_code'
+      @_hash['valid_countries'] = 'valid_countries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(exemption_class = nil, provider_code = nil,
+                   valid_countries = nil, display_text = SKIP)
+      @display_text = display_text unless display_text == SKIP
+      @exemption_class = exemption_class
+      @provider_code = provider_code
+      @valid_countries = valid_countries
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      exemption_class =
+        hash.key?('exemption_class') ? hash['exemption_class'] : nil
+      provider_code = hash.key?('provider_code') ? hash['provider_code'] : nil
+      valid_countries =
+        hash.key?('valid_countries') ? hash['valid_countries'] : nil
+      display_text = hash.key?('display_text') ? hash['display_text'] : SKIP
+
+      # Create object from extracted values.
+      ExemptionClassItemExtendedDto.new(exemption_class,
+                                        provider_code,
+                                        valid_countries,
+                                        display_text)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_text: #{@display_text}, exemption_class: #{@exemption_class},"\
+      " provider_code: #{@provider_code}, valid_countries: #{@valid_countries}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_text: #{@display_text.inspect}, exemption_class:"\
+      " #{@exemption_class.inspect}, provider_code: #{@provider_code.inspect}, valid_countries:"\
+      " #{@valid_countries.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/exemption_class_item_update_dto.rb

@@ -0,0 +1,93 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ExemptionClassItemUpdateDto Model.
+  class ExemptionClassItemUpdateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Display text to be used in Associate App while rendering the exemption
+    # class.
+    # * Required for custom tax exemption classes.
+    # * Optional for pre-defined tax exemption classes.
+    # * Keys must be a valid ISO 639-1 language code.
+    # * Must include English translation by default.
+    # @return [Hash[String, Object]]
+    attr_accessor :display_text
+
+    # Display text to be used in Associate App while rendering the exemption
+    # class.
+    # * Required for custom tax exemption classes.
+    # * Optional for pre-defined tax exemption classes.
+    # * Keys must be a valid ISO 639-1 language code.
+    # * Must include English translation by default.
+    # @return [ExemptionClassEnum]
+    attr_accessor :exemption_class
+
+    # The list of countries where this tax exemption class is valid.
+    # @return [Array[TaxExemptionCountryCodeEnum]]
+    attr_accessor :valid_countries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_text'] = 'display_text'
+      @_hash['exemption_class'] = 'exemption_class'
+      @_hash['valid_countries'] = 'valid_countries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(exemption_class = nil, valid_countries = nil,
+                   display_text = SKIP)
+      @display_text = display_text unless display_text == SKIP
+      @exemption_class = exemption_class
+      @valid_countries = valid_countries
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      exemption_class =
+        hash.key?('exemption_class') ? hash['exemption_class'] : nil
+      valid_countries =
+        hash.key?('valid_countries') ? hash['valid_countries'] : nil
+      display_text = hash.key?('display_text') ? hash['display_text'] : SKIP
+
+      # Create object from extracted values.
+      ExemptionClassItemUpdateDto.new(exemption_class,
+                                      valid_countries,
+                                      display_text)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_text: #{@display_text}, exemption_class: #{@exemption_class},"\
+      " valid_countries: #{@valid_countries}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} display_text: #{@display_text.inspect}, exemption_class:"\
+      " #{@exemption_class.inspect}, valid_countries: #{@valid_countries.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/exemption_class_mapping_it_v1_dto.rb

@@ -0,0 +1,97 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ExemptionClassMappingItV1Dto Model.
+  class ExemptionClassMappingItV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Tax exemption class.
+    # * Tax exemption class that is set for the order when tax exemption is
+    # applied to the cart.
+    # @return [String]
+    attr_accessor :exemption_class
+
+    # Tax exemption class.
+    # * Tax exemption class that is set for the order when tax exemption is
+    # applied to the cart.
+    # @return [ExemptionCodeItEnum]
+    attr_accessor :exemption_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['exemption_class'] = 'exemption_class'
+      @_hash['exemption_code'] = 'exemption_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(exemption_class = nil, exemption_code = nil)
+      @exemption_class = exemption_class
+      @exemption_code = exemption_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      exemption_class =
+        hash.key?('exemption_class') ? hash['exemption_class'] : nil
+      exemption_code =
+        hash.key?('exemption_code') ? hash['exemption_code'] : nil
+
+      # Create object from extracted values.
+      ExemptionClassMappingItV1Dto.new(exemption_class,
+                                       exemption_code)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ExemptionClassMappingItV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.exemption_class,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.exemption_code,
+                                  ->(val) { ExemptionCodeItEnum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['exemption_class'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['exemption_code'],
+                                ->(val) { ExemptionCodeItEnum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} exemption_class: #{@exemption_class}, exemption_code: #{@exemption_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} exemption_class: #{@exemption_class.inspect}, exemption_code:"\
+      " #{@exemption_code.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/exemption_code_it_enum.rb

@@ -0,0 +1,52 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Tax exemption (nature) codes applicable in Italy.
+  class ExemptionCodeItEnum
+    EXEMPTION_CODE_IT_ENUM = [
+      # TODO: Write general description for N1
+      N1 = 'N1'.freeze,
+
+      # TODO: Write general description for N2
+      N2 = 'N2'.freeze,
+
+      # TODO: Write general description for N3
+      N3 = 'N3'.freeze,
+
+      # TODO: Write general description for N4
+      N4 = 'N4'.freeze,
+
+      # TODO: Write general description for N5
+      N5 = 'N5'.freeze,
+
+      # TODO: Write general description for N6
+      N6 = 'N6'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXEMPTION_CODE_IT_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = N1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'n1' then N1
+      when 'n2' then N2
+      when 'n3' then N3
+      when 'n4' then N4
+      when 'n5' then N5
+      when 'n6' then N6
+      else
+        default_value
+      end
+    end
+  end
+end