Class: DocuSign_eSign::TemplateRole

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

Overview

Information about a specific role.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateRole

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/docusign_esign/models/template_role.rb', line 111

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

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

  if attributes.has_key?(:'clientUserId')
    self.client_user_id = attributes[:'clientUserId']
  end

  if attributes.has_key?(:'defaultRecipient')
    self.default_recipient = attributes[:'defaultRecipient']
  end

  if attributes.has_key?(:'deliveryMethod')
    self.delivery_method = attributes[:'deliveryMethod']
  end

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

  if attributes.has_key?(:'emailNotification')
    self.email_notification = attributes[:'emailNotification']
  end

  if attributes.has_key?(:'embeddedRecipientStartURL')
    self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
  end

  if attributes.has_key?(:'inPersonSignerName')
    self.in_person_signer_name = attributes[:'inPersonSignerName']
  end

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

  if attributes.has_key?(:'phoneNumber')
    self.phone_number = attributes[:'phoneNumber']
  end

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

  if attributes.has_key?(:'roleName')
    self.role_name = attributes[:'roleName']
  end

  if attributes.has_key?(:'routingOrder')
    self.routing_order = attributes[:'routingOrder']
  end

  if attributes.has_key?(:'signingGroupId')
    self.signing_group_id = attributes[:'signingGroupId']
  end

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

Instance Attribute Details

#access_code ⇒ Object

If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer ‘accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.



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

def access_code
  @access_code
end

#additional_notifications ⇒ Object

Returns the value of attribute additional_notifications.



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

def additional_notifications
  @additional_notifications
end

#client_user_id ⇒ Object

Specifies whether the recipient is embedded or remote. If the ‘clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters.



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

def client_user_id
  @client_user_id
end

#default_recipient ⇒ Object

When set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.



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

def default_recipient
  @default_recipient
end

#delivery_method ⇒ Object

Reserved: For DocuSign use only.



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

def delivery_method
  @delivery_method
end

#email ⇒ Object

Specifies the email associated with a role name.



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

def email
  @email
end

#email_notification ⇒ Object

A complex type that contains information sets the language of the recipient’s email information. IMPORTANT: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and ‘EmailBlurb` property settings.



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

def email_notification
  @email_notification
end

#embedded_recipient_start_url ⇒ Object

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to ‘SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets ‘EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[]`



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

def embedded_recipient_start_url
  @embedded_recipient_start_url
end

#in_person_signer_name ⇒ Object

Specifies the full legal name of the signer in person signer template roles. Maximum Length: 100 characters.



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

def in_person_signer_name
  @in_person_signer_name
end

#name ⇒ Object

Specifies the recipient’s name.



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

def name
  @name
end

#phone_number ⇒ Object

Describes the recipient phone number.



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

def phone_number
  @phone_number
end

#recipient_signature_providers ⇒ Object

Returns the value of attribute recipient_signature_providers.



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

def recipient_signature_providers
  @recipient_signature_providers
end

#role_name ⇒ Object

Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.



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

def role_name
  @role_name
end

#routing_order ⇒ Object

Specifies the routing order of the recipient in the envelope.



57
58
59
 
# File 'lib/docusign_esign/models/template_role.rb', line 57

def routing_order
  @routing_order
end

#signing_group_id ⇒ Object

When set to true and the feature is enabled in the sender’s account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).



60
61
62
 
# File 'lib/docusign_esign/models/template_role.rb', line 60

def signing_group_id
  @signing_group_id
end

#tabs ⇒ Object

A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.



63
64
65
 
# File 'lib/docusign_esign/models/template_role.rb', line 63

def tabs
  @tabs
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/docusign_esign/models/template_role.rb', line 66

def self.attribute_map
  {
    :'access_code' => :'accessCode',
    :'additional_notifications' => :'additionalNotifications',
    :'client_user_id' => :'clientUserId',
    :'default_recipient' => :'defaultRecipient',
    :'delivery_method' => :'deliveryMethod',
    :'email' => :'email',
    :'email_notification' => :'emailNotification',
    :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
    :'in_person_signer_name' => :'inPersonSignerName',
    :'name' => :'name',
    :'phone_number' => :'phoneNumber',
    :'recipient_signature_providers' => :'recipientSignatureProviders',
    :'role_name' => :'roleName',
    :'routing_order' => :'routingOrder',
    :'signing_group_id' => :'signingGroupId',
    :'tabs' => :'tabs'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/docusign_esign/models/template_role.rb', line 88

def self.swagger_types
  {
    :'access_code' => :'String',
    :'additional_notifications' => :'Array<RecipientAdditionalNotification>',
    :'client_user_id' => :'String',
    :'default_recipient' => :'String',
    :'delivery_method' => :'String',
    :'email' => :'String',
    :'email_notification' => :'RecipientEmailNotification',
    :'embedded_recipient_start_url' => :'String',
    :'in_person_signer_name' => :'String',
    :'name' => :'String',
    :'phone_number' => :'RecipientPhoneNumber',
    :'recipient_signature_providers' => :'Array<RecipientSignatureProvider>',
    :'role_name' => :'String',
    :'routing_order' => :'String',
    :'signing_group_id' => :'String',
    :'tabs' => :'Tabs'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/docusign_esign/models/template_role.rb', line 201

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_code == o.access_code &&
      additional_notifications == o.additional_notifications &&
      client_user_id == o.client_user_id &&
      default_recipient == o.default_recipient &&
      delivery_method == o.delivery_method &&
      email == o.email &&
      email_notification == o.email_notification &&
      embedded_recipient_start_url == o.embedded_recipient_start_url &&
      in_person_signer_name == o.in_person_signer_name &&
      name == o.name &&
      phone_number == o.phone_number &&
      recipient_signature_providers == o.recipient_signature_providers &&
      role_name == o.role_name &&
      routing_order == o.routing_order &&
      signing_group_id == o.signing_group_id &&
      tabs == o.tabs
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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/docusign_esign/models/template_role.rb', line 258

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/docusign_esign/models/template_role.rb', line 324

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/docusign_esign/models/template_role.rb', line 237

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


224
225
226
 
# File 'lib/docusign_esign/models/template_role.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



230
231
232
 
# File 'lib/docusign_esign/models/template_role.rb', line 230

def hash
  [access_code, additional_notifications, client_user_id, default_recipient, delivery_method, email, email_notification, embedded_recipient_start_url, in_person_signer_name, name, phone_number, recipient_signature_providers, role_name, routing_order, signing_group_id, tabs].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



188
189
190
191
 
# File 'lib/docusign_esign/models/template_role.rb', line 188

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



304
305
306
 
# File 'lib/docusign_esign/models/template_role.rb', line 304

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



310
311
312
313
314
315
316
317
318
 
# File 'lib/docusign_esign/models/template_role.rb', line 310

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



298
299
300
 
# File 'lib/docusign_esign/models/template_role.rb', line 298

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



195
196
197
 
# File 'lib/docusign_esign/models/template_role.rb', line 195

def valid?
  true
end