Class: TalonOne::ManagementKey

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/management_key.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementKey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
127
128
129
130
131
132
133
134
 
# File 'lib/talon_one/models/management_key.rb', line 82

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

ID of account the key is used for.



36
37
38
 
# File 'lib/talon_one/models/management_key.rb', line 36

def 
  @account_id
end

#allowed_application_ids ⇒ Object

A list of Application IDs that you can access with the management key. An empty or missing list means the management key can be used for all Applications in the account.



27
28
29
 
# File 'lib/talon_one/models/management_key.rb', line 27

def allowed_application_ids
  @allowed_application_ids
end

#created ⇒ Object

The date the management key was created.



39
40
41
 
# File 'lib/talon_one/models/management_key.rb', line 39

def created
  @created
end

#created_by ⇒ Object

ID of the user who created it.



33
34
35
 
# File 'lib/talon_one/models/management_key.rb', line 33

def created_by
  @created_by
end

#disabled ⇒ Object

The management key is disabled (this property is set to ‘true`) when the user who created the key is disabled or deleted.



42
43
44
 
# File 'lib/talon_one/models/management_key.rb', line 42

def disabled
  @disabled
end

#endpoints ⇒ Object

The list of endpoints that can be accessed with the key



24
25
26
 
# File 'lib/talon_one/models/management_key.rb', line 24

def endpoints
  @endpoints
end

#expiry_date ⇒ Object

The date the management key expires.



21
22
23
 
# File 'lib/talon_one/models/management_key.rb', line 21

def expiry_date
  @expiry_date
end

#id ⇒ Object

ID of the management key.



30
31
32
 
# File 'lib/talon_one/models/management_key.rb', line 30

def id
  @id
end

#name ⇒ Object

Name for management key.



18
19
20
 
# File 'lib/talon_one/models/management_key.rb', line 18

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/talon_one/models/management_key.rb', line 45

def self.attribute_map
  {
    :'name' => :'name',
    :'expiry_date' => :'expiryDate',
    :'endpoints' => :'endpoints',
    :'allowed_application_ids' => :'allowedApplicationIds',
    :'id' => :'id',
    :'created_by' => :'createdBy',
    :'account_id' => :'accountID',
    :'created' => :'created',
    :'disabled' => :'disabled'
  }
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



215
216
217
 
# File 'lib/talon_one/models/management_key.rb', line 215

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
 
# File 'lib/talon_one/models/management_key.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/talon_one/models/management_key.rb', line 60

def self.openapi_types
  {
    :'name' => :'String',
    :'expiry_date' => :'DateTime',
    :'endpoints' => :'Array<Endpoint>',
    :'allowed_application_ids' => :'Array<Integer>',
    :'id' => :'Integer',
    :'created_by' => :'Integer',
    :'account_id' => :'Integer',
    :'created' => :'DateTime',
    :'disabled' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/talon_one/models/management_key.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      expiry_date == o.expiry_date &&
      endpoints == o.endpoints &&
      allowed_application_ids == o.allowed_application_ids &&
      id == o.id &&
      created_by == o.created_by &&
       == o. &&
      created == o.created &&
      disabled == o.disabled
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/talon_one/models/management_key.rb', line 243

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
    TalonOne.const_get(type).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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/talon_one/models/management_key.rb', line 312

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/talon_one/models/management_key.rb', line 222

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


202
203
204
 
# File 'lib/talon_one/models/management_key.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



208
209
210
 
# File 'lib/talon_one/models/management_key.rb', line 208

def hash
  [name, expiry_date, endpoints, allowed_application_ids, id, created_by, , created, disabled].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



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
 
# File 'lib/talon_one/models/management_key.rb', line 138

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

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

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

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

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

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

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



288
289
290
 
# File 'lib/talon_one/models/management_key.rb', line 288

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/talon_one/models/management_key.rb', line 294

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



282
283
284
 
# File 'lib/talon_one/models/management_key.rb', line 282

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



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/talon_one/models/management_key.rb', line 173

def valid?
  return false if @name.nil?
  return false if @expiry_date.nil?
  return false if @endpoints.nil?
  return false if @id.nil?
  return false if @created_by.nil?
  return false if @account_id.nil?
  return false if @created.nil?
  true
end