docusign_esign 3.15.0 → 3.18.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 +21 -0
- data/lib/docusign_esign/api/accounts_api.rb +15 -66
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +12 -4
- data/lib/docusign_esign/api/envelopes_api.rb +116 -140
- data/lib/docusign_esign/api/power_forms_api.rb +8 -0
- data/lib/docusign_esign/api/templates_api.rb +0 -59
- data/lib/docusign_esign/api/users_api.rb +4 -0
- data/lib/docusign_esign/client/api_client.rb +1 -1
- data/lib/docusign_esign/models/account_information.rb +10 -1
- data/lib/docusign_esign/models/account_role_settings.rb +42 -4
- data/lib/docusign_esign/models/account_settings_information.rb +222 -19
- data/lib/docusign_esign/models/account_ui_settings.rb +13 -13
- data/lib/docusign_esign/models/agent.rb +13 -1
- data/lib/docusign_esign/models/approve.rb +20 -1
- data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
- data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
- data/lib/docusign_esign/models/billing_plan_information.rb +21 -1
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +11 -1
- data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +101 -1
- data/lib/docusign_esign/models/bulk_send_error_status.rb +11 -1
- data/lib/docusign_esign/models/carbon_copy.rb +13 -1
- data/lib/docusign_esign/models/certified_delivery.rb +13 -1
- data/lib/docusign_esign/models/checkbox.rb +20 -1
- data/lib/docusign_esign/models/comment_thread.rb +20 -1
- data/lib/docusign_esign/models/commission_county.rb +20 -1
- data/lib/docusign_esign/models/commission_expiration.rb +20 -1
- data/lib/docusign_esign/models/commission_number.rb +20 -1
- data/lib/docusign_esign/models/commission_state.rb +20 -1
- data/lib/docusign_esign/models/company.rb +20 -1
- data/lib/docusign_esign/models/connect_custom_configuration.rb +33 -1
- data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +195 -0
- data/lib/docusign_esign/models/consent_details.rb +204 -0
- data/lib/docusign_esign/models/currency.rb +20 -1
- data/lib/docusign_esign/models/date.rb +20 -1
- data/lib/docusign_esign/models/date_signed.rb +20 -1
- data/lib/docusign_esign/models/decline.rb +20 -1
- data/lib/docusign_esign/models/delayed_routing.rb +206 -0
- data/lib/docusign_esign/models/draw.rb +20 -1
- data/lib/docusign_esign/models/editor.rb +13 -1
- data/lib/docusign_esign/models/email.rb +20 -1
- data/lib/docusign_esign/models/email_address.rb +20 -1
- data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
- data/lib/docusign_esign/models/envelope_id.rb +20 -1
- data/lib/docusign_esign/models/envelope_publish_transaction.rb +307 -0
- data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -0
- data/lib/docusign_esign/models/first_name.rb +20 -1
- data/lib/docusign_esign/models/formula_tab.rb +20 -1
- data/lib/docusign_esign/models/full_name.rb +20 -1
- data/lib/docusign_esign/models/id_evidence_resource_token.rb +194 -0
- data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
- data/lib/docusign_esign/models/initial_here.rb +20 -1
- data/lib/docusign_esign/models/intermediary.rb +13 -1
- data/lib/docusign_esign/models/last_name.rb +20 -1
- data/lib/docusign_esign/models/linked_external_primary_account.rb +11 -1
- data/lib/docusign_esign/models/list.rb +20 -1
- data/lib/docusign_esign/models/new_account_definition.rb +21 -1
- data/lib/docusign_esign/models/notarize.rb +20 -1
- data/lib/docusign_esign/models/notary_recipient.rb +23 -1
- data/lib/docusign_esign/models/notary_seal.rb +20 -1
- data/lib/docusign_esign/models/note.rb +20 -1
- data/lib/docusign_esign/models/number.rb +20 -1
- data/lib/docusign_esign/models/participant.rb +908 -0
- data/lib/docusign_esign/models/phone_number.rb +20 -1
- data/lib/docusign_esign/models/poly_line_overlay.rb +20 -1
- data/lib/docusign_esign/models/prefill_tabs.rb +64 -4
- data/lib/docusign_esign/models/radio.rb +20 -1
- data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +102 -2
- data/lib/docusign_esign/models/recipients.rb +13 -1
- data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
- data/lib/docusign_esign/models/sender_company.rb +20 -1
- data/lib/docusign_esign/models/sender_name.rb +20 -1
- data/lib/docusign_esign/models/sign_here.rb +20 -1
- data/lib/docusign_esign/models/signer.rb +13 -1
- data/lib/docusign_esign/models/signer_attachment.rb +20 -1
- data/lib/docusign_esign/models/smart_section.rb +20 -1
- data/lib/docusign_esign/models/ssn.rb +20 -1
- data/lib/docusign_esign/models/tab_group.rb +20 -1
- data/lib/docusign_esign/models/template_recipients.rb +13 -1
- data/lib/docusign_esign/models/text.rb +20 -1
- data/lib/docusign_esign/models/title.rb +20 -1
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +20 -1
- data/lib/docusign_esign/models/user_information.rb +11 -1
- data/lib/docusign_esign/models/user_settings_information.rb +42 -4
- data/lib/docusign_esign/models/view.rb +20 -1
- data/lib/docusign_esign/models/witness.rb +13 -1
- data/lib/docusign_esign/models/workflow.rb +12 -2
- data/lib/docusign_esign/models/workflow_step.rb +1 -1
- data/lib/docusign_esign/models/zip.rb +20 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +10 -8
- data/tests/spec/unit_tests_using_jwt_spec.rb +4 -4
- metadata +16 -6
@@ -68,6 +68,11 @@ module DocuSign_eSign
|
|
68
68
|
|
69
69
|
attr_accessor :bold_metadata
|
70
70
|
|
71
|
+
#
|
72
|
+
attr_accessor :caption
|
73
|
+
|
74
|
+
attr_accessor :caption_metadata
|
75
|
+
|
71
76
|
# 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.
|
72
77
|
attr_accessor :conceal_value_on_document
|
73
78
|
|
@@ -287,6 +292,8 @@ module DocuSign_eSign
|
|
287
292
|
:'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
|
288
293
|
:'bold' => :'bold',
|
289
294
|
:'bold_metadata' => :'boldMetadata',
|
295
|
+
:'caption' => :'caption',
|
296
|
+
:'caption_metadata' => :'captionMetadata',
|
290
297
|
:'conceal_value_on_document' => :'concealValueOnDocument',
|
291
298
|
:'conceal_value_on_document_metadata' => :'concealValueOnDocumentMetadata',
|
292
299
|
:'conditional_parent_label' => :'conditionalParentLabel',
|
@@ -393,6 +400,8 @@ module DocuSign_eSign
|
|
393
400
|
:'anchor_y_offset_metadata' => :'PropertyMetadata',
|
394
401
|
:'bold' => :'String',
|
395
402
|
:'bold_metadata' => :'PropertyMetadata',
|
403
|
+
:'caption' => :'String',
|
404
|
+
:'caption_metadata' => :'PropertyMetadata',
|
396
405
|
:'conceal_value_on_document' => :'String',
|
397
406
|
:'conceal_value_on_document_metadata' => :'PropertyMetadata',
|
398
407
|
:'conditional_parent_label' => :'String',
|
@@ -570,6 +579,14 @@ module DocuSign_eSign
|
|
570
579
|
self.bold_metadata = attributes[:'boldMetadata']
|
571
580
|
end
|
572
581
|
|
582
|
+
if attributes.has_key?(:'caption')
|
583
|
+
self.caption = attributes[:'caption']
|
584
|
+
end
|
585
|
+
|
586
|
+
if attributes.has_key?(:'captionMetadata')
|
587
|
+
self.caption_metadata = attributes[:'captionMetadata']
|
588
|
+
end
|
589
|
+
|
573
590
|
if attributes.has_key?(:'concealValueOnDocument')
|
574
591
|
self.conceal_value_on_document = attributes[:'concealValueOnDocument']
|
575
592
|
end
|
@@ -925,6 +942,8 @@ module DocuSign_eSign
|
|
925
942
|
anchor_y_offset_metadata == o.anchor_y_offset_metadata &&
|
926
943
|
bold == o.bold &&
|
927
944
|
bold_metadata == o.bold_metadata &&
|
945
|
+
caption == o.caption &&
|
946
|
+
caption_metadata == o.caption_metadata &&
|
928
947
|
conceal_value_on_document == o.conceal_value_on_document &&
|
929
948
|
conceal_value_on_document_metadata == o.conceal_value_on_document_metadata &&
|
930
949
|
conditional_parent_label == o.conditional_parent_label &&
|
@@ -1014,7 +1033,7 @@ module DocuSign_eSign
|
|
1014
1033
|
# Calculates hash code according to all attributes.
|
1015
1034
|
# @return [Fixnum] Hash code
|
1016
1035
|
def hash
|
1017
|
-
[anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, merge_field, merge_field_xml, name, name_metadata, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, required, required_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
1036
|
+
[anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, caption, caption_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, merge_field, merge_field_xml, name, name_metadata, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, required, required_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
1018
1037
|
end
|
1019
1038
|
|
1020
1039
|
# Builds the object from hash
|
@@ -22,6 +22,9 @@ module DocuSign_eSign
|
|
22
22
|
# When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.
|
23
23
|
attr_accessor :all_users
|
24
24
|
|
25
|
+
#
|
26
|
+
attr_accessor :all_users_except
|
27
|
+
|
25
28
|
# If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.
|
26
29
|
attr_accessor :configuration_type
|
27
30
|
|
@@ -31,6 +34,9 @@ module DocuSign_eSign
|
|
31
34
|
#
|
32
35
|
attr_accessor :delivery_mode
|
33
36
|
|
37
|
+
#
|
38
|
+
attr_accessor :disabled_by
|
39
|
+
|
34
40
|
# This turns Connect logging on or off. When set to **true**, logging is turned on.
|
35
41
|
attr_accessor :enable_log
|
36
42
|
|
@@ -48,6 +54,9 @@ module DocuSign_eSign
|
|
48
54
|
#
|
49
55
|
attr_accessor :external_folder_label
|
50
56
|
|
57
|
+
#
|
58
|
+
attr_accessor :group_ids
|
59
|
+
|
51
60
|
# When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes.
|
52
61
|
attr_accessor :include_certificate_of_completion
|
53
62
|
|
@@ -132,15 +141,18 @@ module DocuSign_eSign
|
|
132
141
|
:'allow_envelope_publish' => :'allowEnvelopePublish',
|
133
142
|
:'allow_salesforce_publish' => :'allowSalesforcePublish',
|
134
143
|
:'all_users' => :'allUsers',
|
144
|
+
:'all_users_except' => :'allUsersExcept',
|
135
145
|
:'configuration_type' => :'configurationType',
|
136
146
|
:'connect_id' => :'connectId',
|
137
147
|
:'delivery_mode' => :'deliveryMode',
|
148
|
+
:'disabled_by' => :'disabledBy',
|
138
149
|
:'enable_log' => :'enableLog',
|
139
150
|
:'envelope_events' => :'envelopeEvents',
|
140
151
|
:'event_data' => :'eventData',
|
141
152
|
:'events' => :'events',
|
142
153
|
:'external_folder_id' => :'externalFolderId',
|
143
154
|
:'external_folder_label' => :'externalFolderLabel',
|
155
|
+
:'group_ids' => :'groupIds',
|
144
156
|
:'include_certificate_of_completion' => :'includeCertificateOfCompletion',
|
145
157
|
:'include_cert_soap_header' => :'includeCertSoapHeader',
|
146
158
|
:'include_document_fields' => :'includeDocumentFields',
|
@@ -176,15 +188,18 @@ module DocuSign_eSign
|
|
176
188
|
:'allow_envelope_publish' => :'String',
|
177
189
|
:'allow_salesforce_publish' => :'String',
|
178
190
|
:'all_users' => :'String',
|
191
|
+
:'all_users_except' => :'String',
|
179
192
|
:'configuration_type' => :'String',
|
180
193
|
:'connect_id' => :'String',
|
181
194
|
:'delivery_mode' => :'String',
|
195
|
+
:'disabled_by' => :'String',
|
182
196
|
:'enable_log' => :'String',
|
183
197
|
:'envelope_events' => :'Array<String>',
|
184
198
|
:'event_data' => :'ConnectEventData',
|
185
199
|
:'events' => :'Array<String>',
|
186
200
|
:'external_folder_id' => :'String',
|
187
201
|
:'external_folder_label' => :'String',
|
202
|
+
:'group_ids' => :'Array<String>',
|
188
203
|
:'include_certificate_of_completion' => :'String',
|
189
204
|
:'include_cert_soap_header' => :'String',
|
190
205
|
:'include_document_fields' => :'String',
|
@@ -234,6 +249,10 @@ module DocuSign_eSign
|
|
234
249
|
self.all_users = attributes[:'allUsers']
|
235
250
|
end
|
236
251
|
|
252
|
+
if attributes.has_key?(:'allUsersExcept')
|
253
|
+
self.all_users_except = attributes[:'allUsersExcept']
|
254
|
+
end
|
255
|
+
|
237
256
|
if attributes.has_key?(:'configurationType')
|
238
257
|
self.configuration_type = attributes[:'configurationType']
|
239
258
|
end
|
@@ -246,6 +265,10 @@ module DocuSign_eSign
|
|
246
265
|
self.delivery_mode = attributes[:'deliveryMode']
|
247
266
|
end
|
248
267
|
|
268
|
+
if attributes.has_key?(:'disabledBy')
|
269
|
+
self.disabled_by = attributes[:'disabledBy']
|
270
|
+
end
|
271
|
+
|
249
272
|
if attributes.has_key?(:'enableLog')
|
250
273
|
self.enable_log = attributes[:'enableLog']
|
251
274
|
end
|
@@ -274,6 +297,12 @@ module DocuSign_eSign
|
|
274
297
|
self.external_folder_label = attributes[:'externalFolderLabel']
|
275
298
|
end
|
276
299
|
|
300
|
+
if attributes.has_key?(:'groupIds')
|
301
|
+
if (value = attributes[:'groupIds']).is_a?(Array)
|
302
|
+
self.group_ids = value
|
303
|
+
end
|
304
|
+
end
|
305
|
+
|
277
306
|
if attributes.has_key?(:'includeCertificateOfCompletion')
|
278
307
|
self.include_certificate_of_completion = attributes[:'includeCertificateOfCompletion']
|
279
308
|
end
|
@@ -408,15 +437,18 @@ module DocuSign_eSign
|
|
408
437
|
allow_envelope_publish == o.allow_envelope_publish &&
|
409
438
|
allow_salesforce_publish == o.allow_salesforce_publish &&
|
410
439
|
all_users == o.all_users &&
|
440
|
+
all_users_except == o.all_users_except &&
|
411
441
|
configuration_type == o.configuration_type &&
|
412
442
|
connect_id == o.connect_id &&
|
413
443
|
delivery_mode == o.delivery_mode &&
|
444
|
+
disabled_by == o.disabled_by &&
|
414
445
|
enable_log == o.enable_log &&
|
415
446
|
envelope_events == o.envelope_events &&
|
416
447
|
event_data == o.event_data &&
|
417
448
|
events == o.events &&
|
418
449
|
external_folder_id == o.external_folder_id &&
|
419
450
|
external_folder_label == o.external_folder_label &&
|
451
|
+
group_ids == o.group_ids &&
|
420
452
|
include_certificate_of_completion == o.include_certificate_of_completion &&
|
421
453
|
include_cert_soap_header == o.include_cert_soap_header &&
|
422
454
|
include_document_fields == o.include_document_fields &&
|
@@ -454,7 +486,7 @@ module DocuSign_eSign
|
|
454
486
|
# Calculates hash code according to all attributes.
|
455
487
|
# @return [Fixnum] Hash code
|
456
488
|
def hash
|
457
|
-
[allow_envelope_publish, allow_salesforce_publish, all_users, configuration_type, connect_id, delivery_mode, enable_log, envelope_events, event_data, events, external_folder_id, external_folder_label, include_certificate_of_completion, include_cert_soap_header, include_document_fields, include_documents, include_envelope_void_reason, include_hmac, include_sender_accountas_custom_field, include_time_zone_information, name, password, recipient_events, require_mutual_tls, requires_acknowledgement, salesforce_api_version, salesforce_authcode, salesforce_call_back_url, salesforce_documents_as_content_files, sender_override, sender_selectable_items, sf_objects, sign_message_with_x509_certificate, soap_namespace, url_to_publish_to, user_ids, user_name, use_soap_interface].hash
|
489
|
+
[allow_envelope_publish, allow_salesforce_publish, all_users, all_users_except, configuration_type, connect_id, delivery_mode, disabled_by, enable_log, envelope_events, event_data, events, external_folder_id, external_folder_label, group_ids, include_certificate_of_completion, include_cert_soap_header, include_document_fields, include_documents, include_envelope_void_reason, include_hmac, include_sender_accountas_custom_field, include_time_zone_information, name, password, recipient_events, require_mutual_tls, requires_acknowledgement, salesforce_api_version, salesforce_authcode, salesforce_call_back_url, salesforce_documents_as_content_files, sender_override, sender_selectable_items, sf_objects, sign_message_with_x509_certificate, soap_namespace, url_to_publish_to, user_ids, user_name, use_soap_interface].hash
|
458
490
|
end
|
459
491
|
|
460
492
|
# Builds the object from hash
|
@@ -0,0 +1,195 @@
|
|
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 ConnectHistoricalEnvelopeRepublish
|
16
|
+
attr_accessor :config
|
17
|
+
|
18
|
+
#
|
19
|
+
attr_accessor :envelopes
|
20
|
+
|
21
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
22
|
+
def self.attribute_map
|
23
|
+
{
|
24
|
+
:'config' => :'config',
|
25
|
+
:'envelopes' => :'envelopes'
|
26
|
+
}
|
27
|
+
end
|
28
|
+
|
29
|
+
# Attribute type mapping.
|
30
|
+
def self.swagger_types
|
31
|
+
{
|
32
|
+
:'config' => :'ConnectCustomConfiguration',
|
33
|
+
:'envelopes' => :'Array<String>'
|
34
|
+
}
|
35
|
+
end
|
36
|
+
|
37
|
+
# Initializes the object
|
38
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
39
|
+
def initialize(attributes = {})
|
40
|
+
return unless attributes.is_a?(Hash)
|
41
|
+
|
42
|
+
# convert string to symbol for hash key
|
43
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
44
|
+
|
45
|
+
if attributes.has_key?(:'config')
|
46
|
+
self.config = attributes[:'config']
|
47
|
+
end
|
48
|
+
|
49
|
+
if attributes.has_key?(:'envelopes')
|
50
|
+
if (value = attributes[:'envelopes']).is_a?(Array)
|
51
|
+
self.envelopes = value
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
57
|
+
# @return Array for valid properties with the reasons
|
58
|
+
def list_invalid_properties
|
59
|
+
invalid_properties = Array.new
|
60
|
+
invalid_properties
|
61
|
+
end
|
62
|
+
|
63
|
+
# Check to see if the all the properties in the model are valid
|
64
|
+
# @return true if the model is valid
|
65
|
+
def valid?
|
66
|
+
true
|
67
|
+
end
|
68
|
+
|
69
|
+
# Checks equality by comparing each attribute.
|
70
|
+
# @param [Object] Object to be compared
|
71
|
+
def ==(o)
|
72
|
+
return true if self.equal?(o)
|
73
|
+
self.class == o.class &&
|
74
|
+
config == o.config &&
|
75
|
+
envelopes == o.envelopes
|
76
|
+
end
|
77
|
+
|
78
|
+
# @see the `==` method
|
79
|
+
# @param [Object] Object to be compared
|
80
|
+
def eql?(o)
|
81
|
+
self == o
|
82
|
+
end
|
83
|
+
|
84
|
+
# Calculates hash code according to all attributes.
|
85
|
+
# @return [Fixnum] Hash code
|
86
|
+
def hash
|
87
|
+
[config, envelopes].hash
|
88
|
+
end
|
89
|
+
|
90
|
+
# Builds the object from hash
|
91
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
92
|
+
# @return [Object] Returns the model itself
|
93
|
+
def build_from_hash(attributes)
|
94
|
+
return nil unless attributes.is_a?(Hash)
|
95
|
+
self.class.swagger_types.each_pair do |key, type|
|
96
|
+
if type =~ /\AArray<(.*)>/i
|
97
|
+
# check to ensure the input is an array given that the attribute
|
98
|
+
# is documented as an array but the input is not
|
99
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
100
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
101
|
+
end
|
102
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
103
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
104
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
105
|
+
end
|
106
|
+
|
107
|
+
self
|
108
|
+
end
|
109
|
+
|
110
|
+
# Deserializes the data based on type
|
111
|
+
# @param string type Data type
|
112
|
+
# @param string value Value to be deserialized
|
113
|
+
# @return [Object] Deserialized data
|
114
|
+
def _deserialize(type, value)
|
115
|
+
case type.to_sym
|
116
|
+
when :DateTime
|
117
|
+
DateTime.parse(value)
|
118
|
+
when :Date
|
119
|
+
Date.parse(value)
|
120
|
+
when :String
|
121
|
+
value.to_s
|
122
|
+
when :Integer
|
123
|
+
value.to_i
|
124
|
+
when :Float
|
125
|
+
value.to_f
|
126
|
+
when :BOOLEAN
|
127
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
128
|
+
true
|
129
|
+
else
|
130
|
+
false
|
131
|
+
end
|
132
|
+
when :Object
|
133
|
+
# generic object (usually a Hash), return directly
|
134
|
+
value
|
135
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
136
|
+
inner_type = Regexp.last_match[:inner_type]
|
137
|
+
value.map { |v| _deserialize(inner_type, v) }
|
138
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
139
|
+
k_type = Regexp.last_match[:k_type]
|
140
|
+
v_type = Regexp.last_match[:v_type]
|
141
|
+
{}.tap do |hash|
|
142
|
+
value.each do |k, v|
|
143
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
144
|
+
end
|
145
|
+
end
|
146
|
+
else # model
|
147
|
+
temp_model = DocuSign_eSign.const_get(type).new
|
148
|
+
temp_model.build_from_hash(value)
|
149
|
+
end
|
150
|
+
end
|
151
|
+
|
152
|
+
# Returns the string representation of the object
|
153
|
+
# @return [String] String presentation of the object
|
154
|
+
def to_s
|
155
|
+
to_hash.to_s
|
156
|
+
end
|
157
|
+
|
158
|
+
# to_body is an alias to to_hash (backward compatibility)
|
159
|
+
# @return [Hash] Returns the object in the form of hash
|
160
|
+
def to_body
|
161
|
+
to_hash
|
162
|
+
end
|
163
|
+
|
164
|
+
# Returns the object in the form of hash
|
165
|
+
# @return [Hash] Returns the object in the form of hash
|
166
|
+
def to_hash
|
167
|
+
hash = {}
|
168
|
+
self.class.attribute_map.each_pair do |attr, param|
|
169
|
+
value = self.send(attr)
|
170
|
+
next if value.nil?
|
171
|
+
hash[param] = _to_hash(value)
|
172
|
+
end
|
173
|
+
hash
|
174
|
+
end
|
175
|
+
|
176
|
+
# Outputs non-array value in the form of hash
|
177
|
+
# For object, use to_hash. Otherwise, just return the value
|
178
|
+
# @param [Object] value Any valid value
|
179
|
+
# @return [Hash] Returns the value in the form of hash
|
180
|
+
def _to_hash(value)
|
181
|
+
if value.is_a?(Array)
|
182
|
+
value.compact.map { |v| _to_hash(v) }
|
183
|
+
elsif value.is_a?(Hash)
|
184
|
+
{}.tap do |hash|
|
185
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
186
|
+
end
|
187
|
+
elsif value.respond_to? :to_hash
|
188
|
+
value.to_hash
|
189
|
+
else
|
190
|
+
value
|
191
|
+
end
|
192
|
+
end
|
193
|
+
|
194
|
+
end
|
195
|
+
end
|
@@ -0,0 +1,204 @@
|
|
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 ConsentDetails
|
16
|
+
#
|
17
|
+
attr_accessor :consent_key
|
18
|
+
|
19
|
+
# Reserved: For DocuSign use only.
|
20
|
+
attr_accessor :delivery_method
|
21
|
+
|
22
|
+
#
|
23
|
+
attr_accessor :signer_consent_status
|
24
|
+
|
25
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
26
|
+
def self.attribute_map
|
27
|
+
{
|
28
|
+
:'consent_key' => :'consentKey',
|
29
|
+
:'delivery_method' => :'deliveryMethod',
|
30
|
+
:'signer_consent_status' => :'signerConsentStatus'
|
31
|
+
}
|
32
|
+
end
|
33
|
+
|
34
|
+
# Attribute type mapping.
|
35
|
+
def self.swagger_types
|
36
|
+
{
|
37
|
+
:'consent_key' => :'String',
|
38
|
+
:'delivery_method' => :'String',
|
39
|
+
:'signer_consent_status' => :'String'
|
40
|
+
}
|
41
|
+
end
|
42
|
+
|
43
|
+
# Initializes the object
|
44
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
45
|
+
def initialize(attributes = {})
|
46
|
+
return unless attributes.is_a?(Hash)
|
47
|
+
|
48
|
+
# convert string to symbol for hash key
|
49
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
50
|
+
|
51
|
+
if attributes.has_key?(:'consentKey')
|
52
|
+
self.consent_key = attributes[:'consentKey']
|
53
|
+
end
|
54
|
+
|
55
|
+
if attributes.has_key?(:'deliveryMethod')
|
56
|
+
self.delivery_method = attributes[:'deliveryMethod']
|
57
|
+
end
|
58
|
+
|
59
|
+
if attributes.has_key?(:'signerConsentStatus')
|
60
|
+
self.signer_consent_status = attributes[:'signerConsentStatus']
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
65
|
+
# @return Array for valid properties with the reasons
|
66
|
+
def list_invalid_properties
|
67
|
+
invalid_properties = Array.new
|
68
|
+
invalid_properties
|
69
|
+
end
|
70
|
+
|
71
|
+
# Check to see if the all the properties in the model are valid
|
72
|
+
# @return true if the model is valid
|
73
|
+
def valid?
|
74
|
+
true
|
75
|
+
end
|
76
|
+
|
77
|
+
# Checks equality by comparing each attribute.
|
78
|
+
# @param [Object] Object to be compared
|
79
|
+
def ==(o)
|
80
|
+
return true if self.equal?(o)
|
81
|
+
self.class == o.class &&
|
82
|
+
consent_key == o.consent_key &&
|
83
|
+
delivery_method == o.delivery_method &&
|
84
|
+
signer_consent_status == o.signer_consent_status
|
85
|
+
end
|
86
|
+
|
87
|
+
# @see the `==` method
|
88
|
+
# @param [Object] Object to be compared
|
89
|
+
def eql?(o)
|
90
|
+
self == o
|
91
|
+
end
|
92
|
+
|
93
|
+
# Calculates hash code according to all attributes.
|
94
|
+
# @return [Fixnum] Hash code
|
95
|
+
def hash
|
96
|
+
[consent_key, delivery_method, signer_consent_status].hash
|
97
|
+
end
|
98
|
+
|
99
|
+
# Builds the object from hash
|
100
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
101
|
+
# @return [Object] Returns the model itself
|
102
|
+
def build_from_hash(attributes)
|
103
|
+
return nil unless attributes.is_a?(Hash)
|
104
|
+
self.class.swagger_types.each_pair do |key, type|
|
105
|
+
if type =~ /\AArray<(.*)>/i
|
106
|
+
# check to ensure the input is an array given that the attribute
|
107
|
+
# is documented as an array but the input is not
|
108
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
109
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
110
|
+
end
|
111
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
112
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
113
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
114
|
+
end
|
115
|
+
|
116
|
+
self
|
117
|
+
end
|
118
|
+
|
119
|
+
# Deserializes the data based on type
|
120
|
+
# @param string type Data type
|
121
|
+
# @param string value Value to be deserialized
|
122
|
+
# @return [Object] Deserialized data
|
123
|
+
def _deserialize(type, value)
|
124
|
+
case type.to_sym
|
125
|
+
when :DateTime
|
126
|
+
DateTime.parse(value)
|
127
|
+
when :Date
|
128
|
+
Date.parse(value)
|
129
|
+
when :String
|
130
|
+
value.to_s
|
131
|
+
when :Integer
|
132
|
+
value.to_i
|
133
|
+
when :Float
|
134
|
+
value.to_f
|
135
|
+
when :BOOLEAN
|
136
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
137
|
+
true
|
138
|
+
else
|
139
|
+
false
|
140
|
+
end
|
141
|
+
when :Object
|
142
|
+
# generic object (usually a Hash), return directly
|
143
|
+
value
|
144
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
145
|
+
inner_type = Regexp.last_match[:inner_type]
|
146
|
+
value.map { |v| _deserialize(inner_type, v) }
|
147
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
148
|
+
k_type = Regexp.last_match[:k_type]
|
149
|
+
v_type = Regexp.last_match[:v_type]
|
150
|
+
{}.tap do |hash|
|
151
|
+
value.each do |k, v|
|
152
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
153
|
+
end
|
154
|
+
end
|
155
|
+
else # model
|
156
|
+
temp_model = DocuSign_eSign.const_get(type).new
|
157
|
+
temp_model.build_from_hash(value)
|
158
|
+
end
|
159
|
+
end
|
160
|
+
|
161
|
+
# Returns the string representation of the object
|
162
|
+
# @return [String] String presentation of the object
|
163
|
+
def to_s
|
164
|
+
to_hash.to_s
|
165
|
+
end
|
166
|
+
|
167
|
+
# to_body is an alias to to_hash (backward compatibility)
|
168
|
+
# @return [Hash] Returns the object in the form of hash
|
169
|
+
def to_body
|
170
|
+
to_hash
|
171
|
+
end
|
172
|
+
|
173
|
+
# Returns the object in the form of hash
|
174
|
+
# @return [Hash] Returns the object in the form of hash
|
175
|
+
def to_hash
|
176
|
+
hash = {}
|
177
|
+
self.class.attribute_map.each_pair do |attr, param|
|
178
|
+
value = self.send(attr)
|
179
|
+
next if value.nil?
|
180
|
+
hash[param] = _to_hash(value)
|
181
|
+
end
|
182
|
+
hash
|
183
|
+
end
|
184
|
+
|
185
|
+
# Outputs non-array value in the form of hash
|
186
|
+
# For object, use to_hash. Otherwise, just return the value
|
187
|
+
# @param [Object] value Any valid value
|
188
|
+
# @return [Hash] Returns the value in the form of hash
|
189
|
+
def _to_hash(value)
|
190
|
+
if value.is_a?(Array)
|
191
|
+
value.compact.map { |v| _to_hash(v) }
|
192
|
+
elsif value.is_a?(Hash)
|
193
|
+
{}.tap do |hash|
|
194
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
195
|
+
end
|
196
|
+
elsif value.respond_to? :to_hash
|
197
|
+
value.to_hash
|
198
|
+
else
|
199
|
+
value
|
200
|
+
end
|
201
|
+
end
|
202
|
+
|
203
|
+
end
|
204
|
+
end
|
@@ -68,6 +68,11 @@ module DocuSign_eSign
|
|
68
68
|
|
69
69
|
attr_accessor :bold_metadata
|
70
70
|
|
71
|
+
#
|
72
|
+
attr_accessor :caption
|
73
|
+
|
74
|
+
attr_accessor :caption_metadata
|
75
|
+
|
71
76
|
# 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.
|
72
77
|
attr_accessor :conceal_value_on_document
|
73
78
|
|
@@ -316,6 +321,8 @@ module DocuSign_eSign
|
|
316
321
|
:'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
|
317
322
|
:'bold' => :'bold',
|
318
323
|
:'bold_metadata' => :'boldMetadata',
|
324
|
+
:'caption' => :'caption',
|
325
|
+
:'caption_metadata' => :'captionMetadata',
|
319
326
|
:'conceal_value_on_document' => :'concealValueOnDocument',
|
320
327
|
:'conceal_value_on_document_metadata' => :'concealValueOnDocumentMetadata',
|
321
328
|
:'conditional_parent_label' => :'conditionalParentLabel',
|
@@ -433,6 +440,8 @@ module DocuSign_eSign
|
|
433
440
|
:'anchor_y_offset_metadata' => :'PropertyMetadata',
|
434
441
|
:'bold' => :'String',
|
435
442
|
:'bold_metadata' => :'PropertyMetadata',
|
443
|
+
:'caption' => :'String',
|
444
|
+
:'caption_metadata' => :'PropertyMetadata',
|
436
445
|
:'conceal_value_on_document' => :'String',
|
437
446
|
:'conceal_value_on_document_metadata' => :'PropertyMetadata',
|
438
447
|
:'conditional_parent_label' => :'String',
|
@@ -621,6 +630,14 @@ module DocuSign_eSign
|
|
621
630
|
self.bold_metadata = attributes[:'boldMetadata']
|
622
631
|
end
|
623
632
|
|
633
|
+
if attributes.has_key?(:'caption')
|
634
|
+
self.caption = attributes[:'caption']
|
635
|
+
end
|
636
|
+
|
637
|
+
if attributes.has_key?(:'captionMetadata')
|
638
|
+
self.caption_metadata = attributes[:'captionMetadata']
|
639
|
+
end
|
640
|
+
|
624
641
|
if attributes.has_key?(:'concealValueOnDocument')
|
625
642
|
self.conceal_value_on_document = attributes[:'concealValueOnDocument']
|
626
643
|
end
|
@@ -1020,6 +1037,8 @@ module DocuSign_eSign
|
|
1020
1037
|
anchor_y_offset_metadata == o.anchor_y_offset_metadata &&
|
1021
1038
|
bold == o.bold &&
|
1022
1039
|
bold_metadata == o.bold_metadata &&
|
1040
|
+
caption == o.caption &&
|
1041
|
+
caption_metadata == o.caption_metadata &&
|
1023
1042
|
conceal_value_on_document == o.conceal_value_on_document &&
|
1024
1043
|
conceal_value_on_document_metadata == o.conceal_value_on_document_metadata &&
|
1025
1044
|
conditional_parent_label == o.conditional_parent_label &&
|
@@ -1120,7 +1139,7 @@ module DocuSign_eSign
|
|
1120
1139
|
# Calculates hash code according to all attributes.
|
1121
1140
|
# @return [Fixnum] Hash code
|
1122
1141
|
def hash
|
1123
|
-
[anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, max_numerical_value, merge_field, merge_field_xml, min_numerical_value, name, name_metadata, numerical_value, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
1142
|
+
[anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, caption, caption_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, max_numerical_value, merge_field, merge_field_xml, min_numerical_value, name, name_metadata, numerical_value, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
1124
1143
|
end
|
1125
1144
|
|
1126
1145
|
# Builds the object from hash
|