newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/vertex_config_create_dto.rb

@@ -0,0 +1,227 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # VertexConfigCreateDto Model.
+  class VertexConfigCreateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Administrative origin information of the legal entity. Should be set based
+    # on the retailer corporate information.
+    # @return [VertexAdministrativeOriginCreateDto]
+    attr_accessor :administrative_origin
+
+    # Vertex taxpayer code of the company.
+    # * Identifies the top-level legal entity (company).
+    # * The value should be set to the taxpayer code of the top-level taxpayer
+    # (company).
+    # @return [String]
+    attr_accessor :company_code
+
+    # Vertex taxpayer code of the division.
+    # * Identifies the mid-level legal entity (division) under a top-level legal
+    # entity (company).
+    # * If exists, the value can be set to the taxpayer code of the mid-level
+    # taxpayer (division) under a top-level taxpayer (company).
+    # @return [String]
+    attr_accessor :division_code
+
+    # A list of mappings between `ExemptionClass` enum and Vertex class codes.
+    # @return [Array[VertexExemptionClassItemCreateDto]]
+    attr_accessor :exemption_classes
+
+    # The mapping between extended attributes of items in the NewStore platform
+    # and flexible fields as defined in Vertex.
+    # @return [Array[VertexFlexibleFieldConfigCreateDto]]
+    attr_accessor :flexible_fields
+
+    # Enable appending the jurisdiction name to the tax line's `tax_name` field.
+    # * This can help identify which jurisdiction imposed a given tax line.
+    # * Example: The tax name `Sales And Use Tax - Colorado` includes the
+    # jurisdiction name `Colorado` when the given flag is enabled.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :jurisdiction_in_tax_name_enabled
+
+    # Enable appending the jurisdiction name to the tax line's `tax_name` field.
+    # * This can help identify which jurisdiction imposed a given tax line.
+    # * Example: The tax name `Sales And Use Tax - Colorado` includes the
+    # jurisdiction name `Colorado` when the given flag is enabled.
+    # @return [VertexAuthLoginTypeEnum]
+    attr_accessor :login_type
+
+    # Password of the Vertex account.
+    # * Required if `login_type` is set to `user_and_password`.
+    # @return [String]
+    attr_accessor :password
+
+    # SOAP URL of the Vertex CalculateTax endpoint.
+    # @return [String]
+    attr_accessor :soap_url
+
+    # Trusted ID of the Vertex account.
+    # * Required if `login_type` is set to `trusted_id`.
+    # @return [String]
+    attr_accessor :trusted_id
+
+    # Use Vertex location code instead of address information.
+    # * When this value is set to `true` the NewStore platform will use the
+    # Store IDs to communicate origin and destination addresses instead of using
+    # standard address information (address line 1, postal code, etc.).
+    # * Store IDs are currently only available for cash & carry orders, all
+    # other order scenarios will use the standard address information to
+    # communicate origin and destination addresses even with this value set to
+    # `true`.
+    # * In case the NewStore Store ID length is longer than 20 characters,
+    # NewStore will only send the first 20 characters as Vertex field length is
+    # capped at that limit.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_location_code
+
+    # Username of the Vertex account.
+    # * Required if `login_type` is set to `user_and_password`.
+    # @return [String]
+    attr_accessor :username
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['administrative_origin'] = 'administrative_origin'
+      @_hash['company_code'] = 'company_code'
+      @_hash['division_code'] = 'division_code'
+      @_hash['exemption_classes'] = 'exemption_classes'
+      @_hash['flexible_fields'] = 'flexible_fields'
+      @_hash['jurisdiction_in_tax_name_enabled'] =
+        'jurisdiction_in_tax_name_enabled'
+      @_hash['login_type'] = 'login_type'
+      @_hash['password'] = 'password'
+      @_hash['soap_url'] = 'soap_url'
+      @_hash['trusted_id'] = 'trusted_id'
+      @_hash['use_location_code'] = 'use_location_code'
+      @_hash['username'] = 'username'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        administrative_origin
+        division_code
+        exemption_classes
+        flexible_fields
+        jurisdiction_in_tax_name_enabled
+        password
+        trusted_id
+        use_location_code
+        username
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(company_code = nil, login_type = nil, soap_url = nil,
+                   administrative_origin = SKIP, division_code = SKIP,
+                   exemption_classes = SKIP, flexible_fields = SKIP,
+                   jurisdiction_in_tax_name_enabled = SKIP, password = SKIP,
+                   trusted_id = SKIP, use_location_code = false,
+                   username = SKIP)
+      @administrative_origin = administrative_origin unless administrative_origin == SKIP
+      @company_code = company_code
+      @division_code = division_code unless division_code == SKIP
+      @exemption_classes = exemption_classes unless exemption_classes == SKIP
+      @flexible_fields = flexible_fields unless flexible_fields == SKIP
+      unless jurisdiction_in_tax_name_enabled == SKIP
+        @jurisdiction_in_tax_name_enabled =
+          jurisdiction_in_tax_name_enabled
+      end
+      @login_type = login_type
+      @password = password unless password == SKIP
+      @soap_url = soap_url
+      @trusted_id = trusted_id unless trusted_id == SKIP
+      @use_location_code = use_location_code unless use_location_code == SKIP
+      @username = username unless username == 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.
+      company_code = hash.key?('company_code') ? hash['company_code'] : nil
+      login_type = hash.key?('login_type') ? hash['login_type'] : nil
+      soap_url = hash.key?('soap_url') ? hash['soap_url'] : nil
+      if hash['administrative_origin']
+        administrative_origin = VertexAdministrativeOriginCreateDto.from_hash(hash['administrative_origin'])
+      end
+      division_code = hash.key?('division_code') ? hash['division_code'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      exemption_classes = nil
+      unless hash['exemption_classes'].nil?
+        exemption_classes = []
+        hash['exemption_classes'].each do |structure|
+          exemption_classes << (VertexExemptionClassItemCreateDto.from_hash(structure) if structure)
+        end
+      end
+
+      exemption_classes = SKIP unless hash.key?('exemption_classes')
+      # Parameter is an array, so we need to iterate through it
+      flexible_fields = nil
+      unless hash['flexible_fields'].nil?
+        flexible_fields = []
+        hash['flexible_fields'].each do |structure|
+          flexible_fields << (VertexFlexibleFieldConfigCreateDto.from_hash(structure) if structure)
+        end
+      end
+
+      flexible_fields = SKIP unless hash.key?('flexible_fields')
+      jurisdiction_in_tax_name_enabled =
+        hash.key?('jurisdiction_in_tax_name_enabled') ? hash['jurisdiction_in_tax_name_enabled'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+      trusted_id = hash.key?('trusted_id') ? hash['trusted_id'] : SKIP
+      use_location_code = hash['use_location_code'] ||= false
+      username = hash.key?('username') ? hash['username'] : SKIP
+
+      # Create object from extracted values.
+      VertexConfigCreateDto.new(company_code,
+                                login_type,
+                                soap_url,
+                                administrative_origin,
+                                division_code,
+                                exemption_classes,
+                                flexible_fields,
+                                jurisdiction_in_tax_name_enabled,
+                                password,
+                                trusted_id,
+                                use_location_code,
+                                username)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} administrative_origin: #{@administrative_origin}, company_code:"\
+      " #{@company_code}, division_code: #{@division_code}, exemption_classes:"\
+      " #{@exemption_classes}, flexible_fields: #{@flexible_fields},"\
+      " jurisdiction_in_tax_name_enabled: #{@jurisdiction_in_tax_name_enabled}, login_type:"\
+      " #{@login_type}, password: #{@password}, soap_url: #{@soap_url}, trusted_id:"\
+      " #{@trusted_id}, use_location_code: #{@use_location_code}, username: #{@username}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} administrative_origin: #{@administrative_origin.inspect}, company_code:"\
+      " #{@company_code.inspect}, division_code: #{@division_code.inspect}, exemption_classes:"\
+      " #{@exemption_classes.inspect}, flexible_fields: #{@flexible_fields.inspect},"\
+      " jurisdiction_in_tax_name_enabled: #{@jurisdiction_in_tax_name_enabled.inspect},"\
+      " login_type: #{@login_type.inspect}, password: #{@password.inspect}, soap_url:"\
+      " #{@soap_url.inspect}, trusted_id: #{@trusted_id.inspect}, use_location_code:"\
+      " #{@use_location_code.inspect}, username: #{@username.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/vertex_config_dto.rb

@@ -0,0 +1,253 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # VertexConfigDto Model.
+  class VertexConfigDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Administrative origin information of the legal entity. Should be set based
+    # on the retailer corporate information.
+    # @return [VertexAdministrativeOriginDto]
+    attr_accessor :administrative_origin
+
+    # Vertex taxpayer code of the company.
+    # * Identifies the top-level legal entity (company).
+    # * The value should be set to the taxpayer code of the top-level taxpayer
+    # (company).
+    # @return [String]
+    attr_accessor :company_code
+
+    # Vertex taxpayer code of the division.
+    # * Identifies the mid-level legal entity (division) under a top-level legal
+    # entity (company).
+    # * If exists, the value can be set to the taxpayer code of the mid-level
+    # taxpayer (division) under a top-level taxpayer (company).
+    # @return [String]
+    attr_accessor :division_code
+
+    # A list of mappings between `ExemptionClass` enum and Vertex class codes.
+    # @return [Array[VertexExemptionClassItemDto]]
+    attr_accessor :exemption_classes
+
+    # The mapping between extended attributes of items in the NewStore platform
+    # and flexible fields as defined in Vertex.
+    # @return [Array[VertexFlexibleFieldConfigDto]]
+    attr_accessor :flexible_fields
+
+    # Enable appending the jurisdiction name to the tax line's `tax_name` field.
+    # * This can help identify which jurisdiction imposed a given tax line.
+    # * Example: The tax name `Sales And Use Tax - Colorado` includes the
+    # jurisdiction name `Colorado` when the given flag is enabled.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :jurisdiction_in_tax_name_enabled
+
+    # Enable appending the jurisdiction name to the tax line's `tax_name` field.
+    # * This can help identify which jurisdiction imposed a given tax line.
+    # * Example: The tax name `Sales And Use Tax - Colorado` includes the
+    # jurisdiction name `Colorado` when the given flag is enabled.
+    # @return [VertexAuthLoginTypeEnum]
+    attr_accessor :login_type
+
+    # Password of the Vertex account.
+    # * Required if `login_type` is set to `user_and_password`.
+    # @return [String]
+    attr_accessor :password
+
+    # SOAP URL of the Vertex CalculateTax endpoint.
+    # @return [String]
+    attr_accessor :soap_url
+
+    # Trusted ID of the Vertex account.
+    # * Required if `login_type` is set to `trusted_id`.
+    # @return [String]
+    attr_accessor :trusted_id
+
+    # Use Vertex location code instead of address information.
+    # * When this value is set to `true` the NewStore platform will use the
+    # Store IDs to communicate origin and destination addresses instead of using
+    # standard address information (address line 1, postal code, etc.).
+    # * Store IDs are currently only available for cash & carry orders, all
+    # other order scenarios will use the standard address information to
+    # communicate origin and destination addresses even with this value set to
+    # `true`.
+    # * In case the NewStore Store ID length is longer than 20 characters,
+    # NewStore will only send the first 20 characters as Vertex field length is
+    # capped at that limit.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_location_code
+
+    # Username of the Vertex account.
+    # * Required if `login_type` is set to `user_and_password`.
+    # @return [String]
+    attr_accessor :username
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['administrative_origin'] = 'administrative_origin'
+      @_hash['company_code'] = 'company_code'
+      @_hash['division_code'] = 'division_code'
+      @_hash['exemption_classes'] = 'exemption_classes'
+      @_hash['flexible_fields'] = 'flexible_fields'
+      @_hash['jurisdiction_in_tax_name_enabled'] =
+        'jurisdiction_in_tax_name_enabled'
+      @_hash['login_type'] = 'login_type'
+      @_hash['password'] = 'password'
+      @_hash['soap_url'] = 'soap_url'
+      @_hash['trusted_id'] = 'trusted_id'
+      @_hash['use_location_code'] = 'use_location_code'
+      @_hash['username'] = 'username'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        administrative_origin
+        division_code
+        exemption_classes
+        flexible_fields
+        jurisdiction_in_tax_name_enabled
+        password
+        trusted_id
+        use_location_code
+        username
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(company_code = nil, login_type = nil, soap_url = nil,
+                   administrative_origin = SKIP, division_code = SKIP,
+                   exemption_classes = SKIP, flexible_fields = SKIP,
+                   jurisdiction_in_tax_name_enabled = SKIP, password = SKIP,
+                   trusted_id = SKIP, use_location_code = false,
+                   username = SKIP)
+      @administrative_origin = administrative_origin unless administrative_origin == SKIP
+      @company_code = company_code
+      @division_code = division_code unless division_code == SKIP
+      @exemption_classes = exemption_classes unless exemption_classes == SKIP
+      @flexible_fields = flexible_fields unless flexible_fields == SKIP
+      unless jurisdiction_in_tax_name_enabled == SKIP
+        @jurisdiction_in_tax_name_enabled =
+          jurisdiction_in_tax_name_enabled
+      end
+      @login_type = login_type
+      @password = password unless password == SKIP
+      @soap_url = soap_url
+      @trusted_id = trusted_id unless trusted_id == SKIP
+      @use_location_code = use_location_code unless use_location_code == SKIP
+      @username = username unless username == 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.
+      company_code = hash.key?('company_code') ? hash['company_code'] : nil
+      login_type = hash.key?('login_type') ? hash['login_type'] : nil
+      soap_url = hash.key?('soap_url') ? hash['soap_url'] : nil
+      if hash['administrative_origin']
+        administrative_origin = VertexAdministrativeOriginDto.from_hash(hash['administrative_origin'])
+      end
+      division_code = hash.key?('division_code') ? hash['division_code'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      exemption_classes = nil
+      unless hash['exemption_classes'].nil?
+        exemption_classes = []
+        hash['exemption_classes'].each do |structure|
+          exemption_classes << (VertexExemptionClassItemDto.from_hash(structure) if structure)
+        end
+      end
+
+      exemption_classes = SKIP unless hash.key?('exemption_classes')
+      # Parameter is an array, so we need to iterate through it
+      flexible_fields = nil
+      unless hash['flexible_fields'].nil?
+        flexible_fields = []
+        hash['flexible_fields'].each do |structure|
+          flexible_fields << (VertexFlexibleFieldConfigDto.from_hash(structure) if structure)
+        end
+      end
+
+      flexible_fields = SKIP unless hash.key?('flexible_fields')
+      jurisdiction_in_tax_name_enabled =
+        hash.key?('jurisdiction_in_tax_name_enabled') ? hash['jurisdiction_in_tax_name_enabled'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+      trusted_id = hash.key?('trusted_id') ? hash['trusted_id'] : SKIP
+      use_location_code = hash['use_location_code'] ||= false
+      username = hash.key?('username') ? hash['username'] : SKIP
+
+      # Create object from extracted values.
+      VertexConfigDto.new(company_code,
+                          login_type,
+                          soap_url,
+                          administrative_origin,
+                          division_code,
+                          exemption_classes,
+                          flexible_fields,
+                          jurisdiction_in_tax_name_enabled,
+                          password,
+                          trusted_id,
+                          use_location_code,
+                          username)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VertexConfigDto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.company_code,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.login_type,
+                                  ->(val) { VertexAuthLoginTypeEnum.validate(val) }) and
+            APIHelper.valid_type?(value.soap_url,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['company_code'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['login_type'],
+                                ->(val) { VertexAuthLoginTypeEnum.validate(val) }) and
+          APIHelper.valid_type?(value['soap_url'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} administrative_origin: #{@administrative_origin}, company_code:"\
+      " #{@company_code}, division_code: #{@division_code}, exemption_classes:"\
+      " #{@exemption_classes}, flexible_fields: #{@flexible_fields},"\
+      " jurisdiction_in_tax_name_enabled: #{@jurisdiction_in_tax_name_enabled}, login_type:"\
+      " #{@login_type}, password: #{@password}, soap_url: #{@soap_url}, trusted_id:"\
+      " #{@trusted_id}, use_location_code: #{@use_location_code}, username: #{@username}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} administrative_origin: #{@administrative_origin.inspect}, company_code:"\
+      " #{@company_code.inspect}, division_code: #{@division_code.inspect}, exemption_classes:"\
+      " #{@exemption_classes.inspect}, flexible_fields: #{@flexible_fields.inspect},"\
+      " jurisdiction_in_tax_name_enabled: #{@jurisdiction_in_tax_name_enabled.inspect},"\
+      " login_type: #{@login_type.inspect}, password: #{@password.inspect}, soap_url:"\
+      " #{@soap_url.inspect}, trusted_id: #{@trusted_id.inspect}, use_location_code:"\
+      " #{@use_location_code.inspect}, username: #{@username.inspect}>"
+    end
+  end
+end