Class: SwaggerClient::AddClientToClassRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddClientToClassRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
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
124
125
126
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 81

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

  if attributes.has_key?(:'ClassId')
    self.class_id = attributes[:'ClassId']
  end

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

  if attributes.has_key?(:'RequirePayment')
    self.require_payment = attributes[:'RequirePayment']
  end

  if attributes.has_key?(:'Waitlist')
    self.waitlist = attributes[:'Waitlist']
  end

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

  if attributes.has_key?(:'WaitlistEntryId')
    self.waitlist_entry_id = attributes[:'WaitlistEntryId']
  end

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

  if attributes.has_key?(:'CrossRegionalBooking')
    self.cross_regional_booking = attributes[:'CrossRegionalBooking']
  end

  if attributes.has_key?(:'CrossRegionalBookingClientServiceSiteId')
    self.cross_regional_booking_client_service_site_id = attributes[:'CrossRegionalBookingClientServiceSiteId']
  end
end

Instance Attribute Details

#class_id ⇒ Object

The ID of the class into which the client is being booked



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

def class_id
  @class_id
end

#client_id ⇒ Object

The ID of the client who is being booked into the class



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

def client_id
  @client_id
end

#client_service_id ⇒ Object

The ID of the pricing option on the client’s account that you want to use to pay for this booking, if payment is required at the time of the update.



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

def client_service_id
  @client_service_id
end

#cross_regional_booking ⇒ Object

When ‘true`, cross regional series are checked and used if applicable.



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

def cross_regional_booking
  @cross_regional_booking
end

#cross_regional_booking_client_service_site_id ⇒ Object

If the request is cross regional, use a purchased pricing option from this specified site. If omitted, an attempt is made to use an applicable pricing option from the local site.



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

def cross_regional_booking_client_service_site_id
  @cross_regional_booking_client_service_site_id
end

#require_payment ⇒ Object

When ‘true`, the client must have an active, usable pricing option on their account.<br /> When `false` or omitted, an active pricing option is not required to complete the client’s booking.



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

def require_payment
  @require_payment
end

#send_email ⇒ Object

When ‘true`, the subscriber’s configured Booking Confirmation automatic email is sent to the client. Note that an email is sent only if the client has an email address and automatic emails have been set up.<br /> When `false`, indicates that the client does not receive emails.<br /> Default: false



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

def send_email
  @send_email
end

#test ⇒ Object

When ‘true`, indicates that input information is validated, but not committed.<br /> When `false`, the information is committed and the database is affected.<br /> Default: false



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

def test
  @test
end

#waitlist ⇒ Object

When ‘true`, indicates that the client should be added to a specific class waiting list.<br /> When `false`, the client should not be added to the waiting list.



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

def waitlist
  @waitlist
end

#waitlist_entry_id ⇒ Object

The ID of the waiting list entry from which you are moving a client into a class.



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

def waitlist_entry_id
  @waitlist_entry_id
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 48

def self.attribute_map
  {
    :'client_id' => :'ClientId',
    :'class_id' => :'ClassId',
    :'test' => :'Test',
    :'require_payment' => :'RequirePayment',
    :'waitlist' => :'Waitlist',
    :'send_email' => :'SendEmail',
    :'waitlist_entry_id' => :'WaitlistEntryId',
    :'client_service_id' => :'ClientServiceId',
    :'cross_regional_booking' => :'CrossRegionalBooking',
    :'cross_regional_booking_client_service_site_id' => :'CrossRegionalBookingClientServiceSiteId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 64

def self.swagger_types
  {
    :'client_id' => :'String',
    :'class_id' => :'Integer',
    :'test' => :'BOOLEAN',
    :'require_payment' => :'BOOLEAN',
    :'waitlist' => :'BOOLEAN',
    :'send_email' => :'BOOLEAN',
    :'waitlist_entry_id' => :'Integer',
    :'client_service_id' => :'Integer',
    :'cross_regional_booking' => :'BOOLEAN',
    :'cross_regional_booking_client_service_site_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      class_id == o.class_id &&
      test == o.test &&
      require_payment == o.require_payment &&
      waitlist == o.waitlist &&
      send_email == o.send_email &&
      waitlist_entry_id == o.waitlist_entry_id &&
      client_service_id == o.client_service_id &&
      cross_regional_booking == o.cross_regional_booking &&
      cross_regional_booking_client_service_site_id == o.cross_regional_booking_client_service_site_id
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



204
205
206
207
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
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 204

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 270

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 183

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


170
171
172
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 170

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



176
177
178
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 176

def hash
  [client_id, class_id, test, require_payment, waitlist, send_email, waitlist_entry_id, client_service_id, cross_regional_booking, cross_regional_booking_client_service_site_id].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



130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 130

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 @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id 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



250
251
252
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 250

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



256
257
258
259
260
261
262
263
264
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 256

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



244
245
246
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 244

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



145
146
147
148
149
 
# File 'lib/swagger_client/models/add_client_to_class_request.rb', line 145

def valid?
  return false if @client_id.nil?
  return false if @class_id.nil?
  true
end