Class: WalmartApIs::UpdateVerificationStatusRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/walmart_ap_is/models/update_verification_status_request.rb

Overview

Records the seller's verification decision for a regulated order. REJECTED requires a rejectionReason; APPROVED leaves rejectionReason unset.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(verification_status:, rejection_reason: SKIP, additional_properties: nil) ⇒ UpdateVerificationStatusRequest

Returns a new instance of UpdateVerificationStatusRequest.



43
44
45
46
47
48
49
50
51
 
# File 'lib/walmart_ap_is/models/update_verification_status_request.rb', line 43

def initialize(verification_status:, rejection_reason: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @verification_status = verification_status
  @rejection_reason = rejection_reason unless rejection_reason == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#rejection_reason ⇒ RejectionReason

Reason the verification was rejected. Required when verificationStatus=REJECTED; ignored otherwise. Mirrors Amazon SP-API's enumerated rejection reasons.

Returns:



21
22
23
 
# File 'lib/walmart_ap_is/models/update_verification_status_request.rb', line 21

def rejection_reason
  @rejection_reason
end

#verification_status ⇒ VerificationStatus

Outcome of the doorstep / pickup identity verification.

Returns:



15
16
17
 
# File 'lib/walmart_ap_is/models/update_verification_status_request.rb', line 15

def verification_status
  @verification_status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/walmart_ap_is/models/update_verification_status_request.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  verification_status =
    hash.key?('verificationStatus') ? hash['verificationStatus'] : nil
  rejection_reason =
    hash.key?('rejectionReason') ? hash['rejectionReason'] : 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.
  UpdateVerificationStatusRequest.new(verification_status: verification_status,
                                      rejection_reason: rejection_reason,
                                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



24
25
26
27
28
29
 
# File 'lib/walmart_ap_is/models/update_verification_status_request.rb', line 24

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['verification_status'] = 'verificationStatus'
  @_hash['rejection_reason'] = 'rejectionReason'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/walmart_ap_is/models/update_verification_status_request.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



32
33
34
35
36
 
# File 'lib/walmart_ap_is/models/update_verification_status_request.rb', line 32

def self.optionals
  %w[
    rejection_reason
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



84
85
86
87
88
 
# File 'lib/walmart_ap_is/models/update_verification_status_request.rb', line 84

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} verification_status: #{@verification_status.inspect}, rejection_reason:"\
  " #{@rejection_reason.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



77
78
79
80
81
 
# File 'lib/walmart_ap_is/models/update_verification_status_request.rb', line 77

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} verification_status: #{@verification_status}, rejection_reason:"\
  " #{@rejection_reason}, additional_properties: #{@additional_properties}>"
end