Class: AmznSpApi::OrdersApiModel::ItemApproval

Inherits:
Object
  • Object
show all
Defined in:
lib/orders_api_model/models/item_approval.rb

Overview

Generic item approval. Check the applicable restrictions at the specific approval type schemas.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemApproval

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/orders_api_model/models/item_approval.rb', line 89

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::OrdersApiModel::ItemApproval` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::OrdersApiModel::ItemApproval`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.sequence_id = attributes[:sequence_id] if attributes.key?(:sequence_id)

  self.timestamp = attributes[:timestamp] if attributes.key?(:timestamp)

  self.actor = attributes[:actor] if attributes.key?(:actor)

  self.approver = attributes[:approver] if attributes.key?(:approver)

  self.approval_action = attributes[:approval_action] if attributes.key?(:approval_action)

  self.approval_action_process_status = attributes[:approval_action_process_status] if attributes.key?(:approval_action_process_status)

  return unless attributes.key?(:approval_action_process_status_message)

  self.approval_action_process_status_message = attributes[:approval_action_process_status_message]
end

Instance Attribute Details

#actor ⇒ Object

High level actors involved in the approval process.



22
23
24
 
# File 'lib/orders_api_model/models/item_approval.rb', line 22

def actor
  @actor
end

#approval_action ⇒ Object

Returns the value of attribute approval_action.



27
28
29
 
# File 'lib/orders_api_model/models/item_approval.rb', line 27

def approval_action
  @approval_action
end

#approval_action_process_status ⇒ Object

Status of approval action.



30
31
32
 
# File 'lib/orders_api_model/models/item_approval.rb', line 30

def approval_action_process_status
  @approval_action_process_status
end

#approval_action_process_status_message ⇒ Object

Optional message to communicate optional additional context about the current status of the approval action.



33
34
35
 
# File 'lib/orders_api_model/models/item_approval.rb', line 33

def approval_action_process_status_message
  @approval_action_process_status_message
end

#approver ⇒ Object

Person or system that triggers the approval actions on behalf of the actor.



25
26
27
 
# File 'lib/orders_api_model/models/item_approval.rb', line 25

def approver
  @approver
end

#sequence_id ⇒ Object

Sequence number of the item approval. Each ItemApproval gets its sequenceId automatically from a monotonic increasing function.



16
17
18
 
# File 'lib/orders_api_model/models/item_approval.rb', line 16

def sequence_id
  @sequence_id
end

#timestamp ⇒ Object

Timestamp when the ItemApproval was recorded by Amazon’s internal order approvals system. In ISO 8601 date time format.



19
20
21
 
# File 'lib/orders_api_model/models/item_approval.rb', line 19

def timestamp
  @timestamp
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/orders_api_model/models/item_approval.rb', line 57

def self.attribute_map
  {
    'sequence_id': :SequenceId,
    'timestamp': :Timestamp,
    'actor': :Actor,
    'approver': :Approver,
    'approval_action': :ApprovalAction,
    'approval_action_process_status': :ApprovalActionProcessStatus,
    'approval_action_process_status_message': :ApprovalActionProcessStatusMessage
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



199
200
201
 
# File 'lib/orders_api_model/models/item_approval.rb', line 199

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
 
# File 'lib/orders_api_model/models/item_approval.rb', line 83

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/orders_api_model/models/item_approval.rb', line 70

def self.openapi_types
  {
    'sequence_id': :Object,
    'timestamp': :Object,
    'actor': :Object,
    'approver': :Object,
    'approval_action': :Object,
    'approval_action_process_status': :Object,
    'approval_action_process_status_message': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/orders_api_model/models/item_approval.rb', line 171

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    sequence_id == other.sequence_id &&
    timestamp == other.timestamp &&
    actor == other.actor &&
    approver == other.approver &&
    approval_action == other.approval_action &&
    approval_action_process_status == other.approval_action_process_status &&
    approval_action_process_status_message == other.approval_action_process_status_message
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/orders_api_model/models/item_approval.rb', line 228

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    AmznSpApi::OrdersApiModel.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/orders_api_model/models/item_approval.rb', line 297

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/orders_api_model/models/item_approval.rb', line 206

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


186
187
188
 
# File 'lib/orders_api_model/models/item_approval.rb', line 186

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



192
193
194
 
# File 'lib/orders_api_model/models/item_approval.rb', line 192

def hash
  [sequence_id, timestamp, actor, approver, approval_action, approval_action_process_status, approval_action_process_status_message].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/orders_api_model/models/item_approval.rb', line 118

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "sequence_id", sequence_id cannot be nil.') if @sequence_id.nil?

  invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.') if @timestamp.nil?

  invalid_properties.push('invalid value for "actor", actor cannot be nil.') if @actor.nil?

  invalid_properties.push('invalid value for "approval_action", approval_action cannot be nil.') if @approval_action.nil?

  invalid_properties.push('invalid value for "approval_action_process_status", approval_action_process_status cannot be nil.') if @approval_action_process_status.nil?

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



273
274
275
 
# File 'lib/orders_api_model/models/item_approval.rb', line 273

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/orders_api_model/models/item_approval.rb', line 279

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



267
268
269
 
# File 'lib/orders_api_model/models/item_approval.rb', line 267

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/orders_api_model/models/item_approval.rb', line 135

def valid?
  return false if @sequence_id.nil?
  return false if @timestamp.nil?
  return false if @actor.nil?

  actor_validator = EnumAttributeValidator.new('Object', %w[SELLING_PARTNER AMAZON])
  return false unless actor_validator.valid?(@actor)
  return false if @approval_action.nil?
  return false if @approval_action_process_status.nil?

  approval_action_process_status_validator = EnumAttributeValidator.new('Object', %w[PROCESSING SUCCESS ERROR])
  return false unless approval_action_process_status_validator.valid?(@approval_action_process_status)

  true
end