Class: DocuSign_WebForms::OAuth::OAuthToken

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuthToken

Initializes the object

Parameters:

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

    Model attributes in the form of hash



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 457

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?(:'accessToken')
    self.access_token = attributes[:'accessToken']
  end

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

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

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

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

  if attributes.has_key?(:'data')
    if (value = attributes[:'data']).is_a?(Array)
      self.data = value
    end
  end
end

Instance Attribute Details

#access_token ⇒ Object

The account ID.



414
415
416
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 414

def access_token
  @access_token
end

#data ⇒ Object

Returns the value of attribute data.



417
418
419
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 417

def data
  @data
end

#expires_in ⇒ Object

Returns the value of attribute expires_in.



420
421
422
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 420

def expires_in
  @expires_in
end

#refresh_token ⇒ Object

Reserved: TBD



423
424
425
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 423

def refresh_token
  @refresh_token
end

#scope ⇒ Object

Reserved: TBD



426
427
428
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 426

def scope
  @scope
end

#token_type ⇒ Object

Reserved: TBD



429
430
431
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 429

def token_type
  @token_type
end

Class Method Details

.attribute_map ⇒ Object

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



432
433
434
435
436
437
438
439
440
441
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 432

def self.attribute_map
  {
      :'access_token' => :'access_token',
      :'data' => :'data',
      :'expires_in' => :'expires_in',
      :'refresh_token' => :'refresh_token',
      :'scope' => :'scope',
      :'token_type' => :'token_type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



444
445
446
447
448
449
450
451
452
453
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 444

def self.swagger_types
  {
      :'access_token' => :'String',
      :'expires_in' => :'String',
      :'refresh_token' => :'String',
      :'scope' => :'String',
      :'data' => :'Array<NameValue>',
      :'token_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



505
506
507
508
509
510
511
512
513
514
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 505

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_token == o.access_token &&
      data == o.data &&
      expires_in == o.expires_in &&
      refresh_token == o.refresh_token &&
      token_type == o.token_type &&
      scope == o.scope
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



552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 552

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



618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 618

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



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 531

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


518
519
520
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 518

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



524
525
526
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 524

def hash
  [expires_in, data, access_token, refresh_token, scope, token_type].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



492
493
494
495
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 492

def list_invalid_properties
  invalid_properties = Array.new
  return 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



598
599
600
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 598

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



604
605
606
607
608
609
610
611
612
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 604

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



592
593
594
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 592

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



499
500
501
 
# File 'lib/docusign_webforms/client/auth/oauth.rb', line 499

def valid?
  return true
end