Class: Fastly::TokenCreatedResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/token_created_response.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TokenCreatedResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/fastly/models/token_created_response.rb', line 136

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

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

  if attributes.key?(:'scope')
    self.scope = attributes[:'scope']
  else
    self.scope = 'global'
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_token ⇒ Object

The alphanumeric string for accessing the API (only available on token creation).



51
52
53
 
# File 'lib/fastly/models/token_created_response.rb', line 51

def access_token
  @access_token
end

#created_at ⇒ Object

Time-stamp (UTC) of when the token was created.



26
27
28
 
# File 'lib/fastly/models/token_created_response.rb', line 26

def created_at
  @created_at
end

#deleted_at ⇒ Object

Date and time in ISO 8601 format.



29
30
31
 
# File 'lib/fastly/models/token_created_response.rb', line 29

def deleted_at
  @deleted_at
end

#expires_at ⇒ Object

Time-stamp (UTC) of when the token will expire (optional).



42
43
44
 
# File 'lib/fastly/models/token_created_response.rb', line 42

def expires_at
  @expires_at
end

#id ⇒ Object

Returns the value of attribute id.



34
35
36
 
# File 'lib/fastly/models/token_created_response.rb', line 34

def id
  @id
end

#ip ⇒ Object

IP Address of the client that last used the token.



45
46
47
 
# File 'lib/fastly/models/token_created_response.rb', line 45

def ip
  @ip
end

#last_used_at ⇒ Object

Time-stamp (UTC) of when the token was last used.



39
40
41
 
# File 'lib/fastly/models/token_created_response.rb', line 39

def last_used_at
  @last_used_at
end

#name ⇒ Object

Name of the token.



20
21
22
 
# File 'lib/fastly/models/token_created_response.rb', line 20

def name
  @name
end

#scope ⇒ Object

Space-delimited list of authorization scope.



23
24
25
 
# File 'lib/fastly/models/token_created_response.rb', line 23

def scope
  @scope
end

#services ⇒ Object

List of alphanumeric strings identifying services (optional). If no services are specified, the token will have access to all services on the account.



17
18
19
 
# File 'lib/fastly/models/token_created_response.rb', line 17

def services
  @services
end

#updated_at ⇒ Object

Date and time in ISO 8601 format.



32
33
34
 
# File 'lib/fastly/models/token_created_response.rb', line 32

def updated_at
  @updated_at
end

#user_agent ⇒ Object

User-Agent header of the client that last used the token.



48
49
50
 
# File 'lib/fastly/models/token_created_response.rb', line 48

def user_agent
  @user_agent
end

#user_id ⇒ Object

Returns the value of attribute user_id.



36
37
38
 
# File 'lib/fastly/models/token_created_response.rb', line 36

def user_id
  @user_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/fastly/models/token_created_response.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/fastly/models/token_created_response.rb', line 76

def self.attribute_map
  {
    :'services' => :'services',
    :'name' => :'name',
    :'scope' => :'scope',
    :'created_at' => :'created_at',
    :'deleted_at' => :'deleted_at',
    :'updated_at' => :'updated_at',
    :'id' => :'id',
    :'user_id' => :'user_id',
    :'last_used_at' => :'last_used_at',
    :'expires_at' => :'expires_at',
    :'ip' => :'ip',
    :'user_agent' => :'user_agent',
    :'access_token' => :'access_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



266
267
268
 
# File 'lib/fastly/models/token_created_response.rb', line 266

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

.fastly_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



127
128
129
130
131
132
 
# File 'lib/fastly/models/token_created_response.rb', line 127

def self.fastly_all_of
  [
  :'TokenCreatedResponseAllOf',
  :'TokenResponse'
  ]
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
123
124
 
# File 'lib/fastly/models/token_created_response.rb', line 119

def self.fastly_nullable
  Set.new([
    :'deleted_at',
    :'updated_at',
  ])
end

.fastly_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/fastly/models/token_created_response.rb', line 100

def self.fastly_types
  {
    :'services' => :'Array<String>',
    :'name' => :'String',
    :'scope' => :'String',
    :'created_at' => :'String',
    :'deleted_at' => :'Time',
    :'updated_at' => :'Time',
    :'id' => :'String',
    :'user_id' => :'String',
    :'last_used_at' => :'String',
    :'expires_at' => :'String',
    :'ip' => :'String',
    :'user_agent' => :'String',
    :'access_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/fastly/models/token_created_response.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      services == o.services &&
      name == o.name &&
      scope == o.scope &&
      created_at == o.created_at &&
      deleted_at == o.deleted_at &&
      updated_at == o.updated_at &&
      id == o.id &&
      user_id == o.user_id &&
      last_used_at == o.last_used_at &&
      expires_at == o.expires_at &&
      ip == o.ip &&
      user_agent == o.user_agent &&
      access_token == o.access_token
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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/fastly/models/token_created_response.rb', line 296

def _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 = Fastly.const_get(type)
    klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/fastly/models/token_created_response.rb', line 367

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/fastly/models/token_created_response.rb', line 273

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


253
254
255
 
# File 'lib/fastly/models/token_created_response.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/fastly/models/token_created_response.rb', line 259

def hash
  [services, name, scope, created_at, deleted_at, updated_at, id, user_id, last_used_at, expires_at, ip, user_agent, access_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



208
209
210
211
 
# File 'lib/fastly/models/token_created_response.rb', line 208

def list_invalid_properties
  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



343
344
345
 
# File 'lib/fastly/models/token_created_response.rb', line 343

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/fastly/models/token_created_response.rb', line 349

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_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



337
338
339
 
# File 'lib/fastly/models/token_created_response.rb', line 337

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



215
216
217
218
219
 
# File 'lib/fastly/models/token_created_response.rb', line 215

def valid?
  scope_validator = EnumAttributeValidator.new('String', ["global", "purge_select", "purge_all", "global:read"])
  return false unless scope_validator.valid?(@scope)
  true
end