Class: OryClient::Message

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/message.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Message

Initializes the object

Parameters:

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

    Model attributes in the form of hash



122
123
124
125
126
127
128
129
130
131
132
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
205
 
# File 'lib/ory-client/models/message.rb', line 122

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::Message` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::Message`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'body')
    self.body = attributes[:'body']
  else
    self.body = nil
  end

  if attributes.key?(:'channel')
    self.channel = attributes[:'channel']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'recipient')
    self.recipient = attributes[:'recipient']
  else
    self.recipient = nil
  end

  if attributes.key?(:'send_count')
    self.send_count = attributes[:'send_count']
  else
    self.send_count = nil
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

  if attributes.key?(:'subject')
    self.subject = attributes[:'subject']
  else
    self.subject = nil
  end

  if attributes.key?(:'template_type')
    self.template_type = attributes[:'template_type']
  else
    self.template_type = nil
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  else
    self.updated_at = nil
  end
end

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



18
19
20
 
# File 'lib/ory-client/models/message.rb', line 18

def body
  @body
end

#channel ⇒ Object

Returns the value of attribute channel.



20
21
22
 
# File 'lib/ory-client/models/message.rb', line 20

def channel
  @channel
end

#created_at ⇒ Object

CreatedAt is a helper struct field for gobuffalo.pop.



23
24
25
 
# File 'lib/ory-client/models/message.rb', line 23

def created_at
  @created_at
end

#dispatches ⇒ Object

Dispatches store information about the attempts of delivering a message May contain an error if any happened, or just the success state.



26
27
28
 
# File 'lib/ory-client/models/message.rb', line 26

def dispatches
  @dispatches
end

#id ⇒ Object

Returns the value of attribute id.



28
29
30
 
# File 'lib/ory-client/models/message.rb', line 28

def id
  @id
end

#recipient ⇒ Object

Returns the value of attribute recipient.



30
31
32
 
# File 'lib/ory-client/models/message.rb', line 30

def recipient
  @recipient
end

#send_count ⇒ Object

Returns the value of attribute send_count.



32
33
34
 
# File 'lib/ory-client/models/message.rb', line 32

def send_count
  @send_count
end

#status ⇒ Object

Returns the value of attribute status.



34
35
36
 
# File 'lib/ory-client/models/message.rb', line 34

def status
  @status
end

#subject ⇒ Object

Returns the value of attribute subject.



36
37
38
 
# File 'lib/ory-client/models/message.rb', line 36

def subject
  @subject
end

#template_type ⇒ Object

recovery_invalid TypeRecoveryInvalid recovery_valid TypeRecoveryValid recovery_code_invalid TypeRecoveryCodeInvalid recovery_code_valid TypeRecoveryCodeValid verification_invalid TypeVerificationInvalid verification_valid TypeVerificationValid verification_code_invalid TypeVerificationCodeInvalid verification_code_valid TypeVerificationCodeValid stub TypeTestStub login_code_valid TypeLoginCodeValid registration_code_valid TypeRegistrationCodeValid



39
40
41
 
# File 'lib/ory-client/models/message.rb', line 39

def template_type
  @template_type
end

#type ⇒ Object

Returns the value of attribute type.



41
42
43
 
# File 'lib/ory-client/models/message.rb', line 41

def type
  @type
end

#updated_at ⇒ Object

UpdatedAt is a helper struct field for gobuffalo.pop.



44
45
46
 
# File 'lib/ory-client/models/message.rb', line 44

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



87
88
89
 
# File 'lib/ory-client/models/message.rb', line 87

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/ory-client/models/message.rb', line 92

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ory-client/models/message.rb', line 69

def self.attribute_map
  {
    :'body' => :'body',
    :'channel' => :'channel',
    :'created_at' => :'created_at',
    :'dispatches' => :'dispatches',
    :'id' => :'id',
    :'recipient' => :'recipient',
    :'send_count' => :'send_count',
    :'status' => :'status',
    :'subject' => :'subject',
    :'template_type' => :'template_type',
    :'type' => :'type',
    :'updated_at' => :'updated_at'
  }
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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/ory-client/models/message.rb', line 408

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
 
# File 'lib/ory-client/models/message.rb', line 115

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/ory-client/models/message.rb', line 97

def self.openapi_types
  {
    :'body' => :'String',
    :'channel' => :'String',
    :'created_at' => :'Time',
    :'dispatches' => :'Array<MessageDispatch>',
    :'id' => :'String',
    :'recipient' => :'String',
    :'send_count' => :'Integer',
    :'status' => :'CourierMessageStatus',
    :'subject' => :'String',
    :'template_type' => :'String',
    :'type' => :'CourierMessageType',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/ory-client/models/message.rb', line 376

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      body == o.body &&
      channel == o.channel &&
      created_at == o.created_at &&
      dispatches == o.dispatches &&
      id == o.id &&
      recipient == o.recipient &&
      send_count == o.send_count &&
      status == o.status &&
      subject == o.subject &&
      template_type == o.template_type &&
      type == o.type &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


395
396
397
 
# File 'lib/ory-client/models/message.rb', line 395

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



401
402
403
 
# File 'lib/ory-client/models/message.rb', line 401

def hash
  [body, channel, created_at, dispatches, id, recipient, send_count, status, subject, template_type, type, updated_at].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



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
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/ory-client/models/message.rb', line 209

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @body.nil?
    invalid_properties.push('invalid value for "body", body cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/ory-client/models/message.rb', line 430

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ory-client/models/message.rb', line 257

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @body.nil?
  return false if @created_at.nil?
  return false if @id.nil?
  return false if @recipient.nil?
  return false if @send_count.nil?
  return false if @status.nil?
  return false if @subject.nil?
  return false if @template_type.nil?
  template_type_validator = EnumAttributeValidator.new('String', ["recovery_invalid", "recovery_valid", "recovery_code_invalid", "recovery_code_valid", "verification_invalid", "verification_valid", "verification_code_invalid", "verification_code_valid", "stub", "login_code_valid", "registration_code_valid"])
  return false unless template_type_validator.valid?(@template_type)
  return false if @type.nil?
  return false if @updated_at.nil?
  true
end