newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/avalara_exemption_class_item_create_dto.rb

@@ -0,0 +1,111 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # AvalaraExemptionClassItemCreateDto Model.
+  class AvalaraExemptionClassItemCreateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Avalara entity use code.
+    # * For pre-defined tax exemption classes, value must correspond to the
+    # Avalara entity use code. For the possible options, please refer to the
+    # [List of entity use
+    # codes](https://knowledge.avalara.com/bundle/hff1682048150115_hff1682048150
+    # 115/page/List_of_entity_use_codes.html).
+    # * For custom tax exemption classes, value must correspond to the custom
+    # entity use code defined under the exempt entity custom tax rule.
+    # @return [String]
+    attr_accessor :avalara_entity_use_code
+
+    # 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['avalara_entity_use_code'] = 'avalara_entity_use_code'
+      @_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(avalara_entity_use_code = nil, exemption_class = nil,
+                   valid_countries = nil, display_text = SKIP)
+      @avalara_entity_use_code = avalara_entity_use_code
+      @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.
+      avalara_entity_use_code =
+        hash.key?('avalara_entity_use_code') ? hash['avalara_entity_use_code'] : nil
+      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.
+      AvalaraExemptionClassItemCreateDto.new(avalara_entity_use_code,
+                                             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} avalara_entity_use_code: #{@avalara_entity_use_code}, 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} avalara_entity_use_code: #{@avalara_entity_use_code.inspect}, display_text:"\
+      " #{@display_text.inspect}, exemption_class: #{@exemption_class.inspect}, valid_countries:"\
+      " #{@valid_countries.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/avalara_exemption_class_item_dto.rb

@@ -0,0 +1,137 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # AvalaraExemptionClassItemDto Model.
+  class AvalaraExemptionClassItemDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Avalara entity use code.
+    # * For pre-defined tax exemption classes, value must correspond to the
+    # Avalara entity use code. For the possible options, please refer to the
+    # [List of entity use
+    # codes](https://knowledge.avalara.com/bundle/hff1682048150115_hff1682048150
+    # 115/page/List_of_entity_use_codes.html).
+    # * For custom tax exemption classes, value must correspond to the custom
+    # entity use code defined under the exempt entity custom tax rule.
+    # @return [String]
+    attr_accessor :avalara_entity_use_code
+
+    # 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['avalara_entity_use_code'] = 'avalara_entity_use_code'
+      @_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(avalara_entity_use_code = nil, exemption_class = nil,
+                   valid_countries = nil, display_text = SKIP)
+      @avalara_entity_use_code = avalara_entity_use_code
+      @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.
+      avalara_entity_use_code =
+        hash.key?('avalara_entity_use_code') ? hash['avalara_entity_use_code'] : nil
+      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.
+      AvalaraExemptionClassItemDto.new(avalara_entity_use_code,
+                                       exemption_class,
+                                       valid_countries,
+                                       display_text)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AvalaraExemptionClassItemDto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.avalara_entity_use_code,
+                                ->(val) { val.instance_of? String }) and
+            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['avalara_entity_use_code'],
+                              ->(val) { val.instance_of? String }) and
+          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} avalara_entity_use_code: #{@avalara_entity_use_code}, 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} avalara_entity_use_code: #{@avalara_entity_use_code.inspect}, display_text:"\
+      " #{@display_text.inspect}, exemption_class: #{@exemption_class.inspect}, valid_countries:"\
+      " #{@valid_countries.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/avalara_exemption_class_item_update_dto.rb

@@ -0,0 +1,111 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # AvalaraExemptionClassItemUpdateDto Model.
+  class AvalaraExemptionClassItemUpdateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Avalara entity use code.
+    # * For pre-defined tax exemption classes, value must correspond to the
+    # Avalara entity use code. For the possible options, please refer to the
+    # [List of entity use
+    # codes](https://knowledge.avalara.com/bundle/hff1682048150115_hff1682048150
+    # 115/page/List_of_entity_use_codes.html).
+    # * For custom tax exemption classes, value must correspond to the custom
+    # entity use code defined under the exempt entity custom tax rule.
+    # @return [String]
+    attr_accessor :avalara_entity_use_code
+
+    # 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['avalara_entity_use_code'] = 'avalara_entity_use_code'
+      @_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(avalara_entity_use_code = nil, exemption_class = nil,
+                   valid_countries = nil, display_text = SKIP)
+      @avalara_entity_use_code = avalara_entity_use_code
+      @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.
+      avalara_entity_use_code =
+        hash.key?('avalara_entity_use_code') ? hash['avalara_entity_use_code'] : nil
+      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.
+      AvalaraExemptionClassItemUpdateDto.new(avalara_entity_use_code,
+                                             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} avalara_entity_use_code: #{@avalara_entity_use_code}, 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} avalara_entity_use_code: #{@avalara_entity_use_code.inspect}, display_text:"\
+      " #{@display_text.inspect}, exemption_class: #{@exemption_class.inspect}, valid_countries:"\
+      " #{@valid_countries.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/axena_activation_data_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
+  # AxenaActivationDataV1Dto Model.
+  class AxenaActivationDataV1Dto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Activation identifier.
+    # @return [Integer]
+    attr_accessor :activation_id
+
+    # API key user for accessing Axena (Srv4pos) `/kd` API endpoint.
+    # @return [String]
+    attr_accessor :api_key
+
+    # Serial number that uniquely identifies instance of every installation.
+    # * Will be set by Axena (Srv4pos) after the fiscal activation.
+    # * Represents production number of cash register according to the Swedish
+    # regulations.
+    # @return [String]
+    attr_accessor :production_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['activation_id'] = 'activation_id'
+      @_hash['api_key'] = 'api_key'
+      @_hash['production_number'] = 'production_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        activation_id
+        api_key
+        production_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(activation_id = SKIP, api_key = SKIP,
+                   production_number = SKIP)
+      @activation_id = activation_id unless activation_id == SKIP
+      @api_key = api_key unless api_key == SKIP
+      @production_number = production_number unless production_number == 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.
+      activation_id = hash.key?('activation_id') ? hash['activation_id'] : SKIP
+      api_key = hash.key?('api_key') ? hash['api_key'] : SKIP
+      production_number =
+        hash.key?('production_number') ? hash['production_number'] : SKIP
+
+      # Create object from extracted values.
+      AxenaActivationDataV1Dto.new(activation_id,
+                                   api_key,
+                                   production_number)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AxenaActivationDataV1Dto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} activation_id: #{@activation_id}, api_key: #{@api_key}, production_number:"\
+      " #{@production_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} activation_id: #{@activation_id.inspect}, api_key: #{@api_key.inspect},"\
+      " production_number: #{@production_number.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/base_model.rb

@@ -0,0 +1,110 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/new_store_api/models/billing_address.rb

@@ -0,0 +1,62 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The consumer's billing address for the returned order. As billing address is
+  # optional for an order, this field is set to null when the order doesn't have
+  # an explicit billing address set.
+  class BillingAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil)
+      @name = name
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+
+      # Create object from extracted values.
+      BillingAddress.new(name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/body.rb

@@ -0,0 +1,62 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Body Model.
+  class Body < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # fulfillment node ID to customs signer config
+    # @return [Value]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value = SKIP)
+      @value = value unless value == 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.
+      value = Value.from_hash(hash['value']) if hash['value']
+
+      # Create object from extracted values.
+      Body.new(value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} value: #{@value.inspect}>"
+    end
+  end
+end