Class: DocuSign_eSign::BulkRecipientsUpdateResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/bulk_recipients_update_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkRecipientsUpdateResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash


35
36
37
38
39
40
41
42
43
44
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 35

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

Instance Attribute Details

#signerObject

Returns the value of attribute signer


17
18
19
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 17

def signer
  @signer
end

Class Method Details

.attribute_mapObject

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


20
21
22
23
24
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 20

def self.attribute_map
  {
    :'signer' => :'signer'
  }
end

.swagger_typesObject

Attribute type mapping.


27
28
29
30
31
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 27

def self.swagger_types
  {
    :'signer' => :'Signer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


61
62
63
64
65
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 61

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


103
104
105
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
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 103

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


169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 169

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


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 82

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

69
70
71
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 69

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


75
76
77
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 75

def hash
  [signer].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


48
49
50
51
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 48

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


149
150
151
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 149

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


155
156
157
158
159
160
161
162
163
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 155

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


143
144
145
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 143

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


55
56
57
# File 'lib/docusign_esign/models/bulk_recipients_update_response.rb', line 55

def valid?
  true
end