walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/tracking_summary.rb

@@ -0,0 +1,95 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # TrackingSummary Model.
+  class TrackingSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Status5]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :status_updated_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['status_updated_time'] = 'statusUpdatedTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        status_updated_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, status_updated_time: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @status = status unless status == SKIP
+      @status_updated_time = status_updated_time unless status_updated_time == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_updated_time = if hash.key?('statusUpdatedTime')
+                              (DateTimeHelper.from_rfc3339(hash['statusUpdatedTime']) if hash['statusUpdatedTime'])
+                            else
+                              SKIP
+                            end
+
+      # 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.
+      TrackingSummary.new(status: status,
+                          status_updated_time: status_updated_time,
+                          additional_properties: additional_properties)
+    end
+
+    def to_custom_status_updated_time
+      DateTimeHelper.to_rfc3339(status_updated_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, status_updated_time: #{@status_updated_time},"\
+      " 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} status: #{@status.inspect}, status_updated_time:"\
+      " #{@status_updated_time.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/transaction_search_response.rb

@@ -0,0 +1,105 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # TransactionSearchResponse Model.
+  class TransactionSearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :next_token
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_records
+
+    # TODO: Write general description for this method
+    # @return [Array[SettlementTransaction]]
+    attr_accessor :transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['next_token'] = 'nextToken'
+      @_hash['total_records'] = 'totalRecords'
+      @_hash['transactions'] = 'transactions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        next_token
+        total_records
+        transactions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(next_token: SKIP, total_records: SKIP, transactions: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @next_token = next_token unless next_token == SKIP
+      @total_records = total_records unless total_records == SKIP
+      @transactions = transactions unless transactions == 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.
+      next_token = hash.key?('nextToken') ? hash['nextToken'] : SKIP
+      total_records = hash.key?('totalRecords') ? hash['totalRecords'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['transactions'].nil?
+        transactions = []
+        hash['transactions'].each do |structure|
+          transactions << (SettlementTransaction.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('transactions')
+
+      # 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.
+      TransactionSearchResponse.new(next_token: next_token,
+                                    total_records: total_records,
+                                    transactions: transactions,
+                                    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} next_token: #{@next_token}, total_records: #{@total_records}, transactions:"\
+      " #{@transactions}, 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} next_token: #{@next_token.inspect}, total_records:"\
+      " #{@total_records.inspect}, transactions: #{@transactions.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/transportation_option.rb

@@ -0,0 +1,151 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Contains information pertaining to a transportation option and the related
+  # carrier.
+  class TransportationOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The carrier for the inbound shipment.
+    # @return [Carrier]
+    attr_accessor :carrier
+
+    # Contains details for a transportation carrier appointment.
+    # @return [AppointmentSlotTime]
+    attr_accessor :carrier_appointment
+
+    # Identifies a list of preconditions for confirming the transportation
+    # option.
+    # @return [Array[String]]
+    attr_accessor :preconditions
+
+    # The estimated shipping cost associated with the transportation option.
+    # @return [Quote]
+    attr_accessor :quote
+
+    # Identifier of a shipment.
+    # @return [String]
+    attr_accessor :shipment_id
+
+    # Mode of shipment transportation. Possible values: `GROUND_SMALL_PARCEL`,
+    # `FREIGHT_LTL`, `FREIGHT_FTL_PALLET`, `FREIGHT_FTL_NONPALLET`, `OCEAN_LCL`,
+    # `OCEAN_FCL`, `AIR_SMALL_PARCEL`, `AIR_SMALL_PARCEL_EXPRESS`.
+    # @return [String]
+    attr_accessor :shipping_mode
+
+    # Shipping program for the option. Possible values:
+    # `WALMART_PARTNERED_CARRIER`, `USE_YOUR_OWN_CARRIER`.
+    # @return [String]
+    attr_accessor :shipping_solution
+
+    # Identifier of a transportation option.
+    # @return [String]
+    attr_accessor :transportation_option_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier'] = 'carrier'
+      @_hash['carrier_appointment'] = 'carrierAppointment'
+      @_hash['preconditions'] = 'preconditions'
+      @_hash['quote'] = 'quote'
+      @_hash['shipment_id'] = 'shipmentId'
+      @_hash['shipping_mode'] = 'shippingMode'
+      @_hash['shipping_solution'] = 'shippingSolution'
+      @_hash['transportation_option_id'] = 'transportationOptionId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_appointment
+        quote
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(carrier:, preconditions:, shipment_id:, shipping_mode:,
+                   shipping_solution:, transportation_option_id:,
+                   carrier_appointment: SKIP, quote: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @carrier = carrier
+      @carrier_appointment = carrier_appointment unless carrier_appointment == SKIP
+      @preconditions = preconditions
+      @quote = quote unless quote == SKIP
+      @shipment_id = shipment_id
+      @shipping_mode = shipping_mode
+      @shipping_solution = shipping_solution
+      @transportation_option_id = transportation_option_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.
+      carrier = Carrier.from_hash(hash['carrier']) if hash['carrier']
+      preconditions = hash.key?('preconditions') ? hash['preconditions'] : nil
+      shipment_id = hash.key?('shipmentId') ? hash['shipmentId'] : nil
+      shipping_mode = hash.key?('shippingMode') ? hash['shippingMode'] : nil
+      shipping_solution =
+        hash.key?('shippingSolution') ? hash['shippingSolution'] : nil
+      transportation_option_id =
+        hash.key?('transportationOptionId') ? hash['transportationOptionId'] : nil
+      carrier_appointment = AppointmentSlotTime.from_hash(hash['carrierAppointment']) if
+        hash['carrierAppointment']
+      quote = Quote.from_hash(hash['quote']) if hash['quote']
+
+      # 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.
+      TransportationOption.new(carrier: carrier,
+                               preconditions: preconditions,
+                               shipment_id: shipment_id,
+                               shipping_mode: shipping_mode,
+                               shipping_solution: shipping_solution,
+                               transportation_option_id: transportation_option_id,
+                               carrier_appointment: carrier_appointment,
+                               quote: quote,
+                               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} carrier: #{@carrier}, carrier_appointment: #{@carrier_appointment},"\
+      " preconditions: #{@preconditions}, quote: #{@quote}, shipment_id: #{@shipment_id},"\
+      " shipping_mode: #{@shipping_mode}, shipping_solution: #{@shipping_solution},"\
+      " transportation_option_id: #{@transportation_option_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} carrier: #{@carrier.inspect}, carrier_appointment:"\
+      " #{@carrier_appointment.inspect}, preconditions: #{@preconditions.inspect}, quote:"\
+      " #{@quote.inspect}, shipment_id: #{@shipment_id.inspect}, shipping_mode:"\
+      " #{@shipping_mode.inspect}, shipping_solution: #{@shipping_solution.inspect},"\
+      " transportation_option_id: #{@transportation_option_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/transportation_selection.rb

@@ -0,0 +1,97 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # The transportation option selected to confirm.
+  class TransportationSelection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The seller's contact information.
+    # @return [ContactInformation]
+    attr_accessor :contact_information
+
+    # Shipment ID that the transportation option is for.
+    # @return [String]
+    attr_accessor :shipment_id
+
+    # Transportation option being selected for the provided shipment.
+    # @return [String]
+    attr_accessor :transportation_option_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['contact_information'] = 'contactInformation'
+      @_hash['shipment_id'] = 'shipmentId'
+      @_hash['transportation_option_id'] = 'transportationOptionId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        contact_information
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shipment_id:, transportation_option_id:,
+                   contact_information: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @contact_information = contact_information unless contact_information == SKIP
+      @shipment_id = shipment_id
+      @transportation_option_id = transportation_option_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.
+      shipment_id = hash.key?('shipmentId') ? hash['shipmentId'] : nil
+      transportation_option_id =
+        hash.key?('transportationOptionId') ? hash['transportationOptionId'] : nil
+      contact_information = ContactInformation.from_hash(hash['contactInformation']) if
+        hash['contactInformation']
+
+      # 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.
+      TransportationSelection.new(shipment_id: shipment_id,
+                                  transportation_option_id: transportation_option_id,
+                                  contact_information: contact_information,
+                                  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} contact_information: #{@contact_information}, shipment_id: #{@shipment_id},"\
+      " transportation_option_id: #{@transportation_option_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} contact_information: #{@contact_information.inspect}, shipment_id:"\
+      " #{@shipment_id.inspect}, transportation_option_id: #{@transportation_option_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/type.rb

@@ -0,0 +1,40 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Type.
+  class Type
+    TYPE = [
+      # TODO: Write general description for VARIATION
+      VARIATION = 'VARIATION'.freeze,
+
+      # TODO: Write general description for ACCESSORY
+      ACCESSORY = 'ACCESSORY'.freeze,
+
+      # TODO: Write general description for BUNDLE_COMPONENT
+      BUNDLE_COMPONENT = 'BUNDLE_COMPONENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = VARIATION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'variation' then VARIATION
+      when 'accessory' then ACCESSORY
+      when 'bundle_component' then BUNDLE_COMPONENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/type1.rb

@@ -0,0 +1,44 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Type1.
+  class Type1
+    TYPE1 = [
+      # TODO: Write general description for LABEL
+      LABEL = 'LABEL'.freeze,
+
+      # TODO: Write general description for RECEIPT
+      RECEIPT = 'RECEIPT'.freeze,
+
+      # TODO: Write general description for CUSTOMS_FORM
+      CUSTOMS_FORM = 'CUSTOMS_FORM'.freeze,
+
+      # TODO: Write general description for COMMERCIAL_INVOICE
+      COMMERCIAL_INVOICE = 'COMMERCIAL_INVOICE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE1.include?(value)
+    end
+
+    def self.from_value(value, default_value = LABEL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'label' then LABEL
+      when 'receipt' then RECEIPT
+      when 'customs_form' then CUSTOMS_FORM
+      when 'commercial_invoice' then COMMERCIAL_INVOICE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/type11.rb

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

data/lib/walmart_ap_is/models/unit.rb

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

data/lib/walmart_ap_is/models/unit1.rb

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

data/lib/walmart_ap_is/models/unit11.rb

@@ -0,0 +1,44 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Unit11.
+  class Unit11
+    UNIT11 = [
+      # TODO: Write general description for OZ
+      OZ = 'oz'.freeze,
+
+      # TODO: Write general description for G
+      G = 'g'.freeze,
+
+      # TODO: Write general description for LB
+      LB = 'lb'.freeze,
+
+      # TODO: Write general description for KG
+      KG = 'kg'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      UNIT11.include?(value)
+    end
+
+    def self.from_value(value, default_value = OZ)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'oz' then OZ
+      when 'g' then G
+      when 'lb' then LB
+      when 'kg' then KG
+      else
+        default_value
+      end
+    end
+  end
+end