newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/models/fulfillment_option.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
+  # Service-level fulfillment option (e.g. in-store handover). The source spec
+  # models this as a `oneOf`; this MVP supports only the service-level variant
+  # and omits the shipping (`shipping_offer_token`) one.
+  class FulfillmentOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The price of the fulfillment option before discounts, in the currency's
+    # minor unit. It might include taxes depending on the pricing method.
+    # @return [Integer]
+    attr_accessor :price
+
+    # Service level identifier of the fulfillment option. Set it to
+    # IN_STORE_HANDOVER in case of an in-store purchase order.
+    # @return [String]
+    attr_accessor :service_level_identifier
+
+    # The tax applied to the fulfillment option, in the currency's minor unit.
+    # @return [Integer]
+    attr_accessor :tax
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price'] = 'price'
+      @_hash['service_level_identifier'] = 'service_level_identifier'
+      @_hash['tax'] = 'tax'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price = nil, service_level_identifier = nil, tax = nil)
+      @price = price
+      @service_level_identifier = service_level_identifier
+      @tax = tax
+    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 = hash.key?('price') ? hash['price'] : nil
+      service_level_identifier =
+        hash.key?('service_level_identifier') ? hash['service_level_identifier'] : nil
+      tax = hash.key?('tax') ? hash['tax'] : nil
+
+      # Create object from extracted values.
+      FulfillmentOption.new(price,
+                            service_level_identifier,
+                            tax)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price: #{@price}, service_level_identifier: #{@service_level_identifier},"\
+      " tax: #{@tax}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price: #{@price.inspect}, service_level_identifier:"\
+      " #{@service_level_identifier.inspect}, tax: #{@tax.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_request.rb

@@ -0,0 +1,133 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # The fulfillment request.
+  class FulfillmentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date and time when fulfillment request was created.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Fulfillment node where fulfillment request was routed to.
+    # @return [String]
+    attr_accessor :fulfillment_node_id
+
+    # The identifier of the fulfillment request.
+    # @return [UUID | String]
+    attr_accessor :fulfillment_request_id
+
+    # The identifier of the fulfillment request.
+    # @return [Array[FulfillmentRequestLineItem]]
+    attr_accessor :items
+
+    # Service level fulfillment request was routed with.
+    # @return [String]
+    attr_accessor :service_level
+
+    # Service level fulfillment request was routed with.
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['fulfillment_node_id'] = 'fulfillment_node_id'
+      @_hash['fulfillment_request_id'] = 'fulfillment_request_id'
+      @_hash['items'] = 'items'
+      @_hash['service_level'] = 'service_level'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        fulfillment_node_id
+        fulfillment_request_id
+        service_level
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items = nil, created_at = SKIP, fulfillment_node_id = SKIP,
+                   fulfillment_request_id = SKIP, service_level = SKIP,
+                   status = SKIP)
+      @created_at = created_at unless created_at == SKIP
+      @fulfillment_node_id = fulfillment_node_id unless fulfillment_node_id == SKIP
+      @fulfillment_request_id = fulfillment_request_id unless fulfillment_request_id == SKIP
+      @items = items
+      @service_level = service_level unless service_level == SKIP
+      @status = status unless status == 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
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (FulfillmentRequestLineItem.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
+      fulfillment_node_id =
+        hash.key?('fulfillment_node_id') ? hash['fulfillment_node_id'] : SKIP
+      fulfillment_request_id =
+        hash.key?('fulfillment_request_id') ? hash['fulfillment_request_id'] : SKIP
+      service_level = hash.key?('service_level') ? hash['service_level'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Create object from extracted values.
+      FulfillmentRequest.new(items,
+                             created_at,
+                             fulfillment_node_id,
+                             fulfillment_request_id,
+                             service_level,
+                             status)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at}, fulfillment_node_id: #{@fulfillment_node_id},"\
+      " fulfillment_request_id: #{@fulfillment_request_id}, items: #{@items}, service_level:"\
+      " #{@service_level}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at.inspect}, fulfillment_node_id:"\
+      " #{@fulfillment_node_id.inspect}, fulfillment_request_id:"\
+      " #{@fulfillment_request_id.inspect}, items: #{@items.inspect}, service_level:"\
+      " #{@service_level.inspect}, status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_request1.rb

@@ -0,0 +1,131 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module NewStoreApi
+  # The fulfillment request.
+  class FulfillmentRequest1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date and time when fulfillment request was created.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Fulfillment node where fulfillment request was routed to.
+    # @return [String]
+    attr_accessor :fulfillment_node_id
+
+    # The identifier of the fulfillment request.
+    # @return [String]
+    attr_accessor :fulfillment_request_id
+
+    # The identifier of the fulfillment request.
+    # @return [Array[Item8]]
+    attr_accessor :items
+
+    # Service level fulfillment request was routed with.
+    # @return [String]
+    attr_accessor :service_level
+
+    # Current status of fulfillment request: dispatched - fulfillment request
+    # was sent to sent to store/DC services, but wasn't acknowledged yet;
+    # acknowledged - fulfillment request was acknowledged by store/DC service
+    # and will be send to store/DC for fulfillment; partially_completed - some
+    # items of fulfillment request were already processed (cancelled, rejected,
+    # shipped) but not all of them; completed - all items of fulfillment request
+    # were processed (cancelled, rejected, shipped).
+    # @return [Status11Enum]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['fulfillment_node_id'] = 'fulfillment_node_id'
+      @_hash['fulfillment_request_id'] = 'fulfillment_request_id'
+      @_hash['items'] = 'items'
+      @_hash['service_level'] = 'service_level'
+      @_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(created_at = nil, fulfillment_node_id = nil,
+                   fulfillment_request_id = nil, items = nil,
+                   service_level = nil, status = nil)
+      @created_at = created_at
+      @fulfillment_node_id = fulfillment_node_id
+      @fulfillment_request_id = fulfillment_request_id
+      @items = items
+      @service_level = service_level
+      @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.
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      fulfillment_node_id =
+        hash.key?('fulfillment_node_id') ? hash['fulfillment_node_id'] : nil
+      fulfillment_request_id =
+        hash.key?('fulfillment_request_id') ? hash['fulfillment_request_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 << (Item8.from_hash(structure) if structure)
+        end
+      end
+
+      items = nil unless hash.key?('items')
+      service_level = hash.key?('service_level') ? hash['service_level'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+
+      # Create object from extracted values.
+      FulfillmentRequest1.new(created_at,
+                              fulfillment_node_id,
+                              fulfillment_request_id,
+                              items,
+                              service_level,
+                              status)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at}, fulfillment_node_id: #{@fulfillment_node_id},"\
+      " fulfillment_request_id: #{@fulfillment_request_id}, items: #{@items}, service_level:"\
+      " #{@service_level}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at.inspect}, fulfillment_node_id:"\
+      " #{@fulfillment_node_id.inspect}, fulfillment_request_id:"\
+      " #{@fulfillment_request_id.inspect}, items: #{@items.inspect}, service_level:"\
+      " #{@service_level.inspect}, status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_request_items_states_request.rb

@@ -0,0 +1,131 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Request payload for marking fulfillment request items as shipped or
+  # rejected.
+  class FulfillmentRequestItemsStatesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier of the associate who is changing the items's states.
+    # @return [String]
+    attr_accessor :associate_id
+
+    # Carrier used to ship items, which state is being changed to `shipped`.
+    # @return [String]
+    attr_accessor :carrier
+
+    # List of fulfillment request items with the target state.
+    # @return [Array[LineItem11]]
+    attr_accessor :line_items
+
+    # List of fulfillment request items with the target state.
+    # @return [Object]
+    attr_accessor :reason
+
+    # Tracking code applied to items, which state is being changed to `shipped`.
+    # @return [String]
+    attr_accessor :tracking_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['associate_id'] = 'associate_id'
+      @_hash['carrier'] = 'carrier'
+      @_hash['line_items'] = 'line_items'
+      @_hash['reason'] = 'reason'
+      @_hash['tracking_code'] = 'tracking_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        associate_id
+        carrier
+        reason
+        tracking_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_items = nil, associate_id = SKIP, carrier = SKIP,
+                   reason = SKIP, tracking_code = SKIP)
+      @associate_id = associate_id unless associate_id == SKIP
+      @carrier = carrier unless carrier == SKIP
+      @line_items = line_items
+      @reason = reason unless reason == SKIP
+      @tracking_code = tracking_code unless tracking_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.
+      # 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 << (LineItem11.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = nil unless hash.key?('line_items')
+      associate_id = hash.key?('associate_id') ? hash['associate_id'] : SKIP
+      carrier = hash.key?('carrier') ? hash['carrier'] : SKIP
+      reason = hash.key?('reason') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FulfillmentRequestItemsStatesRequestReason), hash['reason']
+      ) : SKIP
+      tracking_code = hash.key?('tracking_code') ? hash['tracking_code'] : SKIP
+
+      # Create object from extracted values.
+      FulfillmentRequestItemsStatesRequest.new(line_items,
+                                               associate_id,
+                                               carrier,
+                                               reason,
+                                               tracking_code)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FulfillmentRequestItemsStatesRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.line_items,
+                                     ->(val) { LineItem11.validate(val) },
+                                     is_model_hash: true,
+                                     is_inner_model_hash: true)
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['line_items'],
+                            ->(val) { LineItem11.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} associate_id: #{@associate_id}, carrier: #{@carrier}, line_items:"\
+      " #{@line_items}, reason: #{@reason}, tracking_code: #{@tracking_code}>"
+    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}, carrier: #{@carrier.inspect},"\
+      " line_items: #{@line_items.inspect}, reason: #{@reason.inspect}, tracking_code:"\
+      " #{@tracking_code.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_request_line_item.rb

@@ -0,0 +1,139 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # Fulfillment Request Line Item Details
+  class FulfillmentRequestLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Carrier for a shipped item.
+    # @return [String]
+    attr_accessor :carrier
+
+    # Carrier service level for a shipped item.
+    # @return [String]
+    attr_accessor :carrier_service_level
+
+    # Unique identifier of the line item.
+    # @return [UUID | String]
+    attr_accessor :item_id
+
+    # Unique identifier of the line item.
+    # @return [String]
+    attr_accessor :product_id
+
+    # Rejection reason of a rejected fulfillment request item.
+    # @return [String]
+    attr_accessor :rejection_reason
+
+    # Status of an individual fulfillment request item.
+    # @return [String]
+    attr_accessor :status
+
+    # Tracking code for a shipped item.
+    # @return [String]
+    attr_accessor :tracking_code
+
+    # Tracking url for a shipped item.
+    # @return [String]
+    attr_accessor :tracking_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier'] = 'carrier'
+      @_hash['carrier_service_level'] = 'carrier_service_level'
+      @_hash['item_id'] = 'item_id'
+      @_hash['product_id'] = 'product_id'
+      @_hash['rejection_reason'] = 'rejection_reason'
+      @_hash['status'] = 'status'
+      @_hash['tracking_code'] = 'tracking_code'
+      @_hash['tracking_url'] = 'tracking_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier
+        carrier_service_level
+        product_id
+        rejection_reason
+        tracking_code
+        tracking_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        carrier
+        carrier_service_level
+        tracking_code
+        tracking_url
+      ]
+    end
+
+    def initialize(item_id = nil, status = nil, carrier = SKIP,
+                   carrier_service_level = SKIP, product_id = SKIP,
+                   rejection_reason = SKIP, tracking_code = SKIP,
+                   tracking_url = SKIP)
+      @carrier = carrier unless carrier == SKIP
+      @carrier_service_level = carrier_service_level unless carrier_service_level == SKIP
+      @item_id = item_id
+      @product_id = product_id unless product_id == SKIP
+      @rejection_reason = rejection_reason unless rejection_reason == SKIP
+      @status = status
+      @tracking_code = tracking_code unless tracking_code == SKIP
+      @tracking_url = tracking_url unless tracking_url == 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_id = hash.key?('item_id') ? hash['item_id'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      carrier = hash.key?('carrier') ? hash['carrier'] : SKIP
+      carrier_service_level =
+        hash.key?('carrier_service_level') ? hash['carrier_service_level'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      rejection_reason =
+        hash.key?('rejection_reason') ? hash['rejection_reason'] : SKIP
+      tracking_code = hash.key?('tracking_code') ? hash['tracking_code'] : SKIP
+      tracking_url = hash.key?('tracking_url') ? hash['tracking_url'] : SKIP
+
+      # Create object from extracted values.
+      FulfillmentRequestLineItem.new(item_id,
+                                     status,
+                                     carrier,
+                                     carrier_service_level,
+                                     product_id,
+                                     rejection_reason,
+                                     tracking_code,
+                                     tracking_url)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier: #{@carrier}, carrier_service_level: #{@carrier_service_level},"\
+      " item_id: #{@item_id}, product_id: #{@product_id}, rejection_reason: #{@rejection_reason},"\
+      " status: #{@status}, tracking_code: #{@tracking_code}, tracking_url: #{@tracking_url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier: #{@carrier.inspect}, carrier_service_level:"\
+      " #{@carrier_service_level.inspect}, item_id: #{@item_id.inspect}, product_id:"\
+      " #{@product_id.inspect}, rejection_reason: #{@rejection_reason.inspect}, status:"\
+      " #{@status.inspect}, tracking_code: #{@tracking_code.inspect}, tracking_url:"\
+      " #{@tracking_url.inspect}>"
+    end
+  end
+end

data/lib/new_store_api/models/fulfillment_task_document.rb

@@ -0,0 +1,81 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # FulfillmentTaskDocument Model.
+  class FulfillmentTaskDocument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :permalink
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['permalink'] = 'permalink'
+      @_hash['status'] = 'status'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        permalink
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        permalink
+      ]
+    end
+
+    def initialize(status = nil, type = nil, permalink = SKIP)
+      @permalink = permalink unless permalink == SKIP
+      @status = status
+      @type = type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      status = hash.key?('status') ? hash['status'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      permalink = hash.key?('permalink') ? hash['permalink'] : SKIP
+
+      # Create object from extracted values.
+      FulfillmentTaskDocument.new(status,
+                                  type,
+                                  permalink)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} permalink: #{@permalink}, status: #{@status}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} permalink: #{@permalink.inspect}, status: #{@status.inspect}, type:"\
+      " #{@type.inspect}>"
+    end
+  end
+end