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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b8b2f7520758f61111c5da5b3dec4aa245dcdc813d1709070dc0d02d35010f2c
|
4
|
+
data.tar.gz: c78c4bc15dde0d80d1649d80d7ac4feec4bb9afa4b164af40ecd3b90caf0e817
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ee81048fbcabd253b2f00f2daae51db180aa0f70994c943edc9160289546266e97368fd18eb922acff3c61d0393429d707fbee26df5e8921fcd3a3f514e63b12
|
7
|
+
data.tar.gz: ed271c8a6a0c26dd150fee9627af52934f1b2909a6c8094666898bc71309bb7219a167d1552eba0929128b7c8b4a9670e55a32249b3e6714dbc5d21fd1d4fede
|
data/CHANGELOG.md
CHANGED
@@ -3,6 +3,16 @@ All notable changes to this project will be documented in this file.
|
|
3
3
|
|
4
4
|
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
|
5
5
|
|
6
|
+
## [v3.23.0] - eSignature API v2.1-23.1.01.01 - 2023-04-05
|
7
|
+
### Changed
|
8
|
+
- Added support for version v2.1-23.1.01.01 of the DocuSign ESignature API.
|
9
|
+
- Updated the SDK release version.
|
10
|
+
|
11
|
+
## [v3.22.0] - eSignature API v2.1-23.1.01.00 - 2023-03-17
|
12
|
+
### Changed
|
13
|
+
- Added support for version v2.1-23.1.01.00 of the DocuSign ESignature API.
|
14
|
+
- Updated the SDK release version.
|
15
|
+
|
6
16
|
## [v3.21.0] - eSignature API v2.1-22.4.02.00 - 2023-02-02
|
7
17
|
### Changed
|
8
18
|
- Added support for version v2.1-22.4.02.00 of the DocuSign ESignature API.
|
@@ -100,6 +100,30 @@ module DocuSign_eSign
|
|
100
100
|
end
|
101
101
|
end
|
102
102
|
|
103
|
+
class GetAgentUserAuthorizationsOptions
|
104
|
+
#
|
105
|
+
attr_accessor :active_only
|
106
|
+
|
107
|
+
#
|
108
|
+
attr_accessor :count
|
109
|
+
|
110
|
+
#
|
111
|
+
attr_accessor :email_substring
|
112
|
+
|
113
|
+
#
|
114
|
+
attr_accessor :permissions
|
115
|
+
|
116
|
+
#
|
117
|
+
attr_accessor :start_position
|
118
|
+
|
119
|
+
#
|
120
|
+
attr_accessor :user_name_substring
|
121
|
+
|
122
|
+
def self.default
|
123
|
+
@@default ||= GetAgentUserAuthorizationsOptions.new
|
124
|
+
end
|
125
|
+
end
|
126
|
+
|
103
127
|
class GetBillingChargesOptions
|
104
128
|
# Specifies which billing charges to return. Valid values are: * envelopes * seats
|
105
129
|
attr_accessor :include_charges
|
@@ -151,6 +175,30 @@ module DocuSign_eSign
|
|
151
175
|
end
|
152
176
|
end
|
153
177
|
|
178
|
+
class GetPrincipalUserAuthorizationsOptions
|
179
|
+
#
|
180
|
+
attr_accessor :active_only
|
181
|
+
|
182
|
+
#
|
183
|
+
attr_accessor :count
|
184
|
+
|
185
|
+
#
|
186
|
+
attr_accessor :email_substring
|
187
|
+
|
188
|
+
#
|
189
|
+
attr_accessor :permissions
|
190
|
+
|
191
|
+
#
|
192
|
+
attr_accessor :start_position
|
193
|
+
|
194
|
+
#
|
195
|
+
attr_accessor :user_name_substring
|
196
|
+
|
197
|
+
def self.default
|
198
|
+
@@default ||= GetPrincipalUserAuthorizationsOptions.new
|
199
|
+
end
|
200
|
+
end
|
201
|
+
|
154
202
|
class ListBrandsOptions
|
155
203
|
# When set to **true**, excludes distributor brand information from the response set.
|
156
204
|
attr_accessor :exclude_distributor_brand
|
@@ -551,6 +599,116 @@ module DocuSign_eSign
|
|
551
599
|
return data, status_code, headers
|
552
600
|
end
|
553
601
|
|
602
|
+
# Creates the user authorization
|
603
|
+
#
|
604
|
+
# @param account_id The external account number (int) or account ID Guid.
|
605
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
606
|
+
# @param user_authorization_create_request (optional parameter)
|
607
|
+
# @return [UserAuthorization]
|
608
|
+
def create_user_authorization(account_id, user_id, user_authorization_create_request)
|
609
|
+
data, _status_code, _headers = create_user_authorization_with_http_info(account_id, user_id, user_authorization_create_request)
|
610
|
+
return data
|
611
|
+
end
|
612
|
+
|
613
|
+
# Creates the user authorization
|
614
|
+
#
|
615
|
+
# @param account_id The external account number (int) or account ID Guid.
|
616
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
617
|
+
# @param user_authorization_create_request (optional parameter)
|
618
|
+
# @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
|
619
|
+
def create_user_authorization_with_http_info(account_id, user_id, user_authorization_create_request)
|
620
|
+
if @api_client.config.debugging
|
621
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.create_user_authorization ..."
|
622
|
+
end
|
623
|
+
# verify the required parameter 'account_id' is set
|
624
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_user_authorization" if account_id.nil?
|
625
|
+
# verify the required parameter 'user_id' is set
|
626
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.create_user_authorization" if user_id.nil?
|
627
|
+
# resource path
|
628
|
+
local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorization".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
629
|
+
|
630
|
+
# query parameters
|
631
|
+
query_params = {}
|
632
|
+
|
633
|
+
# header parameters
|
634
|
+
header_params = {}
|
635
|
+
# HTTP header 'Accept' (if needed)
|
636
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
637
|
+
|
638
|
+
# form parameters
|
639
|
+
form_params = {}
|
640
|
+
|
641
|
+
# http body (model)
|
642
|
+
post_body = @api_client.object_to_http_body(user_authorization_create_request)
|
643
|
+
auth_names = []
|
644
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
645
|
+
:header_params => header_params,
|
646
|
+
:query_params => query_params,
|
647
|
+
:form_params => form_params,
|
648
|
+
:body => post_body,
|
649
|
+
:auth_names => auth_names,
|
650
|
+
:return_type => 'UserAuthorization')
|
651
|
+
if @api_client.config.debugging
|
652
|
+
@api_client.config.logger.debug "API called: AccountsApi#create_user_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
653
|
+
end
|
654
|
+
return data, status_code, headers
|
655
|
+
end
|
656
|
+
|
657
|
+
# Creates ot updates user authorizations
|
658
|
+
#
|
659
|
+
# @param account_id The external account number (int) or account ID Guid.
|
660
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
661
|
+
# @param user_authorizations_request (optional parameter)
|
662
|
+
# @return [UserAuthorizationsResponse]
|
663
|
+
def create_user_authorizations(account_id, user_id, user_authorizations_request)
|
664
|
+
data, _status_code, _headers = create_user_authorizations_with_http_info(account_id, user_id, user_authorizations_request)
|
665
|
+
return data
|
666
|
+
end
|
667
|
+
|
668
|
+
# Creates ot updates user authorizations
|
669
|
+
#
|
670
|
+
# @param account_id The external account number (int) or account ID Guid.
|
671
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
672
|
+
# @param user_authorizations_request (optional parameter)
|
673
|
+
# @return [Array<(UserAuthorizationsResponse, Fixnum, Hash)>] UserAuthorizationsResponse data, response status code and response headers
|
674
|
+
def create_user_authorizations_with_http_info(account_id, user_id, user_authorizations_request)
|
675
|
+
if @api_client.config.debugging
|
676
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.create_user_authorizations ..."
|
677
|
+
end
|
678
|
+
# verify the required parameter 'account_id' is set
|
679
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_user_authorizations" if account_id.nil?
|
680
|
+
# verify the required parameter 'user_id' is set
|
681
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.create_user_authorizations" if user_id.nil?
|
682
|
+
# resource path
|
683
|
+
local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorizations".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
684
|
+
|
685
|
+
# query parameters
|
686
|
+
query_params = {}
|
687
|
+
|
688
|
+
# header parameters
|
689
|
+
header_params = {}
|
690
|
+
# HTTP header 'Accept' (if needed)
|
691
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
692
|
+
|
693
|
+
# form parameters
|
694
|
+
form_params = {}
|
695
|
+
|
696
|
+
# http body (model)
|
697
|
+
post_body = @api_client.object_to_http_body(user_authorizations_request)
|
698
|
+
auth_names = []
|
699
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
700
|
+
:header_params => header_params,
|
701
|
+
:query_params => query_params,
|
702
|
+
:form_params => form_params,
|
703
|
+
:body => post_body,
|
704
|
+
:auth_names => auth_names,
|
705
|
+
:return_type => 'UserAuthorizationsResponse')
|
706
|
+
if @api_client.config.debugging
|
707
|
+
@api_client.config.logger.debug "API called: AccountsApi#create_user_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
708
|
+
end
|
709
|
+
return data, status_code, headers
|
710
|
+
end
|
711
|
+
|
554
712
|
# Deletes the specified account.
|
555
713
|
# This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
|
556
714
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -1080,6 +1238,117 @@ module DocuSign_eSign
|
|
1080
1238
|
return data, status_code, headers
|
1081
1239
|
end
|
1082
1240
|
|
1241
|
+
# Deletes the user authorization
|
1242
|
+
#
|
1243
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1244
|
+
# @param authorization_id
|
1245
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
1246
|
+
# @return [nil]
|
1247
|
+
def delete_user_authorization(account_id, authorization_id, user_id)
|
1248
|
+
delete_user_authorization_with_http_info(account_id, authorization_id, user_id)
|
1249
|
+
return nil
|
1250
|
+
end
|
1251
|
+
|
1252
|
+
# Deletes the user authorization
|
1253
|
+
#
|
1254
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1255
|
+
# @param authorization_id
|
1256
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
1257
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1258
|
+
def delete_user_authorization_with_http_info(account_id, authorization_id, user_id)
|
1259
|
+
if @api_client.config.debugging
|
1260
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_user_authorization ..."
|
1261
|
+
end
|
1262
|
+
# verify the required parameter 'account_id' is set
|
1263
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_user_authorization" if account_id.nil?
|
1264
|
+
# verify the required parameter 'authorization_id' is set
|
1265
|
+
fail ArgumentError, "Missing the required parameter 'authorization_id' when calling AccountsApi.delete_user_authorization" if authorization_id.nil?
|
1266
|
+
# verify the required parameter 'user_id' is set
|
1267
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.delete_user_authorization" if user_id.nil?
|
1268
|
+
# resource path
|
1269
|
+
local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'authorizationId' + '}', authorization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
1270
|
+
|
1271
|
+
# query parameters
|
1272
|
+
query_params = {}
|
1273
|
+
|
1274
|
+
# header parameters
|
1275
|
+
header_params = {}
|
1276
|
+
# HTTP header 'Accept' (if needed)
|
1277
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1278
|
+
|
1279
|
+
# form parameters
|
1280
|
+
form_params = {}
|
1281
|
+
|
1282
|
+
# http body (model)
|
1283
|
+
post_body = nil
|
1284
|
+
auth_names = []
|
1285
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
1286
|
+
:header_params => header_params,
|
1287
|
+
:query_params => query_params,
|
1288
|
+
:form_params => form_params,
|
1289
|
+
:body => post_body,
|
1290
|
+
:auth_names => auth_names)
|
1291
|
+
if @api_client.config.debugging
|
1292
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_user_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1293
|
+
end
|
1294
|
+
return data, status_code, headers
|
1295
|
+
end
|
1296
|
+
|
1297
|
+
# Creates ot updates user authorizations
|
1298
|
+
#
|
1299
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1300
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
1301
|
+
# @param user_authorizations_delete_request (optional parameter)
|
1302
|
+
# @return [UserAuthorizationsDeleteResponse]
|
1303
|
+
def delete_user_authorizations(account_id, user_id, user_authorizations_delete_request)
|
1304
|
+
data, _status_code, _headers = delete_user_authorizations_with_http_info(account_id, user_id, user_authorizations_delete_request)
|
1305
|
+
return data
|
1306
|
+
end
|
1307
|
+
|
1308
|
+
# Creates ot updates user authorizations
|
1309
|
+
#
|
1310
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1311
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
1312
|
+
# @param user_authorizations_delete_request (optional parameter)
|
1313
|
+
# @return [Array<(UserAuthorizationsDeleteResponse, Fixnum, Hash)>] UserAuthorizationsDeleteResponse data, response status code and response headers
|
1314
|
+
def delete_user_authorizations_with_http_info(account_id, user_id, user_authorizations_delete_request)
|
1315
|
+
if @api_client.config.debugging
|
1316
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_user_authorizations ..."
|
1317
|
+
end
|
1318
|
+
# verify the required parameter 'account_id' is set
|
1319
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_user_authorizations" if account_id.nil?
|
1320
|
+
# verify the required parameter 'user_id' is set
|
1321
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.delete_user_authorizations" if user_id.nil?
|
1322
|
+
# resource path
|
1323
|
+
local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorizations".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
1324
|
+
|
1325
|
+
# query parameters
|
1326
|
+
query_params = {}
|
1327
|
+
|
1328
|
+
# header parameters
|
1329
|
+
header_params = {}
|
1330
|
+
# HTTP header 'Accept' (if needed)
|
1331
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1332
|
+
|
1333
|
+
# form parameters
|
1334
|
+
form_params = {}
|
1335
|
+
|
1336
|
+
# http body (model)
|
1337
|
+
post_body = @api_client.object_to_http_body(user_authorizations_delete_request)
|
1338
|
+
auth_names = []
|
1339
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
1340
|
+
:header_params => header_params,
|
1341
|
+
:query_params => query_params,
|
1342
|
+
:form_params => form_params,
|
1343
|
+
:body => post_body,
|
1344
|
+
:auth_names => auth_names,
|
1345
|
+
:return_type => 'UserAuthorizationsDeleteResponse')
|
1346
|
+
if @api_client.config.debugging
|
1347
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_user_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1348
|
+
end
|
1349
|
+
return data, status_code, headers
|
1350
|
+
end
|
1351
|
+
|
1083
1352
|
# Get the list of identity verification options for an account
|
1084
1353
|
# This method returns a list of Identity Verification workflows that are available to an account. **Note:** To use this method, you must either be an account administrator or a sender. ### Related topics - [How to require ID Verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)
|
1085
1354
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -1397,6 +1666,67 @@ module DocuSign_eSign
|
|
1397
1666
|
return data, status_code, headers
|
1398
1667
|
end
|
1399
1668
|
|
1669
|
+
# Returns the agent user authorizations
|
1670
|
+
#
|
1671
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1672
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
1673
|
+
# @param DocuSign_eSign::GetAgentUserAuthorizationsOptions Options for modifying the behavior of the function.
|
1674
|
+
# @return [UserAuthorizations]
|
1675
|
+
def get_agent_user_authorizations(account_id, user_id, options = DocuSign_eSign::GetAgentUserAuthorizationsOptions.default)
|
1676
|
+
data, _status_code, _headers = get_agent_user_authorizations_with_http_info(account_id, user_id, options)
|
1677
|
+
return data
|
1678
|
+
end
|
1679
|
+
|
1680
|
+
# Returns the agent user authorizations
|
1681
|
+
#
|
1682
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1683
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
1684
|
+
# @param DocuSign_eSign::GetAgentUserAuthorizationsOptions Options for modifying the behavior of the function.
|
1685
|
+
# @return [Array<(UserAuthorizations, Fixnum, Hash)>] UserAuthorizations data, response status code and response headers
|
1686
|
+
def get_agent_user_authorizations_with_http_info(account_id, user_id, options = DocuSign_eSign::GetAgentUserAuthorizationsOptions.default)
|
1687
|
+
if @api_client.config.debugging
|
1688
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_agent_user_authorizations ..."
|
1689
|
+
end
|
1690
|
+
# verify the required parameter 'account_id' is set
|
1691
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_agent_user_authorizations" if account_id.nil?
|
1692
|
+
# verify the required parameter 'user_id' is set
|
1693
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.get_agent_user_authorizations" if user_id.nil?
|
1694
|
+
# resource path
|
1695
|
+
local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorizations/agent".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
1696
|
+
|
1697
|
+
# query parameters
|
1698
|
+
query_params = {}
|
1699
|
+
query_params[:'active_only'] = options.active_only if !options.active_only.nil?
|
1700
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
1701
|
+
query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
|
1702
|
+
query_params[:'permissions'] = options.permissions if !options.permissions.nil?
|
1703
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
1704
|
+
query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?
|
1705
|
+
|
1706
|
+
# header parameters
|
1707
|
+
header_params = {}
|
1708
|
+
# HTTP header 'Accept' (if needed)
|
1709
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1710
|
+
|
1711
|
+
# form parameters
|
1712
|
+
form_params = {}
|
1713
|
+
|
1714
|
+
# http body (model)
|
1715
|
+
post_body = nil
|
1716
|
+
auth_names = []
|
1717
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1718
|
+
:header_params => header_params,
|
1719
|
+
:query_params => query_params,
|
1720
|
+
:form_params => form_params,
|
1721
|
+
:body => post_body,
|
1722
|
+
:auth_names => auth_names,
|
1723
|
+
:return_type => 'UserAuthorizations')
|
1724
|
+
if @api_client.config.debugging
|
1725
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_agent_user_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1726
|
+
end
|
1727
|
+
return data, status_code, headers
|
1728
|
+
end
|
1729
|
+
|
1400
1730
|
# Get all payment gateway account for the provided accountId
|
1401
1731
|
# This method returns a list of payment gateway accounts and basic information about them.
|
1402
1732
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -1780,7 +2110,7 @@ module DocuSign_eSign
|
|
1780
2110
|
# Gets the Electronic Record and Signature Disclosure.
|
1781
2111
|
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
|
1782
2112
|
# @param account_id The external account number (int) or account ID Guid.
|
1783
|
-
# @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),
|
2113
|
+
# @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.
|
1784
2114
|
# @return [ConsumerDisclosure]
|
1785
2115
|
def get_consumer_disclosure(account_id, lang_code)
|
1786
2116
|
data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
|
@@ -1790,7 +2120,7 @@ module DocuSign_eSign
|
|
1790
2120
|
# Gets the Electronic Record and Signature Disclosure.
|
1791
2121
|
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
|
1792
2122
|
# @param account_id The external account number (int) or account ID Guid.
|
1793
|
-
# @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),
|
2123
|
+
# @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.
|
1794
2124
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
1795
2125
|
def get_consumer_disclosure_with_http_info(account_id, lang_code)
|
1796
2126
|
if @api_client.config.debugging
|
@@ -2228,6 +2558,67 @@ module DocuSign_eSign
|
|
2228
2558
|
return data, status_code, headers
|
2229
2559
|
end
|
2230
2560
|
|
2561
|
+
# Returns the principal user authorizations
|
2562
|
+
#
|
2563
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2564
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
2565
|
+
# @param DocuSign_eSign::GetPrincipalUserAuthorizationsOptions Options for modifying the behavior of the function.
|
2566
|
+
# @return [UserAuthorizations]
|
2567
|
+
def get_principal_user_authorizations(account_id, user_id, options = DocuSign_eSign::GetPrincipalUserAuthorizationsOptions.default)
|
2568
|
+
data, _status_code, _headers = get_principal_user_authorizations_with_http_info(account_id, user_id, options)
|
2569
|
+
return data
|
2570
|
+
end
|
2571
|
+
|
2572
|
+
# Returns the principal user authorizations
|
2573
|
+
#
|
2574
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2575
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
2576
|
+
# @param DocuSign_eSign::GetPrincipalUserAuthorizationsOptions Options for modifying the behavior of the function.
|
2577
|
+
# @return [Array<(UserAuthorizations, Fixnum, Hash)>] UserAuthorizations data, response status code and response headers
|
2578
|
+
def get_principal_user_authorizations_with_http_info(account_id, user_id, options = DocuSign_eSign::GetPrincipalUserAuthorizationsOptions.default)
|
2579
|
+
if @api_client.config.debugging
|
2580
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_principal_user_authorizations ..."
|
2581
|
+
end
|
2582
|
+
# verify the required parameter 'account_id' is set
|
2583
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_principal_user_authorizations" if account_id.nil?
|
2584
|
+
# verify the required parameter 'user_id' is set
|
2585
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.get_principal_user_authorizations" if user_id.nil?
|
2586
|
+
# resource path
|
2587
|
+
local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorizations".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
2588
|
+
|
2589
|
+
# query parameters
|
2590
|
+
query_params = {}
|
2591
|
+
query_params[:'active_only'] = options.active_only if !options.active_only.nil?
|
2592
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
2593
|
+
query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
|
2594
|
+
query_params[:'permissions'] = options.permissions if !options.permissions.nil?
|
2595
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
2596
|
+
query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?
|
2597
|
+
|
2598
|
+
# header parameters
|
2599
|
+
header_params = {}
|
2600
|
+
# HTTP header 'Accept' (if needed)
|
2601
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2602
|
+
|
2603
|
+
# form parameters
|
2604
|
+
form_params = {}
|
2605
|
+
|
2606
|
+
# http body (model)
|
2607
|
+
post_body = nil
|
2608
|
+
auth_names = []
|
2609
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2610
|
+
:header_params => header_params,
|
2611
|
+
:query_params => query_params,
|
2612
|
+
:form_params => form_params,
|
2613
|
+
:body => post_body,
|
2614
|
+
:auth_names => auth_names,
|
2615
|
+
:return_type => 'UserAuthorizations')
|
2616
|
+
if @api_client.config.debugging
|
2617
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_principal_user_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2618
|
+
end
|
2619
|
+
return data, status_code, headers
|
2620
|
+
end
|
2621
|
+
|
2231
2622
|
# Retrieves the account provisioning information for the account.
|
2232
2623
|
# Retrieves the account provisioning information for the account.
|
2233
2624
|
# @return [ProvisioningInformation]
|
@@ -2322,6 +2713,63 @@ module DocuSign_eSign
|
|
2322
2713
|
return data, status_code, headers
|
2323
2714
|
end
|
2324
2715
|
|
2716
|
+
# Returns the user authorization for a given authorization id
|
2717
|
+
#
|
2718
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2719
|
+
# @param authorization_id
|
2720
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
2721
|
+
# @return [UserAuthorization]
|
2722
|
+
def get_user_authorization(account_id, authorization_id, user_id)
|
2723
|
+
data, _status_code, _headers = get_user_authorization_with_http_info(account_id, authorization_id, user_id)
|
2724
|
+
return data
|
2725
|
+
end
|
2726
|
+
|
2727
|
+
# Returns the user authorization for a given authorization id
|
2728
|
+
#
|
2729
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2730
|
+
# @param authorization_id
|
2731
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
2732
|
+
# @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
|
2733
|
+
def get_user_authorization_with_http_info(account_id, authorization_id, user_id)
|
2734
|
+
if @api_client.config.debugging
|
2735
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_user_authorization ..."
|
2736
|
+
end
|
2737
|
+
# verify the required parameter 'account_id' is set
|
2738
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_user_authorization" if account_id.nil?
|
2739
|
+
# verify the required parameter 'authorization_id' is set
|
2740
|
+
fail ArgumentError, "Missing the required parameter 'authorization_id' when calling AccountsApi.get_user_authorization" if authorization_id.nil?
|
2741
|
+
# verify the required parameter 'user_id' is set
|
2742
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.get_user_authorization" if user_id.nil?
|
2743
|
+
# resource path
|
2744
|
+
local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'authorizationId' + '}', authorization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
2745
|
+
|
2746
|
+
# query parameters
|
2747
|
+
query_params = {}
|
2748
|
+
|
2749
|
+
# header parameters
|
2750
|
+
header_params = {}
|
2751
|
+
# HTTP header 'Accept' (if needed)
|
2752
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2753
|
+
|
2754
|
+
# form parameters
|
2755
|
+
form_params = {}
|
2756
|
+
|
2757
|
+
# http body (model)
|
2758
|
+
post_body = nil
|
2759
|
+
auth_names = []
|
2760
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2761
|
+
:header_params => header_params,
|
2762
|
+
:query_params => query_params,
|
2763
|
+
:form_params => form_params,
|
2764
|
+
:body => post_body,
|
2765
|
+
:auth_names => auth_names,
|
2766
|
+
:return_type => 'UserAuthorization')
|
2767
|
+
if @api_client.config.debugging
|
2768
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_user_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2769
|
+
end
|
2770
|
+
return data, status_code, headers
|
2771
|
+
end
|
2772
|
+
|
2325
2773
|
# Get watermark information.
|
2326
2774
|
#
|
2327
2775
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -3292,7 +3740,7 @@ module DocuSign_eSign
|
|
3292
3740
|
# Update Consumer Disclosure.
|
3293
3741
|
# Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter. **Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - `accountEsignId`: This property is read-only. - `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure. - `esignAgreement`: This property is read-only. - `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`. - Metadata properties: These properties are read-only. **Note:** The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating. **Important:** When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.
|
3294
3742
|
# @param account_id The external account number (int) or account ID Guid.
|
3295
|
-
# @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),
|
3743
|
+
# @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.
|
3296
3744
|
# @param consumer_disclosure (optional parameter)
|
3297
3745
|
# @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
|
3298
3746
|
# @return [ConsumerDisclosure]
|
@@ -3304,7 +3752,7 @@ module DocuSign_eSign
|
|
3304
3752
|
# Update Consumer Disclosure.
|
3305
3753
|
# Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter. **Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - `accountEsignId`: This property is read-only. - `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure. - `esignAgreement`: This property is read-only. - `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`. - Metadata properties: These properties are read-only. **Note:** The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating. **Important:** When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.
|
3306
3754
|
# @param account_id The external account number (int) or account ID Guid.
|
3307
|
-
# @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),
|
3755
|
+
# @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.
|
3308
3756
|
# @param consumer_disclosure (optional parameter)
|
3309
3757
|
# @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
|
3310
3758
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
@@ -3824,6 +4272,65 @@ module DocuSign_eSign
|
|
3824
4272
|
return data, status_code, headers
|
3825
4273
|
end
|
3826
4274
|
|
4275
|
+
# Updates the user authorization
|
4276
|
+
#
|
4277
|
+
# @param account_id The external account number (int) or account ID Guid.
|
4278
|
+
# @param authorization_id
|
4279
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
4280
|
+
# @param user_authorization_update_request (optional parameter)
|
4281
|
+
# @return [UserAuthorization]
|
4282
|
+
def update_user_authorization(account_id, authorization_id, user_id, user_authorization_update_request)
|
4283
|
+
data, _status_code, _headers = update_user_authorization_with_http_info(account_id, authorization_id, user_id, user_authorization_update_request)
|
4284
|
+
return data
|
4285
|
+
end
|
4286
|
+
|
4287
|
+
# Updates the user authorization
|
4288
|
+
#
|
4289
|
+
# @param account_id The external account number (int) or account ID Guid.
|
4290
|
+
# @param authorization_id
|
4291
|
+
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
4292
|
+
# @param user_authorization_update_request (optional parameter)
|
4293
|
+
# @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
|
4294
|
+
def update_user_authorization_with_http_info(account_id, authorization_id, user_id, user_authorization_update_request)
|
4295
|
+
if @api_client.config.debugging
|
4296
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_user_authorization ..."
|
4297
|
+
end
|
4298
|
+
# verify the required parameter 'account_id' is set
|
4299
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_user_authorization" if account_id.nil?
|
4300
|
+
# verify the required parameter 'authorization_id' is set
|
4301
|
+
fail ArgumentError, "Missing the required parameter 'authorization_id' when calling AccountsApi.update_user_authorization" if authorization_id.nil?
|
4302
|
+
# verify the required parameter 'user_id' is set
|
4303
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.update_user_authorization" if user_id.nil?
|
4304
|
+
# resource path
|
4305
|
+
local_var_path = "/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'authorizationId' + '}', authorization_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
|
4306
|
+
|
4307
|
+
# query parameters
|
4308
|
+
query_params = {}
|
4309
|
+
|
4310
|
+
# header parameters
|
4311
|
+
header_params = {}
|
4312
|
+
# HTTP header 'Accept' (if needed)
|
4313
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4314
|
+
|
4315
|
+
# form parameters
|
4316
|
+
form_params = {}
|
4317
|
+
|
4318
|
+
# http body (model)
|
4319
|
+
post_body = @api_client.object_to_http_body(user_authorization_update_request)
|
4320
|
+
auth_names = []
|
4321
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
4322
|
+
:header_params => header_params,
|
4323
|
+
:query_params => query_params,
|
4324
|
+
:form_params => form_params,
|
4325
|
+
:body => post_body,
|
4326
|
+
:auth_names => auth_names,
|
4327
|
+
:return_type => 'UserAuthorization')
|
4328
|
+
if @api_client.config.debugging
|
4329
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_user_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4330
|
+
end
|
4331
|
+
return data, status_code, headers
|
4332
|
+
end
|
4333
|
+
|
3827
4334
|
# Update watermark information.
|
3828
4335
|
#
|
3829
4336
|
# @param account_id The external account number (int) or account ID Guid.
|