newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/order_injection_tenant_configuration.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
+  # Tenant configuration object.
+  class OrderInjectionTenantConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The order item limits that determine if the order is routed or is
+    # considered a big order and placed on hold.
+    # @return [OrderInjectionConfigurationBigSalesOrder]
+    attr_accessor :big_sales_order
+
+    # When set to true, do not do the soft routing for injected orders with a
+    # service level identifier.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skip_soft_routing_on_injection
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['big_sales_order'] = 'big_sales_order'
+      @_hash['skip_soft_routing_on_injection'] =
+        'skip_soft_routing_on_injection'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        big_sales_order
+        skip_soft_routing_on_injection
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(big_sales_order = SKIP,
+                   skip_soft_routing_on_injection = SKIP)
+      @big_sales_order = big_sales_order unless big_sales_order == SKIP
+      unless skip_soft_routing_on_injection == SKIP
+        @skip_soft_routing_on_injection =
+          skip_soft_routing_on_injection
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      if hash['big_sales_order']
+        big_sales_order = OrderInjectionConfigurationBigSalesOrder.from_hash(hash['big_sales_order'])
+      end
+      skip_soft_routing_on_injection =
+        hash.key?('skip_soft_routing_on_injection') ? hash['skip_soft_routing_on_injection'] : SKIP
+
+      # Create object from extracted values.
+      OrderInjectionTenantConfiguration.new(big_sales_order,
+                                            skip_soft_routing_on_injection)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} big_sales_order: #{@big_sales_order}, skip_soft_routing_on_injection:"\
+      " #{@skip_soft_routing_on_injection}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} big_sales_order: #{@big_sales_order.inspect},"\
+      " skip_soft_routing_on_injection: #{@skip_soft_routing_on_injection.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/order_management_state_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 state.
+  class OrderManagementStateEnum
+    ORDER_MANAGEMENT_STATE_ENUM = [
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORDER_MANAGEMENT_STATE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = OK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ok' then OK
+      when 'failed' then FAILED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/order_request.rb

@@ -0,0 +1,208 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The minimum-viable order placement request. Required fields only. This first
+  # slice supports in-store cash-and-carry orders from self-checkout machines
+  # and Associate App.
+  class OrderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The catalogue and locale used to resolve the order's items.
+    # @return [Catalog]
+    attr_accessor :catalog
+
+    # Describes the origin of the order.
+    # @return [Channel1]
+    attr_accessor :channel
+
+    # Associated checkout ID for reconciliation.
+    # @return [String]
+    attr_accessor :checkout_id
+
+    # The customer placing the order. Omitted for anonymous orders.
+    # @return [Customer]
+    attr_accessor :customer
+
+    # Tenant-defined name/value pairs for the order, propagated through the
+    # platform.
+    # @return [Array[ExtendedAttribute]]
+    attr_accessor :extended_attributes
+
+    # Caller-supplied external identifier for correlation and external lookup.
+    # Must be unique per tenant when supplied. The order number is generated by
+    # the system.
+    # @return [String]
+    attr_accessor :external_id
+
+    # Caller-supplied external identifier for correlation and external lookup.
+    # Must be unique per tenant when supplied. The order number is generated by
+    # the system.
+    # @return [Array[Fulfillment1]]
+    attr_accessor :fulfillments
+
+    # Gift wrapping applied to the order's line items. At most one, and it must
+    # cover every line item — partial gift wrapping (wrapping only some items)
+    # is not yet supported. Omitted when nothing is gift-wrapped.
+    # @return [Array[GiftWrapping]]
+    attr_accessor :gift_wrappings
+
+    # Gift wrapping applied to the order's line items. At most one, and it must
+    # cover every line item — partial gift wrapping (wrapping only some items)
+    # is not yet supported. Omitted when nothing is gift-wrapped.
+    # @return [Array[LineItem2]]
+    attr_accessor :line_items
+
+    # The payments attached to an order.
+    # @return [Payment]
+    attr_accessor :payment
+
+    # Currency and tax treatment for all prices in the payload.
+    # @return [Pricing]
+    attr_accessor :pricing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['catalog'] = 'catalog'
+      @_hash['channel'] = 'channel'
+      @_hash['checkout_id'] = 'checkout_id'
+      @_hash['customer'] = 'customer'
+      @_hash['extended_attributes'] = 'extended_attributes'
+      @_hash['external_id'] = 'external_id'
+      @_hash['fulfillments'] = 'fulfillments'
+      @_hash['gift_wrappings'] = 'gift_wrappings'
+      @_hash['line_items'] = 'line_items'
+      @_hash['payment'] = 'payment'
+      @_hash['pricing'] = 'pricing'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        checkout_id
+        customer
+        extended_attributes
+        external_id
+        gift_wrappings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        checkout_id
+        customer
+        external_id
+      ]
+    end
+
+    def initialize(catalog = nil, channel = nil, fulfillments = nil,
+                   line_items = nil, payment = nil, pricing = nil,
+                   checkout_id = SKIP, customer = SKIP,
+                   extended_attributes = SKIP, external_id = SKIP,
+                   gift_wrappings = SKIP)
+      @catalog = catalog
+      @channel = channel
+      @checkout_id = checkout_id unless checkout_id == SKIP
+      @customer = customer unless customer == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @external_id = external_id unless external_id == SKIP
+      @fulfillments = fulfillments
+      @gift_wrappings = gift_wrappings unless gift_wrappings == SKIP
+      @line_items = line_items
+      @payment = payment
+      @pricing = pricing
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      catalog = Catalog.from_hash(hash['catalog']) if hash['catalog']
+      channel = Channel1.from_hash(hash['channel']) if hash['channel']
+      # Parameter is an array, so we need to iterate through it
+      fulfillments = nil
+      unless hash['fulfillments'].nil?
+        fulfillments = []
+        hash['fulfillments'].each do |structure|
+          fulfillments << (Fulfillment1.from_hash(structure) if structure)
+        end
+      end
+
+      fulfillments = nil unless hash.key?('fulfillments')
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (LineItem2.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+      payment = Payment.from_hash(hash['payment']) if hash['payment']
+      pricing = Pricing.from_hash(hash['pricing']) if hash['pricing']
+      checkout_id = hash.key?('checkout_id') ? hash['checkout_id'] : SKIP
+      customer = Customer.from_hash(hash['customer']) if hash['customer']
+      # Parameter is an array, so we need to iterate through it
+      extended_attributes = nil
+      unless hash['extended_attributes'].nil?
+        extended_attributes = []
+        hash['extended_attributes'].each do |structure|
+          extended_attributes << (ExtendedAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extended_attributes')
+      external_id = hash.key?('external_id') ? hash['external_id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      gift_wrappings = nil
+      unless hash['gift_wrappings'].nil?
+        gift_wrappings = []
+        hash['gift_wrappings'].each do |structure|
+          gift_wrappings << (GiftWrapping.from_hash(structure) if structure)
+        end
+      end
+
+      gift_wrappings = SKIP unless hash.key?('gift_wrappings')
+
+      # Create object from extracted values.
+      OrderRequest.new(catalog,
+                       channel,
+                       fulfillments,
+                       line_items,
+                       payment,
+                       pricing,
+                       checkout_id,
+                       customer,
+                       extended_attributes,
+                       external_id,
+                       gift_wrappings)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} catalog: #{@catalog}, channel: #{@channel}, checkout_id: #{@checkout_id},"\
+      " customer: #{@customer}, extended_attributes: #{@extended_attributes}, external_id:"\
+      " #{@external_id}, fulfillments: #{@fulfillments}, gift_wrappings: #{@gift_wrappings},"\
+      " line_items: #{@line_items}, payment: #{@payment}, pricing: #{@pricing}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} catalog: #{@catalog.inspect}, channel: #{@channel.inspect}, checkout_id:"\
+      " #{@checkout_id.inspect}, customer: #{@customer.inspect}, extended_attributes:"\
+      " #{@extended_attributes.inspect}, external_id: #{@external_id.inspect}, fulfillments:"\
+      " #{@fulfillments.inspect}, gift_wrappings: #{@gift_wrappings.inspect}, line_items:"\
+      " #{@line_items.inspect}, payment: #{@payment.inspect}, pricing: #{@pricing.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/order_response.rb

@@ -0,0 +1,101 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The response returned after an order is accepted.
+  class OrderResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Caller-provided external identifier echoed back when supplied in the
+    # request.
+    # @return [String]
+    attr_accessor :external_id
+
+    # The unique identifier of the order assigned by the system.
+    # @return [String]
+    attr_accessor :id
+
+    # Identifiers of the order items.
+    # @return [Array[ResponseUnitItem]]
+    attr_accessor :items
+
+    # Human-readable order number generated by the system.
+    # @return [String]
+    attr_accessor :order_number
+
+    # 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['items'] = 'items'
+      @_hash['order_number'] = 'order_number'
+      @_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, items = nil, order_number = nil,
+                   external_id = SKIP)
+      @external_id = external_id unless external_id == SKIP
+      @id = id
+      @items = items
+      @order_number = order_number
+    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 << (ResponseUnitItem.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+      order_number = hash.key?('order_number') ? hash['order_number'] : nil
+      external_id = hash.key?('external_id') ? hash['external_id'] : SKIP
+
+      # Create object from extracted values.
+      OrderResponse.new(id,
+                        items,
+                        order_number,
+                        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}, items: #{@items}, order_number:"\
+      " #{@order_number}>"
+    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}, items:"\
+      " #{@items.inspect}, order_number: #{@order_number.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/origin.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 ship-from origin for this fulfillment group. Omitted when neither zip
+  # code nor country code is known.
+  class Origin < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ship-from country code (ISO 3166-1 alpha-2).
+    # @return [String]
+    attr_accessor :country_code
+
+    # The ship-from postal code.
+    # @return [String]
+    attr_accessor :zip_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country_code'] = 'country_code'
+      @_hash['zip_code'] = 'zip_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country_code
+        zip_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code = SKIP, zip_code = SKIP)
+      @country_code = country_code unless country_code == SKIP
+      @zip_code = zip_code unless zip_code == 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.
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      zip_code = hash.key?('zip_code') ? hash['zip_code'] : SKIP
+
+      # Create object from extracted values.
+      Origin.new(country_code,
+                 zip_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code}, zip_code: #{@zip_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country_code: #{@country_code.inspect}, zip_code: #{@zip_code.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/original.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 original routing strategy on order creation
+  class Original < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :fulfillment_node_id
+
+    # TODO: Write general description for this method
+    # @return [RoutingInsightsStrategyTypeEnum]
+    attr_accessor :strategy
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fulfillment_node_id'] = 'fulfillment_node_id'
+      @_hash['strategy'] = 'strategy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fulfillment_node_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(strategy = nil, fulfillment_node_id = SKIP)
+      @fulfillment_node_id = fulfillment_node_id unless fulfillment_node_id == SKIP
+      @strategy = strategy
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      strategy = hash.key?('strategy') ? hash['strategy'] : nil
+      fulfillment_node_id =
+        hash.key?('fulfillment_node_id') ? hash['fulfillment_node_id'] : SKIP
+
+      # Create object from extracted values.
+      Original.new(strategy,
+                   fulfillment_node_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fulfillment_node_id: #{@fulfillment_node_id}, strategy: #{@strategy}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fulfillment_node_id: #{@fulfillment_node_id.inspect}, strategy:"\
+      " #{@strategy.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/package_dimensions.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
+  # The physical dimensions of a package type.
+  class PackageDimensions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Height of the package.
+    # @return [Float]
+    attr_accessor :height
+
+    # Length of the package.
+    # @return [Float]
+    attr_accessor :length
+
+    # Unit of measurement for the dimensions.
+    # @return [DimensionUnitEnum]
+    attr_accessor :unit
+
+    # Width of the package.
+    # @return [Float]
+    attr_accessor :width
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['height'] = 'height'
+      @_hash['length'] = 'length'
+      @_hash['unit'] = 'unit'
+      @_hash['width'] = 'width'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(height = nil, length = nil, unit = nil, width = nil)
+      @height = height
+      @length = length
+      @unit = unit
+      @width = width
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      height = hash.key?('height') ? hash['height'] : nil
+      length = hash.key?('length') ? hash['length'] : nil
+      unit = hash.key?('unit') ? hash['unit'] : nil
+      width = hash.key?('width') ? hash['width'] : nil
+
+      # Create object from extracted values.
+      PackageDimensions.new(height,
+                            length,
+                            unit,
+                            width)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} height: #{@height}, length: #{@length}, unit: #{@unit}, width: #{@width}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} height: #{@height.inspect}, length: #{@length.inspect}, unit:"\
+      " #{@unit.inspect}, width: #{@width.inspect}>"
+    end
+  end
+end