newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/sales_order_discount.rb

@@ -0,0 +1,123 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SalesOrderDiscount Model.
+  class SalesOrderDiscount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The coupon code used for this discount.
+    # @return [String]
+    attr_accessor :coupon_code
+
+    # On which level the discount was applied, either on the entire order or
+    # only on this item.
+    # @return [LevelEnum]
+    attr_accessor :level
+
+    # The applied discount.
+    # @return [Float]
+    attr_accessor :price_adjustment
+
+    # The UUID of the the discount.
+    # @return [String]
+    attr_accessor :promotion_uuid
+
+    # The reason of the discount.
+    # @return [String]
+    attr_accessor :reason
+
+    # The type of the discount, either 'fixed' or 'percentage'.
+    # @return [Type1Enum]
+    attr_accessor :type
+
+    # If the discount is of type 'fixed', this is equal to the adjusted price
+    # amount. If the discount is of type 'percentage', this is the percentage,
+    # e.g. 20%.
+    # @return [Float]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['coupon_code'] = 'coupon_code'
+      @_hash['level'] = 'level'
+      @_hash['price_adjustment'] = 'price_adjustment'
+      @_hash['promotion_uuid'] = 'promotion_uuid'
+      @_hash['reason'] = 'reason'
+      @_hash['type'] = 'type'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        coupon_code
+        promotion_uuid
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(level = nil, price_adjustment = nil, type = nil, value = nil,
+                   coupon_code = SKIP, promotion_uuid = SKIP, reason = SKIP)
+      @coupon_code = coupon_code unless coupon_code == SKIP
+      @level = level
+      @price_adjustment = price_adjustment
+      @promotion_uuid = promotion_uuid unless promotion_uuid == SKIP
+      @reason = reason unless reason == SKIP
+      @type = type
+      @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.
+      level = hash.key?('level') ? hash['level'] : nil
+      price_adjustment =
+        hash.key?('price_adjustment') ? hash['price_adjustment'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+      coupon_code = hash.key?('coupon_code') ? hash['coupon_code'] : SKIP
+      promotion_uuid =
+        hash.key?('promotion_uuid') ? hash['promotion_uuid'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      SalesOrderDiscount.new(level,
+                             price_adjustment,
+                             type,
+                             value,
+                             coupon_code,
+                             promotion_uuid,
+                             reason)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} coupon_code: #{@coupon_code}, level: #{@level}, price_adjustment:"\
+      " #{@price_adjustment}, promotion_uuid: #{@promotion_uuid}, reason: #{@reason}, type:"\
+      " #{@type}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} coupon_code: #{@coupon_code.inspect}, level: #{@level.inspect},"\
+      " price_adjustment: #{@price_adjustment.inspect}, promotion_uuid:"\
+      " #{@promotion_uuid.inspect}, reason: #{@reason.inspect}, type: #{@type.inspect}, value:"\
+      " #{@value.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_extended_attribute.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
+  # SalesOrderExtendedAttribute Model.
+  class SalesOrderExtendedAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_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(name = nil, value = nil)
+      @name = name
+      @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.
+      name = hash.key?('name') ? hash['name'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+
+      # Create object from extracted values.
+      SalesOrderExtendedAttribute.new(name,
+                                      value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_external_identifier.rb

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

data/lib/new_store_api/models/sales_order_fulfillment.rb

@@ -0,0 +1,71 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # SalesOrderFulfillment Model.
+  class SalesOrderFulfillment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The order item UUIDs belonging to this fulfillment group.
+    # @return [Array[String]]
+    attr_accessor :item_ids
+
+    # The ship-from origin for this fulfillment group. Omitted when neither zip
+    # code nor country code is known.
+    # @return [Origin]
+    attr_accessor :origin
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['item_ids'] = 'item_ids'
+      @_hash['origin'] = 'origin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        origin
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_ids = nil, origin = SKIP)
+      @item_ids = item_ids
+      @origin = origin unless origin == 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.
+      item_ids = hash.key?('item_ids') ? hash['item_ids'] : nil
+      origin = Origin.from_hash(hash['origin']) if hash['origin']
+
+      # Create object from extracted values.
+      SalesOrderFulfillment.new(item_ids,
+                                origin)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_ids: #{@item_ids}, origin: #{@origin}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_ids: #{@item_ids.inspect}, origin: #{@origin.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_fulfillment_type_enum.rb

@@ -0,0 +1,49 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # The fulfillment type of the order. In case of mixed cart orders, fulfillment
+  # type is always 'multiple'
+  class SalesOrderFulfillmentTypeEnum
+    SALES_ORDER_FULFILLMENT_TYPE_ENUM = [
+      # TODO: Write general description for TRADITIONAL
+      TRADITIONAL = 'traditional'.freeze,
+
+      # TODO: Write general description for SAME_DAY_DELIVERY
+      SAME_DAY_DELIVERY = 'same_day_delivery'.freeze,
+
+      # TODO: Write general description for IN_STORE_PICKUP
+      IN_STORE_PICKUP = 'in_store_pickup'.freeze,
+
+      # TODO: Write general description for IN_STORE_PURCHASE
+      IN_STORE_PURCHASE = 'in_store_purchase'.freeze,
+
+      # TODO: Write general description for MULTIPLE
+      MULTIPLE = 'multiple'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SALES_ORDER_FULFILLMENT_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = TRADITIONAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'traditional' then TRADITIONAL
+      when 'same_day_delivery' then SAME_DAY_DELIVERY
+      when 'in_store_pickup' then IN_STORE_PICKUP
+      when 'in_store_purchase' then IN_STORE_PURCHASE
+      when 'multiple' then MULTIPLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_gift_wrapping.rb

@@ -0,0 +1,90 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Gift wrapping information. This field is not required and will not be
+  # present if gift wrapping is not applicable for the order
+  class SalesOrderGiftWrapping < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Personalised message to be printing on the gift wrapper.
+    # @return [String]
+    attr_accessor :message
+
+    # Personalised message to be printing on the gift wrapper.
+    # @return [Price1]
+    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['message'] = 'message'
+      @_hash['price'] = 'price'
+      @_hash['tax_lines'] = 'tax_lines'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        message
+        tax_lines
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price = nil, message = SKIP, tax_lines = SKIP)
+      @message = message unless message == SKIP
+      @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.
+      price = Price1.from_hash(hash['price']) if hash['price']
+      message = hash.key?('message') ? hash['message'] : SKIP
+      # 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.
+      SalesOrderGiftWrapping.new(price,
+                                 message,
+                                 tax_lines)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}, 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} message: #{@message.inspect}, price: #{@price.inspect}, tax_lines:"\
+      " #{@tax_lines.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_item.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
+  # SalesOrderItem Model.
+  class SalesOrderItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # External identifier for the order item
+    # @return [SalesOrderExternalIdentifier]
+    attr_accessor :external_identifier
+
+    # External ID of the item
+    # @return [String]
+    attr_accessor :id
+
+    # If the origin of the order is 'newstore', this should be the order item
+    # identifier. If the order originated in an external system, it should be
+    # the identifier from the external system.
+    # @return [String]
+    attr_accessor :origin_id
+
+    # The response for retrieving price information.
+    # @return [SalesOrderPrice1]
+    attr_accessor :price
+
+    # Additional product-related information.
+    # @return [SalesOrderProductAttributes]
+    attr_accessor :product_attributes
+
+    # 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['external_identifier'] = 'external_identifier'
+      @_hash['id'] = 'id'
+      @_hash['origin_id'] = 'origin_id'
+      @_hash['price'] = 'price'
+      @_hash['product_attributes'] = 'product_attributes'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_identifier = nil, id = nil, origin_id = nil,
+                   price = nil, product_attributes = nil, status = nil)
+      @external_identifier = external_identifier
+      @id = id
+      @origin_id = origin_id
+      @price = price
+      @product_attributes = product_attributes
+      @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.
+      external_identifier = SalesOrderExternalIdentifier.from_hash(hash['external_identifier']) if
+        hash['external_identifier']
+      id = hash.key?('id') ? hash['id'] : nil
+      origin_id = hash.key?('origin_id') ? hash['origin_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
+
+      # Create object from extracted values.
+      SalesOrderItem.new(external_identifier,
+                         id,
+                         origin_id,
+                         price,
+                         product_attributes,
+                         status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} external_identifier: #{@external_identifier}, id: #{@id}, origin_id:"\
+      " #{@origin_id}, price: #{@price}, product_attributes: #{@product_attributes}, status:"\
+      " #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} external_identifier: #{@external_identifier.inspect}, id: #{@id.inspect},"\
+      " origin_id: #{@origin_id.inspect}, price: #{@price.inspect}, product_attributes:"\
+      " #{@product_attributes.inspect}, status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/sales_order_item_payment_history.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
+  # Contains the payments/refunds history for the order. Can also include
+  # multiple payments against multiple credit sources (i.e. gift card + credit
+  # card)
+  class SalesOrderItemPaymentHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary value of the payment/refund.
+    # @return [Float]
+    attr_accessor :amount
+
+    # Describes if it is a Payment (authorization or capture) or Refund.
+    # @return [CategoryEnum]
+    attr_accessor :category
+
+    # The currency of the amount as 3 character ISO-4217 code. Example USD, EUR.
+    # @return [String]
+    attr_accessor :currency
+
+    # The method customer paid for the order.
+    # @return [SalesOrderPaymentMethodEnum]
+    attr_accessor :method
+
+    # Any payment information related to the payment method used. For example,
+    # it can contain the card type along with the last 4 digits of the credit
+    # card number.
+    # @return [String]
+    attr_accessor :payment_information
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['category'] = 'category'
+      @_hash['currency'] = 'currency'
+      @_hash['method'] = 'method'
+      @_hash['payment_information'] = 'payment_information'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_information
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, category = nil, currency = nil, method = nil,
+                   payment_information = SKIP)
+      @amount = amount
+      @category = category
+      @currency = currency
+      @method = method
+      @payment_information = payment_information unless payment_information == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      category = hash.key?('category') ? hash['category'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      method = hash.key?('method') ? hash['method'] : nil
+      payment_information =
+        hash.key?('payment_information') ? hash['payment_information'] : SKIP
+
+      # Create object from extracted values.
+      SalesOrderItemPaymentHistory.new(amount,
+                                       category,
+                                       currency,
+                                       method,
+                                       payment_information)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, category: #{@category}, currency: #{@currency}, method:"\
+      " #{@method}, payment_information: #{@payment_information}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, category: #{@category.inspect}, currency:"\
+      " #{@currency.inspect}, method: #{@method.inspect}, payment_information:"\
+      " #{@payment_information.inspect}>"
+    end
+  end
+end