Class: AmznSpApi::ServicesApiModel::Poa

Inherits:
Object
  • Object
show all
Defined in:
lib/services_api_model/models/poa.rb

Overview

Proof of Appointment (POA) details.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Poa

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError)


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/services_api_model/models/poa.rb', line 79

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::ServicesApiModel::Poa` 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::ServicesApiModel::Poa`. 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.appointment_time = attributes[:appointment_time] if attributes.key?(:appointment_time)

  if attributes.key?(:technicians) && (value = attributes[:technicians]).is_a?(Array)
    self.technicians = value
  end

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

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

  return unless attributes.key?(:poa_type)

  self.poa_type = attributes[:poa_type]
end

Instance Attribute Details

#appointment_timeObject

Returns the value of attribute appointment_time.



15
16
17
# File 'lib/services_api_model/models/poa.rb', line 15

def appointment_time
  @appointment_time
end

#poa_typeObject

The type of POA uploaded.



27
28
29
# File 'lib/services_api_model/models/poa.rb', line 27

def poa_type
  @poa_type
end

#techniciansObject

A list of technicians.



18
19
20
# File 'lib/services_api_model/models/poa.rb', line 18

def technicians
  @technicians
end

#upload_timeObject

The date and time when the POA was uploaded in ISO 8601 format.



24
25
26
# File 'lib/services_api_model/models/poa.rb', line 24

def upload_time
  @upload_time
end

#uploading_technicianObject

The identifier of the technician who uploaded the POA.



21
22
23
# File 'lib/services_api_model/models/poa.rb', line 21

def uploading_technician
  @uploading_technician
end

Class Method Details

.attribute_mapObject

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



51
52
53
54
55
56
57
58
59
# File 'lib/services_api_model/models/poa.rb', line 51

def self.attribute_map
  {
    'appointment_time': :appointmentTime,
    'technicians': :technicians,
    'uploading_technician': :uploadingTechnician,
    'upload_time': :uploadTime,
    'poa_type': :poaType
  }
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



156
157
158
# File 'lib/services_api_model/models/poa.rb', line 156

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

.openapi_nullableObject

List of attributes with nullable: true



73
74
75
# File 'lib/services_api_model/models/poa.rb', line 73

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

.openapi_typesObject

Attribute type mapping.



62
63
64
65
66
67
68
69
70
# File 'lib/services_api_model/models/poa.rb', line 62

def self.openapi_types
  {
    'appointment_time': :Object,
    'technicians': :Object,
    'uploading_technician': :Object,
    'upload_time': :Object,
    'poa_type': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



130
131
132
133
134
135
136
137
138
139
# File 'lib/services_api_model/models/poa.rb', line 130

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

  self.class == other.class &&
    appointment_time == other.appointment_time &&
    technicians == other.technicians &&
    uploading_technician == other.uploading_technician &&
    upload_time == other.upload_time &&
    poa_type == other.poa_type
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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/services_api_model/models/poa.rb', line 185

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::ServicesApiModel.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



254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/services_api_model/models/poa.rb', line 254

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/services_api_model/models/poa.rb', line 163

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


143
144
145
# File 'lib/services_api_model/models/poa.rb', line 143

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



149
150
151
# File 'lib/services_api_model/models/poa.rb', line 149

def hash
  [appointment_time, technicians, uploading_technician, upload_time, poa_type].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



106
107
108
# File 'lib/services_api_model/models/poa.rb', line 106

def list_invalid_properties
  []
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



230
231
232
# File 'lib/services_api_model/models/poa.rb', line 230

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/services_api_model/models/poa.rb', line 236

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



224
225
226
# File 'lib/services_api_model/models/poa.rb', line 224

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



112
113
114
115
116
117
# File 'lib/services_api_model/models/poa.rb', line 112

def valid?
  poa_type_validator = EnumAttributeValidator.new('Object', %w[NO_SIGNATURE_DUMMY_POS CUSTOMER_SIGNATURE DUMMY_RECEIPT POA_RECEIPT])
  return false unless poa_type_validator.valid?(@poa_type)

  true
end