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
@@ -223,7 +223,7 @@ module DocuSign_eSign
|
|
223
223
|
end
|
224
224
|
|
225
225
|
# Retrieves a billing invoice.
|
226
|
-
# Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | IDÂ
|
226
|
+
# Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
|
227
227
|
# @param account_id The external account number (int) or account ID Guid.
|
228
228
|
# @param invoice_id
|
229
229
|
# @return [BillingInvoice]
|
@@ -233,7 +233,7 @@ module DocuSign_eSign
|
|
233
233
|
end
|
234
234
|
|
235
235
|
# Retrieves a billing invoice.
|
236
|
-
# Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | IDÂ
|
236
|
+
# Retrieves the specified invoice. ###### Note: If the `pdfAvailable` property in the response is set to *true*, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the `Accept` property in the header to `Accept: application/pdf`. Privileges required: account administrator The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account. **Response** The following table provides a description of the different `chargeName` property values. The information will grow as more chargeable items are added to the system. | chargeName | Description | | --- | --- | | id_check | IDÂ Check Charge | | in_person_signing | In Person Signing charge | | envelopes Included | Sent Envelopes for the account | | age_verify | Age verification check | | ofac | OFAC Check | | id_confirm | ID confirmation check | | student_authentication | STAN PIN authentication check | | wet_sign_fax | Pages for returning signed documents by fax | | attachment_fax | Pages for returning attachments by fax | | phone_authentication | Phone authentication charge | | powerforms | PowerForm envelopes sent | | signer_payments | Payment processing charge | | outbound_fax | Send by fax charge | | bulk_recipient_envelopes | Bulk Recipient Envelopes sent | | sms_authentications | SMS authentication charge | | saml_authentications | SAML authentication charge | | express_signer_certificate | DocuSign Express Certificate charge | | personal_signer_certificate | Personal Signer Certificate charge | | safe_certificate | SAFE BioPharma Signer Certificate charge | | seats | Included active seats charge | | open_trust_certificate | OpenTrust Signer Certificate charge |
|
237
237
|
# @param account_id The external account number (int) or account ID Guid.
|
238
238
|
# @param invoice_id
|
239
239
|
# @return [Array<(BillingInvoice, Fixnum, Hash)>] BillingInvoice data, response status code and response headers
|
@@ -80,7 +80,7 @@ module DocuSign_eSign
|
|
80
80
|
end
|
81
81
|
|
82
82
|
class GetConsumerDisclosureOptions
|
83
|
-
# The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy),
|
83
|
+
# The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
84
84
|
attr_accessor :lang_code2
|
85
85
|
|
86
86
|
def self.default
|
@@ -463,6 +463,15 @@ module DocuSign_eSign
|
|
463
463
|
end
|
464
464
|
end
|
465
465
|
|
466
|
+
class UpdateEnvelopeDocGenFormFieldsOptions
|
467
|
+
#
|
468
|
+
attr_accessor :update_docgen_formfields_only
|
469
|
+
|
470
|
+
def self.default
|
471
|
+
@@default ||= UpdateEnvelopeDocGenFormFieldsOptions.new
|
472
|
+
end
|
473
|
+
end
|
474
|
+
|
466
475
|
class UpdateRecipientsOptions
|
467
476
|
#
|
468
477
|
attr_accessor :combine_same_order_recipients
|
@@ -3548,7 +3557,7 @@ module DocuSign_eSign
|
|
3548
3557
|
# Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
|
3549
3558
|
# @param account_id The external account number (int) or account ID Guid.
|
3550
3559
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3551
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy),
|
3560
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
3552
3561
|
# @param recipient_id The ID of the recipient being accessed.
|
3553
3562
|
# @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
|
3554
3563
|
# @return [ConsumerDisclosure]
|
@@ -3561,7 +3570,7 @@ module DocuSign_eSign
|
|
3561
3570
|
# Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
|
3562
3571
|
# @param account_id The external account number (int) or account ID Guid.
|
3563
3572
|
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
3564
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy),
|
3573
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
3565
3574
|
# @param recipient_id The ID of the recipient being accessed.
|
3566
3575
|
# @param DocuSign_eSign::GetConsumerDisclosureOptions Options for modifying the behavior of the function.
|
3567
3576
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
@@ -4031,6 +4040,59 @@ module DocuSign_eSign
|
|
4031
4040
|
return data, status_code, headers
|
4032
4041
|
end
|
4033
4042
|
|
4043
|
+
# Returns formfields for an envelope
|
4044
|
+
#
|
4045
|
+
# @param account_id The external account number (int) or account ID Guid.
|
4046
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
4047
|
+
# @return [DocGenFormFieldResponse]
|
4048
|
+
def get_envelope_doc_gen_form_fields(account_id, envelope_id)
|
4049
|
+
data, _status_code, _headers = get_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id)
|
4050
|
+
return data
|
4051
|
+
end
|
4052
|
+
|
4053
|
+
# Returns formfields for an envelope
|
4054
|
+
#
|
4055
|
+
# @param account_id The external account number (int) or account ID Guid.
|
4056
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
4057
|
+
# @return [Array<(DocGenFormFieldResponse, Fixnum, Hash)>] DocGenFormFieldResponse data, response status code and response headers
|
4058
|
+
def get_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id)
|
4059
|
+
if @api_client.config.debugging
|
4060
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_doc_gen_form_fields ..."
|
4061
|
+
end
|
4062
|
+
# verify the required parameter 'account_id' is set
|
4063
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_doc_gen_form_fields" if account_id.nil?
|
4064
|
+
# verify the required parameter 'envelope_id' is set
|
4065
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_doc_gen_form_fields" if envelope_id.nil?
|
4066
|
+
# resource path
|
4067
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
4068
|
+
|
4069
|
+
# query parameters
|
4070
|
+
query_params = {}
|
4071
|
+
|
4072
|
+
# header parameters
|
4073
|
+
header_params = {}
|
4074
|
+
# HTTP header 'Accept' (if needed)
|
4075
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4076
|
+
|
4077
|
+
# form parameters
|
4078
|
+
form_params = {}
|
4079
|
+
|
4080
|
+
# http body (model)
|
4081
|
+
post_body = nil
|
4082
|
+
auth_names = []
|
4083
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
4084
|
+
:header_params => header_params,
|
4085
|
+
:query_params => query_params,
|
4086
|
+
:form_params => form_params,
|
4087
|
+
:body => post_body,
|
4088
|
+
:auth_names => auth_names,
|
4089
|
+
:return_type => 'DocGenFormFieldResponse')
|
4090
|
+
if @api_client.config.debugging
|
4091
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_doc_gen_form_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4092
|
+
end
|
4093
|
+
return data, status_code, headers
|
4094
|
+
end
|
4095
|
+
|
4034
4096
|
# Get the Original HTML Definition used to generate the Responsive HTML for a given document.
|
4035
4097
|
#
|
4036
4098
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -6568,6 +6630,64 @@ module DocuSign_eSign
|
|
6568
6630
|
return data, status_code, headers
|
6569
6631
|
end
|
6570
6632
|
|
6633
|
+
# Updates formfields for an envelope
|
6634
|
+
#
|
6635
|
+
# @param account_id The external account number (int) or account ID Guid.
|
6636
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
6637
|
+
# @param doc_gen_form_field_request (optional parameter)
|
6638
|
+
# @param DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions Options for modifying the behavior of the function.
|
6639
|
+
# @return [DocGenFormFieldResponse]
|
6640
|
+
def update_envelope_doc_gen_form_fields(account_id, envelope_id, doc_gen_form_field_request, options = DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions.default)
|
6641
|
+
data, _status_code, _headers = update_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id, doc_gen_form_field_request, options)
|
6642
|
+
return data
|
6643
|
+
end
|
6644
|
+
|
6645
|
+
# Updates formfields for an envelope
|
6646
|
+
#
|
6647
|
+
# @param account_id The external account number (int) or account ID Guid.
|
6648
|
+
# @param envelope_id The envelopeId Guid of the envelope being accessed.
|
6649
|
+
# @param doc_gen_form_field_request (optional parameter)
|
6650
|
+
# @param DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions Options for modifying the behavior of the function.
|
6651
|
+
# @return [Array<(DocGenFormFieldResponse, Fixnum, Hash)>] DocGenFormFieldResponse data, response status code and response headers
|
6652
|
+
def update_envelope_doc_gen_form_fields_with_http_info(account_id, envelope_id, doc_gen_form_field_request, options = DocuSign_eSign::UpdateEnvelopeDocGenFormFieldsOptions.default)
|
6653
|
+
if @api_client.config.debugging
|
6654
|
+
@api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_doc_gen_form_fields ..."
|
6655
|
+
end
|
6656
|
+
# verify the required parameter 'account_id' is set
|
6657
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_doc_gen_form_fields" if account_id.nil?
|
6658
|
+
# verify the required parameter 'envelope_id' is set
|
6659
|
+
fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_doc_gen_form_fields" if envelope_id.nil?
|
6660
|
+
# resource path
|
6661
|
+
local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/docGenFormFields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s)
|
6662
|
+
|
6663
|
+
# query parameters
|
6664
|
+
query_params = {}
|
6665
|
+
query_params[:'update_docgen_formfields_only'] = options.update_docgen_formfields_only if !options.update_docgen_formfields_only.nil?
|
6666
|
+
|
6667
|
+
# header parameters
|
6668
|
+
header_params = {}
|
6669
|
+
# HTTP header 'Accept' (if needed)
|
6670
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6671
|
+
|
6672
|
+
# form parameters
|
6673
|
+
form_params = {}
|
6674
|
+
|
6675
|
+
# http body (model)
|
6676
|
+
post_body = @api_client.object_to_http_body(doc_gen_form_field_request)
|
6677
|
+
auth_names = []
|
6678
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
6679
|
+
:header_params => header_params,
|
6680
|
+
:query_params => query_params,
|
6681
|
+
:form_params => form_params,
|
6682
|
+
:body => post_body,
|
6683
|
+
:auth_names => auth_names,
|
6684
|
+
:return_type => 'DocGenFormFieldResponse')
|
6685
|
+
if @api_client.config.debugging
|
6686
|
+
@api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_doc_gen_form_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6687
|
+
end
|
6688
|
+
return data, status_code, headers
|
6689
|
+
end
|
6690
|
+
|
6571
6691
|
# Updates the scheduled sending rules for an envelope's workflow definition.
|
6572
6692
|
#
|
6573
6693
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -854,63 +854,6 @@ module DocuSign_eSign
|
|
854
854
|
return data, status_code, headers
|
855
855
|
end
|
856
856
|
|
857
|
-
# Deletes the bulk recipient list on a template.
|
858
|
-
# Deletes the bulk recipient list on a template.
|
859
|
-
# @param account_id The external account number (int) or account ID Guid.
|
860
|
-
# @param recipient_id The ID of the recipient being accessed.
|
861
|
-
# @param template_id The ID of the template being accessed.
|
862
|
-
# @return [BulkRecipientsUpdateResponse]
|
863
|
-
def delete_bulk_recipients(account_id, recipient_id, template_id)
|
864
|
-
data, _status_code, _headers = delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id)
|
865
|
-
return data
|
866
|
-
end
|
867
|
-
|
868
|
-
# Deletes the bulk recipient list on a template.
|
869
|
-
# Deletes the bulk recipient list on a template.
|
870
|
-
# @param account_id The external account number (int) or account ID Guid.
|
871
|
-
# @param recipient_id The ID of the recipient being accessed.
|
872
|
-
# @param template_id The ID of the template being accessed.
|
873
|
-
# @return [Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>] BulkRecipientsUpdateResponse data, response status code and response headers
|
874
|
-
def delete_bulk_recipients_with_http_info(account_id, recipient_id, template_id)
|
875
|
-
if @api_client.config.debugging
|
876
|
-
@api_client.config.logger.debug "Calling API: TemplatesApi.delete_bulk_recipients ..."
|
877
|
-
end
|
878
|
-
# verify the required parameter 'account_id' is set
|
879
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.delete_bulk_recipients" if account_id.nil?
|
880
|
-
# verify the required parameter 'recipient_id' is set
|
881
|
-
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.delete_bulk_recipients" if recipient_id.nil?
|
882
|
-
# verify the required parameter 'template_id' is set
|
883
|
-
fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.delete_bulk_recipients" if template_id.nil?
|
884
|
-
# resource path
|
885
|
-
local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
|
886
|
-
|
887
|
-
# query parameters
|
888
|
-
query_params = {}
|
889
|
-
|
890
|
-
# header parameters
|
891
|
-
header_params = {}
|
892
|
-
# HTTP header 'Accept' (if needed)
|
893
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
894
|
-
|
895
|
-
# form parameters
|
896
|
-
form_params = {}
|
897
|
-
|
898
|
-
# http body (model)
|
899
|
-
post_body = nil
|
900
|
-
auth_names = []
|
901
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
902
|
-
:header_params => header_params,
|
903
|
-
:query_params => query_params,
|
904
|
-
:form_params => form_params,
|
905
|
-
:body => post_body,
|
906
|
-
:auth_names => auth_names,
|
907
|
-
:return_type => 'BulkRecipientsUpdateResponse')
|
908
|
-
if @api_client.config.debugging
|
909
|
-
@api_client.config.logger.debug "API called: TemplatesApi#delete_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
910
|
-
end
|
911
|
-
return data, status_code, headers
|
912
|
-
end
|
913
|
-
|
914
857
|
# Deletes envelope custom fields in a template.
|
915
858
|
# Deletes envelope custom fields in a template.
|
916
859
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -35,7 +35,7 @@ module DocuSign_eSign
|
|
35
35
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
36
36
|
def initialize(config = Configuration.default)
|
37
37
|
@config = config
|
38
|
-
@user_agent = "Swagger-Codegen/3.
|
38
|
+
@user_agent = "Swagger-Codegen/3.23.0/ruby"
|
39
39
|
@default_headers = {
|
40
40
|
'Content-Type' => "application/json",
|
41
41
|
'User-Agent' => @user_agent
|
@@ -20,7 +20,7 @@ module DocuSign_eSign
|
|
20
20
|
# The name of the current account.
|
21
21
|
attr_accessor :account_name
|
22
22
|
|
23
|
-
# The list of account settings
|
23
|
+
# The list of account settings. These determine the features available for the account. Note that some features are determined by the plan used to create the account, and cannot be overridden.
|
24
24
|
attr_accessor :account_settings
|
25
25
|
|
26
26
|
# When set to **true**, the transaction rooms feature exposed through the Workspaces API is enabled.
|
@@ -44,6 +44,7 @@ module DocuSign_eSign
|
|
44
44
|
# Reserved: TBD
|
45
45
|
attr_accessor :billing_profile
|
46
46
|
|
47
|
+
#
|
47
48
|
attr_accessor :brands
|
48
49
|
|
49
50
|
# When set to **true**, specifies that you can upgrade the account through the API.
|
@@ -173,6 +173,7 @@ module DocuSign_eSign
|
|
173
173
|
#
|
174
174
|
attr_accessor :enable_key_terms_suggestions_by_document_type
|
175
175
|
|
176
|
+
#
|
176
177
|
attr_accessor :enable_key_terms_suggestions_by_document_type_metadata
|
177
178
|
|
178
179
|
#
|
@@ -247,6 +248,7 @@ module DocuSign_eSign
|
|
247
248
|
#
|
248
249
|
attr_accessor :web_forms
|
249
250
|
|
251
|
+
#
|
250
252
|
attr_accessor :web_forms_metadata
|
251
253
|
|
252
254
|
# Attribute mapping from ruby-style variable name to JSON key.
|