docusign_esign 3.7.0.rc1 → 3.8.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (55) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +8 -9
  3. data/docusign_esign-2.8.0.rc1.gem +0 -0
  4. data/lib/docusign_esign.rb +29 -1
  5. data/lib/docusign_esign/api/accounts_api.rb +65 -8
  6. data/lib/docusign_esign/api/bulk_envelopes_api.rb +22 -298
  7. data/lib/docusign_esign/api/connect_api.rb +196 -0
  8. data/lib/docusign_esign/api/envelopes_api.rb +1502 -78
  9. data/lib/docusign_esign/api/groups_api.rb +9 -9
  10. data/lib/docusign_esign/api/trust_service_providers_api.rb +232 -0
  11. data/lib/docusign_esign/api/users_api.rb +52 -0
  12. data/lib/docusign_esign/models/account_billing_plan.rb +11 -1
  13. data/lib/docusign_esign/models/account_information.rb +34 -4
  14. data/lib/docusign_esign/models/account_settings_information.rb +134 -1
  15. data/lib/docusign_esign/models/account_ui_settings.rb +20 -1
  16. data/lib/docusign_esign/models/bulk_send_batch_request.rb +184 -0
  17. data/lib/docusign_esign/models/bulk_send_batch_status.rb +21 -1
  18. data/lib/docusign_esign/models/complete_sign_hash_response.rb +7 -11
  19. data/lib/docusign_esign/models/complete_sign_request.rb +7 -11
  20. data/lib/docusign_esign/models/credential.rb +7 -11
  21. data/lib/docusign_esign/models/display_appliance_account.rb +224 -0
  22. data/lib/docusign_esign/models/display_appliance_info.rb +174 -0
  23. data/lib/docusign_esign/models/display_appliance_pdf.rb +174 -0
  24. data/lib/docusign_esign/models/display_appliance_signer_attachment.rb +174 -0
  25. data/lib/docusign_esign/models/document.rb +11 -1
  26. data/lib/docusign_esign/models/document_security_store.rb +7 -11
  27. data/lib/docusign_esign/models/document_update_info.rb +7 -11
  28. data/lib/docusign_esign/models/envelope_form_data.rb +13 -1
  29. data/lib/docusign_esign/models/external_claim.rb +7 -11
  30. data/lib/docusign_esign/models/group_brands.rb +207 -0
  31. data/lib/docusign_esign/models/payment_details.rb +10 -1
  32. data/lib/docusign_esign/models/payment_signer_values.rb +184 -0
  33. data/lib/docusign_esign/models/prefill_tabs.rb +222 -0
  34. data/lib/docusign_esign/models/revision.rb +7 -11
  35. data/lib/docusign_esign/models/seal.rb +8 -12
  36. data/lib/docusign_esign/models/sender.rb +7 -11
  37. data/lib/docusign_esign/models/sign_hash_document.rb +7 -11
  38. data/lib/docusign_esign/models/sign_hash_session_info_response.rb +7 -11
  39. data/lib/docusign_esign/models/sign_session_info_request.rb +7 -11
  40. data/lib/docusign_esign/models/signature_data_info.rb +7 -11
  41. data/lib/docusign_esign/models/signature_properties.rb +7 -11
  42. data/lib/docusign_esign/models/tab_account_settings.rb +20 -1
  43. data/lib/docusign_esign/models/tabs.rb +10 -1
  44. data/lib/docusign_esign/models/template_tabs.rb +10 -1
  45. data/lib/docusign_esign/models/time_stamp_field.rb +7 -11
  46. data/lib/docusign_esign/models/tsp_health_check_request.rb +7 -11
  47. data/lib/docusign_esign/models/tsp_health_check_status_description.rb +7 -11
  48. data/lib/docusign_esign/models/update_transaction_request.rb +7 -11
  49. data/lib/docusign_esign/models/update_transaction_response.rb +7 -11
  50. data/lib/docusign_esign/models/user.rb +7 -11
  51. data/lib/docusign_esign/models/user_info_response.rb +7 -11
  52. data/lib/docusign_esign/models/user_information.rb +11 -1
  53. data/lib/docusign_esign/version.rb +1 -1
  54. data/tests/Gemfile.lock +9 -5
  55. metadata +11 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fa58c56f9c457a432847d350018872f0f08ffe2fd9ef121630d8a2179613dd5c
4
- data.tar.gz: ec1a7ba37addfd5f391018c467af786313ac170441aeebddfccbff793a707035
3
+ metadata.gz: 4261441534349fd5b5ecbc58fafc48750839b8e94c340c745e715110b2f8fff6
4
+ data.tar.gz: ef5fc51375fec46a1c3d1df3071086f09d1b4033a72249fc828888ba309d6119
5
5
  SHA512:
6
- metadata.gz: bbed559fbea75b3aa7730f9686bcc99851502ba29e4c394ef3ba1b59d978f6c0badb1fa7bb2e1f2f18edefba7067049bceb7500faea37a1816336df10c4114c6
7
- data.tar.gz: 4e7f164b4604e3eec6271a27cb2982252e0e35038bca45e7c741f91500c65a0c36ba7f4df0f0e1f0694f8e5e7335742b3860acb976b700167b91d13c07f64e72
6
+ metadata.gz: a52973ced1bb0e8f2ac11342d8e0dfc01dbfbcc171641451898e6b2926693b8d0f8d9925b732a32d7ad0767845942e011307a3454dbcb40903cf1428e5a5de49
7
+ data.tar.gz: 33ead663873b0a77adce3a5ff3a7497ad3fca5d49499dbf1a1d51309a5847cc9fd385ee69a64a99c1e317c0ece2379761f340db81d4aea3aa4c310ac18be7158
@@ -1,7 +1,8 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- docusign_esign (3.6.0.rc1)
4
+ docusign_esign (3.7.0.rc1)
5
+ addressable (~> 2.7, >= 2.7.0)
5
6
  json (~> 2.1, >= 2.1.0)
6
7
  jwt (~> 2.2, >= 2.2.1)
7
8
  typhoeus (~> 1.0, >= 1.0.1)
@@ -18,31 +19,29 @@ GEM
18
19
  sys-uname
19
20
  autotest-growl (0.2.16)
20
21
  autotest-rails-pure (4.1.2)
21
- crack (0.4.3)
22
- safe_yaml (~> 1.0.0)
22
+ crack (0.4.4)
23
23
  diff-lcs (1.4.4)
24
24
  ethon (0.12.0)
25
25
  ffi (>= 1.3.0)
26
26
  ffi (1.13.1)
27
27
  hashdiff (1.0.1)
28
28
  json (2.3.1)
29
- jwt (2.2.1)
30
- public_suffix (4.0.5)
29
+ jwt (2.2.2)
30
+ public_suffix (4.0.6)
31
31
  rake (12.3.3)
32
32
  rspec (3.9.0)
33
33
  rspec-core (~> 3.9.0)
34
34
  rspec-expectations (~> 3.9.0)
35
35
  rspec-mocks (~> 3.9.0)
36
- rspec-core (3.9.2)
36
+ rspec-core (3.9.3)
37
37
  rspec-support (~> 3.9.3)
38
- rspec-expectations (3.9.2)
38
+ rspec-expectations (3.9.3)
39
39
  diff-lcs (>= 1.2.0, < 2.0)
40
40
  rspec-support (~> 3.9.0)
41
41
  rspec-mocks (3.9.1)
42
42
  diff-lcs (>= 1.2.0, < 2.0)
43
43
  rspec-support (~> 3.9.0)
44
- rspec-support (3.9.3)
45
- safe_yaml (1.0.5)
44
+ rspec-support (3.9.4)
46
45
  sys-uname (1.2.1)
47
46
  ffi (>= 1.0.0)
48
47
  typhoeus (1.4.0)
@@ -99,7 +99,6 @@ require 'docusign_esign/models/brands_request'
99
99
  require 'docusign_esign/models/brands_response'
100
100
  require 'docusign_esign/models/bulk_envelope'
101
101
  require 'docusign_esign/models/bulk_envelope_status'
102
- require 'docusign_esign/models/bulk_envelopes_response'
103
102
  require 'docusign_esign/models/bulk_recipient'
104
103
  require 'docusign_esign/models/bulk_recipient_signature_provider'
105
104
  require 'docusign_esign/models/bulk_recipient_tab_label'
@@ -107,6 +106,7 @@ require 'docusign_esign/models/bulk_recipients_request'
107
106
  require 'docusign_esign/models/bulk_recipients_response'
108
107
  require 'docusign_esign/models/bulk_recipients_summary_response'
109
108
  require 'docusign_esign/models/bulk_recipients_update_response'
109
+ require 'docusign_esign/models/bulk_send_batch_request'
110
110
  require 'docusign_esign/models/bulk_send_batch_status'
111
111
  require 'docusign_esign/models/bulk_send_batch_summaries'
112
112
  require 'docusign_esign/models/bulk_send_batch_summary'
@@ -141,6 +141,8 @@ require 'docusign_esign/models/commission_expiration'
141
141
  require 'docusign_esign/models/commission_number'
142
142
  require 'docusign_esign/models/commission_state'
143
143
  require 'docusign_esign/models/company'
144
+ require 'docusign_esign/models/complete_sign_hash_response'
145
+ require 'docusign_esign/models/complete_sign_request'
144
146
  require 'docusign_esign/models/composite_template'
145
147
  require 'docusign_esign/models/conditional_recipient_rule'
146
148
  require 'docusign_esign/models/conditional_recipient_rule_condition'
@@ -166,6 +168,7 @@ require 'docusign_esign/models/contact_phone_number'
166
168
  require 'docusign_esign/models/contact_update_response'
167
169
  require 'docusign_esign/models/correct_view_request'
168
170
  require 'docusign_esign/models/country'
171
+ require 'docusign_esign/models/credential'
169
172
  require 'docusign_esign/models/credit_card_information'
170
173
  require 'docusign_esign/models/credit_card_types'
171
174
  require 'docusign_esign/models/currency_feature_set_price'
@@ -180,6 +183,10 @@ require 'docusign_esign/models/date_stamp_properties'
180
183
  require 'docusign_esign/models/decline'
181
184
  require 'docusign_esign/models/diagnostics_settings_information'
182
185
  require 'docusign_esign/models/direct_debit_processor_information'
186
+ require 'docusign_esign/models/display_appliance_account'
187
+ require 'docusign_esign/models/display_appliance_info'
188
+ require 'docusign_esign/models/display_appliance_pdf'
189
+ require 'docusign_esign/models/display_appliance_signer_attachment'
183
190
  require 'docusign_esign/models/dob_information_input'
184
191
  require 'docusign_esign/models/document'
185
192
  require 'docusign_esign/models/document_fields_information'
@@ -190,8 +197,10 @@ require 'docusign_esign/models/document_html_definition_originals'
190
197
  require 'docusign_esign/models/document_html_definitions'
191
198
  require 'docusign_esign/models/document_html_display_anchor'
192
199
  require 'docusign_esign/models/document_html_display_settings'
200
+ require 'docusign_esign/models/document_security_store'
193
201
  require 'docusign_esign/models/document_template'
194
202
  require 'docusign_esign/models/document_template_list'
203
+ require 'docusign_esign/models/document_update_info'
195
204
  require 'docusign_esign/models/document_visibility'
196
205
  require 'docusign_esign/models/document_visibility_list'
197
206
  require 'docusign_esign/models/downgrad_request_billing_info_response'
@@ -232,6 +241,7 @@ require 'docusign_esign/models/error_details'
232
241
  require 'docusign_esign/models/event_notification'
233
242
  require 'docusign_esign/models/event_result'
234
243
  require 'docusign_esign/models/expirations'
244
+ require 'docusign_esign/models/external_claim'
235
245
  require 'docusign_esign/models/external_doc_service_error_details'
236
246
  require 'docusign_esign/models/external_document_sources'
237
247
  require 'docusign_esign/models/external_file'
@@ -257,6 +267,7 @@ require 'docusign_esign/models/formula_tab'
257
267
  require 'docusign_esign/models/full_name'
258
268
  require 'docusign_esign/models/graphics_context'
259
269
  require 'docusign_esign/models/group'
270
+ require 'docusign_esign/models/group_brands'
260
271
  require 'docusign_esign/models/group_information'
261
272
  require 'docusign_esign/models/id_check_configuration'
262
273
  require 'docusign_esign/models/id_check_information_input'
@@ -321,6 +332,7 @@ require 'docusign_esign/models/payment_gateway_accounts_info'
321
332
  require 'docusign_esign/models/payment_line_item'
322
333
  require 'docusign_esign/models/payment_method_with_options'
323
334
  require 'docusign_esign/models/payment_processor_information'
335
+ require 'docusign_esign/models/payment_signer_values'
324
336
  require 'docusign_esign/models/permission_profile'
325
337
  require 'docusign_esign/models/permission_profile_information'
326
338
  require 'docusign_esign/models/phone_number'
@@ -335,6 +347,7 @@ require 'docusign_esign/models/power_form_senders_response'
335
347
  require 'docusign_esign/models/power_forms_form_data_response'
336
348
  require 'docusign_esign/models/power_forms_request'
337
349
  require 'docusign_esign/models/power_forms_response'
350
+ require 'docusign_esign/models/prefill_tabs'
338
351
  require 'docusign_esign/models/proof_service_resource_token'
339
352
  require 'docusign_esign/models/proof_service_view_link'
340
353
  require 'docusign_esign/models/property_metadata'
@@ -384,18 +397,26 @@ require 'docusign_esign/models/report_in_product_save_response'
384
397
  require 'docusign_esign/models/report_in_product_sent_by_details'
385
398
  require 'docusign_esign/models/resource_information'
386
399
  require 'docusign_esign/models/return_url_request'
400
+ require 'docusign_esign/models/revision'
401
+ require 'docusign_esign/models/seal'
387
402
  require 'docusign_esign/models/seal_identifier'
388
403
  require 'docusign_esign/models/seal_sign'
389
404
  require 'docusign_esign/models/seat_discount'
405
+ require 'docusign_esign/models/sender'
390
406
  require 'docusign_esign/models/sender_email_notifications'
391
407
  require 'docusign_esign/models/server_template'
392
408
  require 'docusign_esign/models/service_information'
393
409
  require 'docusign_esign/models/service_version'
394
410
  require 'docusign_esign/models/settings_metadata'
395
411
  require 'docusign_esign/models/shared_item'
412
+ require 'docusign_esign/models/sign_hash_document'
413
+ require 'docusign_esign/models/sign_hash_session_info_response'
396
414
  require 'docusign_esign/models/sign_here'
415
+ require 'docusign_esign/models/sign_session_info_request'
416
+ require 'docusign_esign/models/signature_data_info'
397
417
  require 'docusign_esign/models/signature_group'
398
418
  require 'docusign_esign/models/signature_group_def'
419
+ require 'docusign_esign/models/signature_properties'
399
420
  require 'docusign_esign/models/signature_provider_required_option'
400
421
  require 'docusign_esign/models/signature_type'
401
422
  require 'docusign_esign/models/signature_user'
@@ -438,11 +459,18 @@ require 'docusign_esign/models/template_tabs'
438
459
  require 'docusign_esign/models/template_update_summary'
439
460
  require 'docusign_esign/models/text'
440
461
  require 'docusign_esign/models/text_custom_field'
462
+ require 'docusign_esign/models/time_stamp_field'
441
463
  require 'docusign_esign/models/title'
464
+ require 'docusign_esign/models/tsp_health_check_request'
465
+ require 'docusign_esign/models/tsp_health_check_status_description'
466
+ require 'docusign_esign/models/update_transaction_request'
467
+ require 'docusign_esign/models/update_transaction_response'
442
468
  require 'docusign_esign/models/usage_history'
469
+ require 'docusign_esign/models/user'
443
470
  require 'docusign_esign/models/user_account_management_granular_information'
444
471
  require 'docusign_esign/models/user_info'
445
472
  require 'docusign_esign/models/user_info_list'
473
+ require 'docusign_esign/models/user_info_response'
446
474
  require 'docusign_esign/models/user_information'
447
475
  require 'docusign_esign/models/user_information_list'
448
476
  require 'docusign_esign/models/user_password_information'
@@ -385,7 +385,7 @@ module DocuSign_eSign
385
385
 
386
386
  # Creates one or more brand profile files for the account.
387
387
  # Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
388
- # @param account_id The external account number (int) or account ID Guid.
388
+ # @param account_id The external account number (int) or account ID GUID.
389
389
  # @param brand (optional parameter)
390
390
  # @return [BrandsResponse]
391
391
  def create_brand(account_id, brand)
@@ -395,7 +395,7 @@ module DocuSign_eSign
395
395
 
396
396
  # Creates one or more brand profile files for the account.
397
397
  # Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties &#x60;canSelfBrandSend&#x60; and &#x60;canSelfBrandSig&#x60;) must be set to **true** for the account to use this call. An error is returned if &#x60;brandId&#x60; property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the &#x60;Content-Type&#x60; must be &#x60;application/zip&#x60;.
398
- # @param account_id The external account number (int) or account ID Guid.
398
+ # @param account_id The external account number (int) or account ID GUID.
399
399
  # @param brand (optional parameter)
400
400
  # @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
401
401
  def create_brand_with_http_info(account_id, brand)
@@ -1276,6 +1276,58 @@ module DocuSign_eSign
1276
1276
  return data, status_code, headers
1277
1277
  end
1278
1278
 
1279
+ # Retrieves an account settings comparison.
1280
+ #
1281
+ # @param organization_id
1282
+ # @param result_id
1283
+ # @return [nil]
1284
+ def get_account_settings_export(organization_id, result_id)
1285
+ get_account_settings_export_with_http_info(organization_id, result_id)
1286
+ return nil
1287
+ end
1288
+
1289
+ # Retrieves an account settings comparison.
1290
+ #
1291
+ # @param organization_id
1292
+ # @param result_id
1293
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1294
+ def get_account_settings_export_with_http_info(organization_id, result_id)
1295
+ if @api_client.config.debugging
1296
+ @api_client.config.logger.debug "Calling API: AccountsApi.get_account_settings_export ..."
1297
+ end
1298
+ # verify the required parameter 'organization_id' is set
1299
+ fail ArgumentError, "Missing the required parameter 'organization_id' when calling AccountsApi.get_account_settings_export" if organization_id.nil?
1300
+ # verify the required parameter 'result_id' is set
1301
+ fail ArgumentError, "Missing the required parameter 'result_id' when calling AccountsApi.get_account_settings_export" if result_id.nil?
1302
+ # resource path
1303
+ local_var_path = "/v2.1/organization_exports/{organizationId}/account_settings/{resultId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'resultId' + '}', result_id.to_s)
1304
+
1305
+ # query parameters
1306
+ query_params = {}
1307
+
1308
+ # header parameters
1309
+ header_params = {}
1310
+ # HTTP header 'Accept' (if needed)
1311
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1312
+
1313
+ # form parameters
1314
+ form_params = {}
1315
+
1316
+ # http body (model)
1317
+ post_body = nil
1318
+ auth_names = []
1319
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1320
+ :header_params => header_params,
1321
+ :query_params => query_params,
1322
+ :form_params => form_params,
1323
+ :body => post_body,
1324
+ :auth_names => auth_names)
1325
+ if @api_client.config.debugging
1326
+ @api_client.config.logger.debug "API called: AccountsApi#get_account_settings_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1327
+ end
1328
+ return data, status_code, headers
1329
+ end
1330
+
1279
1331
  # Returns information about a single signature by specifed signatureId.
1280
1332
  #
1281
1333
  # @param account_id The external account number (int) or account ID Guid.
@@ -3423,9 +3475,9 @@ module DocuSign_eSign
3423
3475
 
3424
3476
  # Uploads a branding resource file.
3425
3477
  #
3426
- # @param account_id The external account number (int) or account ID Guid.
3427
- # @param brand_id The unique identifier of a brand.
3428
- # @param resource_content_type
3478
+ # @param account_id The external account number (int) or account ID GUID.
3479
+ # @param brand_id The id of the brand.
3480
+ # @param resource_content_type The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
3429
3481
  # @return [BrandResources]
3430
3482
  def update_brand_resources_by_content_type(account_id, brand_id, resource_content_type)
3431
3483
  data, _status_code, _headers = update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type)
@@ -3434,9 +3486,9 @@ module DocuSign_eSign
3434
3486
 
3435
3487
  # Uploads a branding resource file.
3436
3488
  #
3437
- # @param account_id The external account number (int) or account ID Guid.
3438
- # @param brand_id The unique identifier of a brand.
3439
- # @param resource_content_type
3489
+ # @param account_id The external account number (int) or account ID GUID.
3490
+ # @param brand_id The id of the brand.
3491
+ # @param resource_content_type The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
3440
3492
  # @return [Array<(BrandResources, Fixnum, Hash)>] BrandResources data, response status code and response headers
3441
3493
  def update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type)
3442
3494
  if @api_client.config.debugging
@@ -3448,6 +3500,8 @@ module DocuSign_eSign
3448
3500
  fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_resources_by_content_type" if brand_id.nil?
3449
3501
  # verify the required parameter 'resource_content_type' is set
3450
3502
  fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.update_brand_resources_by_content_type" if resource_content_type.nil?
3503
+ # verify the required parameter 'file_xml' is set
3504
+ fail ArgumentError, "Missing the required parameter 'file_xml' when calling AccountsApi.update_brand_resources_by_content_type" if file_xml.nil?
3451
3505
  # resource path
3452
3506
  local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)
3453
3507
 
@@ -3458,9 +3512,12 @@ module DocuSign_eSign
3458
3512
  header_params = {}
3459
3513
  # HTTP header 'Accept' (if needed)
3460
3514
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3515
+ # HTTP header 'Content-Type'
3516
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
3461
3517
 
3462
3518
  # form parameters
3463
3519
  form_params = {}
3520
+ form_params["file.xml"] = file_xml
3464
3521
 
3465
3522
  # http body (model)
3466
3523
  post_body = nil
@@ -13,21 +13,6 @@ require "uri"
13
13
 
14
14
  module DocuSign_eSign
15
15
 
16
- class GetOptions
17
- # Specifies the number of entries to return.
18
- attr_accessor :count
19
-
20
- # Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=\"failed,queued\") Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent - This only returns entries with a sent status.
21
- attr_accessor :include
22
-
23
- # Specifies the location in the list of envelopes from which to start.
24
- attr_accessor :start_position
25
-
26
- def self.default
27
- @@default ||= GetOptions.new
28
- end
29
- end
30
-
31
16
  class GetBulkSendBatchesOptions
32
17
  #
33
18
  attr_accessor :batch_ids
@@ -46,30 +31,6 @@ module DocuSign_eSign
46
31
  end
47
32
  end
48
33
 
49
- class GetRecipientsOptions
50
- #
51
- attr_accessor :include_tabs
52
-
53
- #
54
- attr_accessor :start_position
55
-
56
- def self.default
57
- @@default ||= GetRecipientsOptions.new
58
- end
59
- end
60
-
61
- class ListOptions
62
- # The number of results to return. This can be 1 to 20.
63
- attr_accessor :count
64
-
65
- # The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0.
66
- attr_accessor :start_position
67
-
68
- def self.default
69
- @@default ||= ListOptions.new
70
- end
71
- end
72
-
73
34
 
74
35
  class BulkEnvelopesApi
75
36
  attr_accessor :api_client
@@ -292,121 +253,6 @@ module DocuSign_eSign
292
253
  return data, status_code, headers
293
254
  end
294
255
 
295
- # Deletes the bulk recipient file from an envelope.
296
- # Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the `bulkRecipientsUri` property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.
297
- # @param account_id The external account number (int) or account ID Guid.
298
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
299
- # @param recipient_id The ID of the recipient being accessed.
300
- # @return [BulkRecipientsUpdateResponse]
301
- def delete_recipients(account_id, envelope_id, recipient_id)
302
- data, _status_code, _headers = delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
303
- return data
304
- end
305
-
306
- # Deletes the bulk recipient file from an envelope.
307
- # Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent. After using this, the &#x60;bulkRecipientsUri&#x60; property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.
308
- # @param account_id The external account number (int) or account ID Guid.
309
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
310
- # @param recipient_id The ID of the recipient being accessed.
311
- # @return [Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>] BulkRecipientsUpdateResponse data, response status code and response headers
312
- def delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
313
- if @api_client.config.debugging
314
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.delete_recipients ..."
315
- end
316
- # verify the required parameter 'account_id' is set
317
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.delete_recipients" if account_id.nil?
318
- # verify the required parameter 'envelope_id' is set
319
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.delete_recipients" if envelope_id.nil?
320
- # verify the required parameter 'recipient_id' is set
321
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.delete_recipients" if recipient_id.nil?
322
- # resource path
323
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
324
-
325
- # query parameters
326
- query_params = {}
327
-
328
- # header parameters
329
- header_params = {}
330
- # HTTP header 'Accept' (if needed)
331
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
332
-
333
- # form parameters
334
- form_params = {}
335
-
336
- # http body (model)
337
- post_body = nil
338
- auth_names = []
339
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
340
- :header_params => header_params,
341
- :query_params => query_params,
342
- :form_params => form_params,
343
- :body => post_body,
344
- :auth_names => auth_names,
345
- :return_type => 'BulkRecipientsUpdateResponse')
346
- if @api_client.config.debugging
347
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#delete_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
348
- end
349
- return data, status_code, headers
350
- end
351
-
352
- # Gets the status of a specified bulk send operation.
353
- # Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.
354
- # @param account_id The external account number (int) or account ID Guid.
355
- # @param batch_id
356
- # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
357
- # @return [BulkEnvelopeStatus]
358
- def get(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
359
- data, _status_code, _headers = get_with_http_info(account_id, batch_id, options)
360
- return data
361
- end
362
-
363
- # Gets the status of a specified bulk send operation.
364
- # Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.
365
- # @param account_id The external account number (int) or account ID Guid.
366
- # @param batch_id
367
- # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
368
- # @return [Array<(BulkEnvelopeStatus, Fixnum, Hash)>] BulkEnvelopeStatus data, response status code and response headers
369
- def get_with_http_info(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
370
- if @api_client.config.debugging
371
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get ..."
372
- end
373
- # verify the required parameter 'account_id' is set
374
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get" if account_id.nil?
375
- # verify the required parameter 'batch_id' is set
376
- fail ArgumentError, "Missing the required parameter 'batch_id' when calling BulkEnvelopesApi.get" if batch_id.nil?
377
- # resource path
378
- local_var_path = "/v2.1/accounts/{accountId}/bulk_envelopes/{batchId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'batchId' + '}', batch_id.to_s)
379
-
380
- # query parameters
381
- query_params = {}
382
- query_params[:'count'] = options.count if !options.count.nil?
383
- query_params[:'include'] = options.include if !options.include.nil?
384
- query_params[:'start_position'] = options.start_position if !options.start_position.nil?
385
-
386
- # header parameters
387
- header_params = {}
388
- # HTTP header 'Accept' (if needed)
389
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
390
-
391
- # form parameters
392
- form_params = {}
393
-
394
- # http body (model)
395
- post_body = nil
396
- auth_names = []
397
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
398
- :header_params => header_params,
399
- :query_params => query_params,
400
- :form_params => form_params,
401
- :body => post_body,
402
- :auth_names => auth_names,
403
- :return_type => 'BulkEnvelopeStatus')
404
- if @api_client.config.debugging
405
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
406
- end
407
- return data, status_code, headers
408
- end
409
-
410
256
  # Gets a specific bulk send batch status
411
257
  #
412
258
  # @param account_id The external account number (int) or account ID Guid.
@@ -617,95 +463,36 @@ module DocuSign_eSign
617
463
  return data, status_code, headers
618
464
  end
619
465
 
620
- # Gets the bulk recipient file from an envelope.
621
- # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
622
- # @param account_id The external account number (int) or account ID Guid.
623
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
624
- # @param recipient_id The ID of the recipient being accessed.
625
- # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
626
- # @return [BulkRecipientsResponse]
627
- def get_recipients(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
628
- data, _status_code, _headers = get_recipients_with_http_info(account_id, envelope_id, recipient_id, options)
629
- return data
630
- end
631
-
632
- # Gets the bulk recipient file from an envelope.
633
- # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
634
- # @param account_id The external account number (int) or account ID Guid.
635
- # @param envelope_id The envelopeId Guid of the envelope being accessed.
636
- # @param recipient_id The ID of the recipient being accessed.
637
- # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
638
- # @return [Array<(BulkRecipientsResponse, Fixnum, Hash)>] BulkRecipientsResponse data, response status code and response headers
639
- def get_recipients_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
640
- if @api_client.config.debugging
641
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_recipients ..."
642
- end
643
- # verify the required parameter 'account_id' is set
644
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_recipients" if account_id.nil?
645
- # verify the required parameter 'envelope_id' is set
646
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.get_recipients" if envelope_id.nil?
647
- # verify the required parameter 'recipient_id' is set
648
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.get_recipients" if recipient_id.nil?
649
- # resource path
650
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
651
-
652
- # query parameters
653
- query_params = {}
654
- query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
655
- query_params[:'start_position'] = options.start_position if !options.start_position.nil?
656
-
657
- # header parameters
658
- header_params = {}
659
- # HTTP header 'Accept' (if needed)
660
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
661
-
662
- # form parameters
663
- form_params = {}
664
-
665
- # http body (model)
666
- post_body = nil
667
- auth_names = []
668
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
669
- :header_params => header_params,
670
- :query_params => query_params,
671
- :form_params => form_params,
672
- :body => post_body,
673
- :auth_names => auth_names,
674
- :return_type => 'BulkRecipientsResponse')
675
- if @api_client.config.debugging
676
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
677
- end
678
- return data, status_code, headers
679
- end
680
-
681
- # Gets status information about bulk recipient batches.
682
- # Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the `batchId` property, which can be used to retrieve a more detailed status of individual bulk recipient batches.
466
+ # Put/Update a specific bulk send batch status
467
+ #
683
468
  # @param account_id The external account number (int) or account ID Guid.
684
- # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
685
- # @return [BulkEnvelopesResponse]
686
- def list(account_id, options = DocuSign_eSign::ListOptions.default)
687
- data, _status_code, _headers = list_with_http_info(account_id, options)
469
+ # @param bulk_send_batch_id
470
+ # @param bulk_send_batch_request (optional parameter)
471
+ # @return [BulkSendBatchStatus]
472
+ def update_bulk_send_batch_status(account_id, bulk_send_batch_id, bulk_send_batch_request)
473
+ data, _status_code, _headers = update_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id, bulk_send_batch_request)
688
474
  return data
689
475
  end
690
476
 
691
- # Gets status information about bulk recipient batches.
692
- # Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch. The response returns information about the envelopes sent with bulk recipient batches, including the &#x60;batchId&#x60; property, which can be used to retrieve a more detailed status of individual bulk recipient batches.
477
+ # Put/Update a specific bulk send batch status
478
+ #
693
479
  # @param account_id The external account number (int) or account ID Guid.
694
- # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
695
- # @return [Array<(BulkEnvelopesResponse, Fixnum, Hash)>] BulkEnvelopesResponse data, response status code and response headers
696
- def list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default)
480
+ # @param bulk_send_batch_id
481
+ # @param bulk_send_batch_request (optional parameter)
482
+ # @return [Array<(BulkSendBatchStatus, Fixnum, Hash)>] BulkSendBatchStatus data, response status code and response headers
483
+ def update_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id, bulk_send_batch_request)
697
484
  if @api_client.config.debugging
698
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.list ..."
485
+ @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_bulk_send_batch_status ..."
699
486
  end
700
487
  # verify the required parameter 'account_id' is set
701
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.list" if account_id.nil?
488
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_bulk_send_batch_status" if account_id.nil?
489
+ # verify the required parameter 'bulk_send_batch_id' is set
490
+ fail ArgumentError, "Missing the required parameter 'bulk_send_batch_id' when calling BulkEnvelopesApi.update_bulk_send_batch_status" if bulk_send_batch_id.nil?
702
491
  # resource path
703
- local_var_path = "/v2.1/accounts/{accountId}/bulk_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
492
+ local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendBatchId' + '}', bulk_send_batch_id.to_s)
704
493
 
705
494
  # query parameters
706
495
  query_params = {}
707
- query_params[:'count'] = options.count if !options.count.nil?
708
- query_params[:'start_position'] = options.start_position if !options.start_position.nil?
709
496
 
710
497
  # header parameters
711
498
  header_params = {}
@@ -716,17 +503,17 @@ module DocuSign_eSign
716
503
  form_params = {}
717
504
 
718
505
  # http body (model)
719
- post_body = nil
506
+ post_body = @api_client.object_to_http_body(bulk_send_batch_request)
720
507
  auth_names = []
721
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
508
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
722
509
  :header_params => header_params,
723
510
  :query_params => query_params,
724
511
  :form_params => form_params,
725
512
  :body => post_body,
726
513
  :auth_names => auth_names,
727
- :return_type => 'BulkEnvelopesResponse')
514
+ :return_type => 'BulkSendBatchStatus')
728
515
  if @api_client.config.debugging
729
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
516
+ @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_bulk_send_batch_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
730
517
  end
731
518
  return data, status_code, headers
732
519
  end
@@ -785,68 +572,5 @@ module DocuSign_eSign
785
572
  end
786
573
  return data, status_code, headers
787
574
  end
788
-
789
- # Adds or replaces envelope bulk recipients.
790
- # Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
791
- # @param account_id The external account number (int) or account ID GUID.
792
- # @param envelope_id The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
793
- # @param recipient_id A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
794
- # @param bulk_recipients_request
795
- # @return [BulkRecipientsSummaryResponse]
796
- def update_recipients(account_id, envelope_id, recipient_id, bulk_recipients_request)
797
- data, _status_code, _headers = update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
798
- return data
799
- end
800
-
801
- # Adds or replaces envelope bulk recipients.
802
- # Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
803
- # @param account_id The external account number (int) or account ID GUID.
804
- # @param envelope_id The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
805
- # @param recipient_id A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
806
- # @param bulk_recipients_request
807
- # @return [Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>] BulkRecipientsSummaryResponse data, response status code and response headers
808
- def update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
809
- if @api_client.config.debugging
810
- @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_recipients ..."
811
- end
812
- # verify the required parameter 'account_id' is set
813
- fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_recipients" if account_id.nil?
814
- # verify the required parameter 'envelope_id' is set
815
- fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.update_recipients" if envelope_id.nil?
816
- # verify the required parameter 'recipient_id' is set
817
- fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.update_recipients" if recipient_id.nil?
818
- # verify the required parameter 'bulk_recipients_request' is set
819
- fail ArgumentError, "Missing the required parameter 'bulk_recipients_request' when calling BulkEnvelopesApi.update_recipients" if bulk_recipients_request.nil?
820
- # resource path
821
- local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s)
822
-
823
- # query parameters
824
- query_params = {}
825
-
826
- # header parameters
827
- header_params = {}
828
- # HTTP header 'Accept' (if needed)
829
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
830
- # HTTP header 'Content-Type'
831
- header_params['Content-Type'] = @api_client.select_header_content_type(['text/csv'])
832
-
833
- # form parameters
834
- form_params = {}
835
-
836
- # http body (model)
837
- post_body = @api_client.object_to_http_body(bulk_recipients_request)
838
- auth_names = []
839
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
840
- :header_params => header_params,
841
- :query_params => query_params,
842
- :form_params => form_params,
843
- :body => post_body,
844
- :auth_names => auth_names,
845
- :return_type => 'BulkRecipientsSummaryResponse')
846
- if @api_client.config.debugging
847
- @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
848
- end
849
- return data, status_code, headers
850
- end
851
575
  end
852
576
  end