docusign_esign 3.20.0 → 3.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (150) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -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/connect_api.rb +51 -0
  6. data/lib/docusign_esign/api/envelopes_api.rb +132 -65
  7. data/lib/docusign_esign/api/folders_api.rb +8 -0
  8. data/lib/docusign_esign/api/templates_api.rb +0 -130
  9. data/lib/docusign_esign/client/api_client.rb +1 -1
  10. data/lib/docusign_esign/models/account_information.rb +2 -1
  11. data/lib/docusign_esign/models/account_role_settings.rb +2 -0
  12. data/lib/docusign_esign/models/account_settings_information.rb +205 -3
  13. data/lib/docusign_esign/models/account_shared_access.rb +1 -1
  14. data/lib/docusign_esign/models/account_signature.rb +1 -1
  15. data/lib/docusign_esign/models/account_ui_settings.rb +2 -0
  16. data/lib/docusign_esign/models/agent.rb +13 -3
  17. data/lib/docusign_esign/models/approve.rb +2 -1
  18. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  19. data/lib/docusign_esign/models/brand.rb +1 -1
  20. data/lib/docusign_esign/models/bulk_envelope.rb +1 -1
  21. data/lib/docusign_esign/models/bulk_sending_copy.rb +13 -1
  22. data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +12 -2
  23. data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +194 -0
  24. data/lib/docusign_esign/models/captive_recipient.rb +1 -1
  25. data/lib/docusign_esign/models/carbon_copy.rb +13 -3
  26. data/lib/docusign_esign/models/certified_delivery.rb +13 -3
  27. data/lib/docusign_esign/models/checkbox.rb +2 -1
  28. data/lib/docusign_esign/models/cloud_storage_provider.rb +1 -1
  29. data/lib/docusign_esign/models/comment_thread.rb +2 -1
  30. data/lib/docusign_esign/models/commission_county.rb +2 -1
  31. data/lib/docusign_esign/models/commission_expiration.rb +2 -1
  32. data/lib/docusign_esign/models/commission_number.rb +2 -1
  33. data/lib/docusign_esign/models/commission_state.rb +2 -1
  34. data/lib/docusign_esign/models/company.rb +2 -1
  35. data/lib/docusign_esign/models/connect_custom_configuration.rb +11 -1
  36. data/lib/docusign_esign/models/connect_debug_log.rb +1 -1
  37. data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +1 -0
  38. data/lib/docusign_esign/models/contact.rb +12 -2
  39. data/lib/docusign_esign/models/custom_field.rb +1 -1
  40. data/lib/docusign_esign/models/date.rb +2 -1
  41. data/lib/docusign_esign/models/date_signed.rb +2 -1
  42. data/lib/docusign_esign/models/decline.rb +2 -1
  43. data/lib/docusign_esign/models/delayed_routing.rb +1 -1
  44. data/lib/docusign_esign/models/doc_gen_form_field_request.rb +186 -0
  45. data/lib/docusign_esign/models/doc_gen_form_field_response.rb +196 -0
  46. data/lib/docusign_esign/models/doc_gen_form_fields.rb +218 -0
  47. data/lib/docusign_esign/models/document_template.rb +1 -1
  48. data/lib/docusign_esign/models/document_visibility.rb +1 -1
  49. data/lib/docusign_esign/models/draw.rb +2 -1
  50. data/lib/docusign_esign/models/editor.rb +13 -3
  51. data/lib/docusign_esign/models/email.rb +2 -1
  52. data/lib/docusign_esign/models/email_address.rb +2 -1
  53. data/lib/docusign_esign/models/envelope.rb +13 -3
  54. data/lib/docusign_esign/models/envelope_attachment.rb +1 -1
  55. data/lib/docusign_esign/models/envelope_definition.rb +13 -3
  56. data/lib/docusign_esign/models/envelope_document.rb +1 -1
  57. data/lib/docusign_esign/models/envelope_id.rb +2 -1
  58. data/lib/docusign_esign/models/envelope_publish_transaction.rb +1 -0
  59. data/lib/docusign_esign/models/envelope_summary.rb +1 -1
  60. data/lib/docusign_esign/models/envelope_template.rb +13 -3
  61. data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -1
  62. data/lib/docusign_esign/models/envelope_update_summary.rb +1 -1
  63. data/lib/docusign_esign/models/event_notification.rb +11 -1
  64. data/lib/docusign_esign/models/external_folder.rb +1 -1
  65. data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -1
  66. data/lib/docusign_esign/models/favorite_templates_info.rb +1 -1
  67. data/lib/docusign_esign/models/first_name.rb +2 -1
  68. data/lib/docusign_esign/models/folder.rb +1 -1
  69. data/lib/docusign_esign/models/folder_item_v2.rb +1 -1
  70. data/lib/docusign_esign/models/folder_shared_item.rb +1 -1
  71. data/lib/docusign_esign/models/form_data_item.rb +12 -2
  72. data/lib/docusign_esign/models/formula_tab.rb +2 -1
  73. data/lib/docusign_esign/models/full_name.rb +2 -1
  74. data/lib/docusign_esign/models/group.rb +1 -1
  75. data/lib/docusign_esign/models/id_evidence_view_link.rb +3 -3
  76. data/lib/docusign_esign/models/in_person_signer.rb +13 -3
  77. data/lib/docusign_esign/models/initial_here.rb +3 -2
  78. data/lib/docusign_esign/models/inline_template.rb +2 -2
  79. data/lib/docusign_esign/models/intermediary.rb +13 -3
  80. data/lib/docusign_esign/models/jurisdiction_summary.rb +214 -0
  81. data/lib/docusign_esign/models/last_name.rb +2 -1
  82. data/lib/docusign_esign/models/list.rb +2 -1
  83. data/lib/docusign_esign/models/list_custom_field.rb +1 -1
  84. data/lib/docusign_esign/models/locale_policy_tab.rb +14 -4
  85. data/lib/docusign_esign/models/lock_information.rb +1 -1
  86. data/lib/docusign_esign/models/member_group_shared_item.rb +1 -1
  87. data/lib/docusign_esign/models/member_shared_items.rb +1 -1
  88. data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -1
  89. data/lib/docusign_esign/models/name_value.rb +1 -1
  90. data/lib/docusign_esign/models/new_account_definition.rb +2 -2
  91. data/lib/docusign_esign/models/new_user.rb +1 -1
  92. data/lib/docusign_esign/models/notarize.rb +2 -1
  93. data/lib/docusign_esign/models/notary_contact_details.rb +196 -0
  94. data/lib/docusign_esign/models/notary_host.rb +13 -3
  95. data/lib/docusign_esign/models/notary_jurisdiction.rb +1 -1
  96. data/lib/docusign_esign/models/notary_recipient.rb +13 -3
  97. data/lib/docusign_esign/models/notary_seal.rb +2 -1
  98. data/lib/docusign_esign/models/note.rb +2 -1
  99. data/lib/docusign_esign/models/number.rb +2 -1
  100. data/lib/docusign_esign/models/numerical.rb +1346 -0
  101. data/lib/docusign_esign/models/page.rb +1 -1
  102. data/lib/docusign_esign/models/participant.rb +33 -1
  103. data/lib/docusign_esign/models/phone_number.rb +2 -1
  104. data/lib/docusign_esign/models/poly_line_overlay.rb +2 -1
  105. data/lib/docusign_esign/models/power_form.rb +1 -1
  106. data/lib/docusign_esign/models/radio.rb +13 -2
  107. data/lib/docusign_esign/models/recipient_identity_verification.rb +14 -4
  108. data/lib/docusign_esign/models/recipient_update_response.rb +1 -1
  109. data/lib/docusign_esign/models/recipients.rb +1 -1
  110. data/lib/docusign_esign/models/scheduled_sending.rb +1 -1
  111. data/lib/docusign_esign/models/seal_sign.rb +13 -3
  112. data/lib/docusign_esign/models/sender_company.rb +2 -1
  113. data/lib/docusign_esign/models/sender_name.rb +2 -1
  114. data/lib/docusign_esign/models/shared_item.rb +1 -1
  115. data/lib/docusign_esign/models/sign_here.rb +2 -1
  116. data/lib/docusign_esign/models/signer.rb +13 -3
  117. data/lib/docusign_esign/models/signer_attachment.rb +2 -1
  118. data/lib/docusign_esign/models/signing_group.rb +1 -1
  119. data/lib/docusign_esign/models/signing_group_user.rb +1 -1
  120. data/lib/docusign_esign/models/smart_section.rb +4 -3
  121. data/lib/docusign_esign/models/social_account_information.rb +1 -1
  122. data/lib/docusign_esign/models/ssn.rb +2 -1
  123. data/lib/docusign_esign/models/stamp.rb +1 -1
  124. data/lib/docusign_esign/models/tab_account_settings.rb +21 -21
  125. data/lib/docusign_esign/models/tab_group.rb +2 -1
  126. data/lib/docusign_esign/models/tab_metadata.rb +11 -1
  127. data/lib/docusign_esign/models/tabs.rb +13 -13
  128. data/lib/docusign_esign/models/template_recipients.rb +1 -1
  129. data/lib/docusign_esign/models/template_role.rb +12 -2
  130. data/lib/docusign_esign/models/template_shared_item.rb +1 -1
  131. data/lib/docusign_esign/models/template_summary.rb +1 -1
  132. data/lib/docusign_esign/models/template_tabs.rb +13 -13
  133. data/lib/docusign_esign/models/template_update_summary.rb +1 -1
  134. data/lib/docusign_esign/models/text.rb +2 -1
  135. data/lib/docusign_esign/models/text_custom_field.rb +1 -1
  136. data/lib/docusign_esign/models/title.rb +2 -1
  137. data/lib/docusign_esign/models/user_account_management_granular_information.rb +22 -1
  138. data/lib/docusign_esign/models/user_info.rb +12 -2
  139. data/lib/docusign_esign/models/user_information.rb +2 -2
  140. data/lib/docusign_esign/models/user_settings_information.rb +2 -0
  141. data/lib/docusign_esign/models/user_shared_item.rb +1 -1
  142. data/lib/docusign_esign/models/user_signature.rb +1 -1
  143. data/lib/docusign_esign/models/view.rb +2 -1
  144. data/lib/docusign_esign/models/witness.rb +13 -3
  145. data/lib/docusign_esign/models/workspace_user.rb +1 -1
  146. data/lib/docusign_esign/models/workspace_user_authorization.rb +1 -1
  147. data/lib/docusign_esign/models/zip.rb +2 -1
  148. data/lib/docusign_esign/version.rb +1 -1
  149. data/lib/docusign_esign.rb +7 -6
  150. metadata +9 -2
@@ -0,0 +1,196 @@
1
+ =begin
2
+ #DocuSign REST API
3
+
4
+ #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
5
+
6
+ OpenAPI spec version: v2.1
7
+ Contact: devcenter@docusign.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ =end
11
+
12
+ require 'date'
13
+
14
+ module DocuSign_eSign
15
+ class NotaryContactDetails
16
+ #
17
+ attr_accessor :has_docusign_certificate
18
+
19
+ #
20
+ attr_accessor :jurisdictions
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'has_docusign_certificate' => :'hasDocusignCertificate',
26
+ :'jurisdictions' => :'jurisdictions'
27
+ }
28
+ end
29
+
30
+ # Attribute type mapping.
31
+ def self.swagger_types
32
+ {
33
+ :'has_docusign_certificate' => :'String',
34
+ :'jurisdictions' => :'Array<JurisdictionSummary>'
35
+ }
36
+ end
37
+
38
+ # Initializes the object
39
+ # @param [Hash] attributes Model attributes in the form of hash
40
+ def initialize(attributes = {})
41
+ return unless attributes.is_a?(Hash)
42
+
43
+ # convert string to symbol for hash key
44
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
45
+
46
+ if attributes.has_key?(:'hasDocusignCertificate')
47
+ self.has_docusign_certificate = attributes[:'hasDocusignCertificate']
48
+ end
49
+
50
+ if attributes.has_key?(:'jurisdictions')
51
+ if (value = attributes[:'jurisdictions']).is_a?(Array)
52
+ self.jurisdictions = value
53
+ end
54
+ end
55
+ end
56
+
57
+ # Show invalid properties with the reasons. Usually used together with valid?
58
+ # @return Array for valid properties with the reasons
59
+ def list_invalid_properties
60
+ invalid_properties = Array.new
61
+ invalid_properties
62
+ end
63
+
64
+ # Check to see if the all the properties in the model are valid
65
+ # @return true if the model is valid
66
+ def valid?
67
+ true
68
+ end
69
+
70
+ # Checks equality by comparing each attribute.
71
+ # @param [Object] Object to be compared
72
+ def ==(o)
73
+ return true if self.equal?(o)
74
+ self.class == o.class &&
75
+ has_docusign_certificate == o.has_docusign_certificate &&
76
+ jurisdictions == o.jurisdictions
77
+ end
78
+
79
+ # @see the `==` method
80
+ # @param [Object] Object to be compared
81
+ def eql?(o)
82
+ self == o
83
+ end
84
+
85
+ # Calculates hash code according to all attributes.
86
+ # @return [Fixnum] Hash code
87
+ def hash
88
+ [has_docusign_certificate, jurisdictions].hash
89
+ end
90
+
91
+ # Builds the object from hash
92
+ # @param [Hash] attributes Model attributes in the form of hash
93
+ # @return [Object] Returns the model itself
94
+ def build_from_hash(attributes)
95
+ return nil unless attributes.is_a?(Hash)
96
+ self.class.swagger_types.each_pair do |key, type|
97
+ if type =~ /\AArray<(.*)>/i
98
+ # check to ensure the input is an array given that the attribute
99
+ # is documented as an array but the input is not
100
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
101
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
102
+ end
103
+ elsif !attributes[self.class.attribute_map[key]].nil?
104
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
105
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
106
+ end
107
+
108
+ self
109
+ end
110
+
111
+ # Deserializes the data based on type
112
+ # @param string type Data type
113
+ # @param string value Value to be deserialized
114
+ # @return [Object] Deserialized data
115
+ def _deserialize(type, value)
116
+ case type.to_sym
117
+ when :DateTime
118
+ DateTime.parse(value)
119
+ when :Date
120
+ Date.parse(value)
121
+ when :String
122
+ value.to_s
123
+ when :Integer
124
+ value.to_i
125
+ when :Float
126
+ value.to_f
127
+ when :BOOLEAN
128
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
129
+ true
130
+ else
131
+ false
132
+ end
133
+ when :Object
134
+ # generic object (usually a Hash), return directly
135
+ value
136
+ when /\AArray<(?<inner_type>.+)>\z/
137
+ inner_type = Regexp.last_match[:inner_type]
138
+ value.map { |v| _deserialize(inner_type, v) }
139
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
140
+ k_type = Regexp.last_match[:k_type]
141
+ v_type = Regexp.last_match[:v_type]
142
+ {}.tap do |hash|
143
+ value.each do |k, v|
144
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
145
+ end
146
+ end
147
+ else # model
148
+ temp_model = DocuSign_eSign.const_get(type).new
149
+ temp_model.build_from_hash(value)
150
+ end
151
+ end
152
+
153
+ # Returns the string representation of the object
154
+ # @return [String] String presentation of the object
155
+ def to_s
156
+ to_hash.to_s
157
+ end
158
+
159
+ # to_body is an alias to to_hash (backward compatibility)
160
+ # @return [Hash] Returns the object in the form of hash
161
+ def to_body
162
+ to_hash
163
+ end
164
+
165
+ # Returns the object in the form of hash
166
+ # @return [Hash] Returns the object in the form of hash
167
+ def to_hash
168
+ hash = {}
169
+ self.class.attribute_map.each_pair do |attr, param|
170
+ value = self.send(attr)
171
+ next if value.nil?
172
+ hash[param] = _to_hash(value)
173
+ end
174
+ hash
175
+ end
176
+
177
+ # Outputs non-array value in the form of hash
178
+ # For object, use to_hash. Otherwise, just return the value
179
+ # @param [Object] value Any valid value
180
+ # @return [Hash] Returns the value in the form of hash
181
+ def _to_hash(value)
182
+ if value.is_a?(Array)
183
+ value.compact.map { |v| _to_hash(v) }
184
+ elsif value.is_a?(Hash)
185
+ {}.tap do |hash|
186
+ value.each { |k, v| hash[k] = _to_hash(v) }
187
+ end
188
+ elsif value.respond_to? :to_hash
189
+ value.to_hash
190
+ else
191
+ value
192
+ end
193
+ end
194
+
195
+ end
196
+ end
@@ -29,6 +29,9 @@ module DocuSign_eSign
29
29
  #
30
30
  attr_accessor :auto_responded_reason
31
31
 
32
+ #
33
+ attr_accessor :bulk_send_v2_recipient
34
+
32
35
  # 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.
33
36
  attr_accessor :client_user_id
34
37
 
@@ -68,13 +71,13 @@ module DocuSign_eSign
68
71
  # Metadata that indicates whether the `email` property is editable. This property is read-only.
69
72
  attr_accessor :email_metadata
70
73
 
71
- # 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`.
74
+ # 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.
72
75
  attr_accessor :email_notification
73
76
 
74
77
  # 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]]`
75
78
  attr_accessor :embedded_recipient_start_url
76
79
 
77
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
80
+ # Array or errors.
78
81
  attr_accessor :error_details
79
82
 
80
83
  # Reserved:
@@ -214,6 +217,7 @@ module DocuSign_eSign
214
217
  :'add_access_code_to_email' => :'addAccessCodeToEmail',
215
218
  :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
216
219
  :'auto_responded_reason' => :'autoRespondedReason',
220
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
217
221
  :'client_user_id' => :'clientUserId',
218
222
  :'completed_count' => :'completedCount',
219
223
  :'custom_fields' => :'customFields',
@@ -284,6 +288,7 @@ module DocuSign_eSign
284
288
  :'add_access_code_to_email' => :'String',
285
289
  :'allow_system_override_for_locked_recipient' => :'String',
286
290
  :'auto_responded_reason' => :'String',
291
+ :'bulk_send_v2_recipient' => :'String',
287
292
  :'client_user_id' => :'String',
288
293
  :'completed_count' => :'String',
289
294
  :'custom_fields' => :'Array<String>',
@@ -374,6 +379,10 @@ module DocuSign_eSign
374
379
  self.auto_responded_reason = attributes[:'autoRespondedReason']
375
380
  end
376
381
 
382
+ if attributes.has_key?(:'bulkSendV2Recipient')
383
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
384
+ end
385
+
377
386
  if attributes.has_key?(:'clientUserId')
378
387
  self.client_user_id = attributes[:'clientUserId']
379
388
  end
@@ -646,6 +655,7 @@ module DocuSign_eSign
646
655
  add_access_code_to_email == o.add_access_code_to_email &&
647
656
  allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
648
657
  auto_responded_reason == o.auto_responded_reason &&
658
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
649
659
  client_user_id == o.client_user_id &&
650
660
  completed_count == o.completed_count &&
651
661
  custom_fields == o.custom_fields &&
@@ -716,7 +726,7 @@ module DocuSign_eSign
716
726
  # Calculates hash code according to all attributes.
717
727
  # @return [Fixnum] Hash code
718
728
  def hash
719
- [access_code, access_code_metadata, add_access_code_to_email, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, 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, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, host_recipient_id, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, 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, tabs, template_locked, template_required, total_tab_count, user_id].hash
729
+ [access_code, access_code_metadata, add_access_code_to_email, allow_system_override_for_locked_recipient, auto_responded_reason, bulk_send_v2_recipient, client_user_id, completed_count, 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, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, host_recipient_id, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, 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, tabs, template_locked, template_required, total_tab_count, user_id].hash
720
730
  end
721
731
 
722
732
  # Builds the object from hash
@@ -23,7 +23,7 @@ module DocuSign_eSign
23
23
  #
24
24
  attr_accessor :county
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
  # Description of the jurisdiction for this notary. This is a read-only property.
@@ -43,6 +43,9 @@ module DocuSign_eSign
43
43
  # Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.
44
44
  attr_accessor :bulk_recipients_uri
45
45
 
46
+ #
47
+ attr_accessor :bulk_send_v2_recipient
48
+
46
49
  # When set to **true**, specifies that the signer can perform the signing ceremony offline.
47
50
  attr_accessor :can_sign_offline
48
51
 
@@ -100,7 +103,7 @@ module DocuSign_eSign
100
103
  # Metadata that indicates whether the `email` property is editable. This property is read-only.
101
104
  attr_accessor :email_metadata
102
105
 
103
- # 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`.
106
+ # 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.
104
107
  attr_accessor :email_notification
105
108
 
106
109
  #
@@ -109,7 +112,7 @@ module DocuSign_eSign
109
112
  # 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]]`
110
113
  attr_accessor :embedded_recipient_start_url
111
114
 
112
- # This object describes errors that occur. It is only valid for responses and ignored in requests.
115
+ # Array or errors.
113
116
  attr_accessor :error_details
114
117
 
115
118
  # 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.
@@ -329,6 +332,7 @@ module DocuSign_eSign
329
332
  :'auto_navigation' => :'autoNavigation',
330
333
  :'auto_responded_reason' => :'autoRespondedReason',
331
334
  :'bulk_recipients_uri' => :'bulkRecipientsUri',
335
+ :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
332
336
  :'can_sign_offline' => :'canSignOffline',
333
337
  :'client_user_id' => :'clientUserId',
334
338
  :'completed_count' => :'completedCount',
@@ -436,6 +440,7 @@ module DocuSign_eSign
436
440
  :'auto_navigation' => :'String',
437
441
  :'auto_responded_reason' => :'String',
438
442
  :'bulk_recipients_uri' => :'String',
443
+ :'bulk_send_v2_recipient' => :'String',
439
444
  :'can_sign_offline' => :'String',
440
445
  :'client_user_id' => :'String',
441
446
  :'completed_count' => :'String',
@@ -580,6 +585,10 @@ module DocuSign_eSign
580
585
  self.bulk_recipients_uri = attributes[:'bulkRecipientsUri']
581
586
  end
582
587
 
588
+ if attributes.has_key?(:'bulkSendV2Recipient')
589
+ self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
590
+ end
591
+
583
592
  if attributes.has_key?(:'canSignOffline')
584
593
  self.can_sign_offline = attributes[:'canSignOffline']
585
594
  end
@@ -995,6 +1004,7 @@ module DocuSign_eSign
995
1004
  auto_navigation == o.auto_navigation &&
996
1005
  auto_responded_reason == o.auto_responded_reason &&
997
1006
  bulk_recipients_uri == o.bulk_recipients_uri &&
1007
+ bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
998
1008
  can_sign_offline == o.can_sign_offline &&
999
1009
  client_user_id == o.client_user_id &&
1000
1010
  completed_count == o.completed_count &&
@@ -1097,7 +1107,7 @@ module DocuSign_eSign
1097
1107
  # Calculates hash code according to all attributes.
1098
1108
  # @return [Fixnum] Hash code
1099
1109
  def hash
1100
- [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, live_oak_start_url, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, notary_signers, notary_source_type, notary_type, 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].hash
1110
+ [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, live_oak_start_url, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, notary_signers, notary_source_type, notary_type, 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].hash
1101
1111
  end
1102
1112
 
1103
1113
  # 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
  #
@@ -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.
@@ -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.