walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/ltl_tracking_detail.rb

@@ -0,0 +1,89 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains information related to Less-Than-Truckload (LTL) shipment tracking.
+  class LtlTrackingDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number of the carrier shipment acknowledgement document.
+    # @return [String]
+    attr_accessor :bill_of_lading_number
+
+    # The number associated with the freight bill.
+    # @return [Array[String]]
+    attr_accessor :freight_bill_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bill_of_lading_number'] = 'billOfLadingNumber'
+      @_hash['freight_bill_number'] = 'freightBillNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bill_of_lading_number
+        freight_bill_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bill_of_lading_number: SKIP, freight_bill_number: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bill_of_lading_number = bill_of_lading_number unless bill_of_lading_number == SKIP
+      @freight_bill_number = freight_bill_number unless freight_bill_number == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      bill_of_lading_number =
+        hash.key?('billOfLadingNumber') ? hash['billOfLadingNumber'] : SKIP
+      freight_bill_number =
+        hash.key?('freightBillNumber') ? hash['freightBillNumber'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LtlTrackingDetail.new(bill_of_lading_number: bill_of_lading_number,
+                            freight_bill_number: freight_bill_number,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bill_of_lading_number: #{@bill_of_lading_number}, freight_bill_number:"\
+      " #{@freight_bill_number}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bill_of_lading_number: #{@bill_of_lading_number.inspect},"\
+      " freight_bill_number: #{@freight_bill_number.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/ltl_tracking_detail_input.rb

@@ -0,0 +1,88 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains input information to update LTL tracking information.
+  class LtlTrackingDetailInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number of the carrier shipment acknowledgement document.
+    # @return [String]
+    attr_accessor :bill_of_lading_number
+
+    # Number associated with the freight bill.
+    # @return [Array[String]]
+    attr_accessor :freight_bill_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bill_of_lading_number'] = 'billOfLadingNumber'
+      @_hash['freight_bill_number'] = 'freightBillNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bill_of_lading_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(freight_bill_number:, bill_of_lading_number: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bill_of_lading_number = bill_of_lading_number unless bill_of_lading_number == SKIP
+      @freight_bill_number = freight_bill_number
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      freight_bill_number =
+        hash.key?('freightBillNumber') ? hash['freightBillNumber'] : nil
+      bill_of_lading_number =
+        hash.key?('billOfLadingNumber') ? hash['billOfLadingNumber'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LtlTrackingDetailInput.new(freight_bill_number: freight_bill_number,
+                                 bill_of_lading_number: bill_of_lading_number,
+                                 additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bill_of_lading_number: #{@bill_of_lading_number}, freight_bill_number:"\
+      " #{@freight_bill_number}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bill_of_lading_number: #{@bill_of_lading_number.inspect},"\
+      " freight_bill_number: #{@freight_bill_number.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/marketplace.rb

@@ -0,0 +1,117 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Marketplace Model.
+  class Marketplace < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [MarketplaceId]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :country_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :currency_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :default_language_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'countryCode'
+      @_hash['currency_code'] = 'currencyCode'
+      @_hash['default_language_code'] = 'defaultLanguageCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        country_code
+        currency_code
+        default_language_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP, country_code: SKIP,
+                   currency_code: SKIP, default_language_code: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @default_language_code = default_language_code unless default_language_code == SKIP
+      @additional_properties = additional_properties
+    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'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      country_code = hash.key?('countryCode') ? hash['countryCode'] : SKIP
+      currency_code = hash.key?('currencyCode') ? hash['currencyCode'] : SKIP
+      default_language_code =
+        hash.key?('defaultLanguageCode') ? hash['defaultLanguageCode'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Marketplace.new(id: id,
+                      name: name,
+                      country_code: country_code,
+                      currency_code: currency_code,
+                      default_language_code: default_language_code,
+                      additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, name: #{@name}, country_code: #{@country_code}, currency_code:"\
+      " #{@currency_code}, default_language_code: #{@default_language_code},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, name: #{@name.inspect}, country_code:"\
+      " #{@country_code.inspect}, currency_code: #{@currency_code.inspect}, default_language_code:"\
+      " #{@default_language_code.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/marketplace_id.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Marketplace identifier.
+  class MarketplaceId
+    MARKETPLACE_ID = [
+      # TODO: Write general description for WALMART_US
+      WALMART_US = 'WALMART_US'.freeze,
+
+      # TODO: Write general description for WALMART_CA
+      WALMART_CA = 'WALMART_CA'.freeze,
+
+      # TODO: Write general description for WALMART_MX
+      WALMART_MX = 'WALMART_MX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MARKETPLACE_ID.include?(value)
+    end
+
+    def self.from_value(value, default_value = WALMART_US)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'walmart_us' then WALMART_US
+      when 'walmart_ca' then WALMART_CA
+      when 'walmart_mx' then WALMART_MX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/marketplace_order_details.rb

@@ -0,0 +1,118 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # Marketplace-side order context for orders originating on the Walmart
+  # Marketplace surface. Equivalent in shape to industry SP-API's order-details
+  # block; renamed to be vendor-neutral.
+  class MarketplaceOrderDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :order_id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :order_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :seller_id
+
+    # Walmart Purchase Order ID
+    # @return [String]
+    attr_accessor :purchase_order_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'orderId'
+      @_hash['order_date'] = 'orderDate'
+      @_hash['seller_id'] = 'sellerId'
+      @_hash['purchase_order_id'] = 'purchaseOrderId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+        order_date
+        seller_id
+        purchase_order_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_id: SKIP, order_date: SKIP, seller_id: SKIP,
+                   purchase_order_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @order_id = order_id unless order_id == SKIP
+      @order_date = order_date unless order_date == SKIP
+      @seller_id = seller_id unless seller_id == SKIP
+      @purchase_order_id = purchase_order_id unless purchase_order_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      order_id = hash.key?('orderId') ? hash['orderId'] : SKIP
+      order_date = if hash.key?('orderDate')
+                     (DateTimeHelper.from_rfc3339(hash['orderDate']) if hash['orderDate'])
+                   else
+                     SKIP
+                   end
+      seller_id = hash.key?('sellerId') ? hash['sellerId'] : SKIP
+      purchase_order_id =
+        hash.key?('purchaseOrderId') ? hash['purchaseOrderId'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MarketplaceOrderDetails.new(order_id: order_id,
+                                  order_date: order_date,
+                                  seller_id: seller_id,
+                                  purchase_order_id: purchase_order_id,
+                                  additional_properties: additional_properties)
+    end
+
+    def to_custom_order_date
+      DateTimeHelper.to_rfc3339(order_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id}, order_date: #{@order_date}, seller_id:"\
+      " #{@seller_id}, purchase_order_id: #{@purchase_order_id}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id.inspect}, order_date: #{@order_date.inspect},"\
+      " seller_id: #{@seller_id.inspect}, purchase_order_id: #{@purchase_order_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/marketplace_participation.rb

@@ -0,0 +1,86 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # MarketplaceParticipation Model.
+  class MarketplaceParticipation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Marketplace]
+    attr_accessor :marketplace
+
+    # TODO: Write general description for this method
+    # @return [Participation]
+    attr_accessor :participation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['marketplace'] = 'marketplace'
+      @_hash['participation'] = 'participation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        marketplace
+        participation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(marketplace: SKIP, participation: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @marketplace = marketplace unless marketplace == SKIP
+      @participation = participation unless participation == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      marketplace = Marketplace.from_hash(hash['marketplace']) if hash['marketplace']
+      participation = Participation.from_hash(hash['participation']) if hash['participation']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MarketplaceParticipation.new(marketplace: marketplace,
+                                   participation: participation,
+                                   additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} marketplace: #{@marketplace}, participation: #{@participation},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} marketplace: #{@marketplace.inspect}, participation:"\
+      " #{@participation.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/marketplace_shipment_details.rb

@@ -0,0 +1,101 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Marketplace-side shipment context. Renamed from the industry SP-API
+  # "vendor-shipment-details" block to be vendor-neutral.
+  class MarketplaceShipmentDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :seller_order_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :purchase_order_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :seller_tracking_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['seller_order_id'] = 'sellerOrderId'
+      @_hash['purchase_order_id'] = 'purchaseOrderId'
+      @_hash['seller_tracking_id'] = 'sellerTrackingId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        seller_order_id
+        purchase_order_id
+        seller_tracking_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(seller_order_id: SKIP, purchase_order_id: SKIP,
+                   seller_tracking_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @seller_order_id = seller_order_id unless seller_order_id == SKIP
+      @purchase_order_id = purchase_order_id unless purchase_order_id == SKIP
+      @seller_tracking_id = seller_tracking_id unless seller_tracking_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      seller_order_id =
+        hash.key?('sellerOrderId') ? hash['sellerOrderId'] : SKIP
+      purchase_order_id =
+        hash.key?('purchaseOrderId') ? hash['purchaseOrderId'] : SKIP
+      seller_tracking_id =
+        hash.key?('sellerTrackingId') ? hash['sellerTrackingId'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MarketplaceShipmentDetails.new(seller_order_id: seller_order_id,
+                                     purchase_order_id: purchase_order_id,
+                                     seller_tracking_id: seller_tracking_id,
+                                     additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} seller_order_id: #{@seller_order_id}, purchase_order_id:"\
+      " #{@purchase_order_id}, seller_tracking_id: #{@seller_tracking_id}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} seller_order_id: #{@seller_order_id.inspect}, purchase_order_id:"\
+      " #{@purchase_order_id.inspect}, seller_tracking_id: #{@seller_tracking_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/method_code.rb

@@ -0,0 +1,44 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # MethodCode.
+  class MethodCode
+    METHOD_CODE = [
+      # TODO: Write general description for STANDARD
+      STANDARD = 'Standard'.freeze,
+
+      # TODO: Write general description for EXPRESS
+      EXPRESS = 'Express'.freeze,
+
+      # TODO: Write general description for SAMEDAY
+      SAMEDAY = 'SameDay'.freeze,
+
+      # TODO: Write general description for FREIGHT
+      FREIGHT = 'Freight'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      METHOD_CODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = STANDARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'standard' then STANDARD
+      when 'express' then EXPRESS
+      when 'sameday' then SAMEDAY
+      when 'freight' then FREIGHT
+      else
+        default_value
+      end
+    end
+  end
+end