Class: DocuSign_eSign::OAuth::OAuthToken

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 = {}) ⇒ OAuthToken

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
489
490
# File 'lib/docusign_esign/client/auth/oauth.rb', line 459

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_tokenObject

The account ID.


416
417
418
# File 'lib/docusign_esign/client/auth/oauth.rb', line 416

def access_token
  @access_token
end

#dataObject

Returns the value of attribute data


419
420
421
# File 'lib/docusign_esign/client/auth/oauth.rb', line 419

def data
  @data
end

#expires_inObject

Returns the value of attribute expires_in


422
423
424
# File 'lib/docusign_esign/client/auth/oauth.rb', line 422

def expires_in
  @expires_in
end

#refresh_tokenObject

Reserved: TBD


425
426
427
# File 'lib/docusign_esign/client/auth/oauth.rb', line 425

def refresh_token
  @refresh_token
end

#scopeObject

Reserved: TBD


428
429
430
# File 'lib/docusign_esign/client/auth/oauth.rb', line 428

def scope
  @scope
end

#token_typeObject

Reserved: TBD


431
432
433
# File 'lib/docusign_esign/client/auth/oauth.rb', line 431

def token_type
  @token_type
end

Class Method Details

.attribute_mapObject

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


434
435
436
437
438
439
440
441
442
443
# File 'lib/docusign_esign/client/auth/oauth.rb', line 434

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_typesObject

Attribute type mapping.


446
447
448
449
450
451
452
453
454
455
# File 'lib/docusign_esign/client/auth/oauth.rb', line 446

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


507
508
509
510
511
512
513
514
515
516
# File 'lib/docusign_esign/client/auth/oauth.rb', line 507

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


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
589
590
# File 'lib/docusign_esign/client/auth/oauth.rb', line 554

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


620
621
622
623
624
625
626
627
628
629
630
631
632
# File 'lib/docusign_esign/client/auth/oauth.rb', line 620

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


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

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

520
521
522
# File 'lib/docusign_esign/client/auth/oauth.rb', line 520

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


526
527
528
# File 'lib/docusign_esign/client/auth/oauth.rb', line 526

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

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons


494
495
496
497
# File 'lib/docusign_esign/client/auth/oauth.rb', line 494

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


600
601
602
# File 'lib/docusign_esign/client/auth/oauth.rb', line 600

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


606
607
608
609
610
611
612
613
614
# File 'lib/docusign_esign/client/auth/oauth.rb', line 606

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


594
595
596
# File 'lib/docusign_esign/client/auth/oauth.rb', line 594

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


501
502
503
# File 'lib/docusign_esign/client/auth/oauth.rb', line 501

def valid?
  return true
end