walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/shipping_service.rb

@@ -0,0 +1,196 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # ShippingService Model.
+  class ShippingService < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :shipping_service_id
+
+    # TODO: Write general description for this method
+    # @return [CarrierName]
+    attr_accessor :carrier_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :shipping_service_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :shipping_service_offer_id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :ship_date
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :earliest_estimated_delivery_date
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :latest_estimated_delivery_date
+
+    # TODO: Write general description for this method
+    # @return [Money]
+    attr_accessor :rate
+
+    # TODO: Write general description for this method
+    # @return [ShippingServiceOptions]
+    attr_accessor :shipping_service_options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['shipping_service_id'] = 'shippingServiceId'
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash['shipping_service_name'] = 'shippingServiceName'
+      @_hash['shipping_service_offer_id'] = 'shippingServiceOfferId'
+      @_hash['ship_date'] = 'shipDate'
+      @_hash['earliest_estimated_delivery_date'] =
+        'earliestEstimatedDeliveryDate'
+      @_hash['latest_estimated_delivery_date'] = 'latestEstimatedDeliveryDate'
+      @_hash['rate'] = 'rate'
+      @_hash['shipping_service_options'] = 'shippingServiceOptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        shipping_service_name
+        ship_date
+        earliest_estimated_delivery_date
+        latest_estimated_delivery_date
+        rate
+        shipping_service_options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shipping_service_id:, carrier_name:,
+                   shipping_service_offer_id:, shipping_service_name: SKIP,
+                   ship_date: SKIP, earliest_estimated_delivery_date: SKIP,
+                   latest_estimated_delivery_date: SKIP, rate: SKIP,
+                   shipping_service_options: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @shipping_service_id = shipping_service_id
+      @carrier_name = carrier_name
+      @shipping_service_name = shipping_service_name unless shipping_service_name == SKIP
+      @shipping_service_offer_id = shipping_service_offer_id
+      @ship_date = ship_date unless ship_date == SKIP
+      unless earliest_estimated_delivery_date == SKIP
+        @earliest_estimated_delivery_date =
+          earliest_estimated_delivery_date
+      end
+      unless latest_estimated_delivery_date == SKIP
+        @latest_estimated_delivery_date =
+          latest_estimated_delivery_date
+      end
+      @rate = rate unless rate == SKIP
+      @shipping_service_options = shipping_service_options unless shipping_service_options == 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.
+      shipping_service_id =
+        hash.key?('shippingServiceId') ? hash['shippingServiceId'] : nil
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : nil
+      shipping_service_offer_id =
+        hash.key?('shippingServiceOfferId') ? hash['shippingServiceOfferId'] : nil
+      shipping_service_name =
+        hash.key?('shippingServiceName') ? hash['shippingServiceName'] : SKIP
+      ship_date = if hash.key?('shipDate')
+                    (DateTimeHelper.from_rfc3339(hash['shipDate']) if hash['shipDate'])
+                  else
+                    SKIP
+                  end
+      earliest_estimated_delivery_date = if hash.key?('earliestEstimatedDeliveryDate')
+                                           (DateTimeHelper.from_rfc3339(hash['earliestEstimatedDeliveryDate']) if hash['earliestEstimatedDeliveryDate'])
+                                         else
+                                           SKIP
+                                         end
+      latest_estimated_delivery_date = if hash.key?('latestEstimatedDeliveryDate')
+                                         (DateTimeHelper.from_rfc3339(hash['latestEstimatedDeliveryDate']) if hash['latestEstimatedDeliveryDate'])
+                                       else
+                                         SKIP
+                                       end
+      rate = Money.from_hash(hash['rate']) if hash['rate']
+      shipping_service_options = ShippingServiceOptions.from_hash(hash['shippingServiceOptions']) if
+        hash['shippingServiceOptions']
+
+      # 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.
+      ShippingService.new(shipping_service_id: shipping_service_id,
+                          carrier_name: carrier_name,
+                          shipping_service_offer_id: shipping_service_offer_id,
+                          shipping_service_name: shipping_service_name,
+                          ship_date: ship_date,
+                          earliest_estimated_delivery_date: earliest_estimated_delivery_date,
+                          latest_estimated_delivery_date: latest_estimated_delivery_date,
+                          rate: rate,
+                          shipping_service_options: shipping_service_options,
+                          additional_properties: additional_properties)
+    end
+
+    def to_custom_ship_date
+      DateTimeHelper.to_rfc3339(ship_date)
+    end
+
+    def to_custom_earliest_estimated_delivery_date
+      DateTimeHelper.to_rfc3339(earliest_estimated_delivery_date)
+    end
+
+    def to_custom_latest_estimated_delivery_date
+      DateTimeHelper.to_rfc3339(latest_estimated_delivery_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} shipping_service_id: #{@shipping_service_id}, carrier_name:"\
+      " #{@carrier_name}, shipping_service_name: #{@shipping_service_name},"\
+      " shipping_service_offer_id: #{@shipping_service_offer_id}, ship_date: #{@ship_date},"\
+      " earliest_estimated_delivery_date: #{@earliest_estimated_delivery_date},"\
+      " latest_estimated_delivery_date: #{@latest_estimated_delivery_date}, rate: #{@rate},"\
+      " shipping_service_options: #{@shipping_service_options}, 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} shipping_service_id: #{@shipping_service_id.inspect}, carrier_name:"\
+      " #{@carrier_name.inspect}, shipping_service_name: #{@shipping_service_name.inspect},"\
+      " shipping_service_offer_id: #{@shipping_service_offer_id.inspect}, ship_date:"\
+      " #{@ship_date.inspect}, earliest_estimated_delivery_date:"\
+      " #{@earliest_estimated_delivery_date.inspect}, latest_estimated_delivery_date:"\
+      " #{@latest_estimated_delivery_date.inspect}, rate: #{@rate.inspect},"\
+      " shipping_service_options: #{@shipping_service_options.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/shipping_service_options.rb

@@ -0,0 +1,114 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ShippingServiceOptions Model.
+  class ShippingServiceOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DeliveryExperience]
+    attr_accessor :delivery_experience
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :carrier_will_pick_up
+
+    # TODO: Write general description for this method
+    # @return [CarrierWillPickUpOption]
+    attr_accessor :carrier_will_pick_up_option
+
+    # TODO: Write general description for this method
+    # @return [Money]
+    attr_accessor :declared_value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['delivery_experience'] = 'deliveryExperience'
+      @_hash['carrier_will_pick_up'] = 'carrierWillPickUp'
+      @_hash['carrier_will_pick_up_option'] = 'carrierWillPickUpOption'
+      @_hash['declared_value'] = 'declaredValue'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        delivery_experience
+        carrier_will_pick_up
+        carrier_will_pick_up_option
+        declared_value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(delivery_experience: SKIP, carrier_will_pick_up: SKIP,
+                   carrier_will_pick_up_option: SKIP, declared_value: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @delivery_experience = delivery_experience unless delivery_experience == SKIP
+      @carrier_will_pick_up = carrier_will_pick_up unless carrier_will_pick_up == SKIP
+      unless carrier_will_pick_up_option == SKIP
+        @carrier_will_pick_up_option =
+          carrier_will_pick_up_option
+      end
+      @declared_value = declared_value unless declared_value == 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.
+      delivery_experience =
+        hash.key?('deliveryExperience') ? hash['deliveryExperience'] : SKIP
+      carrier_will_pick_up =
+        hash.key?('carrierWillPickUp') ? hash['carrierWillPickUp'] : SKIP
+      carrier_will_pick_up_option =
+        hash.key?('carrierWillPickUpOption') ? hash['carrierWillPickUpOption'] : SKIP
+      declared_value = Money.from_hash(hash['declaredValue']) if hash['declaredValue']
+
+      # 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.
+      ShippingServiceOptions.new(delivery_experience: delivery_experience,
+                                 carrier_will_pick_up: carrier_will_pick_up,
+                                 carrier_will_pick_up_option: carrier_will_pick_up_option,
+                                 declared_value: declared_value,
+                                 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} delivery_experience: #{@delivery_experience}, carrier_will_pick_up:"\
+      " #{@carrier_will_pick_up}, carrier_will_pick_up_option: #{@carrier_will_pick_up_option},"\
+      " declared_value: #{@declared_value}, 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} delivery_experience: #{@delivery_experience.inspect}, carrier_will_pick_up:"\
+      " #{@carrier_will_pick_up.inspect}, carrier_will_pick_up_option:"\
+      " #{@carrier_will_pick_up_option.inspect}, declared_value: #{@declared_value.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/shipping_speed_category.rb

@@ -0,0 +1,44 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # ShippingSpeedCategory.
+  class ShippingSpeedCategory
+    SHIPPING_SPEED_CATEGORY = [
+      # TODO: Write general description for STANDARD
+      STANDARD = 'Standard'.freeze,
+
+      # TODO: Write general description for EXPEDITED
+      EXPEDITED = 'Expedited'.freeze,
+
+      # TODO: Write general description for PRIORITY
+      PRIORITY = 'Priority'.freeze,
+
+      # TODO: Write general description for SCHEDULEDDELIVERY
+      SCHEDULEDDELIVERY = 'ScheduledDelivery'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SHIPPING_SPEED_CATEGORY.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 'expedited' then EXPEDITED
+      when 'priority' then PRIORITY
+      when 'scheduleddelivery' then SCHEDULEDDELIVERY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/ships_from_type.rb

@@ -0,0 +1,85 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The state and country from where the item is shipped.
+  class ShipsFromType < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The state from where the item is shipped.
+    # @return [String]
+    attr_accessor :state
+
+    # The country from where the item is shipped.
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['state'] = 'State'
+      @_hash['country'] = 'Country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        state
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(state: SKIP, country: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @state = state unless state == SKIP
+      @country = country unless country == 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.
+      state = hash.key?('State') ? hash['State'] : SKIP
+      country = hash.key?('Country') ? hash['Country'] : 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.
+      ShipsFromType.new(state: state,
+                        country: country,
+                        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} state: #{@state}, country: #{@country}, 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} state: #{@state.inspect}, country: #{@country.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/size.rb

@@ -0,0 +1,95 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Size Model.
+  class Size < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :width
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :length
+
+    # TODO: Write general description for this method
+    # @return [Unit1]
+    attr_accessor :unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['width'] = 'width'
+      @_hash['length'] = 'length'
+      @_hash['unit'] = 'unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        width
+        length
+        unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(width: SKIP, length: SKIP, unit: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @width = width unless width == SKIP
+      @length = length unless length == SKIP
+      @unit = unit unless unit == 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.
+      width = hash.key?('width') ? hash['width'] : SKIP
+      length = hash.key?('length') ? hash['length'] : SKIP
+      unit = hash.key?('unit') ? hash['unit'] : 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.
+      Size.new(width: width,
+               length: length,
+               unit: unit,
+               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} width: #{@width}, length: #{@length}, unit: #{@unit},"\
+      " 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} width: #{@width.inspect}, length: #{@length.inspect}, unit:"\
+      " #{@unit.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/spd_tracking_detail.rb

@@ -0,0 +1,86 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains information related to Small Parcel Delivery (SPD) shipment
+  # tracking.
+  class SpdTrackingDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of Small Parcel Delivery (SPD) tracking items.
+    # @return [Array[SpdTrackingItem]]
+    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
+      %w[
+        spd_tracking_items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(spd_tracking_items: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @spd_tracking_items = spd_tracking_items unless spd_tracking_items == 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.
+      # 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 << (SpdTrackingItem.from_hash(structure) if structure)
+        end
+      end
+
+      spd_tracking_items = SKIP 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.
+      SpdTrackingDetail.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