Class: DocuSign_eSign::OAuth::Link

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/client/auth/oauth.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Link

Initializes the object

Parameters:

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

    Model attributes in the form of hash


259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'lib/docusign_esign/client/auth/oauth.rb', line 259

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'rel')
    self.rel = attributes[:'rel']
  end

  if attributes.has_key?(:'href')
    self.href = attributes[:'href']
  end
end

Instance Attribute Details

#hrefObject

Link href


239
240
241
# File 'lib/docusign_esign/client/auth/oauth.rb', line 239

def href
  @href
end

#relObject

Link rel


236
237
238
# File 'lib/docusign_esign/client/auth/oauth.rb', line 236

def rel
  @rel
end

Class Method Details

.attribute_mapObject

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


242
243
244
245
246
247
# File 'lib/docusign_esign/client/auth/oauth.rb', line 242

def self.attribute_map
  {
      :'rel' => :'rel',
      :'href' => :'href'
  }
end

.swagger_typesObject

Attribute type mapping.


250
251
252
253
254
255
# File 'lib/docusign_esign/client/auth/oauth.rb', line 250

def self.swagger_types
  {
      :'rel' => :'String',
      :'href' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


289
290
291
292
293
294
# File 'lib/docusign_esign/client/auth/oauth.rb', line 289

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      rel == o.rel &&
      href == o.href
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


332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
# File 'lib/docusign_esign/client/auth/oauth.rb', line 332

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
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.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


398
399
400
401
402
403
404
405
406
407
408
409
410
# File 'lib/docusign_esign/client/auth/oauth.rb', line 398

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


311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/docusign_esign/client/auth/oauth.rb', line 311

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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

298
299
300
# File 'lib/docusign_esign/client/auth/oauth.rb', line 298

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


304
305
306
# File 'lib/docusign_esign/client/auth/oauth.rb', line 304

def hash
  [rel, href].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons


276
277
278
279
# File 'lib/docusign_esign/client/auth/oauth.rb', line 276

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


378
379
380
# File 'lib/docusign_esign/client/auth/oauth.rb', line 378

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


384
385
386
387
388
389
390
391
392
# File 'lib/docusign_esign/client/auth/oauth.rb', line 384

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


372
373
374
# File 'lib/docusign_esign/client/auth/oauth.rb', line 372

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


283
284
285
# File 'lib/docusign_esign/client/auth/oauth.rb', line 283

def valid?
  return true
end