walmart-apimatic-sdk 0.0.1 → 0.0.5

data/lib/walmart_ap_is/models/regulated_info.rb

@@ -0,0 +1,155 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Verification requirements for an order containing regulated items. Mirrors
+  # Amazon SP-API Orders v0 `RegulatedInformation` plus a `regulatedCategory`
+  # discriminator so a caller can short- circuit when the order is not regulated
+  # at all.
+  class RegulatedInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Top-level category of regulation that applies. NOT_REGULATED
+    # means no verification is required and the rest of the fields
+    # are informational only.
+    # @return [RegulatedCategory]
+    attr_accessor :regulated_category
+
+    # How the buyer must prove identity at delivery. NONE means no
+    # verification is required (NOT_REGULATED orders always return
+    # NONE).
+    # @return [RequiredVerificationMethod]
+    attr_accessor :required_verification_method
+
+    # Minimum buyer age in years (e.g. 21 for alcohol in the US).
+    # @return [Integer]
+    attr_accessor :required_age_minimum
+
+    # True when the carrier must capture a signature on delivery.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :signature_required
+
+    # True when the buyer's date of birth must be captured / cross-checked.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :buyer_date_of_birth_required
+
+    # Any value-added services attached to the order that are
+    # relevant to the regulated workflow (e.g. signed-delivery,
+    # adult-signature). Empty when none apply.
+    # @return [Array[ValueAddedService]]
+    attr_accessor :value_added_services
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['regulated_category'] = 'regulatedCategory'
+      @_hash['required_verification_method'] = 'requiredVerificationMethod'
+      @_hash['required_age_minimum'] = 'requiredAgeMinimum'
+      @_hash['signature_required'] = 'signatureRequired'
+      @_hash['buyer_date_of_birth_required'] = 'buyerDateOfBirthRequired'
+      @_hash['value_added_services'] = 'valueAddedServices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        required_age_minimum
+        signature_required
+        buyer_date_of_birth_required
+        value_added_services
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(regulated_category:, required_verification_method:,
+                   required_age_minimum: SKIP, signature_required: SKIP,
+                   buyer_date_of_birth_required: SKIP,
+                   value_added_services: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @regulated_category = regulated_category
+      @required_verification_method = required_verification_method
+      @required_age_minimum = required_age_minimum unless required_age_minimum == SKIP
+      @signature_required = signature_required unless signature_required == SKIP
+      unless buyer_date_of_birth_required == SKIP
+        @buyer_date_of_birth_required =
+          buyer_date_of_birth_required
+      end
+      @value_added_services = value_added_services unless value_added_services == 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.
+      regulated_category =
+        hash.key?('regulatedCategory') ? hash['regulatedCategory'] : nil
+      required_verification_method =
+        hash.key?('requiredVerificationMethod') ? hash['requiredVerificationMethod'] : nil
+      required_age_minimum =
+        hash.key?('requiredAgeMinimum') ? hash['requiredAgeMinimum'] : SKIP
+      signature_required =
+        hash.key?('signatureRequired') ? hash['signatureRequired'] : SKIP
+      buyer_date_of_birth_required =
+        hash.key?('buyerDateOfBirthRequired') ? hash['buyerDateOfBirthRequired'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      value_added_services = nil
+      unless hash['valueAddedServices'].nil?
+        value_added_services = []
+        hash['valueAddedServices'].each do |structure|
+          value_added_services << (ValueAddedService.from_hash(structure) if structure)
+        end
+      end
+
+      value_added_services = SKIP unless hash.key?('valueAddedServices')
+
+      # 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.
+      RegulatedInfo.new(regulated_category: regulated_category,
+                        required_verification_method: required_verification_method,
+                        required_age_minimum: required_age_minimum,
+                        signature_required: signature_required,
+                        buyer_date_of_birth_required: buyer_date_of_birth_required,
+                        value_added_services: value_added_services,
+                        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} regulated_category: #{@regulated_category}, required_verification_method:"\
+      " #{@required_verification_method}, required_age_minimum: #{@required_age_minimum},"\
+      " signature_required: #{@signature_required}, buyer_date_of_birth_required:"\
+      " #{@buyer_date_of_birth_required}, value_added_services: #{@value_added_services},"\
+      " 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} regulated_category: #{@regulated_category.inspect},"\
+      " required_verification_method: #{@required_verification_method.inspect},"\
+      " required_age_minimum: #{@required_age_minimum.inspect}, signature_required:"\
+      " #{@signature_required.inspect}, buyer_date_of_birth_required:"\
+      " #{@buyer_date_of_birth_required.inspect}, value_added_services:"\
+      " #{@value_added_services.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/walmart_ap_is/models/rejected_shipping_service.rb

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

data/lib/walmart_ap_is/models/rejection_reason.rb

@@ -0,0 +1,58 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module WalmartApIs
+  # Reason the verification was rejected. Required when
+  # `verificationStatus=REJECTED`; ignored otherwise. Mirrors Amazon SP-API's
+  # enumerated rejection reasons.
+  class RejectionReason
+    REJECTION_REASON = [
+      # TODO: Write general description for BUYER_CANCELED
+      BUYER_CANCELED = 'BUYER_CANCELED'.freeze,
+
+      # TODO: Write general description for BUYER_REJECTED
+      BUYER_REJECTED = 'BUYER_REJECTED'.freeze,
+
+      # TODO: Write general description for ID_EXPIRED
+      ID_EXPIRED = 'ID_EXPIRED'.freeze,
+
+      # TODO: Write general description for ID_INVALID
+      ID_INVALID = 'ID_INVALID'.freeze,
+
+      # TODO: Write general description for ID_UNDERAGE
+      ID_UNDERAGE = 'ID_UNDERAGE'.freeze,
+
+      # TODO: Write general description for ID_MISMATCH
+      ID_MISMATCH = 'ID_MISMATCH'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REJECTION_REASON.include?(value)
+    end
+
+    def self.from_value(value, default_value = BUYER_CANCELED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'buyer_canceled' then BUYER_CANCELED
+      when 'buyer_rejected' then BUYER_REJECTED
+      when 'id_expired' then ID_EXPIRED
+      when 'id_invalid' then ID_INVALID
+      when 'id_underage' then ID_UNDERAGE
+      when 'id_mismatch' then ID_MISMATCH
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/walmart_ap_is/models/related_item.rb

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

data/lib/walmart_ap_is/models/report.rb

@@ -0,0 +1,211 @@
+# walmart_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module WalmartApIs
+  # Report Model.
+  class Report < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :report_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :report_type
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :data_start_time
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :data_end_time
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :report_schedule_id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_time
+
+    # TODO: Write general description for this method
+    # @return [ProcessingStatus]
+    attr_accessor :processing_status
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :processing_start_time
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :processing_end_time
+
+    # Present only when processingStatus is DONE
+    # @return [String]
+    attr_accessor :report_document_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['report_id'] = 'reportId'
+      @_hash['report_type'] = 'reportType'
+      @_hash['data_start_time'] = 'dataStartTime'
+      @_hash['data_end_time'] = 'dataEndTime'
+      @_hash['report_schedule_id'] = 'reportScheduleId'
+      @_hash['created_time'] = 'createdTime'
+      @_hash['processing_status'] = 'processingStatus'
+      @_hash['processing_start_time'] = 'processingStartTime'
+      @_hash['processing_end_time'] = 'processingEndTime'
+      @_hash['report_document_id'] = 'reportDocumentId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data_start_time
+        data_end_time
+        report_schedule_id
+        created_time
+        processing_start_time
+        processing_end_time
+        report_document_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(report_id:, report_type:, processing_status:,
+                   data_start_time: SKIP, data_end_time: SKIP,
+                   report_schedule_id: SKIP, created_time: SKIP,
+                   processing_start_time: SKIP, processing_end_time: SKIP,
+                   report_document_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @report_id = report_id
+      @report_type = report_type
+      @data_start_time = data_start_time unless data_start_time == SKIP
+      @data_end_time = data_end_time unless data_end_time == SKIP
+      @report_schedule_id = report_schedule_id unless report_schedule_id == SKIP
+      @created_time = created_time unless created_time == SKIP
+      @processing_status = processing_status
+      @processing_start_time = processing_start_time unless processing_start_time == SKIP
+      @processing_end_time = processing_end_time unless processing_end_time == SKIP
+      @report_document_id = report_document_id unless report_document_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.
+      report_id = hash.key?('reportId') ? hash['reportId'] : nil
+      report_type = hash.key?('reportType') ? hash['reportType'] : nil
+      processing_status =
+        hash.key?('processingStatus') ? hash['processingStatus'] : nil
+      data_start_time = if hash.key?('dataStartTime')
+                          (DateTimeHelper.from_rfc3339(hash['dataStartTime']) if hash['dataStartTime'])
+                        else
+                          SKIP
+                        end
+      data_end_time = if hash.key?('dataEndTime')
+                        (DateTimeHelper.from_rfc3339(hash['dataEndTime']) if hash['dataEndTime'])
+                      else
+                        SKIP
+                      end
+      report_schedule_id =
+        hash.key?('reportScheduleId') ? hash['reportScheduleId'] : SKIP
+      created_time = if hash.key?('createdTime')
+                       (DateTimeHelper.from_rfc3339(hash['createdTime']) if hash['createdTime'])
+                     else
+                       SKIP
+                     end
+      processing_start_time = if hash.key?('processingStartTime')
+                                (DateTimeHelper.from_rfc3339(hash['processingStartTime']) if hash['processingStartTime'])
+                              else
+                                SKIP
+                              end
+      processing_end_time = if hash.key?('processingEndTime')
+                              (DateTimeHelper.from_rfc3339(hash['processingEndTime']) if hash['processingEndTime'])
+                            else
+                              SKIP
+                            end
+      report_document_id =
+        hash.key?('reportDocumentId') ? hash['reportDocumentId'] : 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.
+      Report.new(report_id: report_id,
+                 report_type: report_type,
+                 processing_status: processing_status,
+                 data_start_time: data_start_time,
+                 data_end_time: data_end_time,
+                 report_schedule_id: report_schedule_id,
+                 created_time: created_time,
+                 processing_start_time: processing_start_time,
+                 processing_end_time: processing_end_time,
+                 report_document_id: report_document_id,
+                 additional_properties: additional_properties)
+    end
+
+    def to_custom_data_start_time
+      DateTimeHelper.to_rfc3339(data_start_time)
+    end
+
+    def to_custom_data_end_time
+      DateTimeHelper.to_rfc3339(data_end_time)
+    end
+
+    def to_custom_created_time
+      DateTimeHelper.to_rfc3339(created_time)
+    end
+
+    def to_custom_processing_start_time
+      DateTimeHelper.to_rfc3339(processing_start_time)
+    end
+
+    def to_custom_processing_end_time
+      DateTimeHelper.to_rfc3339(processing_end_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} report_id: #{@report_id}, report_type: #{@report_type}, data_start_time:"\
+      " #{@data_start_time}, data_end_time: #{@data_end_time}, report_schedule_id:"\
+      " #{@report_schedule_id}, created_time: #{@created_time}, processing_status:"\
+      " #{@processing_status}, processing_start_time: #{@processing_start_time},"\
+      " processing_end_time: #{@processing_end_time}, report_document_id: #{@report_document_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} report_id: #{@report_id.inspect}, report_type: #{@report_type.inspect},"\
+      " data_start_time: #{@data_start_time.inspect}, data_end_time: #{@data_end_time.inspect},"\
+      " report_schedule_id: #{@report_schedule_id.inspect}, created_time:"\
+      " #{@created_time.inspect}, processing_status: #{@processing_status.inspect},"\
+      " processing_start_time: #{@processing_start_time.inspect}, processing_end_time:"\
+      " #{@processing_end_time.inspect}, report_document_id: #{@report_document_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end