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
@@ -38,9 +38,6 @@ module DocuSign_eSign
38
38
  # Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
39
39
  attr_accessor :company_tabs
40
40
 
41
- #
42
- attr_accessor :currency_tabs
43
-
44
41
  # Specifies a tab on the document where the date the document was signed will automatically appear.
45
42
  attr_accessor :date_signed_tabs
46
43
 
@@ -145,7 +142,6 @@ module DocuSign_eSign
145
142
  :'commission_number_tabs' => :'commissionNumberTabs',
146
143
  :'commission_state_tabs' => :'commissionStateTabs',
147
144
  :'company_tabs' => :'companyTabs',
148
- :'currency_tabs' => :'currencyTabs',
149
145
  :'date_signed_tabs' => :'dateSignedTabs',
150
146
  :'date_tabs' => :'dateTabs',
151
147
  :'decline_tabs' => :'declineTabs',
@@ -191,7 +187,6 @@ module DocuSign_eSign
191
187
  :'commission_number_tabs' => :'Array<CommissionNumber>',
192
188
  :'commission_state_tabs' => :'Array<CommissionState>',
193
189
  :'company_tabs' => :'Array<Company>',
194
- :'currency_tabs' => :'Array<Currency>',
195
190
  :'date_signed_tabs' => :'Array<DateSigned>',
196
191
  :'date_tabs' => :'Array<DocuSign_eSign::Date>',
197
192
  :'decline_tabs' => :'Array<Decline>',
@@ -282,12 +277,6 @@ module DocuSign_eSign
282
277
  end
283
278
  end
284
279
 
285
- if attributes.has_key?(:'currencyTabs')
286
- if (value = attributes[:'currencyTabs']).is_a?(Array)
287
- self.currency_tabs = value
288
- end
289
- end
290
-
291
280
  if attributes.has_key?(:'dateSignedTabs')
292
281
  if (value = attributes[:'dateSignedTabs']).is_a?(Array)
293
282
  self.date_signed_tabs = value
@@ -499,7 +488,6 @@ module DocuSign_eSign
499
488
  commission_number_tabs == o.commission_number_tabs &&
500
489
  commission_state_tabs == o.commission_state_tabs &&
501
490
  company_tabs == o.company_tabs &&
502
- currency_tabs == o.currency_tabs &&
503
491
  date_signed_tabs == o.date_signed_tabs &&
504
492
  date_tabs == o.date_tabs &&
505
493
  decline_tabs == o.decline_tabs &&
@@ -542,7 +530,7 @@ module DocuSign_eSign
542
530
  # Calculates hash code according to all attributes.
543
531
  # @return [Fixnum] Hash code
544
532
  def hash
545
- [approve_tabs, checkbox_tabs, comment_thread_tabs, commission_county_tabs, commission_expiration_tabs, commission_number_tabs, commission_state_tabs, company_tabs, currency_tabs, date_signed_tabs, date_tabs, decline_tabs, draw_tabs, email_address_tabs, email_tabs, envelope_id_tabs, first_name_tabs, formula_tabs, full_name_tabs, initial_here_tabs, last_name_tabs, list_tabs, notarize_tabs, notary_seal_tabs, note_tabs, number_tabs, numerical_tabs, phone_number_tabs, poly_line_overlay_tabs, prefill_tabs, radio_group_tabs, signer_attachment_tabs, sign_here_tabs, smart_section_tabs, ssn_tabs, tab_groups, text_tabs, title_tabs, view_tabs, zip_tabs].hash
533
+ [approve_tabs, checkbox_tabs, comment_thread_tabs, commission_county_tabs, commission_expiration_tabs, commission_number_tabs, commission_state_tabs, company_tabs, date_signed_tabs, date_tabs, decline_tabs, draw_tabs, email_address_tabs, email_tabs, envelope_id_tabs, first_name_tabs, formula_tabs, full_name_tabs, initial_here_tabs, last_name_tabs, list_tabs, notarize_tabs, notary_seal_tabs, note_tabs, number_tabs, numerical_tabs, phone_number_tabs, poly_line_overlay_tabs, prefill_tabs, radio_group_tabs, signer_attachment_tabs, sign_here_tabs, smart_section_tabs, ssn_tabs, tab_groups, text_tabs, title_tabs, view_tabs, zip_tabs].hash
546
534
  end
547
535
 
548
536
  # Builds the object from hash
@@ -28,7 +28,7 @@ module DocuSign_eSign
28
28
  #
29
29
  attr_accessor :editors
30
30
 
31
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
31
+ # Array or errors.
32
32
  attr_accessor :error_details
33
33
 
34
34
  # 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.
@@ -32,7 +32,7 @@ module DocuSign_eSign
32
32
  # Specifies the email associated with a role name.
33
33
  attr_accessor :email
34
34
 
35
- # 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`.
35
+ # 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
36
  attr_accessor :email_notification
37
37
 
38
38
  # 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]]`
@@ -14,7 +14,7 @@ require 'date'
14
14
  module DocuSign_eSign
15
15
  # Information about shared templates.
16
16
  class TemplateSharedItem
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
  # Information about the user who owns the template.
@@ -23,7 +23,7 @@ module DocuSign_eSign
23
23
  #
24
24
  attr_accessor :document_name
25
25
 
26
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
26
+ # Array or errors.
27
27
  attr_accessor :error_details
28
28
 
29
29
  #
@@ -37,9 +37,6 @@ module DocuSign_eSign
37
37
  # Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
38
38
  attr_accessor :company_tabs
39
39
 
40
- #
41
- attr_accessor :currency_tabs
42
-
43
40
  # Specifies a tab on the document where the date the document was signed will automatically appear.
44
41
  attr_accessor :date_signed_tabs
45
42
 
@@ -144,7 +141,6 @@ module DocuSign_eSign
144
141
  :'commission_number_tabs' => :'commissionNumberTabs',
145
142
  :'commission_state_tabs' => :'commissionStateTabs',
146
143
  :'company_tabs' => :'companyTabs',
147
- :'currency_tabs' => :'currencyTabs',
148
144
  :'date_signed_tabs' => :'dateSignedTabs',
149
145
  :'date_tabs' => :'dateTabs',
150
146
  :'decline_tabs' => :'declineTabs',
@@ -190,7 +186,6 @@ module DocuSign_eSign
190
186
  :'commission_number_tabs' => :'Array<CommissionNumber>',
191
187
  :'commission_state_tabs' => :'Array<CommissionState>',
192
188
  :'company_tabs' => :'Array<Company>',
193
- :'currency_tabs' => :'Array<Currency>',
194
189
  :'date_signed_tabs' => :'Array<DateSigned>',
195
190
  :'date_tabs' => :'Array<DocuSign_eSign::Date>',
196
191
  :'decline_tabs' => :'Array<Decline>',
@@ -281,12 +276,6 @@ module DocuSign_eSign
281
276
  end
282
277
  end
283
278
 
284
- if attributes.has_key?(:'currencyTabs')
285
- if (value = attributes[:'currencyTabs']).is_a?(Array)
286
- self.currency_tabs = value
287
- end
288
- end
289
-
290
279
  if attributes.has_key?(:'dateSignedTabs')
291
280
  if (value = attributes[:'dateSignedTabs']).is_a?(Array)
292
281
  self.date_signed_tabs = value
@@ -498,7 +487,6 @@ module DocuSign_eSign
498
487
  commission_number_tabs == o.commission_number_tabs &&
499
488
  commission_state_tabs == o.commission_state_tabs &&
500
489
  company_tabs == o.company_tabs &&
501
- currency_tabs == o.currency_tabs &&
502
490
  date_signed_tabs == o.date_signed_tabs &&
503
491
  date_tabs == o.date_tabs &&
504
492
  decline_tabs == o.decline_tabs &&
@@ -541,7 +529,7 @@ module DocuSign_eSign
541
529
  # Calculates hash code according to all attributes.
542
530
  # @return [Fixnum] Hash code
543
531
  def hash
544
- [approve_tabs, checkbox_tabs, comment_thread_tabs, commission_county_tabs, commission_expiration_tabs, commission_number_tabs, commission_state_tabs, company_tabs, currency_tabs, date_signed_tabs, date_tabs, decline_tabs, draw_tabs, email_address_tabs, email_tabs, envelope_id_tabs, first_name_tabs, formula_tabs, full_name_tabs, initial_here_tabs, last_name_tabs, list_tabs, notarize_tabs, notary_seal_tabs, note_tabs, number_tabs, numerical_tabs, phone_number_tabs, poly_line_overlay_tabs, prefill_tabs, radio_group_tabs, signer_attachment_tabs, sign_here_tabs, smart_section_tabs, ssn_tabs, tab_groups, text_tabs, title_tabs, view_tabs, zip_tabs].hash
532
+ [approve_tabs, checkbox_tabs, comment_thread_tabs, commission_county_tabs, commission_expiration_tabs, commission_number_tabs, commission_state_tabs, company_tabs, date_signed_tabs, date_tabs, decline_tabs, draw_tabs, email_address_tabs, email_tabs, envelope_id_tabs, first_name_tabs, formula_tabs, full_name_tabs, initial_here_tabs, last_name_tabs, list_tabs, notarize_tabs, notary_seal_tabs, note_tabs, number_tabs, numerical_tabs, phone_number_tabs, poly_line_overlay_tabs, prefill_tabs, radio_group_tabs, signer_attachment_tabs, sign_here_tabs, smart_section_tabs, ssn_tabs, tab_groups, text_tabs, title_tabs, view_tabs, zip_tabs].hash
545
533
  end
546
534
 
547
535
  # Builds the object from hash
@@ -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
  #
@@ -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.
@@ -17,7 +17,7 @@ module DocuSign_eSign
17
17
  # If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.
18
18
  attr_accessor :configuration_type
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
  # An ID used to specify a custom field.
@@ -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.
@@ -59,6 +59,7 @@ module DocuSign_eSign
59
59
  #
60
60
  attr_accessor :can_manage_joint_agreements
61
61
 
62
+ #
62
63
  attr_accessor :can_manage_joint_agreements_metadata
63
64
 
64
65
  #
@@ -82,6 +83,7 @@ module DocuSign_eSign
82
83
  #
83
84
  attr_accessor :can_manage_stamps
84
85
 
86
+ #
85
87
  attr_accessor :can_manage_stamps_metadata
86
88
 
87
89
  #
@@ -25,9 +25,12 @@ module DocuSign_eSign
25
25
  #
26
26
  attr_accessor :email
27
27
 
28
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
28
+ # Array or errors.
29
29
  attr_accessor :error_details
30
30
 
31
+ #
32
+ attr_accessor :ip_address
33
+
31
34
  #
32
35
  attr_accessor :login_status
33
36
 
@@ -60,6 +63,7 @@ module DocuSign_eSign
60
63
  :'activation_access_code' => :'activationAccessCode',
61
64
  :'email' => :'email',
62
65
  :'error_details' => :'errorDetails',
66
+ :'ip_address' => :'ipAddress',
63
67
  :'login_status' => :'loginStatus',
64
68
  :'membership_id' => :'membershipId',
65
69
  :'send_activation_email' => :'sendActivationEmail',
@@ -79,6 +83,7 @@ module DocuSign_eSign
79
83
  :'activation_access_code' => :'String',
80
84
  :'email' => :'String',
81
85
  :'error_details' => :'ErrorDetails',
86
+ :'ip_address' => :'String',
82
87
  :'login_status' => :'String',
83
88
  :'membership_id' => :'String',
84
89
  :'send_activation_email' => :'String',
@@ -118,6 +123,10 @@ module DocuSign_eSign
118
123
  self.error_details = attributes[:'errorDetails']
119
124
  end
120
125
 
126
+ if attributes.has_key?(:'ipAddress')
127
+ self.ip_address = attributes[:'ipAddress']
128
+ end
129
+
121
130
  if attributes.has_key?(:'loginStatus')
122
131
  self.login_status = attributes[:'loginStatus']
123
132
  end
@@ -174,6 +183,7 @@ module DocuSign_eSign
174
183
  activation_access_code == o.activation_access_code &&
175
184
  email == o.email &&
176
185
  error_details == o.error_details &&
186
+ ip_address == o.ip_address &&
177
187
  login_status == o.login_status &&
178
188
  membership_id == o.membership_id &&
179
189
  send_activation_email == o.send_activation_email &&
@@ -193,7 +203,7 @@ module DocuSign_eSign
193
203
  # Calculates hash code according to all attributes.
194
204
  # @return [Fixnum] Hash code
195
205
  def hash
196
- [account_id, account_name, activation_access_code, email, error_details, login_status, membership_id, send_activation_email, uri, user_id, user_name, user_status, user_type].hash
206
+ [account_id, account_name, activation_access_code, email, error_details, ip_address, login_status, membership_id, send_activation_email, uri, user_id, user_name, user_status, user_type].hash
197
207
  end
198
208
 
199
209
  # Builds the object from hash
@@ -41,7 +41,7 @@ module DocuSign_eSign
41
41
  # Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false.
42
42
  attr_accessor :enable_connect_for_user
43
43
 
44
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
44
+ # Array or errors.
45
45
  attr_accessor :error_details
46
46
 
47
47
  # The user's first name. Maximum Length: 50 characters.
@@ -134,7 +134,7 @@ module DocuSign_eSign
134
134
  #
135
135
  attr_accessor :user_profile_last_modified_date
136
136
 
137
- # The collection of settings representing the actions a user can perform. See [userSettingsInformation](/docs/esign-rest-api/reference/users/users/get/#userSettingsInformation) for available settings.
137
+ # The name/value pair information for user settings. These determine the actions that a user can take in the account. The `[ML:userSettings]` are listed and described below.
138
138
  attr_accessor :user_settings
139
139
 
140
140
  #
@@ -176,6 +176,7 @@ module DocuSign_eSign
176
176
  #
177
177
  attr_accessor :enable_key_terms_suggestions_by_document_type
178
178
 
179
+ #
179
180
  attr_accessor :enable_key_terms_suggestions_by_document_type_metadata
180
181
 
181
182
  #
@@ -385,6 +386,7 @@ module DocuSign_eSign
385
386
  #
386
387
  attr_accessor :web_forms
387
388
 
389
+ #
388
390
  attr_accessor :web_forms_metadata
389
391
 
390
392
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,7 +14,7 @@ require 'date'
14
14
  module DocuSign_eSign
15
15
  # Information about a shared item.
16
16
  class UserSharedItem
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
  # When set to **true**, this custom tab is shared.
@@ -28,7 +28,7 @@ module DocuSign_eSign
28
28
  #
29
29
  attr_accessor :disallow_user_resize_stamp
30
30
 
31
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
31
+ # Array or errors.
32
32
  attr_accessor :error_details
33
33
 
34
34
  #
@@ -89,6 +89,7 @@ module DocuSign_eSign
89
89
  #
90
90
  attr_accessor :caption
91
91
 
92
+ #
92
93
  attr_accessor :caption_metadata
93
94
 
94
95
  # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -115,7 +116,7 @@ module DocuSign_eSign
115
116
  # Metadata that indicates whether the `documentId` property is editable.
116
117
  attr_accessor :document_id_metadata
117
118
 
118
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
119
+ # Array or errors.
119
120
  attr_accessor :error_details
120
121
 
121
122
  # 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.
@@ -44,6 +44,9 @@ module DocuSign_eSign
44
44
  # Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.
45
45
  attr_accessor :bulk_recipients_uri
46
46
 
47
+ #
48
+ attr_accessor :bulk_send_v2_recipient
49
+
47
50
  # When set to **true**, specifies that the signer can perform the signing ceremony offline.
48
51
  attr_accessor :can_sign_offline
49
52
 
@@ -101,7 +104,7 @@ module DocuSign_eSign
101
104
  # Metadata that indicates whether the `email` property is editable. This property is read-only.
102
105
  attr_accessor :email_metadata
103
106
 
104
- # 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`.
107
+ # 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.
105
108
  attr_accessor :email_notification
106
109
 
107
110
  #
@@ -110,7 +113,7 @@ module DocuSign_eSign
110
113
  # 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]]`
111
114
  attr_accessor :embedded_recipient_start_url
112
115
 
113
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
116
+ # Array or errors.
114
117
  attr_accessor :error_details
115
118
 
116
119
  # 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.
@@ -324,6 +327,7 @@ module DocuSign_eSign
324
327
  :'auto_navigation' => :'autoNavigation',
325
328
  :'auto_responded_reason' => :'autoRespondedReason',
326
329
  :'bulk_recipients_uri' => :'bulkRecipientsUri',
330
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
327
331
  :'can_sign_offline' => :'canSignOffline',
328
332
  :'client_user_id' => :'clientUserId',
329
333
  :'completed_count' => :'completedCount',
@@ -429,6 +433,7 @@ module DocuSign_eSign
429
433
  :'auto_navigation' => :'String',
430
434
  :'auto_responded_reason' => :'String',
431
435
  :'bulk_recipients_uri' => :'String',
436
+ :'bulk_send_v2_recipient' => :'String',
432
437
  :'can_sign_offline' => :'String',
433
438
  :'client_user_id' => :'String',
434
439
  :'completed_count' => :'String',
@@ -571,6 +576,10 @@ module DocuSign_eSign
571
576
  self.bulk_recipients_uri = attributes[:'bulkRecipientsUri']
572
577
  end
573
578
 
579
+ if attributes.has_key?(:'bulkSendV2Recipient')
580
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
581
+ end
582
+
574
583
  if attributes.has_key?(:'canSignOffline')
575
584
  self.can_sign_offline = attributes[:'canSignOffline']
576
585
  end
@@ -976,6 +985,7 @@ module DocuSign_eSign
976
985
  auto_navigation == o.auto_navigation &&
977
986
  auto_responded_reason == o.auto_responded_reason &&
978
987
  bulk_recipients_uri == o.bulk_recipients_uri &&
988
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
979
989
  can_sign_offline == o.can_sign_offline &&
980
990
  client_user_id == o.client_user_id &&
981
991
  completed_count == o.completed_count &&
@@ -1076,7 +1086,7 @@ module DocuSign_eSign
1076
1086
  # Calculates hash code according to all attributes.
1077
1087
  # @return [Fixnum] Hash code
1078
1088
  def hash
1079
- [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, consent_details_list, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, 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, excluded_documents, 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, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, 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, 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, witness_for, witness_for_guid].hash
1089
+ [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, bulk_send_v2_recipient, can_sign_offline, client_user_id, completed_count, consent_details_list, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, 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, excluded_documents, 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, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, 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, 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, witness_for, witness_for_guid].hash
1080
1090
  end
1081
1091
 
1082
1092
  # Builds the object from hash
@@ -32,7 +32,7 @@ module DocuSign_eSign
32
32
  #
33
33
  attr_accessor :email
34
34
 
35
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
35
+ # Array or errors.
36
36
  attr_accessor :error_details
37
37
 
38
38
  #
@@ -32,7 +32,7 @@ module DocuSign_eSign
32
32
  #
33
33
  attr_accessor :created_by_id
34
34
 
35
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
35
+ # Array or errors.
36
36
  attr_accessor :error_details
37
37
 
38
38
  #
@@ -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.
@@ -10,5 +10,5 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
10
10
  =end
11
11
 
12
12
  module DocuSign_eSign
13
- VERSION = '3.21.0'
13
+ VERSION = '3.22.0'
14
14
  end
@@ -106,7 +106,6 @@ require 'docusign_esign/models/bulk_process_result'
106
106
  require 'docusign_esign/models/bulk_processing_list_summaries'
107
107
  require 'docusign_esign/models/bulk_processing_list_summary'
108
108
  require 'docusign_esign/models/bulk_processing_lists'
109
- require 'docusign_esign/models/bulk_recipients_update_response'
110
109
  require 'docusign_esign/models/bulk_send_batch_action_request'
111
110
  require 'docusign_esign/models/bulk_send_batch_error'
112
111
  require 'docusign_esign/models/bulk_send_batch_request'
@@ -178,7 +177,6 @@ require 'docusign_esign/models/correct_view_request'
178
177
  require 'docusign_esign/models/country'
179
178
  require 'docusign_esign/models/credit_card_information'
180
179
  require 'docusign_esign/models/credit_card_types'
181
- require 'docusign_esign/models/currency'
182
180
  require 'docusign_esign/models/currency_feature_set_price'
183
181
  require 'docusign_esign/models/currency_plan_price'
184
182
  require 'docusign_esign/models/custom_field'
@@ -195,6 +193,9 @@ require 'docusign_esign/models/diagnostics_settings_information'
195
193
  require 'docusign_esign/models/direct_debit_processor_information'
196
194
  require 'docusign_esign/models/dob_information_input'
197
195
  require 'docusign_esign/models/doc_gen_form_field'
196
+ require 'docusign_esign/models/doc_gen_form_field_request'
197
+ require 'docusign_esign/models/doc_gen_form_field_response'
198
+ require 'docusign_esign/models/doc_gen_form_fields'
198
199
  require 'docusign_esign/models/doc_gen_syntax_error'
199
200
  require 'docusign_esign/models/document'
200
201
  require 'docusign_esign/models/document_fields_information'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: docusign_esign
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.21.0
4
+ version: 3.22.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - DocuSign
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-02-10 00:00:00.000000000 Z
11
+ date: 2023-03-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jwt
@@ -507,6 +507,9 @@ files:
507
507
  - lib/docusign_esign/models/display_appliance_signer_attachment.rb
508
508
  - lib/docusign_esign/models/dob_information_input.rb
509
509
  - lib/docusign_esign/models/doc_gen_form_field.rb
510
+ - lib/docusign_esign/models/doc_gen_form_field_request.rb
511
+ - lib/docusign_esign/models/doc_gen_form_field_response.rb
512
+ - lib/docusign_esign/models/doc_gen_form_fields.rb
510
513
  - lib/docusign_esign/models/doc_gen_syntax_error.rb
511
514
  - lib/docusign_esign/models/document.rb
512
515
  - lib/docusign_esign/models/document_fields_information.rb