newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/shipment_limits_response.rb

@@ -0,0 +1,69 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # List of all shipments limit rules
+  class ShipmentLimitsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ShipmentLimitsRequest]]
+    attr_accessor :shipments_limit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['shipments_limit'] = 'shipments_limit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shipments_limit = nil)
+      @shipments_limit = shipments_limit
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      shipments_limit = nil
+      unless hash['shipments_limit'].nil?
+        shipments_limit = []
+        hash['shipments_limit'].each do |structure|
+          shipments_limit << (ShipmentLimitsRequest.from_hash(structure) if structure)
+        end
+      end
+
+      shipments_limit = nil unless hash.key?('shipments_limit')
+
+      # Create object from extracted values.
+      ShipmentLimitsResponse.new(shipments_limit)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} shipments_limit: #{@shipments_limit}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} shipments_limit: #{@shipments_limit.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/shipping_address.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
+  # Shipping address of the customer used for risk assessment only.
+  class ShippingAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # City
+    # @return [String]
+    attr_accessor :city
+
+    # Two-letter country code
+    # @return [String]
+    attr_accessor :country
+
+    # House number
+    # @return [String]
+    attr_accessor :house_number
+
+    # Zip code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # State or province
+    # @return [String]
+    attr_accessor :state
+
+    # Street name
+    # @return [String]
+    attr_accessor :street
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['country'] = 'country'
+      @_hash['house_number'] = 'house_number'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['state'] = 'state'
+      @_hash['street'] = 'street'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        country
+        house_number
+        postal_code
+        state
+        street
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city = SKIP, country = SKIP, house_number = SKIP,
+                   postal_code = SKIP, state = SKIP, street = SKIP)
+      @city = city unless city == SKIP
+      @country = country unless country == SKIP
+      @house_number = house_number unless house_number == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @state = state unless state == SKIP
+      @street = street unless street == 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
+      house_number = hash.key?('house_number') ? hash['house_number'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      street = hash.key?('street') ? hash['street'] : SKIP
+
+      # Create object from extracted values.
+      ShippingAddress.new(city,
+                          country,
+                          house_number,
+                          postal_code,
+                          state,
+                          street)
+    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}, house_number: #{@house_number},"\
+      " postal_code: #{@postal_code}, state: #{@state}, street: #{@street}>"
+    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}, house_number:"\
+      " #{@house_number.inspect}, postal_code: #{@postal_code.inspect}, state: #{@state.inspect},"\
+      " street: #{@street.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/shipping_offer_update_settings.rb

@@ -0,0 +1,82 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # ShippingOfferUpdateSettings Model.
+  class ShippingOfferUpdateSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # Determines whether an order routed to a DC needs a shipping offer update.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        updated_at
+        value
+      ]
+    end
+
+    def initialize(value = nil, updated_at = SKIP)
+      @updated_at = updated_at unless updated_at == SKIP
+      @value = value
+    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 = hash.key?('value') ? hash['value'] : nil
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   else
+                     SKIP
+                   end
+
+      # Create object from extracted values.
+      ShippingOfferUpdateSettings.new(value,
+                                      updated_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} updated_at: #{@updated_at}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} updated_at: #{@updated_at.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/shipping_option_audit.rb

@@ -0,0 +1,102 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ShippingOptionAudit Model.
+  class ShippingOptionAudit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # an external order ID if Sales Order UUID is not created yet
+    # @return [String]
+    attr_accessor :external_order_id
+
+    # the Sales Order UUID for which to generate the option
+    # @return [UUID | String]
+    attr_accessor :sales_order_uuid
+
+    # if none of the above match your use case, you can use this field
+    # @return [String]
+    attr_accessor :search_key
+
+    # the Transfer Order ID for which to generate the option
+    # @return [String]
+    attr_accessor :transfer_order_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_order_id'] = 'external_order_id'
+      @_hash['sales_order_uuid'] = 'sales_order_uuid'
+      @_hash['search_key'] = 'search_key'
+      @_hash['transfer_order_id'] = 'transfer_order_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_order_id
+        sales_order_uuid
+        search_key
+        transfer_order_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        external_order_id
+        sales_order_uuid
+        search_key
+        transfer_order_id
+      ]
+    end
+
+    def initialize(external_order_id = SKIP, sales_order_uuid = SKIP,
+                   search_key = SKIP, transfer_order_id = SKIP)
+      @external_order_id = external_order_id unless external_order_id == SKIP
+      @sales_order_uuid = sales_order_uuid unless sales_order_uuid == SKIP
+      @search_key = search_key unless search_key == SKIP
+      @transfer_order_id = transfer_order_id unless transfer_order_id == 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.
+      external_order_id =
+        hash.key?('external_order_id') ? hash['external_order_id'] : SKIP
+      sales_order_uuid =
+        hash.key?('sales_order_uuid') ? hash['sales_order_uuid'] : SKIP
+      search_key = hash.key?('search_key') ? hash['search_key'] : SKIP
+      transfer_order_id =
+        hash.key?('transfer_order_id') ? hash['transfer_order_id'] : SKIP
+
+      # Create object from extracted values.
+      ShippingOptionAudit.new(external_order_id,
+                              sales_order_uuid,
+                              search_key,
+                              transfer_order_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} external_order_id: #{@external_order_id}, sales_order_uuid:"\
+      " #{@sales_order_uuid}, search_key: #{@search_key}, transfer_order_id:"\
+      " #{@transfer_order_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} external_order_id: #{@external_order_id.inspect}, sales_order_uuid:"\
+      " #{@sales_order_uuid.inspect}, search_key: #{@search_key.inspect}, transfer_order_id:"\
+      " #{@transfer_order_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/shipping_type_enum.rb

@@ -0,0 +1,44 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Shipping type.
+  class ShippingTypeEnum
+    SHIPPING_TYPE_ENUM = [
+      # TODO: Write general description for TRADITIONAL_CARRIER
+      TRADITIONAL_CARRIER = 'traditional_carrier'.freeze,
+
+      # TODO: Write general description for SAME_DAY_DELIVERY
+      SAME_DAY_DELIVERY = 'same_day_delivery'.freeze,
+
+      # TODO: Write general description for IN_STORE_PICK_UP
+      IN_STORE_PICK_UP = 'in_store_pick_up'.freeze,
+
+      # TODO: Write general description for IN_STORE_HANDOVER
+      IN_STORE_HANDOVER = 'in_store_handover'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SHIPPING_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = TRADITIONAL_CARRIER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'traditional_carrier' then TRADITIONAL_CARRIER
+      when 'same_day_delivery' then SAME_DAY_DELIVERY
+      when 'in_store_pick_up' then IN_STORE_PICK_UP
+      when 'in_store_handover' then IN_STORE_HANDOVER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/shop.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
+  # Details about the shop the products belong to.
+  class Shop < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier of the shop.
+    # @return [String]
+    attr_accessor :id
+
+    # The locale used for the shop, in RFC 5646.
+    # @return [String]
+    attr_accessor :locale
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['locale'] = 'locale'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, locale = nil)
+      @id = id
+      @locale = locale
+    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
+      locale = hash.key?('locale') ? hash['locale'] : nil
+
+      # Create object from extracted values.
+      Shop.new(id,
+               locale)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, locale: #{@locale}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, locale: #{@locale.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/shorting_model.rb

@@ -0,0 +1,139 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # ShortingModel Model.
+  class ShortingModel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_by
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_by_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :store_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tenant
+
+    # TODO: Write general description for this method
+    # @return [ShortingTypeEnum]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :wave_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['created_by'] = 'created_by'
+      @_hash['created_by_name'] = 'created_by_name'
+      @_hash['product_id'] = 'product_id'
+      @_hash['reason'] = 'reason'
+      @_hash['store_id'] = 'store_id'
+      @_hash['tenant'] = 'tenant'
+      @_hash['type'] = 'type'
+      @_hash['wave_id'] = 'wave_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_at = nil, created_by = nil, created_by_name = nil,
+                   product_id = nil, reason = nil, store_id = nil, tenant = nil,
+                   type = nil, wave_id = nil)
+      @created_at = created_at
+      @created_by = created_by
+      @created_by_name = created_by_name
+      @product_id = product_id
+      @reason = reason
+      @store_id = store_id
+      @tenant = tenant
+      @type = type
+      @wave_id = wave_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.
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      created_by = hash.key?('created_by') ? hash['created_by'] : nil
+      created_by_name =
+        hash.key?('created_by_name') ? hash['created_by_name'] : nil
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      store_id = hash.key?('store_id') ? hash['store_id'] : nil
+      tenant = hash.key?('tenant') ? hash['tenant'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      wave_id = hash.key?('wave_id') ? hash['wave_id'] : nil
+
+      # Create object from extracted values.
+      ShortingModel.new(created_at,
+                        created_by,
+                        created_by_name,
+                        product_id,
+                        reason,
+                        store_id,
+                        tenant,
+                        type,
+                        wave_id)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at}, created_by: #{@created_by}, created_by_name:"\
+      " #{@created_by_name}, product_id: #{@product_id}, reason: #{@reason}, store_id:"\
+      " #{@store_id}, tenant: #{@tenant}, type: #{@type}, wave_id: #{@wave_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at.inspect}, created_by: #{@created_by.inspect},"\
+      " created_by_name: #{@created_by_name.inspect}, product_id: #{@product_id.inspect}, reason:"\
+      " #{@reason.inspect}, store_id: #{@store_id.inspect}, tenant: #{@tenant.inspect}, type:"\
+      " #{@type.inspect}, wave_id: #{@wave_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/shorting_type_enum.rb

@@ -0,0 +1,36 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ShortingType.
+  class ShortingTypeEnum
+    SHORTING_TYPE_ENUM = [
+      # TODO: Write general description for MISPICK
+      MISPICK = 'mispick'.freeze,
+
+      # TODO: Write general description for MISPACK
+      MISPACK = 'mispack'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SHORTING_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = MISPICK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'mispick' then MISPICK
+      when 'mispack' then MISPACK
+      else
+        default_value
+      end
+    end
+  end
+end