newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/channel1.rb

@@ -0,0 +1,94 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Describes the origin of the order.
+  class Channel1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the store associate who processed this order, when an associate was
+    # involved.
+    # @return [String]
+    attr_accessor :associate_id
+
+    # Caller-provided source label used to distinguish store order clients, for
+    # example `self_checkout` or `associate_app`.
+    # @return [String]
+    attr_accessor :name
+
+    # ID of the store where this order was placed. Used to resolve the store's
+    # address for IN_STORE_HANDOVER fulfillment.
+    # @return [String]
+    attr_accessor :store_id
+
+    # ID of the store where this order was placed. Used to resolve the store's
+    # address for IN_STORE_HANDOVER fulfillment.
+    # @return [ChannelTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['associate_id'] = 'associate_id'
+      @_hash['name'] = 'name'
+      @_hash['store_id'] = 'store_id'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        associate_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        associate_id
+      ]
+    end
+
+    def initialize(name = nil, store_id = nil, type = nil, associate_id = SKIP)
+      @associate_id = associate_id unless associate_id == SKIP
+      @name = name
+      @store_id = store_id
+      @type = type
+    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
+      store_id = hash.key?('store_id') ? hash['store_id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      associate_id = hash.key?('associate_id') ? hash['associate_id'] : SKIP
+
+      # Create object from extracted values.
+      Channel1.new(name,
+                   store_id,
+                   type,
+                   associate_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} associate_id: #{@associate_id}, name: #{@name}, store_id: #{@store_id},"\
+      " type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} associate_id: #{@associate_id.inspect}, name: #{@name.inspect}, store_id:"\
+      " #{@store_id.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/channel_type1_enum.rb

@@ -0,0 +1,40 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ChannelType1.
+  class ChannelType1Enum
+    CHANNEL_TYPE1_ENUM = [
+      # TODO: Write general description for WEB
+      WEB = 'web'.freeze,
+
+      # TODO: Write general description for MOBILE
+      MOBILE = 'mobile'.freeze,
+
+      # TODO: Write general description for STORE
+      STORE = 'store'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHANNEL_TYPE1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = WEB)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'web' then WEB
+      when 'mobile' then MOBILE
+      when 'store' then STORE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/channel_type_enum.rb

@@ -0,0 +1,26 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The origin type of the order.
+  class ChannelTypeEnum
+    CHANNEL_TYPE_ENUM = [
+      # TODO: Write general description for STORE
+      STORE = 'STORE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHANNEL_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = STORE)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/new_store_api/models/checkout_financial_documents_exchange_receipts_request.rb

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

data/lib/new_store_api/models/checkout_financial_documents_sales_receipts_request.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
+  # CheckoutFinancialDocumentsSalesReceiptsRequest Model.
+  class CheckoutFinancialDocumentsSalesReceiptsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The order_id for which the sales receipt should be generated.
+    # @return [String]
+    attr_accessor :order_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'order_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_id = SKIP)
+      @order_id = order_id unless 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.
+      order_id = hash.key?('order_id') ? hash['order_id'] : SKIP
+
+      # Create object from extracted values.
+      CheckoutFinancialDocumentsSalesReceiptsRequest.new(order_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/code_enum.rb

@@ -0,0 +1,52 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # A unique error code.
+  class CodeEnum
+    CODE_ENUM = [
+      # TODO: Write general description for NO_CONFLICTED_ORDERS
+      NO_CONFLICTED_ORDERS = 'no_conflicted_orders'.freeze,
+
+      # TODO: Write general description for INVALID_ITEMS_PROVIDED
+      INVALID_ITEMS_PROVIDED = 'invalid_items_provided'.freeze,
+
+      # TODO: Write general description for UNSUPPORTED_CONFLICT_TO_PROCESS
+      UNSUPPORTED_CONFLICT_TO_PROCESS = 'unsupported_conflict_to_process'.freeze,
+
+      # TODO: Write general description for PRODUCT_INFO_DIFFERS
+      PRODUCT_INFO_DIFFERS = 'product_info_differs'.freeze,
+
+      # TODO: Write general description for INSUFFICIENT_STOCK
+      INSUFFICIENT_STOCK = 'insufficient_stock'.freeze,
+
+      # TODO: Write general description for ACTION_NOT_IMPLEMENTED
+      ACTION_NOT_IMPLEMENTED = 'action_not_implemented'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CODE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NO_CONFLICTED_ORDERS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'no_conflicted_orders' then NO_CONFLICTED_ORDERS
+      when 'invalid_items_provided' then INVALID_ITEMS_PROVIDED
+      when 'unsupported_conflict_to_process' then UNSUPPORTED_CONFLICT_TO_PROCESS
+      when 'product_info_differs' then PRODUCT_INFO_DIFFERS
+      when 'insufficient_stock' then INSUFFICIENT_STOCK
+      when 'action_not_implemented' then ACTION_NOT_IMPLEMENTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/combine_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
+  # Combine.
+  class CombineEnum
+    COMBINE_ENUM = [
+      # TODO: Write general description for AND
+      AND = 'AND'.freeze,
+
+      # TODO: Write general description for OR
+      OR = 'OR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      COMBINE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = AND)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'and' then AND
+      when 'or' then OR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/complete_zone_request.rb

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

data/lib/new_store_api/models/completion_response.rb

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

data/lib/new_store_api/models/condition.rb

@@ -0,0 +1,103 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Represents a single filter condition.
+  class Condition < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :field
+
+    # Supported filter operators.
+    # @return [OperatorEnum]
+    attr_accessor :operator
+
+    # Supported filter operators.
+    # @return [Object]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field'] = 'field'
+      @_hash['operator'] = 'operator'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(field = nil, operator = nil, value = nil)
+      @field = field
+      @operator = operator
+      @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.
+      field = hash.key?('field') ? hash['field'] : nil
+      operator = hash.key?('operator') ? hash['operator'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+
+      # Create object from extracted values.
+      Condition.new(field,
+                    operator,
+                    value)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Condition | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.field,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.operator,
+                                  ->(val) { OperatorEnum.validate(val) }) and
+            APIHelper.valid_type?(value.value,
+                                  ->(val) { val.instance_of? Object })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['field'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['operator'],
+                                ->(val) { OperatorEnum.validate(val) }) and
+          APIHelper.valid_type?(value['value'],
+                                ->(val) { val.instance_of? Object })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field: #{@field}, operator: #{@operator}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} field: #{@field.inspect}, operator: #{@operator.inspect}, value:"\
+      " #{@value.inspect}>"
+    end
+  end
+end