Class: SwaggerClient::AddAppointmentRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddAppointmentRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



133
134
135
136
137
138
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
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 133

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?(:'ApplyPayment')
    self.apply_payment = attributes[:'ApplyPayment']
  end

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

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

  if attributes.has_key?(:'Execute')
    self.execute = attributes[:'Execute']
  end

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

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

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

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

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

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

  if attributes.has_key?(:'SendEmail')
    self.send_email = attributes[:'SendEmail']
  end

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

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

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

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

  if attributes.has_key?(:'Test')
    self.test = attributes[:'Test']
  end
end

Instance Attribute Details

#apply_payment ⇒ Object

When ‘true`, indicates that a payment should be applied to the appointment. <br />Default: true



18
19
20
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 18

def apply_payment
  @apply_payment
end

#client_id ⇒ Object

The RRSID of the client for whom the new appointment is being made.



21
22
23
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 21

def client_id
  @client_id
end

#duration ⇒ Object

The duration of the appointment. This parameter is used to change the default duration of an appointment.



24
25
26
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 24

def duration
  @duration
end

#end_date_time ⇒ Object

The end date and time of the new appointment. <br /> Default: StartDateTime, offset by the staff member’s default appointment duration.



30
31
32
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 30

def end_date_time
  @end_date_time
end

#execute ⇒ Object

The action taken to add this appointment.



27
28
29
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 27

def execute
  @execute
end

#gender_preference ⇒ Object

The client’s service provider gender preference.



33
34
35
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 33

def gender_preference
  @gender_preference
end

#location_id ⇒ Object

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



36
37
38
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 36

def location_id
  @location_id
end

#notes ⇒ Object

Any general notes about this appointment.



39
40
41
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 39

def notes
  @notes
end

#provider_id ⇒ Object

If a user has Complementary and Alternative Medicine features enabled, this parameter assigns a provider ID to the appointment.



42
43
44
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 42

def provider_id
  @provider_id
end

#resource_ids ⇒ Object

A list of resource IDs to associate with the new appointment.



45
46
47
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 45

def resource_ids
  @resource_ids
end

#send_email ⇒ Object

Whether to send client an email for cancellations. An email is sent only if the client has an email address and automatic emails have been set up. <br />Default: false



48
49
50
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 48

def send_email
  @send_email
end

#session_type_id ⇒ Object

The session type associated with the new appointment.



51
52
53
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 51

def session_type_id
  @session_type_id
end

#staff_id ⇒ Object

The ID of the staff member who is adding the new appointment.



54
55
56
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 54

def staff_id
  @staff_id
end

#staff_requested ⇒ Object

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



57
58
59
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 57

def staff_requested
  @staff_requested
end

#start_date_time ⇒ Object

The start date and time of the new appointment.



60
61
62
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 60

def start_date_time
  @start_date_time
end

#test ⇒ Object

When true, indicates that the method is to be validated, but no new appointment data is added. <br />Default: false



63
64
65
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 63

def test
  @test
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 88

def self.attribute_map
  {
    :'apply_payment' => :'ApplyPayment',
    :'client_id' => :'ClientId',
    :'duration' => :'Duration',
    :'execute' => :'Execute',
    :'end_date_time' => :'EndDateTime',
    :'gender_preference' => :'GenderPreference',
    :'location_id' => :'LocationId',
    :'notes' => :'Notes',
    :'provider_id' => :'ProviderId',
    :'resource_ids' => :'ResourceIds',
    :'send_email' => :'SendEmail',
    :'session_type_id' => :'SessionTypeId',
    :'staff_id' => :'StaffId',
    :'staff_requested' => :'StaffRequested',
    :'start_date_time' => :'StartDateTime',
    :'test' => :'Test'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 110

def self.swagger_types
  {
    :'apply_payment' => :'BOOLEAN',
    :'client_id' => :'String',
    :'duration' => :'Integer',
    :'execute' => :'String',
    :'end_date_time' => :'DateTime',
    :'gender_preference' => :'String',
    :'location_id' => :'Integer',
    :'notes' => :'String',
    :'provider_id' => :'String',
    :'resource_ids' => :'Array<Integer>',
    :'send_email' => :'BOOLEAN',
    :'session_type_id' => :'Integer',
    :'staff_id' => :'Integer',
    :'staff_requested' => :'BOOLEAN',
    :'start_date_time' => :'DateTime',
    :'test' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      apply_payment == o.apply_payment &&
      client_id == o.client_id &&
      duration == o.duration &&
      execute == o.execute &&
      end_date_time == o.end_date_time &&
      gender_preference == o.gender_preference &&
      location_id == o.location_id &&
      notes == o.notes &&
      provider_id == o.provider_id &&
      resource_ids == o.resource_ids &&
      send_email == o.send_email &&
      session_type_id == o.session_type_id &&
      staff_id == o.staff_id &&
      staff_requested == o.staff_requested &&
      start_date_time == o.start_date_time &&
      test == o.test
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



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
350
351
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 315

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 381

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



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

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


281
282
283
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 281

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



287
288
289
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 287

def hash
  [apply_payment, client_id, duration, execute, end_date_time, gender_preference, location_id, notes, provider_id, resource_ids, send_email, session_type_id, staff_id, staff_requested, start_date_time, test].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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 208

def list_invalid_properties
  invalid_properties = Array.new
  if @client_id.nil?
    invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
  end

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

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

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

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

  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



361
362
363
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 361

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



367
368
369
370
371
372
373
374
375
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 367

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



355
356
357
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 355

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



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/swagger_client/models/add_appointment_request.rb', line 235

def valid?
  return false if @client_id.nil?
  gender_preference_validator = EnumAttributeValidator.new('String', ['None', 'Female', 'Male'])
  return false unless gender_preference_validator.valid?(@gender_preference)
  return false if @location_id.nil?
  return false if @session_type_id.nil?
  return false if @staff_id.nil?
  return false if @start_date_time.nil?
  true
end