Class: SwaggerClient::Appointment

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/models/appointment.rb

Overview

Contains information about 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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
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
 
# File 'lib/swagger_client/models/appointment.rb', line 139

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'GenderPreference')
    self.gender_preference = attributes[:'GenderPreference']
  end

  if attributes.has_key?(:'Duration')
    self.duration = attributes[:'Duration']
  end

  if attributes.has_key?(:'ProviderId')
    self.provider_id = attributes[:'ProviderId']
  end

  if attributes.has_key?(:'Id')
    self.id = attributes[:'Id']
  end

  if attributes.has_key?(:'Status')
    self.status = attributes[:'Status']
  end

  if attributes.has_key?(:'StartDateTime')
    self.start_date_time = attributes[:'StartDateTime']
  end

  if attributes.has_key?(:'EndDateTime')
    self.end_date_time = attributes[:'EndDateTime']
  end

  if attributes.has_key?(:'Notes')
    self.notes = attributes[:'Notes']
  end

  if attributes.has_key?(:'StaffRequested')
    self.staff_requested = attributes[:'StaffRequested']
  end

  if attributes.has_key?(:'ProgramId')
    self.program_id = attributes[:'ProgramId']
  end

  if attributes.has_key?(:'SessionTypeId')
    self.session_type_id = attributes[:'SessionTypeId']
  end

  if attributes.has_key?(:'LocationId')
    self.location_id = attributes[:'LocationId']
  end

  if attributes.has_key?(:'StaffId')
    self.staff_id = attributes[:'StaffId']
  end

  if attributes.has_key?(:'ClientId')
    self.client_id = attributes[:'ClientId']
  end

  if attributes.has_key?(:'FirstAppointment')
    self.first_appointment = attributes[:'FirstAppointment']
  end

  if attributes.has_key?(:'ClientServiceId')
    self.client_service_id = attributes[:'ClientServiceId']
  end

  if attributes.has_key?(:'Resources')
    if (value = attributes[:'Resources']).is_a?(Array)
      self.resources = value
    end
  end
end

Instance Attribute Details

#client_id ⇒ Object

The RSSID of the client who is booked for this appointment.



58
59
60
 
# File 'lib/swagger_client/models/appointment.rb', line 58

def client_id
  @client_id
end

#client_service_id ⇒ Object

The ID of the pass on the client’s account that is to pay for this appointment.



64
65
66
 
# File 'lib/swagger_client/models/appointment.rb', line 64

def client_service_id
  @client_service_id
end

#duration ⇒ Object

The duration of the appointment.



22
23
24
 
# File 'lib/swagger_client/models/appointment.rb', line 22

def duration
  @duration
end

#end_date_time ⇒ Object

The date and time the appointment is to end.



37
38
39
 
# File 'lib/swagger_client/models/appointment.rb', line 37

def end_date_time
  @end_date_time
end

#first_appointment ⇒ Object

When ‘true`, indicates that this is the client’s first appointment at this site.



61
62
63
 
# File 'lib/swagger_client/models/appointment.rb', line 61

def first_appointment
  @first_appointment
end

#gender_preference ⇒ Object

The preferred gender of the appointment provider.



19
20
21
 
# File 'lib/swagger_client/models/appointment.rb', line 19

def gender_preference
  @gender_preference
end

#id ⇒ Object

The unique ID of the appointment.



28
29
30
 
# File 'lib/swagger_client/models/appointment.rb', line 28

def id
  @id
end

#location_id ⇒ Object

The ID of the location where this appointment is to take place.



52
53
54
 
# File 'lib/swagger_client/models/appointment.rb', line 52

def location_id
  @location_id
end

#notes ⇒ Object

Any notes associated with the appointment.



40
41
42
 
# File 'lib/swagger_client/models/appointment.rb', line 40

def notes
  @notes
end

#program_id ⇒ Object

The ID of the program to which this appointment belongs.



46
47
48
 
# File 'lib/swagger_client/models/appointment.rb', line 46

def program_id
  @program_id
end

#provider_id ⇒ Object

If a user has Complementary and Alternative Medicine features enabled, this property indicates the provider assigned to the appointment.



25
26
27
 
# File 'lib/swagger_client/models/appointment.rb', line 25

def provider_id
  @provider_id
end

#resources ⇒ Object

The resources this appointment is to use.



67
68
69
 
# File 'lib/swagger_client/models/appointment.rb', line 67

def resources
  @resources
end

#session_type_id ⇒ Object

The ID of the session type of this appointment.



49
50
51
 
# File 'lib/swagger_client/models/appointment.rb', line 49

def session_type_id
  @session_type_id
end

#staff_id ⇒ Object

The ID of the staff member providing the service for this appointment.



55
56
57
 
# File 'lib/swagger_client/models/appointment.rb', line 55

def staff_id
  @staff_id
end

#staff_requested ⇒ Object

When ‘true`, indicates that the staff member was requested specifically by the client.



43
44
45
 
# File 'lib/swagger_client/models/appointment.rb', line 43

def staff_requested
  @staff_requested
end

#start_date_time ⇒ Object

The date and time the appointment is to start.



34
35
36
 
# File 'lib/swagger_client/models/appointment.rb', line 34

def start_date_time
  @start_date_time
end

#status ⇒ Object

The status of this appointment.



31
32
33
 
# File 'lib/swagger_client/models/appointment.rb', line 31

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/swagger_client/models/appointment.rb', line 92

def self.attribute_map
  {
    :'gender_preference' => :'GenderPreference',
    :'duration' => :'Duration',
    :'provider_id' => :'ProviderId',
    :'id' => :'Id',
    :'status' => :'Status',
    :'start_date_time' => :'StartDateTime',
    :'end_date_time' => :'EndDateTime',
    :'notes' => :'Notes',
    :'staff_requested' => :'StaffRequested',
    :'program_id' => :'ProgramId',
    :'session_type_id' => :'SessionTypeId',
    :'location_id' => :'LocationId',
    :'staff_id' => :'StaffId',
    :'client_id' => :'ClientId',
    :'first_appointment' => :'FirstAppointment',
    :'client_service_id' => :'ClientServiceId',
    :'resources' => :'Resources'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/swagger_client/models/appointment.rb', line 115

def self.swagger_types
  {
    :'gender_preference' => :'String',
    :'duration' => :'Integer',
    :'provider_id' => :'String',
    :'id' => :'Integer',
    :'status' => :'String',
    :'start_date_time' => :'DateTime',
    :'end_date_time' => :'DateTime',
    :'notes' => :'String',
    :'staff_requested' => :'BOOLEAN',
    :'program_id' => :'Integer',
    :'session_type_id' => :'Integer',
    :'location_id' => :'Integer',
    :'staff_id' => :'Integer',
    :'client_id' => :'String',
    :'first_appointment' => :'BOOLEAN',
    :'client_service_id' => :'Integer',
    :'resources' => :'Array<Resource>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/swagger_client/models/appointment.rb', line 255

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      gender_preference == o.gender_preference &&
      duration == o.duration &&
      provider_id == o.provider_id &&
      id == o.id &&
      status == o.status &&
      start_date_time == o.start_date_time &&
      end_date_time == o.end_date_time &&
      notes == o.notes &&
      staff_requested == o.staff_requested &&
      program_id == o.program_id &&
      session_type_id == o.session_type_id &&
      location_id == o.location_id &&
      staff_id == o.staff_id &&
      client_id == o.client_id &&
      first_appointment == o.first_appointment &&
      client_service_id == o.client_service_id &&
      resources == o.resources
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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/swagger_client/models/appointment.rb', line 313

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
    temp_model = SwaggerClient.const_get(type).new
    temp_model.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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/swagger_client/models/appointment.rb', line 379

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/swagger_client/models/appointment.rb', line 292

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


279
280
281
 
# File 'lib/swagger_client/models/appointment.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



285
286
287
 
# File 'lib/swagger_client/models/appointment.rb', line 285

def hash
  [gender_preference, duration, provider_id, id, status, start_date_time, end_date_time, notes, staff_requested, program_id, session_type_id, location_id, staff_id, client_id, first_appointment, client_service_id, resources].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



218
219
220
221
 
# File 'lib/swagger_client/models/appointment.rb', line 218

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



359
360
361
 
# File 'lib/swagger_client/models/appointment.rb', line 359

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



365
366
367
368
369
370
371
372
373
 
# File 'lib/swagger_client/models/appointment.rb', line 365

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



353
354
355
 
# File 'lib/swagger_client/models/appointment.rb', line 353

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



225
226
227
228
229
230
231
 
# File 'lib/swagger_client/models/appointment.rb', line 225

def valid?
  gender_preference_validator = EnumAttributeValidator.new('String', ['None', 'Female', 'Male'])
  return false unless gender_preference_validator.valid?(@gender_preference)
  status_validator = EnumAttributeValidator.new('String', ['None', 'Requested', 'Booked', 'Completed', 'Confirmed', 'Arrived', 'NoShow', 'Cancelled', 'LateCancelled'])
  return false unless status_validator.valid?(@status)
  true
end