newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/injected_order_request.rb

@@ -0,0 +1,402 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # An order placed in an external system, identified by its `external_id` in
+  # NewStore. An order contains a list of shipments and the products in each
+  # shipment.
+  class InjectedOrderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the store associate who processed this order.
+    # @return [String]
+    attr_accessor :associate_id
+
+    # ID of the store associate who processed this order.
+    # @return [InjectedOrderAddress]
+    attr_accessor :billing_address
+
+    # A string used to distinguish between various sources of orders.
+    # @return [String]
+    attr_accessor :channel_name
+
+    # A string used to distinguish between various sources of orders.
+    # @return [ChannelType1Enum]
+    attr_accessor :channel_type
+
+    # The currency for all the prices contained within this payload.
+    # @return [Currency2Enum]
+    attr_accessor :currency
+
+    # The currency for all the prices contained within this payload.
+    # @return [String]
+    attr_accessor :customer_email
+
+    # Language code according to ISO 639-1 to be used in the communication with
+    # the consumer (e.g. 'de', 'en' or 'fr')
+    # @return [String]
+    attr_accessor :customer_language
+
+    # Language code according to ISO 639-1 to be used in the communication with
+    # the consumer (e.g. 'de', 'en' or 'fr')
+    # @return [String]
+    attr_accessor :customer_name
+
+    # Language code according to ISO 639-1 to be used in the communication with
+    # the consumer (e.g. 'de', 'en' or 'fr')
+    # @return [Array[InjectedOrderExtendedAttribute]]
+    attr_accessor :extended_attributes
+
+    # Language code according to ISO 639-1 to be used in the communication with
+    # the consumer (e.g. 'de', 'en' or 'fr')
+    # @return [String]
+    attr_accessor :external_customer_id
+
+    # Language code according to ISO 639-1 to be used in the communication with
+    # the consumer (e.g. 'de', 'en' or 'fr')
+    # @return [String]
+    attr_accessor :external_id
+
+    # Language code according to ISO 639-1 to be used in the communication with
+    # the consumer (e.g. 'de', 'en' or 'fr')
+    # @return [Object]
+    attr_accessor :ip_address
+
+    # Set to true if the order was already fulfilled. It is either an in-store
+    # purchase, or the order was fulfilled by an external system.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_fulfilled
+
+    # Set to true if the order is historical was created and fulfilled by an
+    # external system.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_historical
+
+    # Set to true if the order was handled offline. It is an in-store purchase
+    # with internet connection failure.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_offline
+
+    # Set to true, if the customer was already notified about order being
+    # placed. This is always true for in-store orders.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_preconfirmed
+
+    # Excludes the specified notifications from being sent to the customer.
+    # @return [Array[String]]
+    attr_accessor :notification_blacklist
+
+    # Excludes the specified notifications from being sent to the customer.
+    # @return [Array[InjectedOrderPayment]]
+    attr_accessor :payments
+
+    # Date representation of when the order was placed, containing date, time
+    # and timezone as defined by https://tools.ietf.org/html/rfc3339 (ISO 8601).
+    # @return [DateTime]
+    attr_accessor :placed_at
+
+    # Specifies if the prices for the shipment items and shipping options
+    # include tax or not. This is used in calculating the total order price to
+    # determine if the tax price should be included in the calculation or not.
+    # @return [F11nTaxMethodEnum]
+    attr_accessor :price_method
+
+    # Specifies if the prices for the shipment items and shipping options
+    # include tax or not. This is used in calculating the total order price to
+    # determine if the tax price should be included in the calculation or not.
+    # @return [Array[Object]]
+    attr_accessor :shipments
+
+    # Specifies if the prices for the shipment items and shipping options
+    # include tax or not. This is used in calculating the total order price to
+    # determine if the tax price should be included in the calculation or not.
+    # @return [InjectedOrderAddress]
+    attr_accessor :shipping_address
+
+    # The shop containing the items of the order.
+    # @return [String]
+    attr_accessor :shop
+
+    # The locale of the customer used for the shop, in RFC 5646.
+    # @return [String]
+    attr_accessor :shop_locale
+
+    # ID of the store where this order was placed.
+    # @return [String]
+    attr_accessor :store_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['associate_id'] = 'associate_id'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['channel_name'] = 'channel_name'
+      @_hash['channel_type'] = 'channel_type'
+      @_hash['currency'] = 'currency'
+      @_hash['customer_email'] = 'customer_email'
+      @_hash['customer_language'] = 'customer_language'
+      @_hash['customer_name'] = 'customer_name'
+      @_hash['extended_attributes'] = 'extended_attributes'
+      @_hash['external_customer_id'] = 'external_customer_id'
+      @_hash['external_id'] = 'external_id'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash['is_fulfilled'] = 'is_fulfilled'
+      @_hash['is_historical'] = 'is_historical'
+      @_hash['is_offline'] = 'is_offline'
+      @_hash['is_preconfirmed'] = 'is_preconfirmed'
+      @_hash['notification_blacklist'] = 'notification_blacklist'
+      @_hash['payments'] = 'payments'
+      @_hash['placed_at'] = 'placed_at'
+      @_hash['price_method'] = 'price_method'
+      @_hash['shipments'] = 'shipments'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['shop'] = 'shop'
+      @_hash['shop_locale'] = 'shop_locale'
+      @_hash['store_id'] = 'store_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        associate_id
+        billing_address
+        customer_email
+        customer_language
+        customer_name
+        extended_attributes
+        external_customer_id
+        ip_address
+        is_fulfilled
+        is_historical
+        is_offline
+        is_preconfirmed
+        notification_blacklist
+        payments
+        placed_at
+        price_method
+        shipping_address
+        store_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(channel_name = nil, channel_type = nil, currency = nil,
+                   external_id = nil, shipments = nil, shop = nil,
+                   shop_locale = nil, associate_id = SKIP,
+                   billing_address = SKIP, customer_email = SKIP,
+                   customer_language = SKIP, customer_name = SKIP,
+                   extended_attributes = SKIP, external_customer_id = SKIP,
+                   ip_address = SKIP, is_fulfilled = false,
+                   is_historical = false, is_offline = false,
+                   is_preconfirmed = false, notification_blacklist = SKIP,
+                   payments = SKIP, placed_at = SKIP, price_method = SKIP,
+                   shipping_address = SKIP, store_id = SKIP)
+      @associate_id = associate_id unless associate_id == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @channel_name = channel_name
+      @channel_type = channel_type
+      @currency = currency
+      @customer_email = customer_email unless customer_email == SKIP
+      @customer_language = customer_language unless customer_language == SKIP
+      @customer_name = customer_name unless customer_name == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @external_customer_id = external_customer_id unless external_customer_id == SKIP
+      @external_id = external_id
+      @ip_address = ip_address unless ip_address == SKIP
+      @is_fulfilled = is_fulfilled unless is_fulfilled == SKIP
+      @is_historical = is_historical unless is_historical == SKIP
+      @is_offline = is_offline unless is_offline == SKIP
+      @is_preconfirmed = is_preconfirmed unless is_preconfirmed == SKIP
+      @notification_blacklist = notification_blacklist unless notification_blacklist == SKIP
+      @payments = payments unless payments == SKIP
+      @placed_at = placed_at unless placed_at == SKIP
+      @price_method = price_method unless price_method == SKIP
+      @shipments = shipments
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @shop = shop
+      @shop_locale = shop_locale
+      @store_id = store_id unless store_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.
+      channel_name = hash.key?('channel_name') ? hash['channel_name'] : nil
+      channel_type = hash.key?('channel_type') ? hash['channel_type'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      external_id = hash.key?('external_id') ? hash['external_id'] : nil
+      shipments = hash.key?('shipments') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:InjectedOrderShipment2), hash['shipments']
+      ) : nil
+      shop = hash.key?('shop') ? hash['shop'] : nil
+      shop_locale = hash.key?('shop_locale') ? hash['shop_locale'] : nil
+      associate_id = hash.key?('associate_id') ? hash['associate_id'] : SKIP
+      billing_address = InjectedOrderAddress.from_hash(hash['billing_address']) if
+        hash['billing_address']
+      customer_email =
+        hash.key?('customer_email') ? hash['customer_email'] : SKIP
+      customer_language =
+        hash.key?('customer_language') ? hash['customer_language'] : SKIP
+      customer_name = hash.key?('customer_name') ? hash['customer_name'] : SKIP
+      # 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 << (InjectedOrderExtendedAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extended_attributes')
+      external_customer_id =
+        hash.key?('external_customer_id') ? hash['external_customer_id'] : SKIP
+      ip_address = hash.key?('ip_address') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:InjectedOrderRequestIpAddress), hash['ip_address']
+      ) : SKIP
+      is_fulfilled = hash['is_fulfilled'] ||= false
+      is_historical = hash['is_historical'] ||= false
+      is_offline = hash['is_offline'] ||= false
+      is_preconfirmed = hash['is_preconfirmed'] ||= false
+      notification_blacklist =
+        hash.key?('notification_blacklist') ? hash['notification_blacklist'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      payments = nil
+      unless hash['payments'].nil?
+        payments = []
+        hash['payments'].each do |structure|
+          payments << (InjectedOrderPayment.from_hash(structure) if structure)
+        end
+      end
+
+      payments = SKIP unless hash.key?('payments')
+      placed_at = if hash.key?('placed_at')
+                    (DateTimeHelper.from_rfc3339(hash['placed_at']) if hash['placed_at'])
+                  else
+                    SKIP
+                  end
+      price_method = hash.key?('price_method') ? hash['price_method'] : SKIP
+      shipping_address = InjectedOrderAddress.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+
+      # Create object from extracted values.
+      InjectedOrderRequest.new(channel_name,
+                               channel_type,
+                               currency,
+                               external_id,
+                               shipments,
+                               shop,
+                               shop_locale,
+                               associate_id,
+                               billing_address,
+                               customer_email,
+                               customer_language,
+                               customer_name,
+                               extended_attributes,
+                               external_customer_id,
+                               ip_address,
+                               is_fulfilled,
+                               is_historical,
+                               is_offline,
+                               is_preconfirmed,
+                               notification_blacklist,
+                               payments,
+                               placed_at,
+                               price_method,
+                               shipping_address,
+                               store_id)
+    end
+
+    def to_custom_placed_at
+      DateTimeHelper.to_rfc3339(placed_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InjectedOrderRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.channel_name,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.channel_type,
+                                  ->(val) { ChannelType1Enum.validate(val) }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { Currency2Enum.validate(val) }) and
+            APIHelper.valid_type?(value.external_id,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:InjectedOrderShipment2)
+                           .validate(value.shipments) and
+            APIHelper.valid_type?(value.shop,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.shop_locale,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['channel_name'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['channel_type'],
+                                ->(val) { ChannelType1Enum.validate(val) }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { Currency2Enum.validate(val) }) and
+          APIHelper.valid_type?(value['external_id'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:InjectedOrderShipment2)
+                         .validate(value['shipments']) and
+          APIHelper.valid_type?(value['shop'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['shop_locale'],
+                                ->(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} associate_id: #{@associate_id}, billing_address: #{@billing_address},"\
+      " channel_name: #{@channel_name}, channel_type: #{@channel_type}, currency: #{@currency},"\
+      " customer_email: #{@customer_email}, customer_language: #{@customer_language},"\
+      " customer_name: #{@customer_name}, extended_attributes: #{@extended_attributes},"\
+      " external_customer_id: #{@external_customer_id}, external_id: #{@external_id}, ip_address:"\
+      " #{@ip_address}, is_fulfilled: #{@is_fulfilled}, is_historical: #{@is_historical},"\
+      " is_offline: #{@is_offline}, is_preconfirmed: #{@is_preconfirmed}, notification_blacklist:"\
+      " #{@notification_blacklist}, payments: #{@payments}, placed_at: #{@placed_at},"\
+      " price_method: #{@price_method}, shipments: #{@shipments}, shipping_address:"\
+      " #{@shipping_address}, shop: #{@shop}, shop_locale: #{@shop_locale}, store_id:"\
+      " #{@store_id}>"
+    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}, billing_address:"\
+      " #{@billing_address.inspect}, channel_name: #{@channel_name.inspect}, channel_type:"\
+      " #{@channel_type.inspect}, currency: #{@currency.inspect}, customer_email:"\
+      " #{@customer_email.inspect}, customer_language: #{@customer_language.inspect},"\
+      " customer_name: #{@customer_name.inspect}, extended_attributes:"\
+      " #{@extended_attributes.inspect}, external_customer_id: #{@external_customer_id.inspect},"\
+      " external_id: #{@external_id.inspect}, ip_address: #{@ip_address.inspect}, is_fulfilled:"\
+      " #{@is_fulfilled.inspect}, is_historical: #{@is_historical.inspect}, is_offline:"\
+      " #{@is_offline.inspect}, is_preconfirmed: #{@is_preconfirmed.inspect},"\
+      " notification_blacklist: #{@notification_blacklist.inspect}, payments:"\
+      " #{@payments.inspect}, placed_at: #{@placed_at.inspect}, price_method:"\
+      " #{@price_method.inspect}, shipments: #{@shipments.inspect}, shipping_address:"\
+      " #{@shipping_address.inspect}, shop: #{@shop.inspect}, shop_locale:"\
+      " #{@shop_locale.inspect}, store_id: #{@store_id.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/injected_order_response.rb

@@ -0,0 +1,86 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # InjectedOrderResponse Model.
+  class InjectedOrderResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :external_id
+
+    # The identifier of the order assigned internally by the system.
+    # @return [String]
+    attr_accessor :id
+
+    # Identifiers of the order items.
+    # @return [Array[InjectedOrderItemIds]]
+    attr_accessor :items
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_id = nil, id = nil, items = nil)
+      @external_id = external_id
+      @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.
+      external_id = hash.key?('external_id') ? hash['external_id'] : nil
+      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 << (InjectedOrderItemIds.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+
+      # Create object from extracted values.
+      InjectedOrderResponse.new(external_id,
+                                id,
+                                items)
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/new_store_api/models/injected_order_routing_strategy.rb

@@ -0,0 +1,75 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # InjectedOrderRoutingStrategy Model.
+  class InjectedOrderRoutingStrategy < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The default routing strategy that NewStore uses to determine the best
+    # fulfillment location, based on the fulfillment config.
+    # @return [String]
+    attr_reader :strategy
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['strategy'] = 'strategy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize
+      @strategy = 'default'
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+
+
+      # Create object from extracted values.
+      InjectedOrderRoutingStrategy.new
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InjectedOrderRoutingStrategy | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.strategy,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['strategy'],
+                            ->(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} strategy: #{@strategy}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} strategy: #{@strategy.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/injected_order_routing_strategy1.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
+  # InjectedOrderRoutingStrategy1 Model.
+  class InjectedOrderRoutingStrategy1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The fulfillment node ID to which the order is going to be routed. The
+    # location must have ATP for all items in the order. If there's no ATP for
+    # some items, the items are put [on
+    # hold](/docs/nomapp/nom-monitor-orders.html#managing-on-hold-orders).
+    # @return [String]
+    attr_accessor :fulfillment_node_id
+
+    # The routing strategy used to specify the fulfillment location for the
+    # order, and prevent it from being routed based on the fulfillment config.
+    # @return [String]
+    attr_reader :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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fulfillment_node_id = nil)
+      @fulfillment_node_id = fulfillment_node_id
+      @strategy = 'prerouted'
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      fulfillment_node_id =
+        hash.key?('fulfillment_node_id') ? hash['fulfillment_node_id'] : nil
+
+      # Create object from extracted values.
+      InjectedOrderRoutingStrategy1.new(fulfillment_node_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InjectedOrderRoutingStrategy1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.fulfillment_node_id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.strategy,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['fulfillment_node_id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['strategy'],
+                                ->(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} 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