walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/spd_tracking_detail_input.rb

@@ -0,0 +1,83 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains input information to update SPD tracking information.
+  class SpdTrackingDetailInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of Small Parcel Delivery (SPD) tracking items input.
+    # @return [Array[SpdTrackingItemInput]]
+    attr_accessor :spd_tracking_items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['spd_tracking_items'] = 'spdTrackingItems'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(spd_tracking_items:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @spd_tracking_items = spd_tracking_items
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      spd_tracking_items = nil
+      unless hash['spdTrackingItems'].nil?
+        spd_tracking_items = []
+        hash['spdTrackingItems'].each do |structure|
+          spd_tracking_items << (SpdTrackingItemInput.from_hash(structure) if structure)
+        end
+      end
+
+      spd_tracking_items = nil unless hash.key?('spdTrackingItems')
+
+      # 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.
+      SpdTrackingDetailInput.new(spd_tracking_items: spd_tracking_items,
+                                 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} spd_tracking_items: #{@spd_tracking_items}, 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} spd_tracking_items: #{@spd_tracking_items.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/spd_tracking_item.rb

@@ -0,0 +1,105 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains information used to track and identify a Small Parcel Delivery
+  # (SPD) item.
+  class SpdTrackingItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID provided by Walmart that identifies a given box.
+    # @return [String]
+    attr_accessor :box_id
+
+    # The tracking ID associated with each box in a non-partnered SPD shipment.
+    # @return [String]
+    attr_accessor :tracking_id
+
+    # Indicates whether Walmart has validated the tracking number. Possible
+    # values: `VALIDATED`, `NOT_VALIDATED`, `NOT_SUPPORTED`.
+    # @return [String]
+    attr_accessor :tracking_number_validation_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['box_id'] = 'boxId'
+      @_hash['tracking_id'] = 'trackingId'
+      @_hash['tracking_number_validation_status'] =
+        'trackingNumberValidationStatus'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        box_id
+        tracking_id
+        tracking_number_validation_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(box_id: SKIP, tracking_id: SKIP,
+                   tracking_number_validation_status: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @box_id = box_id unless box_id == SKIP
+      @tracking_id = tracking_id unless tracking_id == SKIP
+      unless tracking_number_validation_status == SKIP
+        @tracking_number_validation_status =
+          tracking_number_validation_status
+      end
+      @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.
+      box_id = hash.key?('boxId') ? hash['boxId'] : SKIP
+      tracking_id = hash.key?('trackingId') ? hash['trackingId'] : SKIP
+      tracking_number_validation_status =
+        hash.key?('trackingNumberValidationStatus') ? hash['trackingNumberValidationStatus'] : 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.
+      SpdTrackingItem.new(box_id: box_id,
+                          tracking_id: tracking_id,
+                          tracking_number_validation_status: tracking_number_validation_status,
+                          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} box_id: #{@box_id}, tracking_id: #{@tracking_id},"\
+      " tracking_number_validation_status: #{@tracking_number_validation_status},"\
+      " 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} box_id: #{@box_id.inspect}, tracking_id: #{@tracking_id.inspect},"\
+      " tracking_number_validation_status: #{@tracking_number_validation_status.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/spd_tracking_item_input.rb

@@ -0,0 +1,82 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Small Parcel Delivery (SPD) tracking items input information.
+  class SpdTrackingItemInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID provided by Walmart that identifies a given box.
+    # @return [String]
+    attr_accessor :box_id
+
+    # The tracking ID associated with each box in a non-partnered SPD shipment.
+    # @return [String]
+    attr_accessor :tracking_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['box_id'] = 'boxId'
+      @_hash['tracking_id'] = 'trackingId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(box_id:, tracking_id:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @box_id = box_id
+      @tracking_id = tracking_id
+      @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.
+      box_id = hash.key?('boxId') ? hash['boxId'] : nil
+      tracking_id = hash.key?('trackingId') ? hash['trackingId'] : nil
+
+      # 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.
+      SpdTrackingItemInput.new(box_id: box_id,
+                               tracking_id: 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} box_id: #{@box_id}, tracking_id: #{@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} box_id: #{@box_id.inspect}, tracking_id: #{@tracking_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/stackability.rb

@@ -0,0 +1,36 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Indicates whether pallets will be stacked when carrier arrives for pick-up.
+  class Stackability
+    STACKABILITY = [
+      # TODO: Write general description for STACKABLE
+      STACKABLE = 'STACKABLE'.freeze,
+
+      # TODO: Write general description for NON_STACKABLE
+      NON_STACKABLE = 'NON_STACKABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STACKABILITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = STACKABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'stackable' then STACKABLE
+      when 'non_stackable' then NON_STACKABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/standard_id_for_label.rb

@@ -0,0 +1,26 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # StandardIdForLabel.
+  class StandardIdForLabel
+    STANDARD_ID_FOR_LABEL = [
+      # TODO: Write general description for WALMARTORDERID
+      WALMARTORDERID = 'WalmartOrderId'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STANDARD_ID_FOR_LABEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = WALMARTORDERID)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/walmart_ap_is/models/status.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Status.
+  class Status
+    STATUS = [
+      # TODO: Write general description for BUYABLE
+      BUYABLE = 'BUYABLE'.freeze,
+
+      # TODO: Write general description for SUPPRESSED
+      SUPPRESSED = 'SUPPRESSED'.freeze,
+
+      # TODO: Write general description for DISCOVERABLE
+      DISCOVERABLE = 'DISCOVERABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = BUYABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'buyable' then BUYABLE
+      when 'suppressed' then SUPPRESSED
+      when 'discoverable' then DISCOVERABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/status1.rb

@@ -0,0 +1,36 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Status1.
+  class Status1
+    STATUS1 = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'ACCEPTED'.freeze,
+
+      # TODO: Write general description for INVALID
+      INVALID = 'INVALID'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS1.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCEPTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accepted' then ACCEPTED
+      when 'invalid' then INVALID
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/status11.rb

@@ -0,0 +1,48 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Status11.
+  class Status11
+    STATUS11 = [
+      # TODO: Write general description for PENDING
+      PENDING = 'Pending'.freeze,
+
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'Processing'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'Completed'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'Failed'.freeze,
+
+      # TODO: Write general description for ONHOLD
+      ONHOLD = 'OnHold'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS11.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'processing' then PROCESSING
+      when 'completed' then COMPLETED
+      when 'failed' then FAILED
+      when 'onhold' then ONHOLD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/status2.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Status2.
+  class Status2
+    STATUS2 = [
+      # TODO: Write general description for OPEN
+      OPEN = 'Open'.freeze,
+
+      # TODO: Write general description for CLOSED
+      CLOSED = 'Closed'.freeze,
+
+      # TODO: Write general description for TRANSFERRED
+      TRANSFERRED = 'Transferred'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS2.include?(value)
+    end
+
+    def self.from_value(value, default_value = OPEN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'open' then OPEN
+      when 'closed' then CLOSED
+      when 'transferred' then TRANSFERRED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/status21.rb

@@ -0,0 +1,44 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Status21.
+  class Status21
+    STATUS21 = [
+      # TODO: Write general description for OPEN
+      OPEN = 'Open'.freeze,
+
+      # TODO: Write general description for UNDERREVIEW
+      UNDERREVIEW = 'UnderReview'.freeze,
+
+      # TODO: Write general description for RESOLVED
+      RESOLVED = 'Resolved'.freeze,
+
+      # TODO: Write general description for CLOSED
+      CLOSED = 'Closed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS21.include?(value)
+    end
+
+    def self.from_value(value, default_value = OPEN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'open' then OPEN
+      when 'underreview' then UNDERREVIEW
+      when 'resolved' then RESOLVED
+      when 'closed' then CLOSED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/status3.rb

@@ -0,0 +1,36 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Status3.
+  class Status3
+    STATUS3 = [
+      # TODO: Write general description for RESOLVED
+      RESOLVED = 'Resolved'.freeze,
+
+      # TODO: Write general description for CLOSED
+      CLOSED = 'Closed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS3.include?(value)
+    end
+
+    def self.from_value(value, default_value = RESOLVED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'resolved' then RESOLVED
+      when 'closed' then CLOSED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/status4.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Outcome of the fee estimate.
+  class Status4
+    STATUS4 = [
+      # TODO: Write general description for SUCCESS
+      SUCCESS = 'Success'.freeze,
+
+      # TODO: Write general description for CLIENTERROR
+      CLIENTERROR = 'ClientError'.freeze,
+
+      # TODO: Write general description for SERVICEERROR
+      SERVICEERROR = 'ServiceError'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS4.include?(value)
+    end
+
+    def self.from_value(value, default_value = SUCCESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'success' then SUCCESS
+      when 'clienterror' then CLIENTERROR
+      when 'serviceerror' then SERVICEERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/status5.rb

@@ -0,0 +1,56 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Status5.
+  class Status5
+    STATUS5 = [
+      # TODO: Write general description for PRE_TRANSIT
+      PRE_TRANSIT = 'PRE_TRANSIT'.freeze,
+
+      # TODO: Write general description for IN_TRANSIT
+      IN_TRANSIT = 'IN_TRANSIT'.freeze,
+
+      # TODO: Write general description for OUT_FOR_DELIVERY
+      OUT_FOR_DELIVERY = 'OUT_FOR_DELIVERY'.freeze,
+
+      # TODO: Write general description for DELIVERED
+      DELIVERED = 'DELIVERED'.freeze,
+
+      # TODO: Write general description for EXCEPTION
+      EXCEPTION = 'EXCEPTION'.freeze,
+
+      # TODO: Write general description for RETURNED
+      RETURNED = 'RETURNED'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS5.include?(value)
+    end
+
+    def self.from_value(value, default_value = PRE_TRANSIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pre_transit' then PRE_TRANSIT
+      when 'in_transit' then IN_TRANSIT
+      when 'out_for_delivery' then OUT_FOR_DELIVERY
+      when 'delivered' then DELIVERED
+      when 'exception' then EXCEPTION
+      when 'returned' then RETURNED
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end