newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/order_by1_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
+  # order_by1.
+  class OrderBy1Enum
+    ORDER_BY1_ENUM = [
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze,
+
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze,
+
+      # TODO: Write general description for DISPLAY_NAME
+      DISPLAY_NAME = 'display_name'.freeze,
+
+      # TODO: Write general description for ID
+      ID = 'id'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORDER_BY1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = UPDATED_AT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'updated_at' then UPDATED_AT
+      when 'created_at' then CREATED_AT
+      when 'display_name' then DISPLAY_NAME
+      when 'id' then ID
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/order_by_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
+  # order_by.
+  class OrderByEnum
+    ORDER_BY_ENUM = [
+      # TODO: Write general description for STORE_IDS
+      STORE_IDS = 'store_ids'.freeze,
+
+      # TODO: Write general description for CUSTOMER_COUNT
+      CUSTOMER_COUNT = 'customer_count'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORDER_BY_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = STORE_IDS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'store_ids' then STORE_IDS
+      when 'customer_count' then CUSTOMER_COUNT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/order_completed_dto.rb

@@ -0,0 +1,117 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # `order.completed` is sent when all order items are fulfilled (or cancelled).
+  # Note that payment processing might not be complete yet.
+  class OrderCompletedDto < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates the capture type of the order. If the order has been placed in
+    # the Associate App or any mPOS then the capture type is pos. If the order
+    # has been injected then the capture_type is injection.
+    # @return [String]
+    attr_accessor :capture_type
+
+    # Unique ID for the order.
+    # @return [String]
+    attr_accessor :id
+
+    # List containing items in the order; one list index equals one item.
+    # @return [Array[Item9]]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['capture_type'] = 'capture_type'
+      @_hash['id'] = 'id'
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        capture_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, items = nil, capture_type = SKIP)
+      @capture_type = capture_type unless capture_type == SKIP
+      @id = id
+      @items = items
+    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
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (Item9.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+      capture_type = hash.key?('capture_type') ? hash['capture_type'] : SKIP
+
+      # Create object from extracted values.
+      OrderCompletedDto.new(id,
+                            items,
+                            capture_type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OrderCompletedDto | 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.items,
+                                  ->(val) { Item9.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['items'],
+                                ->(val) { Item9.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} capture_type: #{@capture_type}, id: #{@id}, items: #{@items}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} capture_type: #{@capture_type.inspect}, id: #{@id.inspect}, items:"\
+      " #{@items.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/order_conflict_resolution_request.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
+  # Triggers processing of logistic orders in 'conflict' state. Specific action
+  # (cancel, reroute, swap, etc) for each conflicted item in order must be
+  # defined.
+  class OrderConflictResolutionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Complete list of items and actions to be performed on them (reroute/cancel
+    # or swap).
+    # @return [Array[Object]]
+    attr_accessor :items
+
+    # The internal identifier(Sales Order UUID) of the order that we want to
+    # fix.
+    # @return [String]
+    attr_accessor :order_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash['order_id'] = 'order_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items = nil, order_id = nil)
+      @items = items
+      @order_id = order_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.
+      items = hash.key?('items') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:OrderConflictResolutionRequestItems), hash['items']
+      ) : nil
+      order_id = hash.key?('order_id') ? hash['order_id'] : nil
+
+      # Create object from extracted values.
+      OrderConflictResolutionRequest.new(items,
+                                         order_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OrderConflictResolutionRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:OrderConflictResolutionRequestItems)
+                         .validate(value.items) and
+            APIHelper.valid_type?(value.order_id,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:OrderConflictResolutionRequestItems)
+                       .validate(value['items']) and
+          APIHelper.valid_type?(value['order_id'],
+                                ->(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} items: #{@items}, 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} items: #{@items.inspect}, order_id: #{@order_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/order_conflict_resolution_response.rb

@@ -0,0 +1,125 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Returns logistic orders along with their items that were rerouted, cancelled
+  # and failed to process. Using the response clients can identify the cancelled
+  # and rerouted items. Note that items belong to new logistic order after
+  # cancelled and reroute.
+  class OrderConflictResolutionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Canceled]]
+    attr_accessor :canceled
+
+    # TODO: Write general description for this method
+    # @return [Error]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [Array[Rerouted]]
+    attr_accessor :rerouted
+
+    # This array contains LOs with original items which were replaced by
+    # swapping. Whenever we do swapping we create an LO which contains original
+    # items which we replaced by swapping. This LO also child of conflicted LO.
+    # Right after creation this will be moved to `swapped` state.
+    # @return [Array[Swapped]]
+    attr_accessor :swapped
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['canceled'] = 'canceled'
+      @_hash['error'] = 'error'
+      @_hash['rerouted'] = 'rerouted'
+      @_hash['swapped'] = 'swapped'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        canceled
+        error
+        rerouted
+        swapped
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(canceled = SKIP, error = SKIP, rerouted = SKIP,
+                   swapped = SKIP)
+      @canceled = canceled unless canceled == SKIP
+      @error = error unless error == SKIP
+      @rerouted = rerouted unless rerouted == SKIP
+      @swapped = swapped unless swapped == 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.
+      # Parameter is an array, so we need to iterate through it
+      canceled = nil
+      unless hash['canceled'].nil?
+        canceled = []
+        hash['canceled'].each do |structure|
+          canceled << (Canceled.from_hash(structure) if structure)
+        end
+      end
+
+      canceled = SKIP unless hash.key?('canceled')
+      error = Error.from_hash(hash['error']) if hash['error']
+      # Parameter is an array, so we need to iterate through it
+      rerouted = nil
+      unless hash['rerouted'].nil?
+        rerouted = []
+        hash['rerouted'].each do |structure|
+          rerouted << (Rerouted.from_hash(structure) if structure)
+        end
+      end
+
+      rerouted = SKIP unless hash.key?('rerouted')
+      # Parameter is an array, so we need to iterate through it
+      swapped = nil
+      unless hash['swapped'].nil?
+        swapped = []
+        hash['swapped'].each do |structure|
+          swapped << (Swapped.from_hash(structure) if structure)
+        end
+      end
+
+      swapped = SKIP unless hash.key?('swapped')
+
+      # Create object from extracted values.
+      OrderConflictResolutionResponse.new(canceled,
+                                          error,
+                                          rerouted,
+                                          swapped)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} canceled: #{@canceled}, error: #{@error}, rerouted: #{@rerouted}, swapped:"\
+      " #{@swapped}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} canceled: #{@canceled.inspect}, error: #{@error.inspect}, rerouted:"\
+      " #{@rerouted.inspect}, swapped: #{@swapped.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/order_fulfillment_requests_response.rb

@@ -0,0 +1,70 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Fulfillment requests for an order
+  class OrderFulfillmentRequestsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # All fulfillment requests that belongs to the order. Can be empty if order
+    # not routed yet, or if order doesn't exist.
+    # @return [Array[FulfillmentRequest1]]
+    attr_accessor :fulfillment_requests
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fulfillment_requests'] = 'fulfillment_requests'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fulfillment_requests = nil)
+      @fulfillment_requests = fulfillment_requests
+    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
+      fulfillment_requests = nil
+      unless hash['fulfillment_requests'].nil?
+        fulfillment_requests = []
+        hash['fulfillment_requests'].each do |structure|
+          fulfillment_requests << (FulfillmentRequest1.from_hash(structure) if structure)
+        end
+      end
+
+      fulfillment_requests = nil unless hash.key?('fulfillment_requests')
+
+      # Create object from extracted values.
+      OrderFulfillmentRequestsResponse.new(fulfillment_requests)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fulfillment_requests: #{@fulfillment_requests}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fulfillment_requests: #{@fulfillment_requests.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/order_injection_configuration_big_sales_order.rb

@@ -0,0 +1,66 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The order item limits that determine if the order is routed or is considered
+  # a big order and placed on hold.
+  class OrderInjectionConfigurationBigSalesOrder < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The maximum number of items an injected or external order can contain for
+    # it to be placed on hold and not be canceled. For example, if this is
+    # ``800`` and ``soft_limit_for_big_orders`` is ``300``, external orders with
+    # items between ``301`` and ``800`` are placed on hold, and an external
+    # order with ``801`` items is canceled.
+    # @return [Float]
+    attr_accessor :hard_limit_for_big_orders
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['hard_limit_for_big_orders'] = 'hard_limit_for_big_orders'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(hard_limit_for_big_orders = nil)
+      @hard_limit_for_big_orders = hard_limit_for_big_orders
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      hard_limit_for_big_orders =
+        hash.key?('hard_limit_for_big_orders') ? hash['hard_limit_for_big_orders'] : nil
+
+      # Create object from extracted values.
+      OrderInjectionConfigurationBigSalesOrder.new(hard_limit_for_big_orders)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} hard_limit_for_big_orders: #{@hard_limit_for_big_orders}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} hard_limit_for_big_orders: #{@hard_limit_for_big_orders.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/order_injection_configuration_response.rb

@@ -0,0 +1,101 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Update configuration response
+  class OrderInjectionConfigurationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # Internal User ID
+    # @return [String]
+    attr_accessor :updated_by
+
+    # Tenant configuration object.
+    # @return [OrderInjectionTenantConfiguration]
+    attr_accessor :value
+
+    # Current Configuration version
+    # @return [String]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['updated_by'] = 'updated_by'
+      @_hash['value'] = 'value'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        updated_at
+        updated_by
+        value
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(updated_at = SKIP, updated_by = SKIP, value = SKIP,
+                   version = SKIP)
+      @updated_at = updated_at unless updated_at == SKIP
+      @updated_by = updated_by unless updated_by == SKIP
+      @value = value unless value == SKIP
+      @version = version unless version == 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.
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   else
+                     SKIP
+                   end
+      updated_by = hash.key?('updated_by') ? hash['updated_by'] : SKIP
+      value = OrderInjectionTenantConfiguration.from_hash(hash['value']) if hash['value']
+      version = hash.key?('version') ? hash['version'] : SKIP
+
+      # Create object from extracted values.
+      OrderInjectionConfigurationResponse.new(updated_at,
+                                              updated_by,
+                                              value,
+                                              version)
+    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}, updated_by: #{@updated_by}, value: #{@value},"\
+      " version: #{@version}>"
+    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}, updated_by: #{@updated_by.inspect},"\
+      " value: #{@value.inspect}, version: #{@version.inspect}>"
+    end
+  end
+end