docusign_esign 3.21.0 → 3.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/lib/docusign_esign/api/accounts_api.rb +511 -4
- data/lib/docusign_esign/api/billing_api.rb +2 -2
- data/lib/docusign_esign/api/envelopes_api.rb +123 -3
- data/lib/docusign_esign/api/templates_api.rb +0 -57
- data/lib/docusign_esign/client/api_client.rb +1 -1
- data/lib/docusign_esign/models/account_information.rb +2 -1
- data/lib/docusign_esign/models/account_role_settings.rb +2 -0
- data/lib/docusign_esign/models/account_settings_information.rb +103 -15
- data/lib/docusign_esign/models/account_shared_access.rb +1 -1
- data/lib/docusign_esign/models/account_signature.rb +1 -1
- data/lib/docusign_esign/models/account_ui_settings.rb +2 -0
- data/lib/docusign_esign/models/agent.rb +13 -3
- data/lib/docusign_esign/models/approve.rb +2 -1
- data/lib/docusign_esign/models/authorization_user.rb +214 -0
- data/lib/docusign_esign/models/billing_charge.rb +1 -1
- data/lib/docusign_esign/models/brand.rb +1 -1
- data/lib/docusign_esign/models/bulk_envelope.rb +1 -1
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +2 -1
- data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +7 -7
- data/lib/docusign_esign/models/captive_recipient.rb +1 -1
- data/lib/docusign_esign/models/carbon_copy.rb +13 -3
- data/lib/docusign_esign/models/certified_delivery.rb +13 -3
- data/lib/docusign_esign/models/checkbox.rb +2 -1
- data/lib/docusign_esign/models/cloud_storage_provider.rb +1 -1
- data/lib/docusign_esign/models/comment_thread.rb +2 -1
- data/lib/docusign_esign/models/commission_county.rb +2 -1
- data/lib/docusign_esign/models/commission_expiration.rb +2 -1
- data/lib/docusign_esign/models/commission_number.rb +2 -1
- data/lib/docusign_esign/models/commission_state.rb +2 -1
- data/lib/docusign_esign/models/company.rb +2 -1
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -1
- data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +1 -0
- data/lib/docusign_esign/models/contact.rb +2 -1
- data/lib/docusign_esign/models/custom_field.rb +1 -1
- data/lib/docusign_esign/models/date.rb +2 -1
- data/lib/docusign_esign/models/date_signed.rb +2 -1
- data/lib/docusign_esign/models/decline.rb +2 -1
- data/lib/docusign_esign/models/delayed_routing.rb +1 -1
- data/lib/docusign_esign/models/delegation_info.rb +12 -12
- data/lib/docusign_esign/models/doc_gen_form_field_request.rb +186 -0
- data/lib/docusign_esign/models/doc_gen_form_field_response.rb +196 -0
- data/lib/docusign_esign/models/doc_gen_form_fields.rb +218 -0
- data/lib/docusign_esign/models/document_template.rb +1 -1
- data/lib/docusign_esign/models/document_visibility.rb +1 -1
- data/lib/docusign_esign/models/draw.rb +2 -1
- data/lib/docusign_esign/models/editor.rb +13 -3
- data/lib/docusign_esign/models/email.rb +2 -1
- data/lib/docusign_esign/models/email_address.rb +2 -1
- data/lib/docusign_esign/models/envelope.rb +2 -2
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -1
- data/lib/docusign_esign/models/envelope_definition.rb +2 -2
- data/lib/docusign_esign/models/envelope_document.rb +1 -1
- data/lib/docusign_esign/models/envelope_id.rb +2 -1
- data/lib/docusign_esign/models/envelope_publish_transaction.rb +1 -0
- data/lib/docusign_esign/models/envelope_summary.rb +1 -1
- data/lib/docusign_esign/models/envelope_template.rb +2 -2
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -1
- data/lib/docusign_esign/models/envelope_update_summary.rb +1 -1
- data/lib/docusign_esign/models/external_folder.rb +1 -1
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -1
- data/lib/docusign_esign/models/favorite_templates_info.rb +1 -1
- data/lib/docusign_esign/models/first_name.rb +2 -1
- data/lib/docusign_esign/models/folder.rb +1 -1
- data/lib/docusign_esign/models/folder_item_v2.rb +1 -1
- data/lib/docusign_esign/models/folder_shared_item.rb +1 -1
- data/lib/docusign_esign/models/form_data_item.rb +12 -2
- data/lib/docusign_esign/models/formula_tab.rb +2 -1
- data/lib/docusign_esign/models/full_name.rb +2 -1
- data/lib/docusign_esign/models/group.rb +1 -1
- data/lib/docusign_esign/models/in_person_signer.rb +13 -3
- data/lib/docusign_esign/models/initial_here.rb +3 -2
- data/lib/docusign_esign/models/inline_template.rb +2 -2
- data/lib/docusign_esign/models/intermediary.rb +13 -3
- data/lib/docusign_esign/models/last_name.rb +2 -1
- data/lib/docusign_esign/models/list.rb +2 -1
- data/lib/docusign_esign/models/list_custom_field.rb +1 -1
- data/lib/docusign_esign/models/lock_information.rb +1 -1
- data/lib/docusign_esign/models/member_group_shared_item.rb +1 -1
- data/lib/docusign_esign/models/member_shared_items.rb +1 -1
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -1
- data/lib/docusign_esign/models/name_value.rb +1 -1
- data/lib/docusign_esign/models/new_account_definition.rb +2 -2
- data/lib/docusign_esign/models/new_user.rb +1 -1
- data/lib/docusign_esign/models/notarize.rb +2 -1
- data/lib/docusign_esign/models/notary_host.rb +13 -3
- data/lib/docusign_esign/models/notary_jurisdiction.rb +1 -1
- data/lib/docusign_esign/models/notary_recipient.rb +13 -3
- data/lib/docusign_esign/models/notary_seal.rb +2 -1
- data/lib/docusign_esign/models/note.rb +2 -1
- data/lib/docusign_esign/models/number.rb +2 -1
- data/lib/docusign_esign/models/numerical.rb +68 -1
- data/lib/docusign_esign/models/page.rb +1 -1
- data/lib/docusign_esign/models/participant.rb +33 -1
- data/lib/docusign_esign/models/phone_number.rb +2 -1
- data/lib/docusign_esign/models/poly_line_overlay.rb +2 -1
- data/lib/docusign_esign/models/power_form.rb +1 -1
- data/lib/docusign_esign/models/radio.rb +13 -2
- data/lib/docusign_esign/models/recipient_form_data.rb +12 -12
- data/lib/docusign_esign/models/recipient_update_response.rb +1 -1
- data/lib/docusign_esign/models/recipients.rb +1 -1
- data/lib/docusign_esign/models/scheduled_sending.rb +1 -1
- data/lib/docusign_esign/models/seal_sign.rb +13 -3
- data/lib/docusign_esign/models/sender_company.rb +2 -1
- data/lib/docusign_esign/models/sender_name.rb +2 -1
- data/lib/docusign_esign/models/shared_item.rb +1 -1
- data/lib/docusign_esign/models/sign_here.rb +2 -1
- data/lib/docusign_esign/models/signer.rb +13 -3
- data/lib/docusign_esign/models/signer_attachment.rb +2 -1
- data/lib/docusign_esign/models/signing_group.rb +1 -1
- data/lib/docusign_esign/models/signing_group_user.rb +1 -1
- data/lib/docusign_esign/models/smart_section.rb +4 -3
- data/lib/docusign_esign/models/social_account_information.rb +1 -1
- data/lib/docusign_esign/models/ssn.rb +2 -1
- data/lib/docusign_esign/models/stamp.rb +1 -1
- data/lib/docusign_esign/models/tab_account_settings.rb +21 -21
- data/lib/docusign_esign/models/tab_group.rb +2 -1
- data/lib/docusign_esign/models/tabs.rb +1 -13
- data/lib/docusign_esign/models/template_recipients.rb +1 -1
- data/lib/docusign_esign/models/template_role.rb +1 -1
- data/lib/docusign_esign/models/template_shared_item.rb +1 -1
- data/lib/docusign_esign/models/template_summary.rb +1 -1
- data/lib/docusign_esign/models/template_tabs.rb +1 -13
- data/lib/docusign_esign/models/template_update_summary.rb +1 -1
- data/lib/docusign_esign/models/text.rb +2 -1
- data/lib/docusign_esign/models/text_custom_field.rb +1 -1
- data/lib/docusign_esign/models/title.rb +2 -1
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +2 -0
- data/lib/docusign_esign/models/user_authorization.rb +274 -0
- data/lib/docusign_esign/models/user_authorization_create_request.rb +214 -0
- data/lib/docusign_esign/models/user_authorization_create_request_with_id.rb +224 -0
- data/lib/docusign_esign/models/user_authorization_id_with_status.rb +204 -0
- data/lib/docusign_esign/models/user_authorization_update_request.rb +194 -0
- data/lib/docusign_esign/models/user_authorization_with_status.rb +204 -0
- data/lib/docusign_esign/models/user_authorizations.rb +246 -0
- data/lib/docusign_esign/models/user_authorizations_delete_request.rb +186 -0
- data/lib/docusign_esign/models/user_authorizations_delete_response.rb +186 -0
- data/lib/docusign_esign/models/user_authorizations_request.rb +186 -0
- data/lib/docusign_esign/models/user_authorizations_response.rb +186 -0
- data/lib/docusign_esign/models/user_info.rb +12 -2
- data/lib/docusign_esign/models/user_information.rb +2 -2
- data/lib/docusign_esign/models/user_settings_information.rb +2 -0
- data/lib/docusign_esign/models/user_shared_item.rb +1 -1
- data/lib/docusign_esign/models/user_signature.rb +1 -1
- data/lib/docusign_esign/models/view.rb +2 -1
- data/lib/docusign_esign/models/witness.rb +13 -3
- data/lib/docusign_esign/models/workspace_user.rb +1 -1
- data/lib/docusign_esign/models/workspace_user_authorization.rb +1 -1
- data/lib/docusign_esign/models/zip.rb +2 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +15 -2
- metadata +17 -2
@@ -0,0 +1,218 @@
|
|
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 DocGenFormFields
|
16
|
+
#
|
17
|
+
attr_accessor :doc_gen_document_status
|
18
|
+
|
19
|
+
#
|
20
|
+
attr_accessor :doc_gen_errors
|
21
|
+
|
22
|
+
#
|
23
|
+
attr_accessor :doc_gen_form_field_list
|
24
|
+
|
25
|
+
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
26
|
+
attr_accessor :document_id
|
27
|
+
|
28
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
29
|
+
def self.attribute_map
|
30
|
+
{
|
31
|
+
:'doc_gen_document_status' => :'docGenDocumentStatus',
|
32
|
+
:'doc_gen_errors' => :'docGenErrors',
|
33
|
+
:'doc_gen_form_field_list' => :'docGenFormFieldList',
|
34
|
+
:'document_id' => :'documentId'
|
35
|
+
}
|
36
|
+
end
|
37
|
+
|
38
|
+
# Attribute type mapping.
|
39
|
+
def self.swagger_types
|
40
|
+
{
|
41
|
+
:'doc_gen_document_status' => :'String',
|
42
|
+
:'doc_gen_errors' => :'Array<DocGenSyntaxError>',
|
43
|
+
:'doc_gen_form_field_list' => :'Array<DocGenFormField>',
|
44
|
+
:'document_id' => :'String'
|
45
|
+
}
|
46
|
+
end
|
47
|
+
|
48
|
+
# Initializes the object
|
49
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
50
|
+
def initialize(attributes = {})
|
51
|
+
return unless attributes.is_a?(Hash)
|
52
|
+
|
53
|
+
# convert string to symbol for hash key
|
54
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
55
|
+
|
56
|
+
if attributes.has_key?(:'docGenDocumentStatus')
|
57
|
+
self.doc_gen_document_status = attributes[:'docGenDocumentStatus']
|
58
|
+
end
|
59
|
+
|
60
|
+
if attributes.has_key?(:'docGenErrors')
|
61
|
+
if (value = attributes[:'docGenErrors']).is_a?(Array)
|
62
|
+
self.doc_gen_errors = value
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
if attributes.has_key?(:'docGenFormFieldList')
|
67
|
+
if (value = attributes[:'docGenFormFieldList']).is_a?(Array)
|
68
|
+
self.doc_gen_form_field_list = value
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.has_key?(:'documentId')
|
73
|
+
self.document_id = attributes[:'documentId']
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
78
|
+
# @return Array for valid properties with the reasons
|
79
|
+
def list_invalid_properties
|
80
|
+
invalid_properties = Array.new
|
81
|
+
invalid_properties
|
82
|
+
end
|
83
|
+
|
84
|
+
# Check to see if the all the properties in the model are valid
|
85
|
+
# @return true if the model is valid
|
86
|
+
def valid?
|
87
|
+
true
|
88
|
+
end
|
89
|
+
|
90
|
+
# Checks equality by comparing each attribute.
|
91
|
+
# @param [Object] Object to be compared
|
92
|
+
def ==(o)
|
93
|
+
return true if self.equal?(o)
|
94
|
+
self.class == o.class &&
|
95
|
+
doc_gen_document_status == o.doc_gen_document_status &&
|
96
|
+
doc_gen_errors == o.doc_gen_errors &&
|
97
|
+
doc_gen_form_field_list == o.doc_gen_form_field_list &&
|
98
|
+
document_id == o.document_id
|
99
|
+
end
|
100
|
+
|
101
|
+
# @see the `==` method
|
102
|
+
# @param [Object] Object to be compared
|
103
|
+
def eql?(o)
|
104
|
+
self == o
|
105
|
+
end
|
106
|
+
|
107
|
+
# Calculates hash code according to all attributes.
|
108
|
+
# @return [Fixnum] Hash code
|
109
|
+
def hash
|
110
|
+
[doc_gen_document_status, doc_gen_errors, doc_gen_form_field_list, document_id].hash
|
111
|
+
end
|
112
|
+
|
113
|
+
# Builds the object from hash
|
114
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
115
|
+
# @return [Object] Returns the model itself
|
116
|
+
def build_from_hash(attributes)
|
117
|
+
return nil unless attributes.is_a?(Hash)
|
118
|
+
self.class.swagger_types.each_pair do |key, type|
|
119
|
+
if type =~ /\AArray<(.*)>/i
|
120
|
+
# check to ensure the input is an array given that the attribute
|
121
|
+
# is documented as an array but the input is not
|
122
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
123
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
124
|
+
end
|
125
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
126
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
127
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
128
|
+
end
|
129
|
+
|
130
|
+
self
|
131
|
+
end
|
132
|
+
|
133
|
+
# Deserializes the data based on type
|
134
|
+
# @param string type Data type
|
135
|
+
# @param string value Value to be deserialized
|
136
|
+
# @return [Object] Deserialized data
|
137
|
+
def _deserialize(type, value)
|
138
|
+
case type.to_sym
|
139
|
+
when :DateTime
|
140
|
+
DateTime.parse(value)
|
141
|
+
when :Date
|
142
|
+
Date.parse(value)
|
143
|
+
when :String
|
144
|
+
value.to_s
|
145
|
+
when :Integer
|
146
|
+
value.to_i
|
147
|
+
when :Float
|
148
|
+
value.to_f
|
149
|
+
when :BOOLEAN
|
150
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
151
|
+
true
|
152
|
+
else
|
153
|
+
false
|
154
|
+
end
|
155
|
+
when :Object
|
156
|
+
# generic object (usually a Hash), return directly
|
157
|
+
value
|
158
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
159
|
+
inner_type = Regexp.last_match[:inner_type]
|
160
|
+
value.map { |v| _deserialize(inner_type, v) }
|
161
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
162
|
+
k_type = Regexp.last_match[:k_type]
|
163
|
+
v_type = Regexp.last_match[:v_type]
|
164
|
+
{}.tap do |hash|
|
165
|
+
value.each do |k, v|
|
166
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
167
|
+
end
|
168
|
+
end
|
169
|
+
else # model
|
170
|
+
temp_model = DocuSign_eSign.const_get(type).new
|
171
|
+
temp_model.build_from_hash(value)
|
172
|
+
end
|
173
|
+
end
|
174
|
+
|
175
|
+
# Returns the string representation of the object
|
176
|
+
# @return [String] String presentation of the object
|
177
|
+
def to_s
|
178
|
+
to_hash.to_s
|
179
|
+
end
|
180
|
+
|
181
|
+
# to_body is an alias to to_hash (backward compatibility)
|
182
|
+
# @return [Hash] Returns the object in the form of hash
|
183
|
+
def to_body
|
184
|
+
to_hash
|
185
|
+
end
|
186
|
+
|
187
|
+
# Returns the object in the form of hash
|
188
|
+
# @return [Hash] Returns the object in the form of hash
|
189
|
+
def to_hash
|
190
|
+
hash = {}
|
191
|
+
self.class.attribute_map.each_pair do |attr, param|
|
192
|
+
value = self.send(attr)
|
193
|
+
next if value.nil?
|
194
|
+
hash[param] = _to_hash(value)
|
195
|
+
end
|
196
|
+
hash
|
197
|
+
end
|
198
|
+
|
199
|
+
# Outputs non-array value in the form of hash
|
200
|
+
# For object, use to_hash. Otherwise, just return the value
|
201
|
+
# @param [Object] value Any valid value
|
202
|
+
# @return [Hash] Returns the value in the form of hash
|
203
|
+
def _to_hash(value)
|
204
|
+
if value.is_a?(Array)
|
205
|
+
value.compact.map { |v| _to_hash(v) }
|
206
|
+
elsif value.is_a?(Hash)
|
207
|
+
{}.tap do |hash|
|
208
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
209
|
+
end
|
210
|
+
elsif value.respond_to? :to_hash
|
211
|
+
value.to_hash
|
212
|
+
else
|
213
|
+
value
|
214
|
+
end
|
215
|
+
end
|
216
|
+
|
217
|
+
end
|
218
|
+
end
|
@@ -22,7 +22,7 @@ module DocuSign_eSign
|
|
22
22
|
#
|
23
23
|
attr_accessor :document_start_page
|
24
24
|
|
25
|
-
#
|
25
|
+
# Array or errors.
|
26
26
|
attr_accessor :error_details
|
27
27
|
|
28
28
|
# The unique identifier of the template. If this is not provided, DocuSign will generate a value.
|
@@ -17,7 +17,7 @@ module DocuSign_eSign
|
|
17
17
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
18
18
|
attr_accessor :document_id
|
19
19
|
|
20
|
-
#
|
20
|
+
# Array or errors.
|
21
21
|
attr_accessor :error_details
|
22
22
|
|
23
23
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -80,6 +80,7 @@ module DocuSign_eSign
|
|
80
80
|
#
|
81
81
|
attr_accessor :caption
|
82
82
|
|
83
|
+
#
|
83
84
|
attr_accessor :caption_metadata
|
84
85
|
|
85
86
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
@@ -106,7 +107,7 @@ module DocuSign_eSign
|
|
106
107
|
# Metadata that indicates whether the `documentId` property is editable.
|
107
108
|
attr_accessor :document_id_metadata
|
108
109
|
|
109
|
-
#
|
110
|
+
# Array or errors.
|
110
111
|
attr_accessor :error_details
|
111
112
|
|
112
113
|
#
|
@@ -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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
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
|
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
|
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.
|
@@ -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
|
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
|
-
#
|
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.
|
@@ -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
|
-
#
|
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.
|
@@ -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
|
-
#
|
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
|
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
|
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
|
-
#
|
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
|
-
#
|
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
|
-
#
|
19
|
+
# Array or errors.
|
20
20
|
attr_accessor :error_details
|
21
21
|
|
22
22
|
#
|
@@ -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
|
-
#
|
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
|
-
#
|
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
|
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 FormDataItem
|
16
|
-
#
|
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
|