Class: DocuSign_eSign::Recipients

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

Overview

Specifies the envelope recipients.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Recipients

Initializes the object

Parameters:

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

    Model attributes in the form of hash



96
97
98
99
100
101
102
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/docusign_esign/models/recipients.rb', line 96

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?(:'agents')
    if (value = attributes[:'agents']).is_a?(Array)
      self.agents = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#agents ⇒ Object

A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.



19
20
21
 
# File 'lib/docusign_esign/models/recipients.rb', line 19

def agents
  @agents
end

#carbon_copies ⇒ Object

A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.



22
23
24
 
# File 'lib/docusign_esign/models/recipients.rb', line 22

def carbon_copies
  @carbon_copies
end

#certified_deliveries ⇒ Object

A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.



25
26
27
 
# File 'lib/docusign_esign/models/recipients.rb', line 25

def certified_deliveries
  @certified_deliveries
end

#current_routing_order ⇒ Object

Returns the value of attribute current_routing_order.



28
29
30
 
# File 'lib/docusign_esign/models/recipients.rb', line 28

def current_routing_order
  @current_routing_order
end

#editors ⇒ Object

A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.



31
32
33
 
# File 'lib/docusign_esign/models/recipients.rb', line 31

def editors
  @editors
end

#error_details ⇒ Object

Returns the value of attribute error_details.



33
34
35
 
# File 'lib/docusign_esign/models/recipients.rb', line 33

def error_details
  @error_details
end

#in_person_signers ⇒ Object

Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.



36
37
38
 
# File 'lib/docusign_esign/models/recipients.rb', line 36

def in_person_signers
  @in_person_signers
end

#intermediaries ⇒ Object

Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).



39
40
41
 
# File 'lib/docusign_esign/models/recipients.rb', line 39

def intermediaries
  @intermediaries
end

#notaries ⇒ Object

Returns the value of attribute notaries.



42
43
44
 
# File 'lib/docusign_esign/models/recipients.rb', line 42

def notaries
  @notaries
end

#recipient_count ⇒ Object

Returns the value of attribute recipient_count.



45
46
47
 
# File 'lib/docusign_esign/models/recipients.rb', line 45

def recipient_count
  @recipient_count
end

#seals ⇒ Object

Returns the value of attribute seals.



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

def seals
  @seals
end

#signers ⇒ Object

A complex type containing information about the Signer recipient.



51
52
53
 
# File 'lib/docusign_esign/models/recipients.rb', line 51

def signers
  @signers
end

#witnesses ⇒ Object

Returns the value of attribute witnesses.



54
55
56
 
# File 'lib/docusign_esign/models/recipients.rb', line 54

def witnesses
  @witnesses
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/docusign_esign/models/recipients.rb', line 57

def self.attribute_map
  {
    :'agents' => :'agents',
    :'carbon_copies' => :'carbonCopies',
    :'certified_deliveries' => :'certifiedDeliveries',
    :'current_routing_order' => :'currentRoutingOrder',
    :'editors' => :'editors',
    :'error_details' => :'errorDetails',
    :'in_person_signers' => :'inPersonSigners',
    :'intermediaries' => :'intermediaries',
    :'notaries' => :'notaries',
    :'recipient_count' => :'recipientCount',
    :'seals' => :'seals',
    :'signers' => :'signers',
    :'witnesses' => :'witnesses'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/docusign_esign/models/recipients.rb', line 76

def self.swagger_types
  {
    :'agents' => :'Array<Agent>',
    :'carbon_copies' => :'Array<CarbonCopy>',
    :'certified_deliveries' => :'Array<CertifiedDelivery>',
    :'current_routing_order' => :'String',
    :'editors' => :'Array<Editor>',
    :'error_details' => :'ErrorDetails',
    :'in_person_signers' => :'Array<InPersonSigner>',
    :'intermediaries' => :'Array<Intermediary>',
    :'notaries' => :'Array<NotaryRecipient>',
    :'recipient_count' => :'String',
    :'seals' => :'Array<SealSign>',
    :'signers' => :'Array<Signer>',
    :'witnesses' => :'Array<Witness>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/docusign_esign/models/recipients.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      agents == o.agents &&
      carbon_copies == o.carbon_copies &&
      certified_deliveries == o.certified_deliveries &&
      current_routing_order == o.current_routing_order &&
      editors == o.editors &&
      error_details == o.error_details &&
      in_person_signers == o.in_person_signers &&
      intermediaries == o.intermediaries &&
      notaries == o.notaries &&
      recipient_count == o.recipient_count &&
      seals == o.seals &&
      signers == o.signers &&
      witnesses == o.witnesses
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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/docusign_esign/models/recipients.rb', line 244

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/docusign_esign/models/recipients.rb', line 310

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/docusign_esign/models/recipients.rb', line 223

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


210
211
212
 
# File 'lib/docusign_esign/models/recipients.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/docusign_esign/models/recipients.rb', line 216

def hash
  [agents, carbon_copies, certified_deliveries, current_routing_order, editors, error_details, in_person_signers, intermediaries, notaries, recipient_count, seals, signers, witnesses].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



177
178
179
180
 
# File 'lib/docusign_esign/models/recipients.rb', line 177

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



290
291
292
 
# File 'lib/docusign_esign/models/recipients.rb', line 290

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



296
297
298
299
300
301
302
303
304
 
# File 'lib/docusign_esign/models/recipients.rb', line 296

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



284
285
286
 
# File 'lib/docusign_esign/models/recipients.rb', line 284

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



184
185
186
 
# File 'lib/docusign_esign/models/recipients.rb', line 184

def valid?
  true
end