newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/value.rb

@@ -0,0 +1,123 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # fulfillment node ID to customs signer config
+  class Value < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Provider Rate customization adapter URL. Must end with a slash /
+    # @return [String]
+    attr_accessor :base_url
+
+    # The shipping provider adapter URL. Must end with a slash /
+    # @return [String]
+    attr_accessor :api_base_url
+
+    # The shipping provider adapter URL. Must end with a slash /
+    # @return [String]
+    attr_accessor :api_key
+
+    # The shipping provider adapter URL. Must end with a slash /
+    # @return [TrueClass | FalseClass]
+    attr_accessor :booking_includes_return
+
+    # The shipping provider adapter URL. Must end with a slash /
+    # @return [TrueClass | FalseClass]
+    attr_accessor :return_deliveries_should_be_canceled
+
+    # The shipping provider adapter URL. Must end with a slash /
+    # @return [String]
+    attr_accessor :customs_signer
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['base_url'] = 'base_url'
+      @_hash['api_base_url'] = 'api_base_url'
+      @_hash['api_key'] = 'api_key'
+      @_hash['booking_includes_return'] = 'booking_includes_return'
+      @_hash['return_deliveries_should_be_canceled'] =
+        'return_deliveries_should_be_canceled'
+      @_hash['customs_signer'] = 'customs_signer'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        api_key
+        booking_includes_return
+        return_deliveries_should_be_canceled
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        api_key
+        booking_includes_return
+        return_deliveries_should_be_canceled
+      ]
+    end
+
+    def initialize(base_url = nil, api_base_url = nil, customs_signer = nil,
+                   api_key = SKIP, booking_includes_return = false,
+                   return_deliveries_should_be_canceled = false)
+      @base_url = base_url
+      @api_base_url = api_base_url
+      @api_key = api_key unless api_key == SKIP
+      @booking_includes_return = booking_includes_return unless booking_includes_return == SKIP
+      unless return_deliveries_should_be_canceled == SKIP
+        @return_deliveries_should_be_canceled =
+          return_deliveries_should_be_canceled
+      end
+      @customs_signer = customs_signer
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      base_url = hash.key?('base_url') ? hash['base_url'] : nil
+      api_base_url = hash.key?('api_base_url') ? hash['api_base_url'] : nil
+      customs_signer =
+        hash.key?('customs_signer') ? hash['customs_signer'] : nil
+      api_key = hash.key?('api_key') ? hash['api_key'] : SKIP
+      booking_includes_return = hash['booking_includes_return'] ||= false
+      return_deliveries_should_be_canceled =
+        hash['return_deliveries_should_be_canceled'] ||= false
+
+      # Create object from extracted values.
+      Value.new(base_url,
+                api_base_url,
+                customs_signer,
+                api_key,
+                booking_includes_return,
+                return_deliveries_should_be_canceled)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} base_url: #{@base_url}, api_base_url: #{@api_base_url}, api_key:"\
+      " #{@api_key}, booking_includes_return: #{@booking_includes_return},"\
+      " return_deliveries_should_be_canceled: #{@return_deliveries_should_be_canceled},"\
+      " customs_signer: #{@customs_signer}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} base_url: #{@base_url.inspect}, api_base_url: #{@api_base_url.inspect},"\
+      " api_key: #{@api_key.inspect}, booking_includes_return:"\
+      " #{@booking_includes_return.inspect}, return_deliveries_should_be_canceled:"\
+      " #{@return_deliveries_should_be_canceled.inspect}, customs_signer:"\
+      " #{@customs_signer.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/vertex_administrative_origin_create_dto.rb

@@ -0,0 +1,129 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # VertexAdministrativeOriginCreateDto Model.
+  class VertexAdministrativeOriginCreateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The proper name of the city used to determine the Tax Area ID.
+    # @return [String]
+    attr_accessor :city
+
+    # The proper name of the city used to determine the Tax Area ID.
+    # @return [String]
+    attr_accessor :country
+
+    # The proper name of the city used to determine the Tax Area ID.
+    # @return [Currency3Enum]
+    attr_accessor :currency_code
+
+    # The rate (multiplier) used for converting the transaction currency amount
+    # to the filing currency amount.
+    # @return [Float]
+    attr_accessor :currency_value
+
+    # The proper name or the postal abbreviation of the state, province, or
+    # territory used to determine the Tax Area ID.
+    # @return [String]
+    attr_accessor :main_division
+
+    # The postal code used to determine the Tax Area ID
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The first line of the street address.
+    # @return [String]
+    attr_accessor :street_address_1
+
+    # The second line of the street address.
+    # @return [String]
+    attr_accessor :street_address_2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['currency_value'] = 'currency_value'
+      @_hash['main_division'] = 'main_division'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['street_address_1'] = 'street_address_1'
+      @_hash['street_address_2'] = 'street_address_2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city = nil, country = nil, currency_code = nil,
+                   currency_value = nil, main_division = nil, postal_code = nil,
+                   street_address_1 = nil, street_address_2 = nil)
+      @city = city
+      @country = country
+      @currency_code = currency_code
+      @currency_value = currency_value
+      @main_division = main_division
+      @postal_code = postal_code
+      @street_address_1 = street_address_1
+      @street_address_2 = street_address_2
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      city = hash.key?('city') ? hash['city'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : nil
+      currency_value =
+        hash.key?('currency_value') ? hash['currency_value'] : nil
+      main_division = hash.key?('main_division') ? hash['main_division'] : nil
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
+      street_address_1 =
+        hash.key?('street_address_1') ? hash['street_address_1'] : nil
+      street_address_2 =
+        hash.key?('street_address_2') ? hash['street_address_2'] : nil
+
+      # Create object from extracted values.
+      VertexAdministrativeOriginCreateDto.new(city,
+                                              country,
+                                              currency_code,
+                                              currency_value,
+                                              main_division,
+                                              postal_code,
+                                              street_address_1,
+                                              street_address_2)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, country: #{@country}, currency_code: #{@currency_code},"\
+      " currency_value: #{@currency_value}, main_division: #{@main_division}, postal_code:"\
+      " #{@postal_code}, street_address_1: #{@street_address_1}, street_address_2:"\
+      " #{@street_address_2}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city.inspect}, country: #{@country.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, currency_value: #{@currency_value.inspect}, main_division:"\
+      " #{@main_division.inspect}, postal_code: #{@postal_code.inspect}, street_address_1:"\
+      " #{@street_address_1.inspect}, street_address_2: #{@street_address_2.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/vertex_administrative_origin_dto.rb

@@ -0,0 +1,175 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # VertexAdministrativeOriginDto Model.
+  class VertexAdministrativeOriginDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The proper name of the city used to determine the Tax Area ID.
+    # @return [String]
+    attr_accessor :city
+
+    # The proper name of the city used to determine the Tax Area ID.
+    # @return [String]
+    attr_accessor :country
+
+    # The proper name of the city used to determine the Tax Area ID.
+    # @return [Currency3Enum]
+    attr_accessor :currency_code
+
+    # The rate (multiplier) used for converting the transaction currency amount
+    # to the filing currency amount.
+    # @return [Float]
+    attr_accessor :currency_value
+
+    # The proper name or the postal abbreviation of the state, province, or
+    # territory used to determine the Tax Area ID.
+    # @return [String]
+    attr_accessor :main_division
+
+    # The postal code used to determine the Tax Area ID
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The first line of the street address.
+    # @return [String]
+    attr_accessor :street_address_1
+
+    # The second line of the street address.
+    # @return [String]
+    attr_accessor :street_address_2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['currency_value'] = 'currency_value'
+      @_hash['main_division'] = 'main_division'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['street_address_1'] = 'street_address_1'
+      @_hash['street_address_2'] = 'street_address_2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city = nil, country = nil, currency_code = nil,
+                   currency_value = nil, main_division = nil, postal_code = nil,
+                   street_address_1 = nil, street_address_2 = nil)
+      @city = city
+      @country = country
+      @currency_code = currency_code
+      @currency_value = currency_value
+      @main_division = main_division
+      @postal_code = postal_code
+      @street_address_1 = street_address_1
+      @street_address_2 = street_address_2
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      city = hash.key?('city') ? hash['city'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : nil
+      currency_value =
+        hash.key?('currency_value') ? hash['currency_value'] : nil
+      main_division = hash.key?('main_division') ? hash['main_division'] : nil
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
+      street_address_1 =
+        hash.key?('street_address_1') ? hash['street_address_1'] : nil
+      street_address_2 =
+        hash.key?('street_address_2') ? hash['street_address_2'] : nil
+
+      # Create object from extracted values.
+      VertexAdministrativeOriginDto.new(city,
+                                        country,
+                                        currency_code,
+                                        currency_value,
+                                        main_division,
+                                        postal_code,
+                                        street_address_1,
+                                        street_address_2)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VertexAdministrativeOriginDto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.city,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.country,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.currency_code,
+                                  ->(val) { Currency3Enum.validate(val) }) and
+            APIHelper.valid_type?(value.currency_value,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.main_division,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.postal_code,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.street_address_1,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.street_address_2,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['city'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['country'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['currency_code'],
+                                ->(val) { Currency3Enum.validate(val) }) and
+          APIHelper.valid_type?(value['currency_value'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['main_division'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['postal_code'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['street_address_1'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['street_address_2'],
+                                ->(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} city: #{@city}, country: #{@country}, currency_code: #{@currency_code},"\
+      " currency_value: #{@currency_value}, main_division: #{@main_division}, postal_code:"\
+      " #{@postal_code}, street_address_1: #{@street_address_1}, street_address_2:"\
+      " #{@street_address_2}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city.inspect}, country: #{@country.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, currency_value: #{@currency_value.inspect}, main_division:"\
+      " #{@main_division.inspect}, postal_code: #{@postal_code.inspect}, street_address_1:"\
+      " #{@street_address_1.inspect}, street_address_2: #{@street_address_2.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/vertex_administrative_origin_update_dto.rb

@@ -0,0 +1,139 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # VertexAdministrativeOriginUpdateDto Model.
+  class VertexAdministrativeOriginUpdateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The proper name of the city used to determine the Tax Area ID.
+    # @return [String]
+    attr_accessor :city
+
+    # The proper name of the city used to determine the Tax Area ID.
+    # @return [String]
+    attr_accessor :country
+
+    # The proper name of the city used to determine the Tax Area ID.
+    # @return [Currency3Enum]
+    attr_accessor :currency_code
+
+    # The rate (multiplier) used for converting the transaction currency amount
+    # to the filing currency amount.
+    # @return [Float]
+    attr_accessor :currency_value
+
+    # The proper name or the postal abbreviation of the state, province, or
+    # territory used to determine the Tax Area ID.
+    # @return [String]
+    attr_accessor :main_division
+
+    # The postal code used to determine the Tax Area ID
+    # @return [String]
+    attr_accessor :postal_code
+
+    # The first line of the street address.
+    # @return [String]
+    attr_accessor :street_address_1
+
+    # The second line of the street address.
+    # @return [String]
+    attr_accessor :street_address_2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['currency_value'] = 'currency_value'
+      @_hash['main_division'] = 'main_division'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['street_address_1'] = 'street_address_1'
+      @_hash['street_address_2'] = 'street_address_2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        country
+        currency_code
+        currency_value
+        main_division
+        postal_code
+        street_address_1
+        street_address_2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city = SKIP, country = SKIP, currency_code = SKIP,
+                   currency_value = SKIP, main_division = SKIP,
+                   postal_code = SKIP, street_address_1 = SKIP,
+                   street_address_2 = SKIP)
+      @city = city unless city == SKIP
+      @country = country unless country == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @currency_value = currency_value unless currency_value == SKIP
+      @main_division = main_division unless main_division == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @street_address_1 = street_address_1 unless street_address_1 == SKIP
+      @street_address_2 = street_address_2 unless street_address_2 == 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.
+      city = hash.key?('city') ? hash['city'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : SKIP
+      currency_value =
+        hash.key?('currency_value') ? hash['currency_value'] : SKIP
+      main_division = hash.key?('main_division') ? hash['main_division'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+      street_address_1 =
+        hash.key?('street_address_1') ? hash['street_address_1'] : SKIP
+      street_address_2 =
+        hash.key?('street_address_2') ? hash['street_address_2'] : SKIP
+
+      # Create object from extracted values.
+      VertexAdministrativeOriginUpdateDto.new(city,
+                                              country,
+                                              currency_code,
+                                              currency_value,
+                                              main_division,
+                                              postal_code,
+                                              street_address_1,
+                                              street_address_2)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, country: #{@country}, currency_code: #{@currency_code},"\
+      " currency_value: #{@currency_value}, main_division: #{@main_division}, postal_code:"\
+      " #{@postal_code}, street_address_1: #{@street_address_1}, street_address_2:"\
+      " #{@street_address_2}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city.inspect}, country: #{@country.inspect}, currency_code:"\
+      " #{@currency_code.inspect}, currency_value: #{@currency_value.inspect}, main_division:"\
+      " #{@main_division.inspect}, postal_code: #{@postal_code.inspect}, street_address_1:"\
+      " #{@street_address_1.inspect}, street_address_2: #{@street_address_2.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/vertex_auth_login_type_enum.rb

@@ -0,0 +1,39 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Vertex Login Type. * Used for selecting the authentication method. *
+  # `trusted_id` field is required if `login_type` is set to `trusted_id`. *
+  # `username` and `password` fields are required if `login_type` is set to
+  # `user_and_password`.
+  class VertexAuthLoginTypeEnum
+    VERTEX_AUTH_LOGIN_TYPE_ENUM = [
+      # TODO: Write general description for TRUSTED_ID
+      TRUSTED_ID = 'trusted_id'.freeze,
+
+      # TODO: Write general description for USER_AND_PASSWORD
+      USER_AND_PASSWORD = 'user_and_password'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERTEX_AUTH_LOGIN_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = TRUSTED_ID)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'trusted_id' then TRUSTED_ID
+      when 'user_and_password' then USER_AND_PASSWORD
+      else
+        default_value
+      end
+    end
+  end
+end