newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/custom_config_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
+  # CustomConfigDto Model.
+  class CustomConfigDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Other necessary configuration specific to the custom provider (currently
+    # configs for non-officially supported avalara based custom implementation)
+    # @return [CustomConfigAdditionalDto]
+    attr_accessor :additional_config
+
+    # Other necessary configuration specific to the custom provider (currently
+    # configs for non-officially supported avalara based custom implementation)
+    # @return [CustomApiVersionEnum]
+    attr_accessor :api_version
+
+    # Custom provider API authentication method.
+    # * Currently, only Basic authentication is supported.
+    # * If the tax calculation strategy is set to `custom` and `api_version` is
+    # set to `v1`, the given configuration will be used.
+    # @return [CustomConfigAuthenticationDto]
+    attr_accessor :authentication
+
+    # The base URL for the custom taxes RESTful API. The value should include
+    # the route prefix to the quotation API.
+    # * Required if the `api_version` is set to `v1`.
+    # * If the tax calculation strategy is set to `custom` and `api_version` is
+    # set to `v1`, the given configuration will be used.
+    # @return [String]
+    attr_accessor :base_url
+
+    # A list of supported exemption classes.
+    # @return [Array[ExemptionClassItemDto]]
+    attr_accessor :exemption_classes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['additional_config'] = 'additional_config'
+      @_hash['api_version'] = 'api_version'
+      @_hash['authentication'] = 'authentication'
+      @_hash['base_url'] = 'base_url'
+      @_hash['exemption_classes'] = 'exemption_classes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        additional_config
+        authentication
+        base_url
+        exemption_classes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(api_version = nil, additional_config = SKIP,
+                   authentication = SKIP, base_url = SKIP,
+                   exemption_classes = SKIP)
+      @additional_config = additional_config unless additional_config == SKIP
+      @api_version = api_version
+      @authentication = authentication unless authentication == SKIP
+      @base_url = base_url unless base_url == SKIP
+      @exemption_classes = exemption_classes unless exemption_classes == 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.
+      api_version = hash.key?('api_version') ? hash['api_version'] : nil
+      additional_config = CustomConfigAdditionalDto.from_hash(hash['additional_config']) if
+        hash['additional_config']
+      authentication = CustomConfigAuthenticationDto.from_hash(hash['authentication']) if
+        hash['authentication']
+      base_url = hash.key?('base_url') ? hash['base_url'] : 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 << (ExemptionClassItemDto.from_hash(structure) if structure)
+        end
+      end
+
+      exemption_classes = SKIP unless hash.key?('exemption_classes')
+
+      # Create object from extracted values.
+      CustomConfigDto.new(api_version,
+                          additional_config,
+                          authentication,
+                          base_url,
+                          exemption_classes)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomConfigDto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.api_version,
+                                     ->(val) { CustomApiVersionEnum.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['api_version'],
+                            ->(val) { CustomApiVersionEnum.validate(val) })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} additional_config: #{@additional_config}, api_version: #{@api_version},"\
+      " authentication: #{@authentication}, base_url: #{@base_url}, exemption_classes:"\
+      " #{@exemption_classes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} additional_config: #{@additional_config.inspect}, api_version:"\
+      " #{@api_version.inspect}, authentication: #{@authentication.inspect}, base_url:"\
+      " #{@base_url.inspect}, exemption_classes: #{@exemption_classes.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/custom_config_update_dto.rb

@@ -0,0 +1,122 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CustomConfigUpdateDto Model.
+  class CustomConfigUpdateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Other necessary configuration specific to the custom provider (currently
+    # configs for non-officially supported avalara based custom implementation)
+    # @return [CustomConfigAdditionalUpdateDto]
+    attr_accessor :additional_config
+
+    # Other necessary configuration specific to the custom provider (currently
+    # configs for non-officially supported avalara based custom implementation)
+    # @return [CustomApiVersionEnum]
+    attr_accessor :api_version
+
+    # Other necessary configuration specific to the custom provider (currently
+    # configs for non-officially supported avalara based custom implementation)
+    # @return [CustomConfigAuthenticationDto]
+    attr_accessor :authentication
+
+    # The base URL for the custom taxes RESTful API. The value should include
+    # the route prefix to the quotation API.
+    # * Required if the `api_version` is set to `v1`.
+    # * If the tax calculation strategy is set to `custom` and `api_version` is
+    # set to `v1`, the given configuration will be used.
+    # @return [String]
+    attr_accessor :base_url
+
+    # A list of supported exemption classes.
+    # @return [Array[ExemptionClassItemUpdateDto]]
+    attr_accessor :exemption_classes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['additional_config'] = 'additional_config'
+      @_hash['api_version'] = 'api_version'
+      @_hash['authentication'] = 'authentication'
+      @_hash['base_url'] = 'base_url'
+      @_hash['exemption_classes'] = 'exemption_classes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        additional_config
+        api_version
+        authentication
+        base_url
+        exemption_classes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(additional_config = SKIP, api_version = SKIP,
+                   authentication = SKIP, base_url = SKIP,
+                   exemption_classes = SKIP)
+      @additional_config = additional_config unless additional_config == SKIP
+      @api_version = api_version unless api_version == SKIP
+      @authentication = authentication unless authentication == SKIP
+      @base_url = base_url unless base_url == SKIP
+      @exemption_classes = exemption_classes unless exemption_classes == 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.
+      additional_config = CustomConfigAdditionalUpdateDto.from_hash(hash['additional_config']) if
+        hash['additional_config']
+      api_version = hash.key?('api_version') ? hash['api_version'] : SKIP
+      authentication = CustomConfigAuthenticationDto.from_hash(hash['authentication']) if
+        hash['authentication']
+      base_url = hash.key?('base_url') ? hash['base_url'] : 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 << (ExemptionClassItemUpdateDto.from_hash(structure) if structure)
+        end
+      end
+
+      exemption_classes = SKIP unless hash.key?('exemption_classes')
+
+      # Create object from extracted values.
+      CustomConfigUpdateDto.new(additional_config,
+                                api_version,
+                                authentication,
+                                base_url,
+                                exemption_classes)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} additional_config: #{@additional_config}, api_version: #{@api_version},"\
+      " authentication: #{@authentication}, base_url: #{@base_url}, exemption_classes:"\
+      " #{@exemption_classes}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} additional_config: #{@additional_config.inspect}, api_version:"\
+      " #{@api_version.inspect}, authentication: #{@authentication.inspect}, base_url:"\
+      " #{@base_url.inspect}, exemption_classes: #{@exemption_classes.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/custom_v0_avalara_config_create_dto.rb

@@ -0,0 +1,91 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CustomV0AvalaraConfigCreateDto Model.
+  class CustomV0AvalaraConfigCreateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # AvaTax account number or account ID.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Company code that identifies the company in the AvaTax account.
+    # * Value is case-sensitive.
+    # * Declared during the company setup in the AvaTax Admin Console.
+    # @return [String]
+    attr_accessor :company_code
+
+    # AvaTax license key.
+    # @return [String]
+    attr_accessor :license_key
+
+    # Custom provider RESTful API URL that uses AvaTax v1 schema. Will be used
+    # for tax calculations.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'account_number'
+      @_hash['company_code'] = 'company_code'
+      @_hash['license_key'] = 'license_key'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number = nil, company_code = nil, license_key = nil,
+                   url = nil)
+      @account_number = account_number
+      @company_code = company_code
+      @license_key = license_key
+      @url = url
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : nil
+      company_code = hash.key?('company_code') ? hash['company_code'] : nil
+      license_key = hash.key?('license_key') ? hash['license_key'] : nil
+      url = hash.key?('url') ? hash['url'] : nil
+
+      # Create object from extracted values.
+      CustomV0AvalaraConfigCreateDto.new(account_number,
+                                         company_code,
+                                         license_key,
+                                         url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_number: #{@account_number}, company_code: #{@company_code},"\
+      " license_key: #{@license_key}, url: #{@url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_number: #{@account_number.inspect}, company_code:"\
+      " #{@company_code.inspect}, license_key: #{@license_key.inspect}, url: #{@url.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/custom_v0_avalara_config_dto.rb

@@ -0,0 +1,121 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CustomV0AvalaraConfigDto Model.
+  class CustomV0AvalaraConfigDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # AvaTax account number or account ID.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Company code that identifies the company in the AvaTax account.
+    # * Value is case-sensitive.
+    # * Declared during the company setup in the AvaTax Admin Console.
+    # @return [String]
+    attr_accessor :company_code
+
+    # AvaTax license key.
+    # @return [String]
+    attr_accessor :license_key
+
+    # Custom provider RESTful API URL that uses AvaTax v1 schema. Will be used
+    # for tax calculations.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'account_number'
+      @_hash['company_code'] = 'company_code'
+      @_hash['license_key'] = 'license_key'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number = nil, company_code = nil, license_key = nil,
+                   url = nil)
+      @account_number = account_number
+      @company_code = company_code
+      @license_key = license_key
+      @url = url
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : nil
+      company_code = hash.key?('company_code') ? hash['company_code'] : nil
+      license_key = hash.key?('license_key') ? hash['license_key'] : nil
+      url = hash.key?('url') ? hash['url'] : nil
+
+      # Create object from extracted values.
+      CustomV0AvalaraConfigDto.new(account_number,
+                                   company_code,
+                                   license_key,
+                                   url)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomV0AvalaraConfigDto | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.account_number,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.company_code,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.license_key,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.url,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['account_number'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['company_code'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['license_key'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['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} account_number: #{@account_number}, company_code: #{@company_code},"\
+      " license_key: #{@license_key}, url: #{@url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_number: #{@account_number.inspect}, company_code:"\
+      " #{@company_code.inspect}, license_key: #{@license_key.inspect}, url: #{@url.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/custom_v0_avalara_config_update_dto.rb

@@ -0,0 +1,96 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # CustomV0AvalaraConfigUpdateDto Model.
+  class CustomV0AvalaraConfigUpdateDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # AvaTax account number or account ID.
+    # @return [String]
+    attr_accessor :account_number
+
+    # Company code that identifies the company in the AvaTax account.
+    # * Value is case-sensitive.
+    # * Declared during the company setup in the AvaTax Admin Console.
+    # @return [String]
+    attr_accessor :company_code
+
+    # AvaTax license key.
+    # @return [String]
+    attr_accessor :license_key
+
+    # Custom provider RESTful API URL that uses AvaTax v1 schema. Will be used
+    # for tax calculations.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'account_number'
+      @_hash['company_code'] = 'company_code'
+      @_hash['license_key'] = 'license_key'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        company_code
+        license_key
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number = SKIP, company_code = SKIP,
+                   license_key = SKIP, url = SKIP)
+      @account_number = account_number unless account_number == SKIP
+      @company_code = company_code unless company_code == SKIP
+      @license_key = license_key unless license_key == SKIP
+      @url = url unless url == 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.
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      company_code = hash.key?('company_code') ? hash['company_code'] : SKIP
+      license_key = hash.key?('license_key') ? hash['license_key'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create object from extracted values.
+      CustomV0AvalaraConfigUpdateDto.new(account_number,
+                                         company_code,
+                                         license_key,
+                                         url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_number: #{@account_number}, company_code: #{@company_code},"\
+      " license_key: #{@license_key}, url: #{@url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_number: #{@account_number.inspect}, company_code:"\
+      " #{@company_code.inspect}, license_key: #{@license_key.inspect}, url: #{@url.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/customer.rb

@@ -0,0 +1,72 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The customer placing the order.
+  class Customer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A reference to the customer in an external system.
+    # @return [String]
+    attr_accessor :external_id
+
+    # The customer's internal NewStore customer-profile UUID.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_id'] = 'external_id'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        external_id
+      ]
+    end
+
+    def initialize(id = nil, external_id = SKIP)
+      @external_id = external_id unless external_id == SKIP
+      @id = id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      external_id = hash.key?('external_id') ? hash['external_id'] : SKIP
+
+      # Create object from extracted values.
+      Customer.new(id,
+                   external_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} external_id: #{@external_id}, id: #{@id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} external_id: #{@external_id.inspect}, id: #{@id.inspect}>"
+    end
+  end
+end