Class: MailSafePro::APIKeyMeta

Inherits:
ApiModelBase show all
Defined in:
lib/mailsafepro/models/api_key_meta.rb

Overview

API Key metadata

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 = {}) ⇒ APIKeyMeta

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
117
118
119
120
121
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
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 116

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSafePro::APIKeyMeta` 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 `MailSafePro::APIKeyMeta`. 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?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Creation timestamp



29
30
31
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 29

def created_at
  @created_at
end

#id ⇒ Object

Unique key identifier



20
21
22
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 20

def id
  @id
end

#key_hash ⇒ Object

Hashed key value



23
24
25
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 23

def key_hash
  @key_hash
end

#last_used ⇒ Object

Returns the value of attribute last_used.



41
42
43
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 41

def last_used
  @last_used
end

#name ⇒ Object

Returns the value of attribute name.



39
40
41
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 39

def name
  @name
end

#plan ⇒ Object

Associated plan



26
27
28
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 26

def plan
  @plan
end

#revoked ⇒ Object

Revocation status



32
33
34
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 32

def revoked
  @revoked
end

#revoked_at ⇒ Object

Returns the value of attribute revoked_at.



34
35
36
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 34

def revoked_at
  @revoked_at
end

#scopes ⇒ Object

Access scopes



37
38
39
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 37

def scopes
  @scopes
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



81
82
83
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 81

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



86
87
88
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 86

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 66

def self.attribute_map
  {
    :'id' => :'id',
    :'key_hash' => :'key_hash',
    :'plan' => :'plan',
    :'created_at' => :'created_at',
    :'revoked' => :'revoked',
    :'revoked_at' => :'revoked_at',
    :'scopes' => :'scopes',
    :'name' => :'name',
    :'last_used' => :'last_used'
  }
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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 300

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



106
107
108
109
110
111
112
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 106

def self.openapi_nullable
  Set.new([
    :'revoked_at',
    :'name',
    :'last_used'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 91

def self.openapi_types
  {
    :'id' => :'String',
    :'key_hash' => :'String',
    :'plan' => :'PlanEnum',
    :'created_at' => :'Time',
    :'revoked' => :'Boolean',
    :'revoked_at' => :'Time',
    :'scopes' => :'Array<String>',
    :'name' => :'String',
    :'last_used' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 271

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      key_hash == o.key_hash &&
      plan == o.plan &&
      created_at == o.created_at &&
      revoked == o.revoked &&
      revoked_at == o.revoked_at &&
      scopes == o.scopes &&
      name == o.name &&
      last_used == o.last_used
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


287
288
289
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



293
294
295
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 293

def hash
  [id, key_hash, plan, created_at, revoked, revoked_at, scopes, name, last_used].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



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/mailsafepro/models/api_key_meta.rb', line 181

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

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

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

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

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 322

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



209
210
211
212
213
214
215
216
217
 
# File 'lib/mailsafepro/models/api_key_meta.rb', line 209

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @key_hash.nil?
  return false if @plan.nil?
  return false if @created_at.nil?
  return false if @revoked.nil?
  true
end