Class: Dropbox::Sign::OAuthTokenGenerateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/dropbox-sign/models/o_auth_token_generate_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuthTokenGenerateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::OAuthTokenGenerateRequest` 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 (!self.class.merged_attributes.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::OAuthTokenGenerateRequest`. 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?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

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

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

  if attributes.key?(:'grant_type')
    self.grant_type = attributes[:'grant_type']
  else
    self.grant_type = 'authorization_code'
  end

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

Instance Attribute Details

#client_id ⇒ String

The client id of the app requesting authorization.

Returns:

  • (String) 


23
24
25
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 23

def client_id
  @client_id
end

#client_secret ⇒ String

The secret token of your app.

Returns:

  • (String) 


27
28
29
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 27

def client_secret
  @client_secret
end

#code ⇒ String

The code passed to your callback when the user granted access.

Returns:

  • (String) 


31
32
33
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 31

def code
  @code
end

#grant_type ⇒ String

When generating a new token use ‘authorization_code`.

Returns:

  • (String) 


35
36
37
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 35

def grant_type
  @grant_type
end

#state ⇒ String

Same as the state you specified earlier.

Returns:

  • (String) 


39
40
41
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 39

def state
  @state
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



53
54
55
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 53

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 58

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 42

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'client_secret' => :'client_secret',
    :'code' => :'code',
    :'grant_type' => :'grant_type',
    :'state' => :'state'
  }
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



258
259
260
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 258

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

.init(data) ⇒ OAuthTokenGenerateRequest

Attempt to instantiate and hydrate a new instance of this class

Parameters:

  • data (Object) —

    Data to be converted

Returns:



97
98
99
100
101
102
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 97

def self.init(data)
  ApiClient.default.convert_to_type(
    data,
    "OAuthTokenGenerateRequest"
  ) || OAuthTokenGenerateRequest.new
end

.merged_attributes ⇒ Object

Returns attribute map of this model + parent



80
81
82
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 80

def self.merged_attributes
  self.attribute_map
end

.merged_nullable ⇒ Object

Returns list of attributes with nullable: true of this model + parent



90
91
92
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 90

def self.merged_nullable
  self.openapi_nullable
end

.merged_types ⇒ Object

Attribute type mapping of this model + parent



85
86
87
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 85

def self.merged_types
  self.openapi_types
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
77
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 74

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 63

def self.openapi_types
  {
    :'client_id' => :'String',
    :'client_secret' => :'String',
    :'code' => :'String',
    :'grant_type' => :'String',
    :'state' => :'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
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      client_secret == o.client_secret &&
      code == o.code &&
      grant_type == o.grant_type &&
      state == o.state
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



288
289
290
291
292
293
294
295
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
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 288

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
    klass = Dropbox::Sign.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

#_to_hash(value, include_nil = true) ⇒ 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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 359

def _to_hash(value, include_nil = true)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v, include_nil) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(include_nil)
  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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 265

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attribute_map = self.class.merged_attributes

  self.class.merged_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 251

def hash
  [client_id, client_secret, code, grant_type, state].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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 145

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

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

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

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

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



334
335
336
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 334

def to_body
  to_hash
end

#to_hash(include_nil = true) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 340

def to_hash(include_nil = true)
  hash = {}
  self.class.merged_attributes.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      next unless include_nil
      is_nullable = self.class.merged_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value, include_nil)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



328
329
330
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 328

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



172
173
174
175
176
177
178
179
 
# File 'lib/dropbox-sign/models/o_auth_token_generate_request.rb', line 172

def valid?
  return false if @client_id.nil?
  return false if @client_secret.nil?
  return false if @code.nil?
  return false if @grant_type.nil?
  return false if @state.nil?
  true
end