docusign_esign 3.21.0 → 3.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/lib/docusign_esign/api/accounts_api.rb +4 -4
  4. data/lib/docusign_esign/api/billing_api.rb +2 -2
  5. data/lib/docusign_esign/api/envelopes_api.rb +123 -3
  6. data/lib/docusign_esign/api/templates_api.rb +0 -57
  7. data/lib/docusign_esign/client/api_client.rb +1 -1
  8. data/lib/docusign_esign/models/account_information.rb +2 -1
  9. data/lib/docusign_esign/models/account_role_settings.rb +2 -0
  10. data/lib/docusign_esign/models/account_settings_information.rb +103 -15
  11. data/lib/docusign_esign/models/account_shared_access.rb +1 -1
  12. data/lib/docusign_esign/models/account_signature.rb +1 -1
  13. data/lib/docusign_esign/models/account_ui_settings.rb +2 -0
  14. data/lib/docusign_esign/models/agent.rb +13 -3
  15. data/lib/docusign_esign/models/approve.rb +2 -1
  16. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  17. data/lib/docusign_esign/models/brand.rb +1 -1
  18. data/lib/docusign_esign/models/bulk_envelope.rb +1 -1
  19. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +2 -1
  20. data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +7 -7
  21. data/lib/docusign_esign/models/captive_recipient.rb +1 -1
  22. data/lib/docusign_esign/models/carbon_copy.rb +13 -3
  23. data/lib/docusign_esign/models/certified_delivery.rb +13 -3
  24. data/lib/docusign_esign/models/checkbox.rb +2 -1
  25. data/lib/docusign_esign/models/cloud_storage_provider.rb +1 -1
  26. data/lib/docusign_esign/models/comment_thread.rb +2 -1
  27. data/lib/docusign_esign/models/commission_county.rb +2 -1
  28. data/lib/docusign_esign/models/commission_expiration.rb +2 -1
  29. data/lib/docusign_esign/models/commission_number.rb +2 -1
  30. data/lib/docusign_esign/models/commission_state.rb +2 -1
  31. data/lib/docusign_esign/models/company.rb +2 -1
  32. data/lib/docusign_esign/models/connect_debug_log.rb +1 -1
  33. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +1 -0
  34. data/lib/docusign_esign/models/contact.rb +2 -1
  35. data/lib/docusign_esign/models/custom_field.rb +1 -1
  36. data/lib/docusign_esign/models/date.rb +2 -1
  37. data/lib/docusign_esign/models/date_signed.rb +2 -1
  38. data/lib/docusign_esign/models/decline.rb +2 -1
  39. data/lib/docusign_esign/models/delayed_routing.rb +1 -1
  40. data/lib/docusign_esign/models/delegation_info.rb +12 -12
  41. data/lib/docusign_esign/models/doc_gen_form_field_request.rb +186 -0
  42. data/lib/docusign_esign/models/doc_gen_form_field_response.rb +196 -0
  43. data/lib/docusign_esign/models/doc_gen_form_fields.rb +218 -0
  44. data/lib/docusign_esign/models/document_template.rb +1 -1
  45. data/lib/docusign_esign/models/document_visibility.rb +1 -1
  46. data/lib/docusign_esign/models/draw.rb +2 -1
  47. data/lib/docusign_esign/models/editor.rb +13 -3
  48. data/lib/docusign_esign/models/email.rb +2 -1
  49. data/lib/docusign_esign/models/email_address.rb +2 -1
  50. data/lib/docusign_esign/models/envelope.rb +2 -2
  51. data/lib/docusign_esign/models/envelope_attachment.rb +1 -1
  52. data/lib/docusign_esign/models/envelope_definition.rb +2 -2
  53. data/lib/docusign_esign/models/envelope_document.rb +1 -1
  54. data/lib/docusign_esign/models/envelope_id.rb +2 -1
  55. data/lib/docusign_esign/models/envelope_publish_transaction.rb +1 -0
  56. data/lib/docusign_esign/models/envelope_summary.rb +1 -1
  57. data/lib/docusign_esign/models/envelope_template.rb +2 -2
  58. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -1
  59. data/lib/docusign_esign/models/envelope_update_summary.rb +1 -1
  60. data/lib/docusign_esign/models/external_folder.rb +1 -1
  61. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -1
  62. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -1
  63. data/lib/docusign_esign/models/first_name.rb +2 -1
  64. data/lib/docusign_esign/models/folder.rb +1 -1
  65. data/lib/docusign_esign/models/folder_item_v2.rb +1 -1
  66. data/lib/docusign_esign/models/folder_shared_item.rb +1 -1
  67. data/lib/docusign_esign/models/form_data_item.rb +12 -2
  68. data/lib/docusign_esign/models/formula_tab.rb +2 -1
  69. data/lib/docusign_esign/models/full_name.rb +2 -1
  70. data/lib/docusign_esign/models/group.rb +1 -1
  71. data/lib/docusign_esign/models/in_person_signer.rb +13 -3
  72. data/lib/docusign_esign/models/initial_here.rb +3 -2
  73. data/lib/docusign_esign/models/inline_template.rb +2 -2
  74. data/lib/docusign_esign/models/intermediary.rb +13 -3
  75. data/lib/docusign_esign/models/last_name.rb +2 -1
  76. data/lib/docusign_esign/models/list.rb +2 -1
  77. data/lib/docusign_esign/models/list_custom_field.rb +1 -1
  78. data/lib/docusign_esign/models/lock_information.rb +1 -1
  79. data/lib/docusign_esign/models/member_group_shared_item.rb +1 -1
  80. data/lib/docusign_esign/models/member_shared_items.rb +1 -1
  81. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -1
  82. data/lib/docusign_esign/models/name_value.rb +1 -1
  83. data/lib/docusign_esign/models/new_account_definition.rb +2 -2
  84. data/lib/docusign_esign/models/new_user.rb +1 -1
  85. data/lib/docusign_esign/models/notarize.rb +2 -1
  86. data/lib/docusign_esign/models/notary_host.rb +13 -3
  87. data/lib/docusign_esign/models/notary_jurisdiction.rb +1 -1
  88. data/lib/docusign_esign/models/notary_recipient.rb +13 -3
  89. data/lib/docusign_esign/models/notary_seal.rb +2 -1
  90. data/lib/docusign_esign/models/note.rb +2 -1
  91. data/lib/docusign_esign/models/number.rb +2 -1
  92. data/lib/docusign_esign/models/numerical.rb +68 -1
  93. data/lib/docusign_esign/models/page.rb +1 -1
  94. data/lib/docusign_esign/models/participant.rb +33 -1
  95. data/lib/docusign_esign/models/phone_number.rb +2 -1
  96. data/lib/docusign_esign/models/poly_line_overlay.rb +2 -1
  97. data/lib/docusign_esign/models/power_form.rb +1 -1
  98. data/lib/docusign_esign/models/radio.rb +13 -2
  99. data/lib/docusign_esign/models/recipient_form_data.rb +12 -12
  100. data/lib/docusign_esign/models/recipient_update_response.rb +1 -1
  101. data/lib/docusign_esign/models/recipients.rb +1 -1
  102. data/lib/docusign_esign/models/scheduled_sending.rb +1 -1
  103. data/lib/docusign_esign/models/seal_sign.rb +13 -3
  104. data/lib/docusign_esign/models/sender_company.rb +2 -1
  105. data/lib/docusign_esign/models/sender_name.rb +2 -1
  106. data/lib/docusign_esign/models/shared_item.rb +1 -1
  107. data/lib/docusign_esign/models/sign_here.rb +2 -1
  108. data/lib/docusign_esign/models/signer.rb +13 -3
  109. data/lib/docusign_esign/models/signer_attachment.rb +2 -1
  110. data/lib/docusign_esign/models/signing_group.rb +1 -1
  111. data/lib/docusign_esign/models/signing_group_user.rb +1 -1
  112. data/lib/docusign_esign/models/smart_section.rb +4 -3
  113. data/lib/docusign_esign/models/social_account_information.rb +1 -1
  114. data/lib/docusign_esign/models/ssn.rb +2 -1
  115. data/lib/docusign_esign/models/stamp.rb +1 -1
  116. data/lib/docusign_esign/models/tab_account_settings.rb +21 -21
  117. data/lib/docusign_esign/models/tab_group.rb +2 -1
  118. data/lib/docusign_esign/models/tabs.rb +1 -13
  119. data/lib/docusign_esign/models/template_recipients.rb +1 -1
  120. data/lib/docusign_esign/models/template_role.rb +1 -1
  121. data/lib/docusign_esign/models/template_shared_item.rb +1 -1
  122. data/lib/docusign_esign/models/template_summary.rb +1 -1
  123. data/lib/docusign_esign/models/template_tabs.rb +1 -13
  124. data/lib/docusign_esign/models/template_update_summary.rb +1 -1
  125. data/lib/docusign_esign/models/text.rb +2 -1
  126. data/lib/docusign_esign/models/text_custom_field.rb +1 -1
  127. data/lib/docusign_esign/models/title.rb +2 -1
  128. data/lib/docusign_esign/models/user_account_management_granular_information.rb +2 -0
  129. data/lib/docusign_esign/models/user_info.rb +12 -2
  130. data/lib/docusign_esign/models/user_information.rb +2 -2
  131. data/lib/docusign_esign/models/user_settings_information.rb +2 -0
  132. data/lib/docusign_esign/models/user_shared_item.rb +1 -1
  133. data/lib/docusign_esign/models/user_signature.rb +1 -1
  134. data/lib/docusign_esign/models/view.rb +2 -1
  135. data/lib/docusign_esign/models/witness.rb +13 -3
  136. data/lib/docusign_esign/models/workspace_user.rb +1 -1
  137. data/lib/docusign_esign/models/workspace_user_authorization.rb +1 -1
  138. data/lib/docusign_esign/models/zip.rb +2 -1
  139. data/lib/docusign_esign/version.rb +1 -1
  140. data/lib/docusign_esign.rb +3 -2
  141. metadata +5 -2
@@ -32,6 +32,9 @@ module DocuSign_eSign
32
32
  #
33
33
  attr_accessor :auto_responded_reason
34
34
 
35
+ #
36
+ attr_accessor :bulk_send_v2_recipient
37
+
35
38
  # 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.
36
39
  attr_accessor :client_user_id
37
40
 
@@ -74,7 +77,7 @@ module DocuSign_eSign
74
77
  # Metadata that indicates whether the `email` property is editable. This property is read-only.
75
78
  attr_accessor :email_metadata
76
79
 
77
- # An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
80
+ # 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.
78
81
  attr_accessor :email_notification
79
82
 
80
83
  #
@@ -83,7 +86,7 @@ module DocuSign_eSign
83
86
  # 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*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
84
87
  attr_accessor :embedded_recipient_start_url
85
88
 
86
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
89
+ # Array or errors.
87
90
  attr_accessor :error_details
88
91
 
89
92
  # Reserved:
@@ -239,6 +242,7 @@ module DocuSign_eSign
239
242
  :'additional_notifications' => :'additionalNotifications',
240
243
  :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
241
244
  :'auto_responded_reason' => :'autoRespondedReason',
245
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
242
246
  :'client_user_id' => :'clientUserId',
243
247
  :'completed_count' => :'completedCount',
244
248
  :'consent_details_list' => :'consentDetailsList',
@@ -317,6 +321,7 @@ module DocuSign_eSign
317
321
  :'additional_notifications' => :'Array<RecipientAdditionalNotification>',
318
322
  :'allow_system_override_for_locked_recipient' => :'String',
319
323
  :'auto_responded_reason' => :'String',
324
+ :'bulk_send_v2_recipient' => :'String',
320
325
  :'client_user_id' => :'String',
321
326
  :'completed_count' => :'String',
322
327
  :'consent_details_list' => :'Array<ConsentDetails>',
@@ -420,6 +425,10 @@ module DocuSign_eSign
420
425
  self.auto_responded_reason = attributes[:'autoRespondedReason']
421
426
  end
422
427
 
428
+ if attributes.has_key?(:'bulkSendV2Recipient')
429
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
430
+ end
431
+
423
432
  if attributes.has_key?(:'clientUserId')
424
433
  self.client_user_id = attributes[:'clientUserId']
425
434
  end
@@ -723,6 +732,7 @@ module DocuSign_eSign
723
732
  additional_notifications == o.additional_notifications &&
724
733
  allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
725
734
  auto_responded_reason == o.auto_responded_reason &&
735
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
726
736
  client_user_id == o.client_user_id &&
727
737
  completed_count == o.completed_count &&
728
738
  consent_details_list == o.consent_details_list &&
@@ -800,7 +810,7 @@ module DocuSign_eSign
800
810
  # Calculates hash code according to all attributes.
801
811
  # @return [Fixnum] Hash code
802
812
  def hash
803
- [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, consent_details_list, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
813
+ [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, bulk_send_v2_recipient, client_user_id, completed_count, consent_details_list, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
804
814
  end
805
815
 
806
816
  # Builds the object from hash
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
@@ -121,7 +122,7 @@ module DocuSign_eSign
121
122
  # Metadata that indicates whether the `documentId` property is editable.
122
123
  attr_accessor :document_id_metadata
123
124
 
124
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
125
+ # Array or errors.
125
126
  attr_accessor :error_details
126
127
 
127
128
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -109,7 +110,7 @@ module DocuSign_eSign
109
110
  # Metadata that indicates whether the `documentId` property is editable.
110
111
  attr_accessor :document_id_metadata
111
112
 
112
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
113
+ # Array or errors.
113
114
  attr_accessor :error_details
114
115
 
115
116
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -67,7 +67,7 @@ module DocuSign_eSign
67
67
  # Indicates the date and time the item was created.
68
68
  attr_accessor :created_date_time
69
69
 
70
- # An optional array of strings that enables 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.
70
+ # 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.
71
71
  attr_accessor :custom_fields
72
72
 
73
73
  # Contains a URI for an endpoint that you can use to retrieve the custom fields.
@@ -202,7 +202,7 @@ module DocuSign_eSign
202
202
  #
203
203
  attr_accessor :purge_state
204
204
 
205
- # An array of recipient objects that provides details about the recipients of the envelope.
205
+ # An array of powerform recipients.
206
206
  attr_accessor :recipients
207
207
 
208
208
  # When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
@@ -22,7 +22,7 @@ module DocuSign_eSign
22
22
  #
23
23
  attr_accessor :attachment_type
24
24
 
25
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
25
+ # Array or errors.
26
26
  attr_accessor :error_details
27
27
 
28
28
  #
@@ -80,7 +80,7 @@ module DocuSign_eSign
80
80
  # Indicates the date and time the item was created.
81
81
  attr_accessor :created_date_time
82
82
 
83
- # An optional array of strings that enables 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. **Note:** Any custom fields you set with this API method will _replace_ custom fields you have defined with [Envelope Custom Fields in Admin](https://support.docusign.com/en/guides/ndse-admin-guide-document-labels), whether the **Show field to envelope creators** or **Make fields required for envelopes** options are checked or not.
83
+ # 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.
84
84
  attr_accessor :custom_fields
85
85
 
86
86
  # Contains a URI for an endpoint that you can use to retrieve the custom fields.
@@ -227,7 +227,7 @@ module DocuSign_eSign
227
227
  # Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue.
228
228
  attr_accessor :purge_state
229
229
 
230
- # Specifies the envelope recipients.
230
+ # An array of powerform recipients.
231
231
  attr_accessor :recipients
232
232
 
233
233
  # When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
@@ -59,7 +59,7 @@ module DocuSign_eSign
59
59
  #
60
60
  attr_accessor :document_id_guid
61
61
 
62
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
62
+ # Array or errors.
63
63
  attr_accessor :error_details
64
64
 
65
65
  #
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -109,7 +110,7 @@ module DocuSign_eSign
109
110
  # Metadata that indicates whether the `documentId` property is editable.
110
111
  attr_accessor :document_id_metadata
111
112
 
112
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
113
+ # Array or errors.
113
114
  attr_accessor :error_details
114
115
 
115
116
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -46,6 +46,7 @@ module DocuSign_eSign
46
46
  #
47
47
  attr_accessor :submission_date
48
48
 
49
+ #
49
50
  attr_accessor :submitted_by_user_info
50
51
 
51
52
  #
@@ -20,7 +20,7 @@ module DocuSign_eSign
20
20
  # The envelope ID of the envelope status that failed to post.
21
21
  attr_accessor :envelope_id
22
22
 
23
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
23
+ # Array or errors.
24
24
  attr_accessor :error_details
25
25
 
26
26
  #
@@ -76,7 +76,7 @@ module DocuSign_eSign
76
76
  # Indicates the date and time the item was created.
77
77
  attr_accessor :created_date_time
78
78
 
79
- # An optional array of strings that enables 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.
79
+ # 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.
80
80
  attr_accessor :custom_fields
81
81
 
82
82
  # Contains a URI for an endpoint that you can use to retrieve the custom fields.
@@ -262,7 +262,7 @@ module DocuSign_eSign
262
262
  #
263
263
  attr_accessor :purge_state
264
264
 
265
- # An array of recipient objects that provides details about the recipients of the envelope.
265
+ # An array of powerform recipients.
266
266
  attr_accessor :recipients
267
267
 
268
268
  # When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
@@ -16,7 +16,7 @@ module DocuSign_eSign
16
16
  # The envelope ID of the envelope status that failed to post.
17
17
  attr_accessor :envelope_id
18
18
 
19
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
19
+ # Array or errors.
20
20
  attr_accessor :error_details
21
21
 
22
22
  # Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
@@ -19,7 +19,7 @@ module DocuSign_eSign
19
19
  # The envelope ID of the envelope status that failed to post.
20
20
  attr_accessor :envelope_id
21
21
 
22
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
22
+ # Array or errors.
23
23
  attr_accessor :error_details
24
24
 
25
25
  #
@@ -16,7 +16,7 @@ module DocuSign_eSign
16
16
  # The last position in the result set.
17
17
  attr_accessor :end_position
18
18
 
19
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
19
+ # Array or errors.
20
20
  attr_accessor :error_details
21
21
 
22
22
  #
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
15
  class FavoriteTemplatesContentItem
16
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
16
+ # Array or errors.
17
17
  attr_accessor :error_details
18
18
 
19
19
  #
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
15
  class FavoriteTemplatesInfo
16
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
16
+ # Array or errors.
17
17
  attr_accessor :error_details
18
18
 
19
19
  #
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -109,7 +110,7 @@ module DocuSign_eSign
109
110
  # Metadata that indicates whether the `documentId` property is editable.
110
111
  attr_accessor :document_id_metadata
111
112
 
112
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
113
+ # Array or errors.
113
114
  attr_accessor :error_details
114
115
 
115
116
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -14,7 +14,7 @@ require 'date'
14
14
  module DocuSign_eSign
15
15
  # This object contains details about a folder.
16
16
  class Folder
17
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
17
+ # Array or errors.
18
18
  attr_accessor :error_details
19
19
 
20
20
  # An object used to present a filtered view of the items in a folder.
@@ -44,7 +44,7 @@ module DocuSign_eSign
44
44
  #
45
45
  attr_accessor :owner_name
46
46
 
47
- # An array of recipient objects that provides details about the recipients of the envelope.
47
+ # An array of powerform recipients.
48
48
  attr_accessor :recipients
49
49
 
50
50
  # Contains a URI for an endpoint that you can use to retrieve the recipients.
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
15
  class FolderSharedItem
16
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
16
+ # Array or errors.
17
17
  attr_accessor :error_details
18
18
 
19
19
  #
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
15
  class FormDataItem
16
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
16
+ # Array or errors.
17
17
  attr_accessor :error_details
18
18
 
19
19
  #
@@ -25,6 +25,9 @@ module DocuSign_eSign
25
25
  #
26
26
  attr_accessor :numerical_value
27
27
 
28
+ #
29
+ attr_accessor :original_numerical_value
30
+
28
31
  # The initial value of the tab when it was sent to the recipient.
29
32
  attr_accessor :original_value
30
33
 
@@ -38,6 +41,7 @@ module DocuSign_eSign
38
41
  :'list_selected_value' => :'listSelectedValue',
39
42
  :'name' => :'name',
40
43
  :'numerical_value' => :'numericalValue',
44
+ :'original_numerical_value' => :'originalNumericalValue',
41
45
  :'original_value' => :'originalValue',
42
46
  :'value' => :'value'
43
47
  }
@@ -50,6 +54,7 @@ module DocuSign_eSign
50
54
  :'list_selected_value' => :'String',
51
55
  :'name' => :'String',
52
56
  :'numerical_value' => :'String',
57
+ :'original_numerical_value' => :'String',
53
58
  :'original_value' => :'String',
54
59
  :'value' => :'String'
55
60
  }
@@ -79,6 +84,10 @@ module DocuSign_eSign
79
84
  self.numerical_value = attributes[:'numericalValue']
80
85
  end
81
86
 
87
+ if attributes.has_key?(:'originalNumericalValue')
88
+ self.original_numerical_value = attributes[:'originalNumericalValue']
89
+ end
90
+
82
91
  if attributes.has_key?(:'originalValue')
83
92
  self.original_value = attributes[:'originalValue']
84
93
  end
@@ -110,6 +119,7 @@ module DocuSign_eSign
110
119
  list_selected_value == o.list_selected_value &&
111
120
  name == o.name &&
112
121
  numerical_value == o.numerical_value &&
122
+ original_numerical_value == o.original_numerical_value &&
113
123
  original_value == o.original_value &&
114
124
  value == o.value
115
125
  end
@@ -123,7 +133,7 @@ module DocuSign_eSign
123
133
  # Calculates hash code according to all attributes.
124
134
  # @return [Fixnum] Hash code
125
135
  def hash
126
- [error_details, list_selected_value, name, numerical_value, original_value, value].hash
136
+ [error_details, list_selected_value, name, numerical_value, original_numerical_value, original_value, value].hash
127
137
  end
128
138
 
129
139
  # Builds the object from hash
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
@@ -121,7 +122,7 @@ module DocuSign_eSign
121
122
  # Metadata that indicates whether the `documentId` property is editable.
122
123
  attr_accessor :document_id_metadata
123
124
 
124
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
125
+ # Array or errors.
125
126
  attr_accessor :error_details
126
127
 
127
128
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -83,6 +83,7 @@ module DocuSign_eSign
83
83
  #
84
84
  attr_accessor :caption
85
85
 
86
+ #
86
87
  attr_accessor :caption_metadata
87
88
 
88
89
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -109,7 +110,7 @@ module DocuSign_eSign
109
110
  # Metadata that indicates whether the `documentId` property is editable.
110
111
  attr_accessor :document_id_metadata
111
112
 
112
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
113
+ # Array or errors.
113
114
  attr_accessor :error_details
114
115
 
115
116
  # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -17,7 +17,7 @@ module DocuSign_eSign
17
17
  #
18
18
  attr_accessor :ds_group_id
19
19
 
20
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
20
+ # Array or errors.
21
21
  attr_accessor :error_details
22
22
 
23
23
  # The DocuSign group ID for the group.
@@ -32,6 +32,9 @@ module DocuSign_eSign
32
32
  #
33
33
  attr_accessor :auto_responded_reason
34
34
 
35
+ #
36
+ attr_accessor :bulk_send_v2_recipient
37
+
35
38
  # When set to **true**, specifies that the signer can perform the signing ceremony offline.
36
39
  attr_accessor :can_sign_offline
37
40
 
@@ -80,13 +83,13 @@ module DocuSign_eSign
80
83
  # Metadata that indicates whether the `email` property is editable. This property is read-only.
81
84
  attr_accessor :email_metadata
82
85
 
83
- # An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
86
+ # 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.
84
87
  attr_accessor :email_notification
85
88
 
86
89
  # 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*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
87
90
  attr_accessor :embedded_recipient_start_url
88
91
 
89
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
92
+ # Array or errors.
90
93
  attr_accessor :error_details
91
94
 
92
95
  # Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
@@ -302,6 +305,7 @@ module DocuSign_eSign
302
305
  :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
303
306
  :'auto_navigation' => :'autoNavigation',
304
307
  :'auto_responded_reason' => :'autoRespondedReason',
308
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
305
309
  :'can_sign_offline' => :'canSignOffline',
306
310
  :'client_user_id' => :'clientUserId',
307
311
  :'completed_count' => :'completedCount',
@@ -401,6 +405,7 @@ module DocuSign_eSign
401
405
  :'allow_system_override_for_locked_recipient' => :'String',
402
406
  :'auto_navigation' => :'String',
403
407
  :'auto_responded_reason' => :'String',
408
+ :'bulk_send_v2_recipient' => :'String',
404
409
  :'can_sign_offline' => :'String',
405
410
  :'client_user_id' => :'String',
406
411
  :'completed_count' => :'String',
@@ -523,6 +528,10 @@ module DocuSign_eSign
523
528
  self.auto_responded_reason = attributes[:'autoRespondedReason']
524
529
  end
525
530
 
531
+ if attributes.has_key?(:'bulkSendV2Recipient')
532
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
533
+ end
534
+
526
535
  if attributes.has_key?(:'canSignOffline')
527
536
  self.can_sign_offline = attributes[:'canSignOffline']
528
537
  end
@@ -912,6 +921,7 @@ module DocuSign_eSign
912
921
  allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
913
922
  auto_navigation == o.auto_navigation &&
914
923
  auto_responded_reason == o.auto_responded_reason &&
924
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
915
925
  can_sign_offline == o.can_sign_offline &&
916
926
  client_user_id == o.client_user_id &&
917
927
  completed_count == o.completed_count &&
@@ -1010,7 +1020,7 @@ module DocuSign_eSign
1010
1020
  # Calculates hash code according to all attributes.
1011
1021
  # @return [Fixnum] Hash code
1012
1022
  def hash
1013
- [access_code, access_code_metadata, add_access_code_to_email, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, host_email, host_email_metadata, host_name, host_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, in_person_signing_type, in_person_signing_type_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_host, notary_id, note, note_metadata, offline_attributes, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, signer_email, signer_email_metadata, signer_first_name, signer_first_name_metadata, signer_last_name, signer_last_name_metadata, signer_name, signer_name_metadata, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
1023
+ [access_code, access_code_metadata, add_access_code_to_email, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_send_v2_recipient, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, host_email, host_email_metadata, host_name, host_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, in_person_signing_type, in_person_signing_type_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_host, notary_id, note, note_metadata, offline_attributes, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, signer_email, signer_email_metadata, signer_first_name, signer_first_name_metadata, signer_last_name, signer_last_name_metadata, signer_name, signer_name_metadata, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
1014
1024
  end
1015
1025
 
1016
1026
  # Builds the object from hash
@@ -77,6 +77,7 @@ module DocuSign_eSign
77
77
  #
78
78
  attr_accessor :caption
79
79
 
80
+ #
80
81
  attr_accessor :caption_metadata
81
82
 
82
83
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -103,7 +104,7 @@ module DocuSign_eSign
103
104
  # Metadata that indicates whether the `documentId` property is editable.
104
105
  attr_accessor :document_id_metadata
105
106
 
106
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
107
+ # Array or errors.
107
108
  attr_accessor :error_details
108
109
 
109
110
  #
@@ -169,7 +170,7 @@ module DocuSign_eSign
169
170
  # Metadata that indicates whether the `recipientId` property is editable.
170
171
  attr_accessor :recipient_id_metadata
171
172
 
172
- # Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size.
173
+ # Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size.
173
174
  attr_accessor :scale_value
174
175
 
175
176
  # Metadata that indicates whether the `scaleValue` property is editable.
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module DocuSign_eSign
15
15
  class InlineTemplate
16
- # An optional array of strings that enables 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.
16
+ # 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.
17
17
  attr_accessor :custom_fields
18
18
 
19
19
  # Complex element contains the details on the documents in the envelope.
@@ -22,7 +22,7 @@ module DocuSign_eSign
22
22
  # A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.
23
23
  attr_accessor :envelope
24
24
 
25
- # An array of recipient objects that provides details about the recipients of the envelope.
25
+ # An array of powerform recipients.
26
26
  attr_accessor :recipients
27
27
 
28
28
  # Specifies the order in which templates are overlaid.