Class: DocuSign_eSign::OAuth::Organization

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 661

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

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

Instance Attribute Details

The name of the current account.



641
642
643
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 641

def links
  @links
end

#organization_id ⇒ Object

The account ID.



638
639
640
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 638

def organization_id
  @organization_id
end

Class Method Details

.attribute_map ⇒ Object

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



644
645
646
647
648
649
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 644

def self.attribute_map
  {
      :'organization_id' => :'organization_id',
      :'links' => :'links'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



652
653
654
655
656
657
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 652

def self.swagger_types
  {
      :'organization_id' => :'String',
      :'links' => :'Array<OAuth::Link>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



693
694
695
696
697
698
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 693

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



736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 736

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



802
803
804
805
806
807
808
809
810
811
812
813
814
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 802

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



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 715

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


702
703
704
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 702

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



708
709
710
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 708

def hash
  [links, organization_id].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



680
681
682
683
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 680

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



782
783
784
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 782

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



788
789
790
791
792
793
794
795
796
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 788

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



776
777
778
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 776

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



687
688
689
 
# File 'lib/docusign_esign/client/auth/oauth.rb', line 687

def valid?
  return true
end