Class: DocuSign_eSign::BulkSendingCopyRecipient

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkSendingCopyRecipient

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
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/bulk_sending_copy_recipient.rb', line 127

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'recipientId')
    self.recipient_id = attributes[:'recipientId']
  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?(:'smsAuthentication')
    self.sms_authentication = attributes[:'smsAuthentication']
  end

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

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

Instance Attribute Details

#access_codeObject

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/bulk_sending_copy_recipient.rb', line 18

def access_code
  @access_code
end

#client_user_idObject

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.


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

def client_user_id
  @client_user_id
end

#custom_fieldsObject

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.


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

def custom_fields
  @custom_fields
end

#delivery_methodObject

Reserved: For DocuSign use only.


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

def delivery_method
  @delivery_method
end

#emailObject

Returns the value of attribute email


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

def email
  @email
end

#email_notificationObject

Returns the value of attribute email_notification


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

def email_notification
  @email_notification
end

#embedded_recipient_start_urlObject

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]]&[]`


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

def embedded_recipient_start_url
  @embedded_recipient_start_url
end

#fax_numberObject

Reserved:


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

def fax_number
  @fax_number
end

#id_check_configuration_nameObject

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.


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

def id_check_configuration_name
  @id_check_configuration_name
end

#id_check_information_inputObject

Returns the value of attribute id_check_information_input


43
44
45
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 43

def id_check_information_input
  @id_check_information_input
end

#identification_methodObject

Returns the value of attribute identification_method


46
47
48
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 46

def identification_method
  @identification_method
end

#nameObject

Returns the value of attribute name


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

def name
  @name
end

#noteObject

Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.


52
53
54
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 52

def note
  @note
end

#phone_authenticationObject

Returns the value of attribute phone_authentication


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

def phone_authentication
  @phone_authentication
end

#recipient_idObject

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.


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

def recipient_id
  @recipient_id
end

#recipient_signature_providersObject

Returns the value of attribute recipient_signature_providers


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

def recipient_signature_providers
  @recipient_signature_providers
end

#role_nameObject

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


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

def role_name
  @role_name
end

#sms_authenticationObject

Returns the value of attribute sms_authentication


65
66
67
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 65

def sms_authentication
  @sms_authentication
end

#social_authenticationsObject

Lists the social ID type that can be used for recipient authentication.


68
69
70
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 68

def social_authentications
  @social_authentications
end

#tabsObject

Returns the value of attribute tabs


71
72
73
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 71

def tabs
  @tabs
end

Class Method Details

.attribute_mapObject

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


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 74

def self.attribute_map
  {
    :'access_code' => :'accessCode',
    :'client_user_id' => :'clientUserId',
    :'custom_fields' => :'customFields',
    :'delivery_method' => :'deliveryMethod',
    :'email' => :'email',
    :'email_notification' => :'emailNotification',
    :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
    :'fax_number' => :'faxNumber',
    :'id_check_configuration_name' => :'idCheckConfigurationName',
    :'id_check_information_input' => :'idCheckInformationInput',
    :'identification_method' => :'identificationMethod',
    :'name' => :'name',
    :'note' => :'note',
    :'phone_authentication' => :'phoneAuthentication',
    :'recipient_id' => :'recipientId',
    :'recipient_signature_providers' => :'recipientSignatureProviders',
    :'role_name' => :'roleName',
    :'sms_authentication' => :'smsAuthentication',
    :'social_authentications' => :'socialAuthentications',
    :'tabs' => :'tabs'
  }
end

.swagger_typesObject

Attribute type mapping.


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 100

def self.swagger_types
  {
    :'access_code' => :'String',
    :'client_user_id' => :'String',
    :'custom_fields' => :'Array<String>',
    :'delivery_method' => :'String',
    :'email' => :'String',
    :'email_notification' => :'RecipientEmailNotification',
    :'embedded_recipient_start_url' => :'String',
    :'fax_number' => :'String',
    :'id_check_configuration_name' => :'String',
    :'id_check_information_input' => :'IdCheckInformationInput',
    :'identification_method' => :'String',
    :'name' => :'String',
    :'note' => :'String',
    :'phone_authentication' => :'RecipientPhoneAuthentication',
    :'recipient_id' => :'String',
    :'recipient_signature_providers' => :'Array<RecipientSignatureProvider>',
    :'role_name' => :'String',
    :'sms_authentication' => :'RecipientSMSAuthentication',
    :'social_authentications' => :'Array<SocialAuthentication>',
    :'tabs' => :'Array<BulkSendingCopyTab>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_code == o.access_code &&
      client_user_id == o.client_user_id &&
      custom_fields == o.custom_fields &&
      delivery_method == o.delivery_method &&
      email == o.email &&
      email_notification == o.email_notification &&
      embedded_recipient_start_url == o.embedded_recipient_start_url &&
      fax_number == o.fax_number &&
      id_check_configuration_name == o.id_check_configuration_name &&
      id_check_information_input == o.id_check_information_input &&
      identification_method == o.identification_method &&
      name == o.name &&
      note == o.note &&
      phone_authentication == o.phone_authentication &&
      recipient_id == o.recipient_id &&
      recipient_signature_providers == o.recipient_signature_providers &&
      role_name == o.role_name &&
      sms_authentication == o.sms_authentication &&
      social_authentications == o.social_authentications &&
      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


298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 298

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


364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 364

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


277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 277

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

264
265
266
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 264

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


270
271
272
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 270

def hash
  [access_code, client_user_id, custom_fields, delivery_method, email, email_notification, embedded_recipient_start_url, fax_number, id_check_configuration_name, id_check_information_input, identification_method, name, note, phone_authentication, recipient_id, recipient_signature_providers, role_name, sms_authentication, social_authentications, tabs].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


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

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


344
345
346
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 344

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


350
351
352
353
354
355
356
357
358
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 350

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


338
339
340
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 338

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


231
232
233
# File 'lib/docusign_esign/models/bulk_sending_copy_recipient.rb', line 231

def valid?
  true
end