Class: AmzSpApi::ServicesApiModel::Appointment

Inherits:
Object
  • Object
show all
Defined in:
lib/services-api-model/models/appointment.rb

Overview

The details of an appointment.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Appointment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



85
86
87
88
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
115
116
117
118
119
120
121
122
123
 
# File 'lib/services-api-model/models/appointment.rb', line 85

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::ServicesApiModel::Appointment` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `AmzSpApi::ServicesApiModel::Appointment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'appointment_id')
    self.appointment_id = attributes[:'appointment_id']
  end

  if attributes.key?(:'appointment_status')
    self.appointment_status = attributes[:'appointment_status']
  end

  if attributes.key?(:'appointment_time')
    self.appointment_time = attributes[:'appointment_time']
  end

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

  if attributes.key?(:'rescheduled_appointment_id')
    self.rescheduled_appointment_id = attributes[:'rescheduled_appointment_id']
  end

  if attributes.key?(:'poa')
    self.poa = attributes[:'poa']
  end
end

Instance Attribute Details

#appointment_id ⇒ Object

Returns the value of attribute appointment_id.



17
18
19
 
# File 'lib/services-api-model/models/appointment.rb', line 17

def appointment_id
  @appointment_id
end

#appointment_status ⇒ Object

The status of the appointment.



20
21
22
 
# File 'lib/services-api-model/models/appointment.rb', line 20

def appointment_status
  @appointment_status
end

#appointment_time ⇒ Object

Returns the value of attribute appointment_time.



22
23
24
 
# File 'lib/services-api-model/models/appointment.rb', line 22

def appointment_time
  @appointment_time
end

#assigned_technicians ⇒ Object

A list of technicians assigned to the service job.



25
26
27
 
# File 'lib/services-api-model/models/appointment.rb', line 25

def assigned_technicians
  @assigned_technicians
end

#poa ⇒ Object

Returns the value of attribute poa.



29
30
31
 
# File 'lib/services-api-model/models/appointment.rb', line 29

def poa
  @poa
end

#rescheduled_appointment_id ⇒ Object

Returns the value of attribute rescheduled_appointment_id.



27
28
29
 
# File 'lib/services-api-model/models/appointment.rb', line 27

def rescheduled_appointment_id
  @rescheduled_appointment_id
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/services-api-model/models/appointment.rb', line 54

def self.attribute_map
  {
    :'appointment_id' => :'appointmentId',
    :'appointment_status' => :'appointmentStatus',
    :'appointment_time' => :'appointmentTime',
    :'assigned_technicians' => :'assignedTechnicians',
    :'rescheduled_appointment_id' => :'rescheduledAppointmentId',
    :'poa' => :'poa'
  }
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



178
179
180
 
# File 'lib/services-api-model/models/appointment.rb', line 178

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
 
# File 'lib/services-api-model/models/appointment.rb', line 78

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/services-api-model/models/appointment.rb', line 66

def self.openapi_types
  {
    :'appointment_id' => :'Object',
    :'appointment_status' => :'Object',
    :'appointment_time' => :'Object',
    :'assigned_technicians' => :'Object',
    :'rescheduled_appointment_id' => :'Object',
    :'poa' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/services-api-model/models/appointment.rb', line 152

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      appointment_id == o.appointment_id &&
      appointment_status == o.appointment_status &&
      appointment_time == o.appointment_time &&
      assigned_technicians == o.assigned_technicians &&
      rescheduled_appointment_id == o.rescheduled_appointment_id &&
      poa == o.poa
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/services-api-model/models/appointment.rb', line 208

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
    AmzSpApi::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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/services-api-model/models/appointment.rb', line 277

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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/services-api-model/models/appointment.rb', line 185

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


165
166
167
 
# File 'lib/services-api-model/models/appointment.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



171
172
173
 
# File 'lib/services-api-model/models/appointment.rb', line 171

def hash
  [appointment_id, appointment_status, appointment_time, assigned_technicians, rescheduled_appointment_id, poa].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



127
128
129
130
 
# File 'lib/services-api-model/models/appointment.rb', line 127

def list_invalid_properties
  invalid_properties = Array.new
  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



253
254
255
 
# File 'lib/services-api-model/models/appointment.rb', line 253

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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/services-api-model/models/appointment.rb', line 259

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



247
248
249
 
# File 'lib/services-api-model/models/appointment.rb', line 247

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



134
135
136
137
138
 
# File 'lib/services-api-model/models/appointment.rb', line 134

def valid?
  appointment_status_validator = EnumAttributeValidator.new('Object', ['ACTIVE', 'CANCELLED', 'COMPLETED'])
  return false unless appointment_status_validator.valid?(@appointment_status)
  true
end