Class: RusticiSoftwareCloudV2::CreatePublicInvitationSchema

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePublicInvitationSchema

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
63
64
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
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 61

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?(:'registrationCap')
    self.registration_cap = attributes[:'registrationCap']
  else
    self.registration_cap = 0
  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
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_public_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_public_invitation_schema.rb', line 21

def creating_user_email
  @creating_user_email
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.



30
31
32
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 30

def expiration_date
  @expiration_date
end

#post_back ⇒ Object

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



27
28
29
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 27

def post_back
  @post_back
end

#registration_cap ⇒ Object

Integer value that represents the maximum number of registrations that can be created for a public invitation. Setting this value to ‘0’ allows an unlimited amount of registrations to be created for the invitation.



24
25
26
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 24

def registration_cap
  @registration_cap
end

#tags ⇒ Object

Optional tags to be applied to this invitation.



33
34
35
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 33

def tags
  @tags
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 36

def self.attribute_map
  {
    :'course_id' => :'courseId',
    :'creating_user_email' => :'creatingUserEmail',
    :'registration_cap' => :'registrationCap',
    :'post_back' => :'postBack',
    :'expiration_date' => :'expirationDate',
    :'tags' => :'tags'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 48

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



122
123
124
125
126
127
128
129
130
131
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 122

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



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
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 169

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



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 235

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 148

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


135
136
137
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 135

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



141
142
143
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 141

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



98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 98

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

  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



215
216
217
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 215

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



221
222
223
224
225
226
227
228
229
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 221

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



209
210
211
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 209

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



113
114
115
116
117
 
# File 'lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb', line 113

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