Class: DigitalFemsa::ApiKeyCreateResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/digital_femsa/models/api_key_create_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiKeyCreateResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



111
112
113
114
115
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
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 111

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Indicates if the api key is active



19
20
21
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 19

def active
  @active
end

#authentication_token ⇒ Object

It is occupied as a user when authenticated with basic authentication, with a blank password. This value will only appear once, in the request to create a new key. Copy and save it in a safe place.



52
53
54
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 52

def authentication_token
  @authentication_token
end

#created_at ⇒ Object

Unix timestamp in seconds of when the api key was created



22
23
24
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 22

def created_at
  @created_at
end

#deactivated_at ⇒ Object

Unix timestamp in seconds of when the api key was deleted



28
29
30
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 28

def deactivated_at
  @deactivated_at
end

#deleted ⇒ Object

Indicates if the api key was deleted



40
41
42
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 40

def deleted
  @deleted
end

#description ⇒ Object

A name or brief explanation of what this api key is used for



31
32
33
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 31

def description
  @description
end

#id ⇒ Object

Unique identifier of the api key



34
35
36
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 34

def id
  @id
end

#livemode ⇒ Object

Indicates if the api key is in production



37
38
39
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 37

def livemode
  @livemode
end

#object ⇒ Object

Object name, value is ‘api_key’



43
44
45
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 43

def object
  @object
end

#prefix ⇒ Object

The first few characters of the authentication_token



46
47
48
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 46

def prefix
  @prefix
end

#role ⇒ Object

Indicates if the api key is private or public



49
50
51
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 49

def role
  @role
end

#updated_at ⇒ Object

Unix timestamp in seconds of when the api key was last updated



25
26
27
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 25

def updated_at
  @updated_at
end

Class Method Details

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



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
279
280
281
282
283
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 246

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = DigitalFemsa.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 55

def self.attribute_map
  {
    :'active' => :'active',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'deactivated_at' => :'deactivated_at',
    :'description' => :'description',
    :'id' => :'id',
    :'livemode' => :'livemode',
    :'deleted' => :'deleted',
    :'object' => :'object',
    :'prefix' => :'prefix',
    :'role' => :'role',
    :'authentication_token' => :'authentication_token'
  }
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
238
239
240
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 222

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



103
104
105
106
107
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 103

def self.openapi_all_of
  [
  :'ApiKeyResponse'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
100
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 96

def self.openapi_nullable
  Set.new([
    :'deactivated_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 78

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'created_at' => :'Integer',
    :'updated_at' => :'Integer',
    :'deactivated_at' => :'Integer',
    :'description' => :'String',
    :'id' => :'String',
    :'livemode' => :'Boolean',
    :'deleted' => :'Boolean',
    :'object' => :'String',
    :'prefix' => :'String',
    :'role' => :'String',
    :'authentication_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      deactivated_at == o.deactivated_at &&
      description == o.description &&
      id == o.id &&
      livemode == o.livemode &&
      deleted == o.deleted &&
      object == o.object &&
      prefix == o.prefix &&
      role == o.role &&
      authentication_token == o.authentication_token
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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 317

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


209
210
211
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 209

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



215
216
217
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 215

def hash
  [active, created_at, updated_at, deactivated_at, description, id, livemode, deleted, object, prefix, role, authentication_token].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



175
176
177
178
179
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 175

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



293
294
295
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 293

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 299

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



287
288
289
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 287

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



183
184
185
186
 
# File 'lib/digital_femsa/models/api_key_create_response.rb', line 183

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end