newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/sales_order_item_shipment.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
+  # SalesOrderItemShipment Model.
+  class SalesOrderItemShipment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of applied discounts
+    # @return [Array[SalesOrderDiscount]]
+    attr_accessor :discounts
+
+    # Order item UUID of the shipment
+    # @return [String]
+    attr_accessor :id
+
+    # The response for retrieving price information.
+    # @return [SalesOrderPrice1]
+    attr_accessor :price
+
+    # Detailed tax information.
+    # @return [Array[SalesOrderTaxLine]]
+    attr_accessor :tax_lines
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discounts'] = 'discounts'
+      @_hash['id'] = 'id'
+      @_hash['price'] = 'price'
+      @_hash['tax_lines'] = 'tax_lines'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        discounts
+        tax_lines
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil, price = nil, discounts = SKIP, tax_lines = SKIP)
+      @discounts = discounts unless discounts == SKIP
+      @id = id
+      @price = price
+      @tax_lines = tax_lines unless tax_lines == 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
+      price = SalesOrderPrice1.from_hash(hash['price']) if hash['price']
+      # Parameter is an array, so we need to iterate through it
+      discounts = nil
+      unless hash['discounts'].nil?
+        discounts = []
+        hash['discounts'].each do |structure|
+          discounts << (SalesOrderDiscount.from_hash(structure) if structure)
+        end
+      end
+
+      discounts = SKIP unless hash.key?('discounts')
+      # Parameter is an array, so we need to iterate through it
+      tax_lines = nil
+      unless hash['tax_lines'].nil?
+        tax_lines = []
+        hash['tax_lines'].each do |structure|
+          tax_lines << (SalesOrderTaxLine.from_hash(structure) if structure)
+        end
+      end
+
+      tax_lines = SKIP unless hash.key?('tax_lines')
+
+      # Create object from extracted values.
+      SalesOrderItemShipment.new(id,
+                                 price,
+                                 discounts,
+                                 tax_lines)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discounts: #{@discounts}, id: #{@id}, price: #{@price}, tax_lines:"\
+      " #{@tax_lines}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discounts: #{@discounts.inspect}, id: #{@id.inspect}, price:"\
+      " #{@price.inspect}, tax_lines: #{@tax_lines.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_item_status_enum.rb

@@ -0,0 +1,54 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Current status of the order item. 'pending' means the item is in the grace
+  # period, 'on_hold' means the item couldn't be fulfilled and is in a conflict
+  # status.
+  class SalesOrderItemStatusEnum
+    SALES_ORDER_ITEM_STATUS_ENUM = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for IN_FULFILLMENT
+      IN_FULFILLMENT = 'in_fulfillment'.freeze,
+
+      # TODO: Write general description for ON_HOLD
+      ON_HOLD = 'on_hold'.freeze,
+
+      # TODO: Write general description for COMPLETE
+      COMPLETE = 'complete'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for RETURNED
+      RETURNED = 'returned'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SALES_ORDER_ITEM_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'in_fulfillment' then IN_FULFILLMENT
+      when 'on_hold' then ON_HOLD
+      when 'complete' then COMPLETE
+      when 'cancelled' then CANCELLED
+      when 'returned' then RETURNED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_item_v2.rb

@@ -0,0 +1,134 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SalesOrderItemV2 Model.
+  class SalesOrderItemV2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Extended attributes of the sales order item.
+    # @return [Array[SalesOrderExtendedAttribute]]
+    attr_accessor :extended_attributes
+
+    # External identifier for the order item
+    # @return [SalesOrderExternalIdentifier]
+    attr_accessor :external_identifier
+
+    # The identifier of the order item
+    # @return [String]
+    attr_accessor :id
+
+    # The response for retrieving price information.
+    # @return [SalesOrderPrice1]
+    attr_accessor :price
+
+    # Additional product-related information.
+    # @return [SalesOrderProductAttributes]
+    attr_accessor :product_attributes
+
+    # Product ID for order item.
+    # @return [String]
+    attr_accessor :product_id
+
+    # Current status of the order item. 'pending' means the item is in the grace
+    # period, 'on_hold' means the item couldn't be fulfilled and is in a
+    # conflict status.
+    # @return [SalesOrderItemStatusEnum]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['extended_attributes'] = 'extended_attributes'
+      @_hash['external_identifier'] = 'external_identifier'
+      @_hash['id'] = 'id'
+      @_hash['price'] = 'price'
+      @_hash['product_attributes'] = 'product_attributes'
+      @_hash['product_id'] = 'product_id'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        extended_attributes
+        external_identifier
+        product_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        extended_attributes
+      ]
+    end
+
+    def initialize(id = nil, price = nil, product_attributes = nil,
+                   status = nil, extended_attributes = SKIP,
+                   external_identifier = SKIP, product_id = SKIP)
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @external_identifier = external_identifier unless external_identifier == SKIP
+      @id = id
+      @price = price
+      @product_attributes = product_attributes
+      @product_id = product_id unless product_id == SKIP
+      @status = status
+    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
+      price = SalesOrderPrice1.from_hash(hash['price']) if hash['price']
+      product_attributes = SalesOrderProductAttributes.from_hash(hash['product_attributes']) if
+        hash['product_attributes']
+      status = hash.key?('status') ? hash['status'] : nil
+      # 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 << (SalesOrderExtendedAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extended_attributes')
+      external_identifier = SalesOrderExternalIdentifier.from_hash(hash['external_identifier']) if
+        hash['external_identifier']
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+
+      # Create object from extracted values.
+      SalesOrderItemV2.new(id,
+                           price,
+                           product_attributes,
+                           status,
+                           extended_attributes,
+                           external_identifier,
+                           product_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} extended_attributes: #{@extended_attributes}, external_identifier:"\
+      " #{@external_identifier}, id: #{@id}, price: #{@price}, product_attributes:"\
+      " #{@product_attributes}, product_id: #{@product_id}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} extended_attributes: #{@extended_attributes.inspect}, external_identifier:"\
+      " #{@external_identifier.inspect}, id: #{@id.inspect}, price: #{@price.inspect},"\
+      " product_attributes: #{@product_attributes.inspect}, product_id: #{@product_id.inspect},"\
+      " status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_items1.rb

@@ -0,0 +1,127 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # Routing insights data for the current sales order item uuid
+  class SalesOrderItems1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Current conflict reason for this sales order item. Empty, if item is not
+    # in a conflict state
+    # @return [String]
+    attr_accessor :conflict_reason
+
+    # Correlation information used to interpret routing attempts by LO uuids
+    # @return [Correlation]
+    attr_accessor :correlation
+
+    # Correlation information used to interpret routing attempts by LO uuids
+    # @return [String]
+    attr_accessor :product_id
+
+    # Correlation information used to interpret routing attempts by LO uuids
+    # @return [RoutingStatusEnum]
+    attr_accessor :routing_status
+
+    # Correlation information used to interpret routing attempts by LO uuids
+    # @return [ServiceLevels]
+    attr_accessor :service_levels
+
+    # Correlation information used to interpret routing attempts by LO uuids
+    # @return [Strategies]
+    attr_accessor :strategies
+
+    # Correlation information used to interpret routing attempts by LO uuids
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['conflict_reason'] = 'conflict_reason'
+      @_hash['correlation'] = 'correlation'
+      @_hash['product_id'] = 'product_id'
+      @_hash['routing_status'] = 'routing_status'
+      @_hash['service_levels'] = 'service_levels'
+      @_hash['strategies'] = 'strategies'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        conflict_reason
+      ]
+    end
+
+    def initialize(conflict_reason = nil, correlation = nil, product_id = nil,
+                   routing_status = nil, service_levels = nil, strategies = nil,
+                   updated_at = nil)
+      @conflict_reason = conflict_reason
+      @correlation = correlation
+      @product_id = product_id
+      @routing_status = routing_status
+      @service_levels = service_levels
+      @strategies = strategies
+      @updated_at = updated_at
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      conflict_reason =
+        hash.key?('conflict_reason') ? hash['conflict_reason'] : nil
+      correlation = Correlation.from_hash(hash['correlation']) if hash['correlation']
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      routing_status =
+        hash.key?('routing_status') ? hash['routing_status'] : nil
+      service_levels = ServiceLevels.from_hash(hash['service_levels']) if hash['service_levels']
+      strategies = Strategies.from_hash(hash['strategies']) if hash['strategies']
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+
+      # Create object from extracted values.
+      SalesOrderItems1.new(conflict_reason,
+                           correlation,
+                           product_id,
+                           routing_status,
+                           service_levels,
+                           strategies,
+                           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} conflict_reason: #{@conflict_reason}, correlation: #{@correlation},"\
+      " product_id: #{@product_id}, routing_status: #{@routing_status}, service_levels:"\
+      " #{@service_levels}, strategies: #{@strategies}, updated_at: #{@updated_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} conflict_reason: #{@conflict_reason.inspect}, correlation:"\
+      " #{@correlation.inspect}, product_id: #{@product_id.inspect}, routing_status:"\
+      " #{@routing_status.inspect}, service_levels: #{@service_levels.inspect}, strategies:"\
+      " #{@strategies.inspect}, updated_at: #{@updated_at.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_list_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
+  # Order history for a customer retrieved from external OMS
+  class SalesOrderListResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Customer's order history
+    # @return [Array[SalesOrder]]
+    attr_accessor :orders
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['orders'] = 'orders'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(orders = nil)
+      @orders = 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.
+      # Parameter is an array, so we need to iterate through it
+      orders = nil
+      unless hash['orders'].nil?
+        orders = []
+        hash['orders'].each do |structure|
+          orders << (SalesOrder.from_hash(structure) if structure)
+        end
+      end
+
+      orders = nil unless hash.key?('orders')
+
+      # Create object from extracted values.
+      SalesOrderListResponse.new(orders)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} orders: #{@orders}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} orders: #{@orders.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_list_response_v2.rb

@@ -0,0 +1,79 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Order history for a customer retrieved from NewStore OMS
+  class SalesOrderListResponseV2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains the list of orders for the customer with the given
+    # ``customer_id``.
+    # @return [Array[SalesOrderV2]]
+    attr_accessor :orders
+
+    # Pagination information for the order history response.
+    # @return [PaginatedResponse]
+    attr_accessor :pagination_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['orders'] = 'orders'
+      @_hash['pagination_info'] = 'pagination_info'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(orders = nil, pagination_info = nil)
+      @orders = orders
+      @pagination_info = pagination_info
+    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
+      orders = nil
+      unless hash['orders'].nil?
+        orders = []
+        hash['orders'].each do |structure|
+          orders << (SalesOrderV2.from_hash(structure) if structure)
+        end
+      end
+
+      orders = nil unless hash.key?('orders')
+      pagination_info = PaginatedResponse.from_hash(hash['pagination_info']) if
+        hash['pagination_info']
+
+      # Create object from extracted values.
+      SalesOrderListResponseV2.new(orders,
+                                   pagination_info)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} orders: #{@orders}, pagination_info: #{@pagination_info}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} orders: #{@orders.inspect}, pagination_info: #{@pagination_info.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_origin_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
+  # Describes in which Order Management System the order originated from.
+  class SalesOrderOriginEnum
+    SALES_ORDER_ORIGIN_ENUM = [
+      # TODO: Write general description for NEWSTORE
+      NEWSTORE = 'newstore'.freeze,
+
+      # TODO: Write general description for EXTERNAL
+      EXTERNAL = 'external'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SALES_ORDER_ORIGIN_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NEWSTORE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'newstore' then NEWSTORE
+      when 'external' then EXTERNAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_payment_method_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
+  # The method customer paid for the order.
+  class SalesOrderPaymentMethodEnum
+    SALES_ORDER_PAYMENT_METHOD_ENUM = [
+      # TODO: Write general description for GIFT_CARD
+      GIFT_CARD = 'gift_card'.freeze,
+
+      # TODO: Write general description for CREDIT_CARD
+      CREDIT_CARD = 'credit_card'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SALES_ORDER_PAYMENT_METHOD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = GIFT_CARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'gift_card' then GIFT_CARD
+      when 'credit_card' then CREDIT_CARD
+      when 'cash' then CASH
+      else
+        default_value
+      end
+    end
+  end
+end