newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/booking_product.rb

@@ -0,0 +1,211 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # BookingProduct Model.
+  class BookingProduct < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [BookingProductCustoms]
+    attr_accessor :customs_info
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :dimension_height
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :dimension_length
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :dimension_unit
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :dimension_width
+
+    # TODO: Write general description for this method
+    # @return [Hash[String, Object]]
+    attr_accessor :external_identifiers
+
+    # It should be the NewStore imported catalog ID
+    # @return [String]
+    attr_accessor :id
+
+    # It should be the NewStore imported catalog ID
+    # @return [Float]
+    attr_accessor :price
+
+    # It should be the NewStore imported catalog ID
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # It should be the NewStore imported catalog ID
+    # @return [Float]
+    attr_accessor :weight
+
+    # It should be the NewStore imported catalog ID
+    # @return [String]
+    attr_accessor :weight_unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['customs_info'] = 'customs_info'
+      @_hash['dimension_height'] = 'dimension_height'
+      @_hash['dimension_length'] = 'dimension_length'
+      @_hash['dimension_unit'] = 'dimension_unit'
+      @_hash['dimension_width'] = 'dimension_width'
+      @_hash['external_identifiers'] = 'external_identifiers'
+      @_hash['id'] = 'id'
+      @_hash['price'] = 'price'
+      @_hash['quantity'] = 'quantity'
+      @_hash['weight'] = 'weight'
+      @_hash['weight_unit'] = 'weight_unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+        customs_info
+        dimension_height
+        dimension_length
+        dimension_unit
+        dimension_width
+        external_identifiers
+        price
+        weight
+        weight_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        currency
+        customs_info
+        dimension_height
+        dimension_length
+        dimension_unit
+        dimension_width
+        external_identifiers
+        price
+        weight
+        weight_unit
+      ]
+    end
+
+    def initialize(id = nil, quantity = nil, currency = SKIP,
+                   customs_info = SKIP, dimension_height = SKIP,
+                   dimension_length = SKIP, dimension_unit = SKIP,
+                   dimension_width = SKIP, external_identifiers = SKIP,
+                   price = SKIP, weight = SKIP, weight_unit = SKIP)
+      @currency = currency unless currency == SKIP
+      @customs_info = customs_info unless customs_info == SKIP
+      @dimension_height = dimension_height unless dimension_height == SKIP
+      @dimension_length = dimension_length unless dimension_length == SKIP
+      @dimension_unit = dimension_unit unless dimension_unit == SKIP
+      @dimension_width = dimension_width unless dimension_width == SKIP
+      @external_identifiers = external_identifiers unless external_identifiers == SKIP
+      @id = id
+      @price = price unless price == SKIP
+      @quantity = quantity
+      @weight = weight unless weight == SKIP
+      @weight_unit = weight_unit unless weight_unit == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      customs_info = BookingProductCustoms.from_hash(hash['customs_info']) if hash['customs_info']
+      dimension_height =
+        hash.key?('dimension_height') ? hash['dimension_height'] : SKIP
+      dimension_length =
+        hash.key?('dimension_length') ? hash['dimension_length'] : SKIP
+      dimension_unit =
+        hash.key?('dimension_unit') ? hash['dimension_unit'] : SKIP
+      dimension_width =
+        hash.key?('dimension_width') ? hash['dimension_width'] : SKIP
+      external_identifiers = hash.key?('external_identifiers') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:BookingProductExternalIdentifiers), hash['external_identifiers']
+      ) : SKIP
+      price = hash.key?('price') ? hash['price'] : SKIP
+      weight = hash.key?('weight') ? hash['weight'] : SKIP
+      weight_unit = hash.key?('weight_unit') ? hash['weight_unit'] : SKIP
+
+      # Create object from extracted values.
+      BookingProduct.new(id,
+                         quantity,
+                         currency,
+                         customs_info,
+                         dimension_height,
+                         dimension_length,
+                         dimension_unit,
+                         dimension_width,
+                         external_identifiers,
+                         price,
+                         weight,
+                         weight_unit)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BookingProduct | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.quantity,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['quantity'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, customs_info: #{@customs_info}, dimension_height:"\
+      " #{@dimension_height}, dimension_length: #{@dimension_length}, dimension_unit:"\
+      " #{@dimension_unit}, dimension_width: #{@dimension_width}, external_identifiers:"\
+      " #{@external_identifiers}, id: #{@id}, price: #{@price}, quantity: #{@quantity}, weight:"\
+      " #{@weight}, weight_unit: #{@weight_unit}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency.inspect}, customs_info: #{@customs_info.inspect},"\
+      " dimension_height: #{@dimension_height.inspect}, dimension_length:"\
+      " #{@dimension_length.inspect}, dimension_unit: #{@dimension_unit.inspect}, dimension_width:"\
+      " #{@dimension_width.inspect}, external_identifiers: #{@external_identifiers.inspect}, id:"\
+      " #{@id.inspect}, price: #{@price.inspect}, quantity: #{@quantity.inspect}, weight:"\
+      " #{@weight.inspect}, weight_unit: #{@weight_unit.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/booking_product_customs.rb

@@ -0,0 +1,107 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # BookingProductCustoms Model.
+  class BookingProductCustoms < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # HTS (10-digit) or HS (6-digit) number. dots are allowed. prefer HTS
+    # numbers. compatibility with HS number exists for historical reasons. See
+    # https://www.trade.gov/harmonized-system-hs-codes
+    # @return [String]
+    attr_accessor :hts_number
+
+    # Alpha2 Country Code. We allow more for historical reasons.
+    # @return [String]
+    attr_accessor :origin_country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['hts_number'] = 'hts_number'
+      @_hash['origin_country'] = 'origin_country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(description = nil, hts_number = nil, origin_country = nil)
+      @description = description
+      @hts_number = hts_number
+      @origin_country = origin_country
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      description = hash.key?('description') ? hash['description'] : nil
+      hts_number = hash.key?('hts_number') ? hash['hts_number'] : nil
+      origin_country =
+        hash.key?('origin_country') ? hash['origin_country'] : nil
+
+      # Create object from extracted values.
+      BookingProductCustoms.new(description,
+                                hts_number,
+                                origin_country)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BookingProductCustoms | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.description,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.hts_number,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.origin_country,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['description'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['hts_number'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['origin_country'],
+                                ->(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} description: #{@description}, hts_number: #{@hts_number}, origin_country:"\
+      " #{@origin_country}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description.inspect}, hts_number: #{@hts_number.inspect},"\
+      " origin_country: #{@origin_country.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/booking_response_cost.rb

@@ -0,0 +1,68 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # BookingResponseCost Model.
+  class BookingResponseCost < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['price'] = 'price'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency = nil, price = nil)
+      @currency = currency
+      @price = price
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      price = hash.key?('price') ? hash['price'] : nil
+
+      # Create object from extracted values.
+      BookingResponseCost.new(currency,
+                              price)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, price: #{@price}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency.inspect}, price: #{@price.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/bulk_profile_lookup_response.rb

@@ -0,0 +1,68 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # BulkProfileLookupResponse Model.
+  class BulkProfileLookupResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Email of the customer.
+    # @return [String]
+    attr_accessor :email
+
+    # The profile identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email = nil, id = nil)
+      @email = email
+      @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.
+      email = hash.key?('email') ? hash['email'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+
+      # Create object from extracted values.
+      BulkProfileLookupResponse.new(email,
+                                    id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email}, id: #{@id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email: #{@email.inspect}, id: #{@id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/byo_crm_config_request.rb

@@ -0,0 +1,85 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # BYO CRM configuration settings
+  class ByoCrmConfigRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # API token for the CRM provider, set to empty string `""` to clear the
+    # value
+    # @return [String]
+    attr_accessor :api_token
+
+    # Whether BYO CRM is enabled for the tenant
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enabled
+
+    # URL of the CRM provider, set to empty string `""` to clear the value
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['api_token'] = 'api_token'
+      @_hash['enabled'] = 'enabled'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        api_token
+        enabled
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        api_token
+        url
+      ]
+    end
+
+    def initialize(api_token = SKIP, enabled = false, url = SKIP)
+      @api_token = api_token unless api_token == SKIP
+      @enabled = enabled unless enabled == 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.
+      api_token = hash.key?('api_token') ? hash['api_token'] : SKIP
+      enabled = hash['enabled'] ||= false
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create object from extracted values.
+      ByoCrmConfigRequest.new(api_token,
+                              enabled,
+                              url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} api_token: #{@api_token}, enabled: #{@enabled}, url: #{@url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} api_token: #{@api_token.inspect}, enabled: #{@enabled.inspect}, url:"\
+      " #{@url.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/byo_crm_config_response.rb

@@ -0,0 +1,80 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # BYO CRM configuration settings
+  class ByoCrmConfigResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # API token for the CRM provider
+    # @return [String]
+    attr_accessor :api_token
+
+    # Whether BYO CRM is enabled for the tenant
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enabled
+
+    # URL of the CRM provider
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['api_token'] = 'api_token'
+      @_hash['enabled'] = 'enabled'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        api_token
+        url
+      ]
+    end
+
+    def initialize(api_token = nil, enabled = false, url = nil)
+      @api_token = api_token
+      @enabled = enabled
+      @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.
+      api_token = hash.key?('api_token') ? hash['api_token'] : nil
+      enabled = hash['enabled'] ||= false
+      url = hash.key?('url') ? hash['url'] : nil
+
+      # Create object from extracted values.
+      ByoCrmConfigResponse.new(api_token,
+                               enabled,
+                               url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} api_token: #{@api_token}, enabled: #{@enabled}, url: #{@url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} api_token: #{@api_token.inspect}, enabled: #{@enabled.inspect}, url:"\
+      " #{@url.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/calculation_mode_enum.rb

@@ -0,0 +1,42 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Type of the tax calculation * `STANDARD`: Standard tax calculation
+  # (default). * Taxes will be calculated for each line from `item_price *
+  # quantity` respecting the `tax_method` (tax incl./excl.). * `REVERSE`:
+  # Reverse calculation of taxes from the total amount paid by customer (e.g.
+  # for injected offline or e-comm orders). * Taxes will be calculated from
+  # `price_line_item` (total gross amount for given quantity) regardless of
+  # `tax_method` (tax incl./excl.).
+  class CalculationModeEnum
+    CALCULATION_MODE_ENUM = [
+      # TODO: Write general description for STANDARD
+      STANDARD = 'STANDARD'.freeze,
+
+      # TODO: Write general description for REVERSE
+      REVERSE = 'REVERSE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CALCULATION_MODE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = STANDARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'standard' then STANDARD
+      when 'reverse' then REVERSE
+      else
+        default_value
+      end
+    end
+  end
+end