Class: RusticiSoftwareCloudV2::CreatePrivateInvitationSchema

Inherits:
Object
  • Object
show all
Defined in:
lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePrivateInvitationSchema

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
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/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 65

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

  if attributes.has_key?(:'creatingUserEmail')
    self.creating_user_email = attributes[:'creatingUserEmail']
  end

  if attributes.has_key?(:'invitationEmail')
    self.invitation_email = attributes[:'invitationEmail']
  end

  if attributes.has_key?(:'postBack')
    self.post_back = attributes[:'postBack']
  end

  if attributes.has_key?(:'expirationDate')
    self.expiration_date = attributes[:'expirationDate']
  end

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

  if attributes.has_key?(:'duplicateRegistrationOption')
    self.duplicate_registration_option = attributes[:'duplicateRegistrationOption']
  else
    self.duplicate_registration_option = 'SEND_EXISTING'
  end
end

Instance Attribute Details

#course_id ⇒ Object

The id of the course for which to create an invitation.



18
19
20
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 18

def course_id
  @course_id
end

#creating_user_email ⇒ Object

The email of the user who is creating the invitation.



21
22
23
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 21

def creating_user_email
  @creating_user_email
end

#duplicate_registration_option ⇒ Object

Represents the possible values that determine how existing registrations will be handled when an invitation is sent to an email address that has already received an invitation: - ‘FAIL`: Do not create a new invitation, do not send an email, and do nothing with registrations - `INSTANCE_EXISTING`: Create a new instance of the existing registration and send it with the invitation - `SEND_EXISTING`: Re-send the existing registration with the new invitation - `CREATE_NEW`: Create a new registration for the invitation



35
36
37
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 35

def duplicate_registration_option
  @duplicate_registration_option
end

#expiration_date ⇒ Object

The ISO 8601 TimeStamp (defaults to UTC) after which this invitation will expire and can no longer be launched. An empty value will represent no expiration date.



29
30
31
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 29

def expiration_date
  @expiration_date
end

#invitation_email ⇒ Object

Returns the value of attribute invitation_email.



23
24
25
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 23

def invitation_email
  @invitation_email
end

#post_back ⇒ Object

Specifies a URL for which to post activity and status data in real time as the course is completed



26
27
28
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 26

def post_back
  @post_back
end

#tags ⇒ Object

Optional tags to be applied to this invitation.



32
33
34
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 32

def tags
  @tags
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 38

def self.attribute_map
  {
    :'course_id' => :'courseId',
    :'creating_user_email' => :'creatingUserEmail',
    :'invitation_email' => :'invitationEmail',
    :'post_back' => :'postBack',
    :'expiration_date' => :'expirationDate',
    :'tags' => :'tags',
    :'duplicate_registration_option' => :'duplicateRegistrationOption'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 51

def self.swagger_types
  {
    :'course_id' => :'String',
    :'creating_user_email' => :'String',
    :'invitation_email' => :'InvitationEmailSchema',
    :'post_back' => :'PostBackSchema',
    :'expiration_date' => :'DateTime',
    :'tags' => :'Array<String>',
    :'duplicate_registration_option' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      course_id == o.course_id &&
      creating_user_email == o.creating_user_email &&
      invitation_email == o.invitation_email &&
      post_back == o.post_back &&
      expiration_date == o.expiration_date &&
      tags == o.tags &&
      duplicate_registration_option == o.duplicate_registration_option
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



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
221
222
223
224
225
226
227
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 191

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 = RusticiSoftwareCloudV2.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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 257

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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 170

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


157
158
159
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 163

def hash
  [course_id, creating_user_email, invitation_email, post_back, expiration_date, tags, duplicate_registration_option].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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 106

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

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

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



237
238
239
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 237

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



243
244
245
246
247
248
249
250
251
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 243

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



231
232
233
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 231

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



125
126
127
128
129
130
 
# File 'lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb', line 125

def valid?
  return false if @course_id.nil?
  return false if @creating_user_email.nil?
  return false if @invitation_email.nil?
  true
end