docusign_esign 3.22.0 → 3.24.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +10 -0
  3. data/lib/docusign_esign/api/accounts_api.rb +519 -4
  4. data/lib/docusign_esign/api/billing_api.rb +2 -2
  5. data/lib/docusign_esign/api/envelopes_api.rb +2 -2
  6. data/lib/docusign_esign/client/api_client.rb +1 -1
  7. data/lib/docusign_esign/models/account_settings_information.rb +302 -2
  8. data/lib/docusign_esign/models/account_ui_settings.rb +21 -1
  9. data/lib/docusign_esign/models/authorization_user.rb +214 -0
  10. data/lib/docusign_esign/models/billing_charge.rb +1 -1
  11. data/lib/docusign_esign/models/bulk_send_batch_summary.rb +21 -1
  12. data/lib/docusign_esign/models/delayed_routing.rb +1 -1
  13. data/lib/docusign_esign/models/initial_here.rb +1 -1
  14. data/lib/docusign_esign/models/offline_attributes.rb +1 -1
  15. data/lib/docusign_esign/models/scheduled_sending.rb +1 -1
  16. data/lib/docusign_esign/models/user_authorization.rb +274 -0
  17. data/lib/docusign_esign/models/user_authorization_create_request.rb +214 -0
  18. data/lib/docusign_esign/models/user_authorization_create_request_with_id.rb +224 -0
  19. data/lib/docusign_esign/models/user_authorization_id_with_status.rb +204 -0
  20. data/lib/docusign_esign/models/user_authorization_update_request.rb +194 -0
  21. data/lib/docusign_esign/models/user_authorization_with_status.rb +204 -0
  22. data/lib/docusign_esign/models/user_authorizations.rb +246 -0
  23. data/lib/docusign_esign/models/user_authorizations_delete_request.rb +186 -0
  24. data/lib/docusign_esign/models/user_authorizations_delete_response.rb +186 -0
  25. data/lib/docusign_esign/models/user_authorizations_request.rb +186 -0
  26. data/lib/docusign_esign/models/user_authorizations_response.rb +186 -0
  27. data/lib/docusign_esign/version.rb +1 -1
  28. data/lib/docusign_esign.rb +12 -0
  29. metadata +14 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 66c42c585fce371eb5dc319f05d6d493f6a36bb9bcd23afe1537f7832817eed7
4
- data.tar.gz: 0a2a90f1acf14622a7c0613edc9ce88f069e77e90d5273817813ec5a0284bcb5
3
+ metadata.gz: fdc21883a35e5026cd600dcd85b453c28986de9bd752c757c68c0d3d15123572
4
+ data.tar.gz: 5c13ca30b9243994b697d1c9de8d408fd458558e0fe07a83bb33a7858bf7af22
5
5
  SHA512:
6
- metadata.gz: 8df425d194f9cc4ee111103f55fcafdb85eef61e5f5b0b1fbf6623d12352cfb96db6859f4819334186abda98ca0375fe8a247488395979d74274935860d79e62
7
- data.tar.gz: 1d6f7256fa83053c2cb5d5036cb4fd8b323d333ec7fb0f3f458638bc049b6a1e1155ab535bafeedb2a3ff4f718fbd66c5353ca16f67d8cfaa7cbbbbdfb9182dd
6
+ metadata.gz: dae5187b86008596000ecec4eeda6648d52d2620d212167b555b632659a5015dae67bc9e926e082fb7438fb58c8b6b7f70209368d95d7a247096e8f1ec7e16a2
7
+ data.tar.gz: 75afd142ef3f42a84999f12b4d946b4b7de25b966142026097026b90af733162433caea00cde17e80756fd3e19ce81ba823124abaa197c46ef391f9eba62b3fd
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.24.0] - eSignature API v2.1-23.2.00.00 - 2023-05-15
7
+ ### Changed
8
+ - Added support for version v2.1-23.2.00.00 of the DocuSign ESignature API.
9
+ - Updated the SDK release version.
10
+
11
+ ## [v3.23.0] - eSignature API v2.1-23.1.01.01 - 2023-04-05
12
+ ### Changed
13
+ - Added support for version v2.1-23.1.01.01 of the DocuSign ESignature API.
14
+ - Updated the SDK release version.
15
+
6
16
  ## [v3.22.0] - eSignature API v2.1-23.1.01.00 - 2023-03-17
7
17
  ### Changed
8
18
  - Added support for version v2.1-23.1.01.00 of the DocuSign ESignature API.
@@ -100,6 +100,33 @@ 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
+ # Part (substring) of email we are searching for.
111
+ attr_accessor :email_substring
112
+
113
+ #
114
+ attr_accessor :include_closed_users
115
+
116
+ #
117
+ attr_accessor :permissions
118
+
119
+ #
120
+ attr_accessor :start_position
121
+
122
+ #
123
+ attr_accessor :user_name_substring
124
+
125
+ def self.default
126
+ @@default ||= GetAgentUserAuthorizationsOptions.new
127
+ end
128
+ end
129
+
103
130
  class GetBillingChargesOptions
104
131
  # Specifies which billing charges to return. Valid values are: * envelopes * seats
105
132
  attr_accessor :include_charges
@@ -151,6 +178,33 @@ module DocuSign_eSign
151
178
  end
152
179
  end
153
180
 
181
+ class GetPrincipalUserAuthorizationsOptions
182
+ #
183
+ attr_accessor :active_only
184
+
185
+ #
186
+ attr_accessor :count
187
+
188
+ # Part (substring) of email we are searching for.
189
+ attr_accessor :email_substring
190
+
191
+ #
192
+ attr_accessor :include_closed_users
193
+
194
+ #
195
+ attr_accessor :permissions
196
+
197
+ #
198
+ attr_accessor :start_position
199
+
200
+ #
201
+ attr_accessor :user_name_substring
202
+
203
+ def self.default
204
+ @@default ||= GetPrincipalUserAuthorizationsOptions.new
205
+ end
206
+ end
207
+
154
208
  class ListBrandsOptions
155
209
  # When set to **true**, excludes distributor brand information from the response set.
156
210
  attr_accessor :exclude_distributor_brand
@@ -551,6 +605,116 @@ module DocuSign_eSign
551
605
  return data, status_code, headers
552
606
  end
553
607
 
608
+ # Creates the user authorization
609
+ #
610
+ # @param account_id The external account number (int) or account ID Guid.
611
+ # @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.
612
+ # @param user_authorization_create_request (optional parameter)
613
+ # @return [UserAuthorization]
614
+ def create_user_authorization(account_id, user_id, user_authorization_create_request)
615
+ data, _status_code, _headers = create_user_authorization_with_http_info(account_id, user_id, user_authorization_create_request)
616
+ return data
617
+ end
618
+
619
+ # Creates the user authorization
620
+ #
621
+ # @param account_id The external account number (int) or account ID Guid.
622
+ # @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.
623
+ # @param user_authorization_create_request (optional parameter)
624
+ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
625
+ def create_user_authorization_with_http_info(account_id, user_id, user_authorization_create_request)
626
+ if @api_client.config.debugging
627
+ @api_client.config.logger.debug "Calling API: AccountsApi.create_user_authorization ..."
628
+ end
629
+ # verify the required parameter 'account_id' is set
630
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_user_authorization" if account_id.nil?
631
+ # verify the required parameter 'user_id' is set
632
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.create_user_authorization" if user_id.nil?
633
+ # resource path
634
+ 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)
635
+
636
+ # query parameters
637
+ query_params = {}
638
+
639
+ # header parameters
640
+ header_params = {}
641
+ # HTTP header 'Accept' (if needed)
642
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
643
+
644
+ # form parameters
645
+ form_params = {}
646
+
647
+ # http body (model)
648
+ post_body = @api_client.object_to_http_body(user_authorization_create_request)
649
+ auth_names = []
650
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
651
+ :header_params => header_params,
652
+ :query_params => query_params,
653
+ :form_params => form_params,
654
+ :body => post_body,
655
+ :auth_names => auth_names,
656
+ :return_type => 'UserAuthorization')
657
+ if @api_client.config.debugging
658
+ @api_client.config.logger.debug "API called: AccountsApi#create_user_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
659
+ end
660
+ return data, status_code, headers
661
+ end
662
+
663
+ # Creates ot updates user authorizations
664
+ #
665
+ # @param account_id The external account number (int) or account ID Guid.
666
+ # @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.
667
+ # @param user_authorizations_request (optional parameter)
668
+ # @return [UserAuthorizationsResponse]
669
+ def create_user_authorizations(account_id, user_id, user_authorizations_request)
670
+ data, _status_code, _headers = create_user_authorizations_with_http_info(account_id, user_id, user_authorizations_request)
671
+ return data
672
+ end
673
+
674
+ # Creates ot updates user authorizations
675
+ #
676
+ # @param account_id The external account number (int) or account ID Guid.
677
+ # @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.
678
+ # @param user_authorizations_request (optional parameter)
679
+ # @return [Array<(UserAuthorizationsResponse, Fixnum, Hash)>] UserAuthorizationsResponse data, response status code and response headers
680
+ def create_user_authorizations_with_http_info(account_id, user_id, user_authorizations_request)
681
+ if @api_client.config.debugging
682
+ @api_client.config.logger.debug "Calling API: AccountsApi.create_user_authorizations ..."
683
+ end
684
+ # verify the required parameter 'account_id' is set
685
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_user_authorizations" if account_id.nil?
686
+ # verify the required parameter 'user_id' is set
687
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.create_user_authorizations" if user_id.nil?
688
+ # resource path
689
+ 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)
690
+
691
+ # query parameters
692
+ query_params = {}
693
+
694
+ # header parameters
695
+ header_params = {}
696
+ # HTTP header 'Accept' (if needed)
697
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
698
+
699
+ # form parameters
700
+ form_params = {}
701
+
702
+ # http body (model)
703
+ post_body = @api_client.object_to_http_body(user_authorizations_request)
704
+ auth_names = []
705
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
706
+ :header_params => header_params,
707
+ :query_params => query_params,
708
+ :form_params => form_params,
709
+ :body => post_body,
710
+ :auth_names => auth_names,
711
+ :return_type => 'UserAuthorizationsResponse')
712
+ if @api_client.config.debugging
713
+ @api_client.config.logger.debug "API called: AccountsApi#create_user_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
714
+ end
715
+ return data, status_code, headers
716
+ end
717
+
554
718
  # Deletes the specified account.
555
719
  # 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
720
  # @param account_id The external account number (int) or account ID Guid.
@@ -1080,6 +1244,117 @@ module DocuSign_eSign
1080
1244
  return data, status_code, headers
1081
1245
  end
1082
1246
 
1247
+ # Deletes the user authorization
1248
+ #
1249
+ # @param account_id The external account number (int) or account ID Guid.
1250
+ # @param authorization_id
1251
+ # @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.
1252
+ # @return [nil]
1253
+ def delete_user_authorization(account_id, authorization_id, user_id)
1254
+ delete_user_authorization_with_http_info(account_id, authorization_id, user_id)
1255
+ return nil
1256
+ end
1257
+
1258
+ # Deletes the user authorization
1259
+ #
1260
+ # @param account_id The external account number (int) or account ID Guid.
1261
+ # @param authorization_id
1262
+ # @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.
1263
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1264
+ def delete_user_authorization_with_http_info(account_id, authorization_id, user_id)
1265
+ if @api_client.config.debugging
1266
+ @api_client.config.logger.debug "Calling API: AccountsApi.delete_user_authorization ..."
1267
+ end
1268
+ # verify the required parameter 'account_id' is set
1269
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_user_authorization" if account_id.nil?
1270
+ # verify the required parameter 'authorization_id' is set
1271
+ fail ArgumentError, "Missing the required parameter 'authorization_id' when calling AccountsApi.delete_user_authorization" if authorization_id.nil?
1272
+ # verify the required parameter 'user_id' is set
1273
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.delete_user_authorization" if user_id.nil?
1274
+ # resource path
1275
+ 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)
1276
+
1277
+ # query parameters
1278
+ query_params = {}
1279
+
1280
+ # header parameters
1281
+ header_params = {}
1282
+ # HTTP header 'Accept' (if needed)
1283
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1284
+
1285
+ # form parameters
1286
+ form_params = {}
1287
+
1288
+ # http body (model)
1289
+ post_body = nil
1290
+ auth_names = []
1291
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
1292
+ :header_params => header_params,
1293
+ :query_params => query_params,
1294
+ :form_params => form_params,
1295
+ :body => post_body,
1296
+ :auth_names => auth_names)
1297
+ if @api_client.config.debugging
1298
+ @api_client.config.logger.debug "API called: AccountsApi#delete_user_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1299
+ end
1300
+ return data, status_code, headers
1301
+ end
1302
+
1303
+ # Creates ot updates user authorizations
1304
+ #
1305
+ # @param account_id The external account number (int) or account ID Guid.
1306
+ # @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.
1307
+ # @param user_authorizations_delete_request (optional parameter)
1308
+ # @return [UserAuthorizationsDeleteResponse]
1309
+ def delete_user_authorizations(account_id, user_id, user_authorizations_delete_request)
1310
+ data, _status_code, _headers = delete_user_authorizations_with_http_info(account_id, user_id, user_authorizations_delete_request)
1311
+ return data
1312
+ end
1313
+
1314
+ # Creates ot updates user authorizations
1315
+ #
1316
+ # @param account_id The external account number (int) or account ID Guid.
1317
+ # @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.
1318
+ # @param user_authorizations_delete_request (optional parameter)
1319
+ # @return [Array<(UserAuthorizationsDeleteResponse, Fixnum, Hash)>] UserAuthorizationsDeleteResponse data, response status code and response headers
1320
+ def delete_user_authorizations_with_http_info(account_id, user_id, user_authorizations_delete_request)
1321
+ if @api_client.config.debugging
1322
+ @api_client.config.logger.debug "Calling API: AccountsApi.delete_user_authorizations ..."
1323
+ end
1324
+ # verify the required parameter 'account_id' is set
1325
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_user_authorizations" if account_id.nil?
1326
+ # verify the required parameter 'user_id' is set
1327
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.delete_user_authorizations" if user_id.nil?
1328
+ # resource path
1329
+ 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)
1330
+
1331
+ # query parameters
1332
+ query_params = {}
1333
+
1334
+ # header parameters
1335
+ header_params = {}
1336
+ # HTTP header 'Accept' (if needed)
1337
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1338
+
1339
+ # form parameters
1340
+ form_params = {}
1341
+
1342
+ # http body (model)
1343
+ post_body = @api_client.object_to_http_body(user_authorizations_delete_request)
1344
+ auth_names = []
1345
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
1346
+ :header_params => header_params,
1347
+ :query_params => query_params,
1348
+ :form_params => form_params,
1349
+ :body => post_body,
1350
+ :auth_names => auth_names,
1351
+ :return_type => 'UserAuthorizationsDeleteResponse')
1352
+ if @api_client.config.debugging
1353
+ @api_client.config.logger.debug "API called: AccountsApi#delete_user_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1354
+ end
1355
+ return data, status_code, headers
1356
+ end
1357
+
1083
1358
  # Get the list of identity verification options for an account
1084
1359
  # 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
1360
  # @param account_id The external account number (int) or account ID Guid.
@@ -1397,6 +1672,68 @@ module DocuSign_eSign
1397
1672
  return data, status_code, headers
1398
1673
  end
1399
1674
 
1675
+ # Returns the agent user authorizations
1676
+ #
1677
+ # @param account_id The external account number (int) or account ID Guid.
1678
+ # @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.
1679
+ # @param DocuSign_eSign::GetAgentUserAuthorizationsOptions Options for modifying the behavior of the function.
1680
+ # @return [UserAuthorizations]
1681
+ def get_agent_user_authorizations(account_id, user_id, options = DocuSign_eSign::GetAgentUserAuthorizationsOptions.default)
1682
+ data, _status_code, _headers = get_agent_user_authorizations_with_http_info(account_id, user_id, options)
1683
+ return data
1684
+ end
1685
+
1686
+ # Returns the agent user authorizations
1687
+ #
1688
+ # @param account_id The external account number (int) or account ID Guid.
1689
+ # @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.
1690
+ # @param DocuSign_eSign::GetAgentUserAuthorizationsOptions Options for modifying the behavior of the function.
1691
+ # @return [Array<(UserAuthorizations, Fixnum, Hash)>] UserAuthorizations data, response status code and response headers
1692
+ def get_agent_user_authorizations_with_http_info(account_id, user_id, options = DocuSign_eSign::GetAgentUserAuthorizationsOptions.default)
1693
+ if @api_client.config.debugging
1694
+ @api_client.config.logger.debug "Calling API: AccountsApi.get_agent_user_authorizations ..."
1695
+ end
1696
+ # verify the required parameter 'account_id' is set
1697
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_agent_user_authorizations" if account_id.nil?
1698
+ # verify the required parameter 'user_id' is set
1699
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.get_agent_user_authorizations" if user_id.nil?
1700
+ # resource path
1701
+ 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)
1702
+
1703
+ # query parameters
1704
+ query_params = {}
1705
+ query_params[:'active_only'] = options.active_only if !options.active_only.nil?
1706
+ query_params[:'count'] = options.count if !options.count.nil?
1707
+ query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
1708
+ query_params[:'include_closed_users'] = options.include_closed_users if !options.include_closed_users.nil?
1709
+ query_params[:'permissions'] = options.permissions if !options.permissions.nil?
1710
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
1711
+ query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?
1712
+
1713
+ # header parameters
1714
+ header_params = {}
1715
+ # HTTP header 'Accept' (if needed)
1716
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1717
+
1718
+ # form parameters
1719
+ form_params = {}
1720
+
1721
+ # http body (model)
1722
+ post_body = nil
1723
+ auth_names = []
1724
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1725
+ :header_params => header_params,
1726
+ :query_params => query_params,
1727
+ :form_params => form_params,
1728
+ :body => post_body,
1729
+ :auth_names => auth_names,
1730
+ :return_type => 'UserAuthorizations')
1731
+ if @api_client.config.debugging
1732
+ @api_client.config.logger.debug "API called: AccountsApi#get_agent_user_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1733
+ end
1734
+ return data, status_code, headers
1735
+ end
1736
+
1400
1737
  # Get all payment gateway account for the provided accountId
1401
1738
  # This method returns a list of payment gateway accounts and basic information about them.
1402
1739
  # @param account_id The external account number (int) or account ID Guid.
@@ -1780,7 +2117,7 @@ module DocuSign_eSign
1780
2117
  # Gets the Electronic Record and Signature Disclosure.
1781
2118
  # 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
2119
  # @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), 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.
2120
+ # @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), 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
2121
  # @return [ConsumerDisclosure]
1785
2122
  def get_consumer_disclosure(account_id, lang_code)
1786
2123
  data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
@@ -1790,7 +2127,7 @@ module DocuSign_eSign
1790
2127
  # Gets the Electronic Record and Signature Disclosure.
1791
2128
  # 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
2129
  # @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), 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.
2130
+ # @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), 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
2131
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
1795
2132
  def get_consumer_disclosure_with_http_info(account_id, lang_code)
1796
2133
  if @api_client.config.debugging
@@ -2228,6 +2565,68 @@ module DocuSign_eSign
2228
2565
  return data, status_code, headers
2229
2566
  end
2230
2567
 
2568
+ # Returns the principal user authorizations
2569
+ #
2570
+ # @param account_id The external account number (int) or account ID Guid.
2571
+ # @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.
2572
+ # @param DocuSign_eSign::GetPrincipalUserAuthorizationsOptions Options for modifying the behavior of the function.
2573
+ # @return [UserAuthorizations]
2574
+ def get_principal_user_authorizations(account_id, user_id, options = DocuSign_eSign::GetPrincipalUserAuthorizationsOptions.default)
2575
+ data, _status_code, _headers = get_principal_user_authorizations_with_http_info(account_id, user_id, options)
2576
+ return data
2577
+ end
2578
+
2579
+ # Returns the principal user authorizations
2580
+ #
2581
+ # @param account_id The external account number (int) or account ID Guid.
2582
+ # @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.
2583
+ # @param DocuSign_eSign::GetPrincipalUserAuthorizationsOptions Options for modifying the behavior of the function.
2584
+ # @return [Array<(UserAuthorizations, Fixnum, Hash)>] UserAuthorizations data, response status code and response headers
2585
+ def get_principal_user_authorizations_with_http_info(account_id, user_id, options = DocuSign_eSign::GetPrincipalUserAuthorizationsOptions.default)
2586
+ if @api_client.config.debugging
2587
+ @api_client.config.logger.debug "Calling API: AccountsApi.get_principal_user_authorizations ..."
2588
+ end
2589
+ # verify the required parameter 'account_id' is set
2590
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_principal_user_authorizations" if account_id.nil?
2591
+ # verify the required parameter 'user_id' is set
2592
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.get_principal_user_authorizations" if user_id.nil?
2593
+ # resource path
2594
+ 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)
2595
+
2596
+ # query parameters
2597
+ query_params = {}
2598
+ query_params[:'active_only'] = options.active_only if !options.active_only.nil?
2599
+ query_params[:'count'] = options.count if !options.count.nil?
2600
+ query_params[:'email_substring'] = options.email_substring if !options.email_substring.nil?
2601
+ query_params[:'include_closed_users'] = options.include_closed_users if !options.include_closed_users.nil?
2602
+ query_params[:'permissions'] = options.permissions if !options.permissions.nil?
2603
+ query_params[:'start_position'] = options.start_position if !options.start_position.nil?
2604
+ query_params[:'user_name_substring'] = options.user_name_substring if !options.user_name_substring.nil?
2605
+
2606
+ # header parameters
2607
+ header_params = {}
2608
+ # HTTP header 'Accept' (if needed)
2609
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2610
+
2611
+ # form parameters
2612
+ form_params = {}
2613
+
2614
+ # http body (model)
2615
+ post_body = nil
2616
+ auth_names = []
2617
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2618
+ :header_params => header_params,
2619
+ :query_params => query_params,
2620
+ :form_params => form_params,
2621
+ :body => post_body,
2622
+ :auth_names => auth_names,
2623
+ :return_type => 'UserAuthorizations')
2624
+ if @api_client.config.debugging
2625
+ @api_client.config.logger.debug "API called: AccountsApi#get_principal_user_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2626
+ end
2627
+ return data, status_code, headers
2628
+ end
2629
+
2231
2630
  # Retrieves the account provisioning information for the account.
2232
2631
  # Retrieves the account provisioning information for the account.
2233
2632
  # @return [ProvisioningInformation]
@@ -2322,6 +2721,63 @@ module DocuSign_eSign
2322
2721
  return data, status_code, headers
2323
2722
  end
2324
2723
 
2724
+ # Returns the user authorization for a given authorization id
2725
+ #
2726
+ # @param account_id The external account number (int) or account ID Guid.
2727
+ # @param authorization_id
2728
+ # @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.
2729
+ # @return [UserAuthorization]
2730
+ def get_user_authorization(account_id, authorization_id, user_id)
2731
+ data, _status_code, _headers = get_user_authorization_with_http_info(account_id, authorization_id, user_id)
2732
+ return data
2733
+ end
2734
+
2735
+ # Returns the user authorization for a given authorization id
2736
+ #
2737
+ # @param account_id The external account number (int) or account ID Guid.
2738
+ # @param authorization_id
2739
+ # @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.
2740
+ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
2741
+ def get_user_authorization_with_http_info(account_id, authorization_id, user_id)
2742
+ if @api_client.config.debugging
2743
+ @api_client.config.logger.debug "Calling API: AccountsApi.get_user_authorization ..."
2744
+ end
2745
+ # verify the required parameter 'account_id' is set
2746
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_user_authorization" if account_id.nil?
2747
+ # verify the required parameter 'authorization_id' is set
2748
+ fail ArgumentError, "Missing the required parameter 'authorization_id' when calling AccountsApi.get_user_authorization" if authorization_id.nil?
2749
+ # verify the required parameter 'user_id' is set
2750
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.get_user_authorization" if user_id.nil?
2751
+ # resource path
2752
+ 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)
2753
+
2754
+ # query parameters
2755
+ query_params = {}
2756
+
2757
+ # header parameters
2758
+ header_params = {}
2759
+ # HTTP header 'Accept' (if needed)
2760
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2761
+
2762
+ # form parameters
2763
+ form_params = {}
2764
+
2765
+ # http body (model)
2766
+ post_body = nil
2767
+ auth_names = []
2768
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2769
+ :header_params => header_params,
2770
+ :query_params => query_params,
2771
+ :form_params => form_params,
2772
+ :body => post_body,
2773
+ :auth_names => auth_names,
2774
+ :return_type => 'UserAuthorization')
2775
+ if @api_client.config.debugging
2776
+ @api_client.config.logger.debug "API called: AccountsApi#get_user_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2777
+ end
2778
+ return data, status_code, headers
2779
+ end
2780
+
2325
2781
  # Get watermark information.
2326
2782
  #
2327
2783
  # @param account_id The external account number (int) or account ID Guid.
@@ -3292,7 +3748,7 @@ module DocuSign_eSign
3292
3748
  # Update Consumer Disclosure.
3293
3749
  # 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
3750
  # @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), 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.
3751
+ # @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), 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
3752
  # @param consumer_disclosure (optional parameter)
3297
3753
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
3298
3754
  # @return [ConsumerDisclosure]
@@ -3304,7 +3760,7 @@ module DocuSign_eSign
3304
3760
  # Update Consumer Disclosure.
3305
3761
  # 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;custom&#x60;: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure. - &#x60;esignAgreement&#x60;: This property is read-only. - &#x60;esignText&#x60;: You cannot edit this property when &#x60;custom&#x60; is set to **false.** The API returns a 200 OK HTTP response, but does not update the &#x60;esignText&#x60;. - 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 &#x60;custom&#x60; property to **true** and customize the value for the &#x60;eSignText&#x60; property. You can also edit all of the other properties except for the following ones: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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 &#x60;langCode&#x60; 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: - &#x60;accountEsignId&#x60;: This property is read-only. - &#x60;esignAgreement&#x60;: 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
3762
  # @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), 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.
3763
+ # @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), 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
3764
  # @param consumer_disclosure (optional parameter)
3309
3765
  # @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
3310
3766
  # @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
@@ -3824,6 +4280,65 @@ module DocuSign_eSign
3824
4280
  return data, status_code, headers
3825
4281
  end
3826
4282
 
4283
+ # Updates the user authorization
4284
+ #
4285
+ # @param account_id The external account number (int) or account ID Guid.
4286
+ # @param authorization_id
4287
+ # @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.
4288
+ # @param user_authorization_update_request (optional parameter)
4289
+ # @return [UserAuthorization]
4290
+ def update_user_authorization(account_id, authorization_id, user_id, user_authorization_update_request)
4291
+ data, _status_code, _headers = update_user_authorization_with_http_info(account_id, authorization_id, user_id, user_authorization_update_request)
4292
+ return data
4293
+ end
4294
+
4295
+ # Updates the user authorization
4296
+ #
4297
+ # @param account_id The external account number (int) or account ID Guid.
4298
+ # @param authorization_id
4299
+ # @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.
4300
+ # @param user_authorization_update_request (optional parameter)
4301
+ # @return [Array<(UserAuthorization, Fixnum, Hash)>] UserAuthorization data, response status code and response headers
4302
+ def update_user_authorization_with_http_info(account_id, authorization_id, user_id, user_authorization_update_request)
4303
+ if @api_client.config.debugging
4304
+ @api_client.config.logger.debug "Calling API: AccountsApi.update_user_authorization ..."
4305
+ end
4306
+ # verify the required parameter 'account_id' is set
4307
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_user_authorization" if account_id.nil?
4308
+ # verify the required parameter 'authorization_id' is set
4309
+ fail ArgumentError, "Missing the required parameter 'authorization_id' when calling AccountsApi.update_user_authorization" if authorization_id.nil?
4310
+ # verify the required parameter 'user_id' is set
4311
+ fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.update_user_authorization" if user_id.nil?
4312
+ # resource path
4313
+ 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)
4314
+
4315
+ # query parameters
4316
+ query_params = {}
4317
+
4318
+ # header parameters
4319
+ header_params = {}
4320
+ # HTTP header 'Accept' (if needed)
4321
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4322
+
4323
+ # form parameters
4324
+ form_params = {}
4325
+
4326
+ # http body (model)
4327
+ post_body = @api_client.object_to_http_body(user_authorization_update_request)
4328
+ auth_names = []
4329
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
4330
+ :header_params => header_params,
4331
+ :query_params => query_params,
4332
+ :form_params => form_params,
4333
+ :body => post_body,
4334
+ :auth_names => auth_names,
4335
+ :return_type => 'UserAuthorization')
4336
+ if @api_client.config.debugging
4337
+ @api_client.config.logger.debug "API called: AccountsApi#update_user_authorization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4338
+ end
4339
+ return data, status_code, headers
4340
+ end
4341
+
3827
4342
  # Update watermark information.
3828
4343
  #
3829
4344
  # @param account_id The external account number (int) or account ID Guid.