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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/lib/docusign_esign/api/accounts_api.rb +4 -4
- data/lib/docusign_esign/api/billing_api.rb +2 -2
- data/lib/docusign_esign/api/connect_api.rb +51 -0
- data/lib/docusign_esign/api/envelopes_api.rb +132 -65
- data/lib/docusign_esign/api/folders_api.rb +8 -0
- data/lib/docusign_esign/api/templates_api.rb +0 -130
- 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 +205 -3
- 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/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.rb +13 -1
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +12 -2
- data/lib/docusign_esign/models/bulksending_copy_doc_gen_form_field.rb +194 -0
- 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_custom_configuration.rb +11 -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 +12 -2
- 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/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 +13 -3
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -1
- data/lib/docusign_esign/models/envelope_definition.rb +13 -3
- 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 +13 -3
- 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/event_notification.rb +11 -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/id_evidence_view_link.rb +3 -3
- 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/jurisdiction_summary.rb +214 -0
- 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/locale_policy_tab.rb +14 -4
- 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_contact_details.rb +196 -0
- 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 +1346 -0
- 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_identity_verification.rb +14 -4
- 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/tab_metadata.rb +11 -1
- data/lib/docusign_esign/models/tabs.rb +13 -13
- data/lib/docusign_esign/models/template_recipients.rb +1 -1
- data/lib/docusign_esign/models/template_role.rb +12 -2
- 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 +13 -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 +22 -1
- 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 +7 -6
- metadata +9 -2
@@ -38,6 +38,9 @@ module DocuSign_eSign
|
|
38
38
|
#
|
39
39
|
attr_accessor :auto_responded_reason
|
40
40
|
|
41
|
+
#
|
42
|
+
attr_accessor :bulk_send_v2_recipient
|
43
|
+
|
41
44
|
# 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.
|
42
45
|
attr_accessor :client_user_id
|
43
46
|
|
@@ -80,7 +83,7 @@ module DocuSign_eSign
|
|
80
83
|
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
81
84
|
attr_accessor :email_metadata
|
82
85
|
|
83
|
-
#
|
86
|
+
# A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings.
|
84
87
|
attr_accessor :email_notification
|
85
88
|
|
86
89
|
#
|
@@ -89,7 +92,7 @@ module DocuSign_eSign
|
|
89
92
|
# 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]]`
|
90
93
|
attr_accessor :embedded_recipient_start_url
|
91
94
|
|
92
|
-
#
|
95
|
+
# Array or errors.
|
93
96
|
attr_accessor :error_details
|
94
97
|
|
95
98
|
# 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.
|
@@ -253,6 +256,7 @@ module DocuSign_eSign
|
|
253
256
|
:'agent_can_edit_name' => :'agentCanEditName',
|
254
257
|
:'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
|
255
258
|
:'auto_responded_reason' => :'autoRespondedReason',
|
259
|
+
:'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
|
256
260
|
:'client_user_id' => :'clientUserId',
|
257
261
|
:'completed_count' => :'completedCount',
|
258
262
|
:'consent_details_list' => :'consentDetailsList',
|
@@ -335,6 +339,7 @@ module DocuSign_eSign
|
|
335
339
|
:'agent_can_edit_name' => :'String',
|
336
340
|
:'allow_system_override_for_locked_recipient' => :'String',
|
337
341
|
:'auto_responded_reason' => :'String',
|
342
|
+
:'bulk_send_v2_recipient' => :'String',
|
338
343
|
:'client_user_id' => :'String',
|
339
344
|
:'completed_count' => :'String',
|
340
345
|
:'consent_details_list' => :'Array<ConsentDetails>',
|
@@ -448,6 +453,10 @@ module DocuSign_eSign
|
|
448
453
|
self.auto_responded_reason = attributes[:'autoRespondedReason']
|
449
454
|
end
|
450
455
|
|
456
|
+
if attributes.has_key?(:'bulkSendV2Recipient')
|
457
|
+
self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
|
458
|
+
end
|
459
|
+
|
451
460
|
if attributes.has_key?(:'clientUserId')
|
452
461
|
self.client_user_id = attributes[:'clientUserId']
|
453
462
|
end
|
@@ -763,6 +772,7 @@ module DocuSign_eSign
|
|
763
772
|
agent_can_edit_name == o.agent_can_edit_name &&
|
764
773
|
allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
|
765
774
|
auto_responded_reason == o.auto_responded_reason &&
|
775
|
+
bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
|
766
776
|
client_user_id == o.client_user_id &&
|
767
777
|
completed_count == o.completed_count &&
|
768
778
|
consent_details_list == o.consent_details_list &&
|
@@ -842,7 +852,7 @@ module DocuSign_eSign
|
|
842
852
|
# Calculates hash code according to all attributes.
|
843
853
|
# @return [Fixnum] Hash code
|
844
854
|
def hash
|
845
|
-
[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_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, 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, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, 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
|
855
|
+
[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_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, 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, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, 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
|
846
856
|
end
|
847
857
|
|
848
858
|
# 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
|
# 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.
|
@@ -17,7 +17,7 @@ module DocuSign_eSign
|
|
17
17
|
# The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl.
|
18
18
|
attr_accessor :authentication_url
|
19
19
|
|
20
|
-
#
|
20
|
+
# Array or errors.
|
21
21
|
attr_accessor :error_details
|
22
22
|
|
23
23
|
# The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.
|
@@ -82,6 +82,7 @@ module DocuSign_eSign
|
|
82
82
|
#
|
83
83
|
attr_accessor :caption
|
84
84
|
|
85
|
+
#
|
85
86
|
attr_accessor :caption_metadata
|
86
87
|
|
87
88
|
#
|
@@ -111,7 +112,7 @@ module DocuSign_eSign
|
|
111
112
|
# Metadata that indicates whether the `documentId` property is editable.
|
112
113
|
attr_accessor :document_id_metadata
|
113
114
|
|
114
|
-
#
|
115
|
+
# Array or errors.
|
115
116
|
attr_accessor :error_details
|
116
117
|
|
117
118
|
# 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
|
-
#
|
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
|
# 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
|
# 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
|
# 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
|
# 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.
|
@@ -86,6 +86,9 @@ module DocuSign_eSign
|
|
86
86
|
# When set to **true**, Connect will include the envelope time zone information.
|
87
87
|
attr_accessor :include_time_zone_information
|
88
88
|
|
89
|
+
#
|
90
|
+
attr_accessor :integrator_managed
|
91
|
+
|
89
92
|
# The name of the Connect configuration. The name helps identify the configuration in the list.
|
90
93
|
attr_accessor :name
|
91
94
|
|
@@ -167,6 +170,7 @@ module DocuSign_eSign
|
|
167
170
|
:'include_o_auth' => :'includeOAuth',
|
168
171
|
:'include_sender_accountas_custom_field' => :'includeSenderAccountasCustomField',
|
169
172
|
:'include_time_zone_information' => :'includeTimeZoneInformation',
|
173
|
+
:'integrator_managed' => :'integratorManaged',
|
170
174
|
:'name' => :'name',
|
171
175
|
:'password' => :'password',
|
172
176
|
:'recipient_events' => :'recipientEvents',
|
@@ -215,6 +219,7 @@ module DocuSign_eSign
|
|
215
219
|
:'include_o_auth' => :'String',
|
216
220
|
:'include_sender_accountas_custom_field' => :'String',
|
217
221
|
:'include_time_zone_information' => :'String',
|
222
|
+
:'integrator_managed' => :'String',
|
218
223
|
:'name' => :'String',
|
219
224
|
:'password' => :'String',
|
220
225
|
:'recipient_events' => :'Array<String>',
|
@@ -346,6 +351,10 @@ module DocuSign_eSign
|
|
346
351
|
self.include_time_zone_information = attributes[:'includeTimeZoneInformation']
|
347
352
|
end
|
348
353
|
|
354
|
+
if attributes.has_key?(:'integratorManaged')
|
355
|
+
self.integrator_managed = attributes[:'integratorManaged']
|
356
|
+
end
|
357
|
+
|
349
358
|
if attributes.has_key?(:'name')
|
350
359
|
self.name = attributes[:'name']
|
351
360
|
end
|
@@ -469,6 +478,7 @@ module DocuSign_eSign
|
|
469
478
|
include_o_auth == o.include_o_auth &&
|
470
479
|
include_sender_accountas_custom_field == o.include_sender_accountas_custom_field &&
|
471
480
|
include_time_zone_information == o.include_time_zone_information &&
|
481
|
+
integrator_managed == o.integrator_managed &&
|
472
482
|
name == o.name &&
|
473
483
|
password == o.password &&
|
474
484
|
recipient_events == o.recipient_events &&
|
@@ -498,7 +508,7 @@ module DocuSign_eSign
|
|
498
508
|
# Calculates hash code according to all attributes.
|
499
509
|
# @return [Fixnum] Hash code
|
500
510
|
def hash
|
501
|
-
[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_o_auth, 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
|
511
|
+
[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_o_auth, include_sender_accountas_custom_field, include_time_zone_information, integrator_managed, 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
|
502
512
|
end
|
503
513
|
|
504
514
|
# Builds the object from hash
|
@@ -31,7 +31,7 @@ module DocuSign_eSign
|
|
31
31
|
#
|
32
32
|
attr_accessor :emails
|
33
33
|
|
34
|
-
#
|
34
|
+
# Array or errors.
|
35
35
|
attr_accessor :error_details
|
36
36
|
|
37
37
|
#
|
@@ -40,6 +40,9 @@ module DocuSign_eSign
|
|
40
40
|
#
|
41
41
|
attr_accessor :name
|
42
42
|
|
43
|
+
#
|
44
|
+
attr_accessor :notary_contact_details
|
45
|
+
|
43
46
|
#
|
44
47
|
attr_accessor :organization
|
45
48
|
|
@@ -67,6 +70,7 @@ module DocuSign_eSign
|
|
67
70
|
:'error_details' => :'errorDetails',
|
68
71
|
:'is_owner' => :'isOwner',
|
69
72
|
:'name' => :'name',
|
73
|
+
:'notary_contact_details' => :'notaryContactDetails',
|
70
74
|
:'organization' => :'organization',
|
71
75
|
:'room_contact_type' => :'roomContactType',
|
72
76
|
:'shared' => :'shared',
|
@@ -87,6 +91,7 @@ module DocuSign_eSign
|
|
87
91
|
:'error_details' => :'ErrorDetails',
|
88
92
|
:'is_owner' => :'BOOLEAN',
|
89
93
|
:'name' => :'String',
|
94
|
+
:'notary_contact_details' => :'NotaryContactDetails',
|
90
95
|
:'organization' => :'String',
|
91
96
|
:'room_contact_type' => :'String',
|
92
97
|
:'shared' => :'String',
|
@@ -143,6 +148,10 @@ module DocuSign_eSign
|
|
143
148
|
self.name = attributes[:'name']
|
144
149
|
end
|
145
150
|
|
151
|
+
if attributes.has_key?(:'notaryContactDetails')
|
152
|
+
self.notary_contact_details = attributes[:'notaryContactDetails']
|
153
|
+
end
|
154
|
+
|
146
155
|
if attributes.has_key?(:'organization')
|
147
156
|
self.organization = attributes[:'organization']
|
148
157
|
end
|
@@ -191,6 +200,7 @@ module DocuSign_eSign
|
|
191
200
|
error_details == o.error_details &&
|
192
201
|
is_owner == o.is_owner &&
|
193
202
|
name == o.name &&
|
203
|
+
notary_contact_details == o.notary_contact_details &&
|
194
204
|
organization == o.organization &&
|
195
205
|
room_contact_type == o.room_contact_type &&
|
196
206
|
shared == o.shared &&
|
@@ -207,7 +217,7 @@ module DocuSign_eSign
|
|
207
217
|
# Calculates hash code according to all attributes.
|
208
218
|
# @return [Fixnum] Hash code
|
209
219
|
def hash
|
210
|
-
[cloud_provider, cloud_provider_container_id, contact_id, contact_phone_numbers, contact_uri, emails, error_details, is_owner, name, organization, room_contact_type, shared, signing_group, signing_group_name].hash
|
220
|
+
[cloud_provider, cloud_provider_container_id, contact_id, contact_phone_numbers, contact_uri, emails, error_details, is_owner, name, notary_contact_details, organization, room_contact_type, shared, signing_group, signing_group_name].hash
|
211
221
|
end
|
212
222
|
|
213
223
|
# 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.
|
@@ -89,6 +89,7 @@ module DocuSign_eSign
|
|
89
89
|
#
|
90
90
|
attr_accessor :caption
|
91
91
|
|
92
|
+
#
|
92
93
|
attr_accessor :caption_metadata
|
93
94
|
|
94
95
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
@@ -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.
|
@@ -19,7 +19,7 @@ module DocuSign_eSign
|
|
19
19
|
# A list of envelope delay rules specified by the user indicating how and when the envelope should be sent in the future for the current workflow step and its associated recipients. Currently only 1 rule may be specified.
|
20
20
|
attr_accessor :rules
|
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.
|
23
23
|
attr_accessor :status
|
24
24
|
|
25
25
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -0,0 +1,186 @@
|
|
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 DocGenFormFieldRequest
|
16
|
+
#
|
17
|
+
attr_accessor :doc_gen_form_fields
|
18
|
+
|
19
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
20
|
+
def self.attribute_map
|
21
|
+
{
|
22
|
+
:'doc_gen_form_fields' => :'docGenFormFields'
|
23
|
+
}
|
24
|
+
end
|
25
|
+
|
26
|
+
# Attribute type mapping.
|
27
|
+
def self.swagger_types
|
28
|
+
{
|
29
|
+
:'doc_gen_form_fields' => :'Array<DocGenFormFields>'
|
30
|
+
}
|
31
|
+
end
|
32
|
+
|
33
|
+
# Initializes the object
|
34
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
35
|
+
def initialize(attributes = {})
|
36
|
+
return unless attributes.is_a?(Hash)
|
37
|
+
|
38
|
+
# convert string to symbol for hash key
|
39
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
40
|
+
|
41
|
+
if attributes.has_key?(:'docGenFormFields')
|
42
|
+
if (value = attributes[:'docGenFormFields']).is_a?(Array)
|
43
|
+
self.doc_gen_form_fields = value
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
49
|
+
# @return Array for valid properties with the reasons
|
50
|
+
def list_invalid_properties
|
51
|
+
invalid_properties = Array.new
|
52
|
+
invalid_properties
|
53
|
+
end
|
54
|
+
|
55
|
+
# Check to see if the all the properties in the model are valid
|
56
|
+
# @return true if the model is valid
|
57
|
+
def valid?
|
58
|
+
true
|
59
|
+
end
|
60
|
+
|
61
|
+
# Checks equality by comparing each attribute.
|
62
|
+
# @param [Object] Object to be compared
|
63
|
+
def ==(o)
|
64
|
+
return true if self.equal?(o)
|
65
|
+
self.class == o.class &&
|
66
|
+
doc_gen_form_fields == o.doc_gen_form_fields
|
67
|
+
end
|
68
|
+
|
69
|
+
# @see the `==` method
|
70
|
+
# @param [Object] Object to be compared
|
71
|
+
def eql?(o)
|
72
|
+
self == o
|
73
|
+
end
|
74
|
+
|
75
|
+
# Calculates hash code according to all attributes.
|
76
|
+
# @return [Fixnum] Hash code
|
77
|
+
def hash
|
78
|
+
[doc_gen_form_fields].hash
|
79
|
+
end
|
80
|
+
|
81
|
+
# Builds the object from hash
|
82
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
83
|
+
# @return [Object] Returns the model itself
|
84
|
+
def build_from_hash(attributes)
|
85
|
+
return nil unless attributes.is_a?(Hash)
|
86
|
+
self.class.swagger_types.each_pair do |key, type|
|
87
|
+
if type =~ /\AArray<(.*)>/i
|
88
|
+
# check to ensure the input is an array given that the attribute
|
89
|
+
# is documented as an array but the input is not
|
90
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
91
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
92
|
+
end
|
93
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
94
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
95
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
96
|
+
end
|
97
|
+
|
98
|
+
self
|
99
|
+
end
|
100
|
+
|
101
|
+
# Deserializes the data based on type
|
102
|
+
# @param string type Data type
|
103
|
+
# @param string value Value to be deserialized
|
104
|
+
# @return [Object] Deserialized data
|
105
|
+
def _deserialize(type, value)
|
106
|
+
case type.to_sym
|
107
|
+
when :DateTime
|
108
|
+
DateTime.parse(value)
|
109
|
+
when :Date
|
110
|
+
Date.parse(value)
|
111
|
+
when :String
|
112
|
+
value.to_s
|
113
|
+
when :Integer
|
114
|
+
value.to_i
|
115
|
+
when :Float
|
116
|
+
value.to_f
|
117
|
+
when :BOOLEAN
|
118
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
119
|
+
true
|
120
|
+
else
|
121
|
+
false
|
122
|
+
end
|
123
|
+
when :Object
|
124
|
+
# generic object (usually a Hash), return directly
|
125
|
+
value
|
126
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
127
|
+
inner_type = Regexp.last_match[:inner_type]
|
128
|
+
value.map { |v| _deserialize(inner_type, v) }
|
129
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
130
|
+
k_type = Regexp.last_match[:k_type]
|
131
|
+
v_type = Regexp.last_match[:v_type]
|
132
|
+
{}.tap do |hash|
|
133
|
+
value.each do |k, v|
|
134
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
135
|
+
end
|
136
|
+
end
|
137
|
+
else # model
|
138
|
+
temp_model = DocuSign_eSign.const_get(type).new
|
139
|
+
temp_model.build_from_hash(value)
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
# Returns the string representation of the object
|
144
|
+
# @return [String] String presentation of the object
|
145
|
+
def to_s
|
146
|
+
to_hash.to_s
|
147
|
+
end
|
148
|
+
|
149
|
+
# to_body is an alias to to_hash (backward compatibility)
|
150
|
+
# @return [Hash] Returns the object in the form of hash
|
151
|
+
def to_body
|
152
|
+
to_hash
|
153
|
+
end
|
154
|
+
|
155
|
+
# Returns the object in the form of hash
|
156
|
+
# @return [Hash] Returns the object in the form of hash
|
157
|
+
def to_hash
|
158
|
+
hash = {}
|
159
|
+
self.class.attribute_map.each_pair do |attr, param|
|
160
|
+
value = self.send(attr)
|
161
|
+
next if value.nil?
|
162
|
+
hash[param] = _to_hash(value)
|
163
|
+
end
|
164
|
+
hash
|
165
|
+
end
|
166
|
+
|
167
|
+
# Outputs non-array value in the form of hash
|
168
|
+
# For object, use to_hash. Otherwise, just return the value
|
169
|
+
# @param [Object] value Any valid value
|
170
|
+
# @return [Hash] Returns the value in the form of hash
|
171
|
+
def _to_hash(value)
|
172
|
+
if value.is_a?(Array)
|
173
|
+
value.compact.map { |v| _to_hash(v) }
|
174
|
+
elsif value.is_a?(Hash)
|
175
|
+
{}.tap do |hash|
|
176
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
177
|
+
end
|
178
|
+
elsif value.respond_to? :to_hash
|
179
|
+
value.to_hash
|
180
|
+
else
|
181
|
+
value
|
182
|
+
end
|
183
|
+
end
|
184
|
+
|
185
|
+
end
|
186
|
+
end
|