Class: DocuSign_eSign::TemplateRecipients

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateRecipients

Initializes the object

Parameters:

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

    Model attributes in the form of hash


90
91
92
93
94
95
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
# File 'lib/docusign_esign/models/template_recipients.rb', line 90

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?(:'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

#agentsObject

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


18
19
20
# File 'lib/docusign_esign/models/template_recipients.rb', line 18

def agents
  @agents
end

#carbon_copiesObject

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


21
22
23
# File 'lib/docusign_esign/models/template_recipients.rb', line 21

def carbon_copies
  @carbon_copies
end

#certified_deliveriesObject

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.


24
25
26
# File 'lib/docusign_esign/models/template_recipients.rb', line 24

def certified_deliveries
  @certified_deliveries
end

#current_routing_orderObject

Returns the value of attribute current_routing_order


27
28
29
# File 'lib/docusign_esign/models/template_recipients.rb', line 27

def current_routing_order
  @current_routing_order
end

#editorsObject

Returns the value of attribute editors


30
31
32
# File 'lib/docusign_esign/models/template_recipients.rb', line 30

def editors
  @editors
end

#error_detailsObject

Returns the value of attribute error_details


32
33
34
# File 'lib/docusign_esign/models/template_recipients.rb', line 32

def error_details
  @error_details
end

#in_person_signersObject

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.


35
36
37
# File 'lib/docusign_esign/models/template_recipients.rb', line 35

def in_person_signers
  @in_person_signers
end

#intermediariesObject

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


38
39
40
# File 'lib/docusign_esign/models/template_recipients.rb', line 38

def intermediaries
  @intermediaries
end

#recipient_countObject

The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to *true*, the envelope time zone information is included in the message.


41
42
43
# File 'lib/docusign_esign/models/template_recipients.rb', line 41

def recipient_count
  @recipient_count
end

#sealsObject

Returns the value of attribute seals


44
45
46
# File 'lib/docusign_esign/models/template_recipients.rb', line 44

def seals
  @seals
end

#signersObject

A complex type containing information about the Signer recipient.


47
48
49
# File 'lib/docusign_esign/models/template_recipients.rb', line 47

def signers
  @signers
end

#witnessesObject

Returns the value of attribute witnesses


50
51
52
# File 'lib/docusign_esign/models/template_recipients.rb', line 50

def witnesses
  @witnesses
end

Class Method Details

.attribute_mapObject

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


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/docusign_esign/models/template_recipients.rb', line 53

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',
    :'recipient_count' => :'recipientCount',
    :'seals' => :'seals',
    :'signers' => :'signers',
    :'witnesses' => :'witnesses'
  }
end

.swagger_typesObject

Attribute type mapping.


71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/docusign_esign/models/template_recipients.rb', line 71

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>',
    :'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


178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/docusign_esign/models/template_recipients.rb', line 178

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


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/docusign_esign/models/template_recipients.rb', line 231

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


297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/docusign_esign/models/template_recipients.rb', line 297

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


210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/docusign_esign/models/template_recipients.rb', line 210

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

197
198
199
# File 'lib/docusign_esign/models/template_recipients.rb', line 197

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


203
204
205
# File 'lib/docusign_esign/models/template_recipients.rb', line 203

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

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


165
166
167
168
# File 'lib/docusign_esign/models/template_recipients.rb', line 165

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


277
278
279
# File 'lib/docusign_esign/models/template_recipients.rb', line 277

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


283
284
285
286
287
288
289
290
291
# File 'lib/docusign_esign/models/template_recipients.rb', line 283

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


271
272
273
# File 'lib/docusign_esign/models/template_recipients.rb', line 271

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


172
173
174
# File 'lib/docusign_esign/models/template_recipients.rb', line 172

def valid?
  true
end