Class: LinodeOpenapiClient::PostClientRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/post_client_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostClientRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 101

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

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

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

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

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

  if attributes.key?(:'public')
    self.public = attributes[:'public']
  else
    self.public = false
  end

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

Instance Attribute Details

#id ⇒ Object

Read-only The OAuth Client ID. This is used to identify the client, and is a publicly-known value (it is not a secret).



22
23
24
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 22

def id
  @id
end

#label ⇒ Object

__Filterable__ The name of this application. This will be presented to users when they are asked to grant it access to their Account.



37
38
39
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 37

def label
  @label
end

#public ⇒ Object

__Filterable__ If this is a public or private OAuth Client. Public clients have a slightly different authentication workflow than private clients. See the [OAuth spec](oauth.net/2/) for more details.



34
35
36
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 34

def public
  @public
end

#redirect_uri ⇒ Object

The location a successful log in from [login.linode.com](login.linode.com) should be redirected to for this client. The receiver of this redirect should be ready to accept an OAuth exchange code and finish the OAuth exchange.



19
20
21
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 19

def redirect_uri
  @redirect_uri
end

#secret ⇒ Object

Read-only The OAuth Client secret, used in the OAuth exchange. This is returned as ‘<REDACTED>` except when an OAuth Client is created or its secret is reset. This is a secret, and should not be shared or disclosed publicly.



25
26
27
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 25

def secret
  @secret
end

#status ⇒ Object

Read-only The status of this application. ‘active` by default.



28
29
30
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 28

def status
  @status
end

#thumbnail_url ⇒ Object

Read-only The URL where this client’s thumbnail may be viewed, or ‘null` if this client does not have a thumbnail set.



31
32
33
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 31

def thumbnail_url
  @thumbnail_url
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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 267

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 = LinodeOpenapiClient.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



75
76
77
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 62

def self.attribute_map
  {
    :'redirect_uri' => :'redirect_uri',
    :'id' => :'id',
    :'secret' => :'secret',
    :'status' => :'status',
    :'thumbnail_url' => :'thumbnail_url',
    :'public' => :'public',
    :'label' => :'label'
  }
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 243

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



93
94
95
96
97
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 80

def self.openapi_types
  {
    :'redirect_uri' => :'String',
    :'id' => :'String',
    :'secret' => :'String',
    :'status' => :'String',
    :'thumbnail_url' => :'String',
    :'public' => :'Boolean',
    :'label' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 216

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      redirect_uri == o.redirect_uri &&
      id == o.id &&
      secret == o.secret &&
      status == o.status &&
      thumbnail_url == o.thumbnail_url &&
      public == o.public &&
      label == o.label
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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 338

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


230
231
232
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 236

def hash
  [redirect_uri, id, secret, status, thumbnail_url, public, label].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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 151

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

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

  if @label.to_s.length > 512
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 512.')
  end

  if @label.to_s.length < 1
    invalid_properties.push('invalid value for "label", the character length must be great than or equal to 1.')
  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



314
315
316
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 314

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 320

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



308
309
310
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 308

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



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/linode_openapi_client/models/post_client_request.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @redirect_uri.nil?
  status_validator = EnumAttributeValidator.new('String', ["active", "disabled", "suspended"])
  return false unless status_validator.valid?(@status)
  return false if @label.nil?
  return false if @label.to_s.length > 512
  return false if @label.to_s.length < 1
  true
end