docusign_esign 3.7.0.rc1 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa58c56f9c457a432847d350018872f0f08ffe2fd9ef121630d8a2179613dd5c
-  data.tar.gz: ec1a7ba37addfd5f391018c467af786313ac170441aeebddfccbff793a707035
+  metadata.gz: 41c1b9f636e02c741ab6cae6f1b1a492525d05be19108b5e036636bc2c618030
+  data.tar.gz: 0ec4460f92370ed6d8a278bf0e67d25eb2bab12d6848c4bbe2f81046e2313ca4
 SHA512:
-  metadata.gz: bbed559fbea75b3aa7730f9686bcc99851502ba29e4c394ef3ba1b59d978f6c0badb1fa7bb2e1f2f18edefba7067049bceb7500faea37a1816336df10c4114c6
-  data.tar.gz: 4e7f164b4604e3eec6271a27cb2982252e0e35038bca45e7c741f91500c65a0c36ba7f4df0f0e1f0694f8e5e7335742b3860acb976b700167b91d13c07f64e72
+  metadata.gz: eb23a6d6a6803bb4269f2034ec2d2750dec422fa7d060d7768ae51f810761e51b7333aa8e96dc01423db46f1212d7f0e0a030bf6013af0d4fefc96f06a23bdff
+  data.tar.gz: 1f42f5440f895a356aa6210e57d259bb6c093f73055fa58d588eaa2bdfd57b5e7720b1abe046b3022b7ddc5bd2dee45d8b7699c9f399c89b6806162b20b7a4b1

data/CHANGELOG.md

@@ -3,6 +3,27 @@ All notable changes to this project will be documented in this file.
 
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v3.10.0.rc1] - eSignature API v2.1-21.1.02.00 - 2021-05-20
+### Breaking
+- Removed methods `get_account_settings_export`,`get_seal_providers` from Accounts.
+- Removed methods `create_connect_secret`,`delete_connect_secret`,`generate_connect_secret`,`get_connect_secrets` from Connect.
+- Removed methods `create_page_info`, `create_pdf_blob`, `delete_custom_fields_0`, `delete_custom_fields_v2`, `delete_document`, `delete_page_info`, `delete_recipient_denied_document_copy`, `delete_signer_attachment`, `get_account`, `get_appliance_info`, `get_custom_fields`, `get_document_pages`, `get_dynamic_system_settings`, `get_image`, `get_locale_policy`, `get_pdf`, `get_pdf_blob`, `get_signer_attachment`, `get_tabs_blob`, `update_document`, `update_document_0`, `update_page_info`, `update_pdf`, `update_pdf_blob`, `update_recipient_denied_document_copy` from Envelopes.
+- Removed methods `complete_sign_hash`,`get_user_info`,`health_check`,`sign_hash_session_info`,`update_transaction` from TrustServiceProviders.
+- Removed methods `get_user_list_export` from Users.
+### Added
+- Added new methods `get_bulk_send_batch_envelopes` to BulkEnvelopes.
+### Changed
+- Added support for version v2.1-21.1.02.00 of the DocuSign eSignature API.
+- Updated the SDK release version.
+
+## [v3.9.0] - eSignature API v2.1-21.1.01.03 - 2021-04-25
+### Added
+- Added new methods `delete_custom_fields_v2`, `delete_page_info_v2`, `get_appliance_envelope_info`, `get_template_info` to envelopes.
+- Added new method `delete_connect_secret` to connect.
+### Changed
+- Added support for version v2.1-21.1.01.03 of the DocuSign eSignature API.
+- Updated the SDK release version.
+
 ## [v3.3.0] - eSignature API v2.1-20.1.02 - 2020-05-31
 ### Changed
 - Added support for version v2.1-20.1.02 of the DocuSign eSignature API.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docusign_esign (3.6.0.rc1)
+    docusign_esign (3.10.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -14,37 +14,37 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
-    autotest-fsevent (0.2.17)
+    autotest-fsevent (0.2.18)
       sys-uname
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.13.1)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.1)
     hashdiff (1.0.1)
-    json (2.3.1)
-    jwt (2.2.1)
-    public_suffix (4.0.5)
+    json (2.5.1)
+    jwt (2.2.3)
+    public_suffix (4.0.6)
     rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    safe_yaml (1.0.5)
-    sys-uname (1.2.1)
-      ffi (>= 1.0.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     vcr (3.0.3)

data/README.md

@@ -1,80 +1,51 @@
-# The Official DocuSign Ruby Client
+# The Official DocuSign eSignature Ruby Client SDK
 
 [![RubyGems version][rubygems-image]][rubygems-url]
 [![RubyGems downloads][downloads-image]][downloads-url]
 [![Build status][travis-image]][travis-url]
 
 ## Requirements
-
-- Ruby 1.9+
-- Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
+*   Ruby 1.9+
+*   Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
 
 ## Compatibility
-
-- Ruby 1.9+
-
-## Note
-
-This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below.
+*   Ruby 1.9+
 
 ## Installation
+This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/esign-rest-api/how-to/) from the [DocuSign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.
 
-### Install via your application's **Gemfile**:
-
-1. In your application's **Gemfile**, add:  
-   **gem 'docusign_esign'**
+### Installation via your application's Gemfile:
+1. In your application's Gemfile, add:  
+    `gem 'docusign_esign'`
 2. Open your preferred console.
-3. In your project directory, execute the installer by typing:  
-   **bundle install**
-
-### Manual install:
+3. In your project directory, execute the installer by typing: **bundle install**
 
+### Manual installation:
 1. Open your preferred console.
-2. In the console, type:  
-   **gem install docusign_esign**
+2. In the console, type: **gem install docusign_esign**
 
 ### Dependencies
-
 This client has the following external dependencies:
+*   Jwt>=1.5.2
+*   Json>=2.1.0
+*   Typhoeus>=1.0.1
 
-- Jwt>=1.5.2
-- Json>=2.1.0
-- Typhoeus>=1.0.1
-
-## Code Examples
-
-### Launchers
+## Code examples
+You can find on our GitHub a self-executing package of code examples for the eSignature C# SDK, called a [Launcher](https://github.com/docusign/code-examples-ruby/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows.
 
-DocuSign provides a sample application code referred to as a [Launcher](https://github.com/docusign/code-examples-ruby). The Launcher contains a set of 31 common use cases and associated source files. These examples use either DocuSign's [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Tokens (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) flows.
-
-### Proof-of-concept applications
-
-If your goal is to create a proof-of-concept application, DocuSign provides a set of [Quick Start](https://github.com/docusign/qs-ruby) examples. The Quick Start examples are meant to be used with DocuSign's [OAuth Token Generator](https://developers.docusign.com/oauth-token-generator), which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.
-
-## OAuth Implementations
-
-For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/esign-rest-api/guides/authentication).
+## OAuth implementations
+For details regarding which type of OAuth grant will work best for your DocuSign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [DocuSign Developer Center](https://developers.docusign.com/).
 
 For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
 
-
 ## Support
-
 Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
 
 ## License
+The DocuSign eSignature Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
 
-The DocuSign Ruby Client is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
-
-[rubygems-image]: https://img.shields.io/gem/v/docusign_esign.svg?style=flat
-[rubygems-url]: https://rubygems.org/gems/docusign_esign
-[downloads-image]: https://img.shields.io/gem/dt/docusign_esign.svg?style=flat
-[downloads-url]: https://rubygems.org/gems/docusign_esign
-[travis-image]: https://img.shields.io/travis/docusign/docusign-ruby-client.svg?style=flat
-[travis-url]: https://travis-ci.org/docusign/docusign-ruby-client
-
-### Additional Resources
-* [DocuSign Developer Center](https://developers.docusign.com)
-* [DocuSign API on Twitter](https://twitter.com/docusignapi)
-* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
-* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
+### Additional resources
+*   [DocuSign Developer Center](https://developers.docusign.com/)
+*   [DocuSign API on Twitter](https://twitter.com/docusignapi)
+*   [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
+*   [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)

data/lib/docusign_esign.rb

@@ -99,7 +99,6 @@ require 'docusign_esign/models/brands_request'
 require 'docusign_esign/models/brands_response'
 require 'docusign_esign/models/bulk_envelope'
 require 'docusign_esign/models/bulk_envelope_status'
-require 'docusign_esign/models/bulk_envelopes_response'
 require 'docusign_esign/models/bulk_recipient'
 require 'docusign_esign/models/bulk_recipient_signature_provider'
 require 'docusign_esign/models/bulk_recipient_tab_label'
@@ -107,6 +106,7 @@ require 'docusign_esign/models/bulk_recipients_request'
 require 'docusign_esign/models/bulk_recipients_response'
 require 'docusign_esign/models/bulk_recipients_summary_response'
 require 'docusign_esign/models/bulk_recipients_update_response'
+require 'docusign_esign/models/bulk_send_batch_request'
 require 'docusign_esign/models/bulk_send_batch_status'
 require 'docusign_esign/models/bulk_send_batch_summaries'
 require 'docusign_esign/models/bulk_send_batch_summary'
@@ -168,6 +168,7 @@ require 'docusign_esign/models/correct_view_request'
 require 'docusign_esign/models/country'
 require 'docusign_esign/models/credit_card_information'
 require 'docusign_esign/models/credit_card_types'
+require 'docusign_esign/models/currency'
 require 'docusign_esign/models/currency_feature_set_price'
 require 'docusign_esign/models/currency_plan_price'
 require 'docusign_esign/models/custom_field'
@@ -180,6 +181,7 @@ require 'docusign_esign/models/date_stamp_properties'
 require 'docusign_esign/models/decline'
 require 'docusign_esign/models/diagnostics_settings_information'
 require 'docusign_esign/models/direct_debit_processor_information'
+require 'docusign_esign/models/display_appliance_info'
 require 'docusign_esign/models/dob_information_input'
 require 'docusign_esign/models/document'
 require 'docusign_esign/models/document_fields_information'
@@ -214,6 +216,7 @@ require 'docusign_esign/models/envelope_document'
 require 'docusign_esign/models/envelope_documents_result'
 require 'docusign_esign/models/envelope_event'
 require 'docusign_esign/models/envelope_form_data'
+require 'docusign_esign/models/envelope_form_data_prefill_form_data'
 require 'docusign_esign/models/envelope_id'
 require 'docusign_esign/models/envelope_ids_request'
 require 'docusign_esign/models/envelope_metadata'
@@ -257,6 +260,7 @@ require 'docusign_esign/models/formula_tab'
 require 'docusign_esign/models/full_name'
 require 'docusign_esign/models/graphics_context'
 require 'docusign_esign/models/group'
+require 'docusign_esign/models/group_brands'
 require 'docusign_esign/models/group_information'
 require 'docusign_esign/models/id_check_configuration'
 require 'docusign_esign/models/id_check_information_input'
@@ -268,6 +272,7 @@ require 'docusign_esign/models/integrated_user_info_list'
 require 'docusign_esign/models/intermediary'
 require 'docusign_esign/models/jurisdiction'
 require 'docusign_esign/models/last_name'
+require 'docusign_esign/models/linked_external_primary_account'
 require 'docusign_esign/models/list'
 require 'docusign_esign/models/list_custom_field'
 require 'docusign_esign/models/list_item'
@@ -321,6 +326,7 @@ require 'docusign_esign/models/payment_gateway_accounts_info'
 require 'docusign_esign/models/payment_line_item'
 require 'docusign_esign/models/payment_method_with_options'
 require 'docusign_esign/models/payment_processor_information'
+require 'docusign_esign/models/payment_signer_values'
 require 'docusign_esign/models/permission_profile'
 require 'docusign_esign/models/permission_profile_information'
 require 'docusign_esign/models/phone_number'
@@ -335,6 +341,7 @@ require 'docusign_esign/models/power_form_senders_response'
 require 'docusign_esign/models/power_forms_form_data_response'
 require 'docusign_esign/models/power_forms_request'
 require 'docusign_esign/models/power_forms_response'
+require 'docusign_esign/models/prefill_tabs'
 require 'docusign_esign/models/proof_service_resource_token'
 require 'docusign_esign/models/proof_service_view_link'
 require 'docusign_esign/models/property_metadata'
@@ -510,4 +517,4 @@ module DocuSign_eSign
       end
     end
   end
-end
+end

data/lib/docusign_esign/api/accounts_api.rb

@@ -385,7 +385,7 @@ module DocuSign_eSign
 
     # Creates one or more brand profile files for the account.
     # 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`.
-    # @param account_id The external account number (int) or account ID Guid.
+    # @param account_id The external account number (int) or account ID GUID.
     # @param brand  (optional parameter)
     # @return [BrandsResponse]
     def create_brand(account_id, brand)
@@ -395,7 +395,7 @@ module DocuSign_eSign
 
     # Creates one or more brand profile files for the account.
     # 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`.
-    # @param account_id The external account number (int) or account ID Guid.
+    # @param account_id The external account number (int) or account ID GUID.
     # @param brand  (optional parameter)
     # @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
     def create_brand_with_http_info(account_id, brand)
@@ -3423,9 +3423,9 @@ module DocuSign_eSign
 
     # Uploads a branding resource file.
     # 
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param brand_id The unique identifier of a brand.
-    # @param resource_content_type 
+    # @param account_id The external account number (int) or account ID GUID.
+    # @param brand_id The id of the brand.
+    # @param resource_content_type The type of brand resource file that you are updating. Valid values are:  - `sending` - `signing` - `email` - `signing_captive`
     # @return [BrandResources]
     def update_brand_resources_by_content_type(account_id, brand_id, resource_content_type)
       data, _status_code, _headers = update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type)
@@ -3434,9 +3434,9 @@ module DocuSign_eSign
 
     # Uploads a branding resource file.
     # 
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param brand_id The unique identifier of a brand.
-    # @param resource_content_type 
+    # @param account_id The external account number (int) or account ID GUID.
+    # @param brand_id The id of the brand.
+    # @param resource_content_type The type of brand resource file that you are updating. Valid values are:  - `sending` - `signing` - `email` - `signing_captive`
     # @return [Array<(BrandResources, Fixnum, Hash)>] BrandResources data, response status code and response headers
     def update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type)
       if @api_client.config.debugging
@@ -3448,6 +3448,8 @@ module DocuSign_eSign
       fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_resources_by_content_type" if brand_id.nil?
       # verify the required parameter 'resource_content_type' is set
       fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.update_brand_resources_by_content_type" if resource_content_type.nil?
+      # verify the required parameter 'file_xml' is set
+      fail ArgumentError, "Missing the required parameter 'file_xml' when calling AccountsApi.update_brand_resources_by_content_type" if file_xml.nil?
       # resource path
       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)
 
@@ -3458,9 +3460,12 @@ module DocuSign_eSign
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
 
       # form parameters
       form_params = {}
+      form_params["file.xml"] = file_xml
 
       # http body (model)
       post_body = nil

data/lib/docusign_esign/api/bulk_envelopes_api.rb

@@ -13,27 +13,21 @@ require "uri"
 
 module DocuSign_eSign
 
-  class GetOptions
-    # Specifies the number of entries to return.
+  class GetBulkSendBatchEnvelopesOptions
+    # 
     attr_accessor :count
 
-    # 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.  
+    # 
     attr_accessor :include
 
-    # Specifies the location in the list of envelopes from which to start.
-    attr_accessor :start_position
-
-    def self.default
-      @@default ||= GetOptions.new
-    end
-  end
+    # 
+    attr_accessor :order
 
-  class GetBulkSendBatchesOptions
     # 
-    attr_accessor :batch_ids
+    attr_accessor :order_by
 
     # 
-    attr_accessor :count
+    attr_accessor :search_text
 
     # 
     attr_accessor :start_position
@@ -41,32 +35,32 @@ module DocuSign_eSign
     # 
     attr_accessor :status
 
+    # 
+    attr_accessor :user_id
+
     def self.default
-      @@default ||= GetBulkSendBatchesOptions.new
+      @@default ||= GetBulkSendBatchEnvelopesOptions.new
     end
   end
 
-  class GetRecipientsOptions
+  class GetBulkSendBatchesOptions
     # 
-    attr_accessor :include_tabs
+    attr_accessor :batch_ids
 
     # 
-    attr_accessor :start_position
-
-    def self.default
-      @@default ||= GetRecipientsOptions.new
-    end
-  end
-
-  class ListOptions
-    # The number of results to return. This can be 1 to 20.
     attr_accessor :count
 
-    # 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.
+    # 
+    attr_accessor :search_text
+
+    # 
     attr_accessor :start_position
 
+    # 
+    attr_accessor :status
+
     def self.default
-      @@default ||= ListOptions.new
+      @@default ||= GetBulkSendBatchesOptions.new
     end
   end
 
@@ -292,96 +286,44 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
-    # Deletes the bulk recipient file from an envelope.
-    # 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.
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param recipient_id The ID of the recipient being accessed.
-    # @return [BulkRecipientsUpdateResponse]
-    def delete_recipients(account_id, envelope_id, recipient_id)
-      data, _status_code, _headers = delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
-      return data
-    end
-
-    # Deletes the bulk recipient file from an envelope.
-    # 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.
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param recipient_id The ID of the recipient being accessed.
-    # @return [Array<(BulkRecipientsUpdateResponse, Fixnum, Hash)>] BulkRecipientsUpdateResponse data, response status code and response headers
-    def delete_recipients_with_http_info(account_id, envelope_id, recipient_id)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.delete_recipients ..."
-      end
-      # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.delete_recipients" if account_id.nil?
-      # verify the required parameter 'envelope_id' is set
-      fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.delete_recipients" if envelope_id.nil?
-      # verify the required parameter 'recipient_id' is set
-      fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.delete_recipients" if recipient_id.nil?
-      # resource path
-      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)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'BulkRecipientsUpdateResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: BulkEnvelopesApi#delete_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Gets the status of a specified bulk send operation.
-    # 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. 
+    # Gets envelopes from a specific bulk send batch
+    # 
     # @param account_id The external account number (int) or account ID Guid.
-    # @param batch_id 
-    # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
-    # @return [BulkEnvelopeStatus]
-    def get(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
-      data, _status_code, _headers = get_with_http_info(account_id, batch_id, options)
+    # @param bulk_send_batch_id 
+    # @param DocuSign_eSign::GetBulkSendBatchEnvelopesOptions Options for modifying the behavior of the function.
+    # @return [EnvelopesInformation]
+    def get_bulk_send_batch_envelopes(account_id, bulk_send_batch_id, options = DocuSign_eSign::GetBulkSendBatchEnvelopesOptions.default)
+      data, _status_code, _headers = get_bulk_send_batch_envelopes_with_http_info(account_id, bulk_send_batch_id, options)
       return data
     end
 
-    # Gets the status of a specified bulk send operation.
-    # 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. 
+    # Gets envelopes from a specific bulk send batch
+    # 
     # @param account_id The external account number (int) or account ID Guid.
-    # @param batch_id 
-    # @param DocuSign_eSign::GetOptions Options for modifying the behavior of the function.
-    # @return [Array<(BulkEnvelopeStatus, Fixnum, Hash)>] BulkEnvelopeStatus data, response status code and response headers
-    def get_with_http_info(account_id, batch_id, options = DocuSign_eSign::GetOptions.default)
+    # @param bulk_send_batch_id 
+    # @param DocuSign_eSign::GetBulkSendBatchEnvelopesOptions Options for modifying the behavior of the function.
+    # @return [Array<(EnvelopesInformation, Fixnum, Hash)>] EnvelopesInformation data, response status code and response headers
+    def get_bulk_send_batch_envelopes_with_http_info(account_id, bulk_send_batch_id, options = DocuSign_eSign::GetBulkSendBatchEnvelopesOptions.default)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get ..."
+        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_batch_envelopes ..."
       end
       # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get" if account_id.nil?
-      # verify the required parameter 'batch_id' is set
-      fail ArgumentError, "Missing the required parameter 'batch_id' when calling BulkEnvelopesApi.get" if batch_id.nil?
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_bulk_send_batch_envelopes" if account_id.nil?
+      # verify the required parameter 'bulk_send_batch_id' is set
+      fail ArgumentError, "Missing the required parameter 'bulk_send_batch_id' when calling BulkEnvelopesApi.get_bulk_send_batch_envelopes" if bulk_send_batch_id.nil?
       # resource path
-      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)
+      local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendBatchId' + '}', bulk_send_batch_id.to_s)
 
       # query parameters
       query_params = {}
       query_params[:'count'] = options.count if !options.count.nil?
       query_params[:'include'] = options.include if !options.include.nil?
+      query_params[:'order'] = options.order if !options.order.nil?
+      query_params[:'order_by'] = options.order_by if !options.order_by.nil?
+      query_params[:'search_text'] = options.search_text if !options.search_text.nil?
       query_params[:'start_position'] = options.start_position if !options.start_position.nil?
+      query_params[:'status'] = options.status if !options.status.nil?
+      query_params[:'user_id'] = options.user_id if !options.user_id.nil?
 
       # header parameters
       header_params = {}
@@ -400,9 +342,9 @@ module DocuSign_eSign
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'BulkEnvelopeStatus')
+        :return_type => 'EnvelopesInformation')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: BulkEnvelopesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_bulk_send_batch_envelopes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -488,6 +430,7 @@ module DocuSign_eSign
       query_params = {}
       query_params[:'batch_ids'] = options.batch_ids if !options.batch_ids.nil?
       query_params[:'count'] = options.count if !options.count.nil?
+      query_params[:'search_text'] = options.search_text if !options.search_text.nil?
       query_params[:'start_position'] = options.start_position if !options.start_position.nil?
       query_params[:'status'] = options.status if !options.status.nil?
 
@@ -617,95 +560,36 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
-    # Gets the bulk recipient file from an envelope.
-    # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param recipient_id The ID of the recipient being accessed.
-    # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
-    # @return [BulkRecipientsResponse]
-    def get_recipients(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
-      data, _status_code, _headers = get_recipients_with_http_info(account_id, envelope_id, recipient_id, options)
-      return data
-    end
-
-    # Gets the bulk recipient file from an envelope.
-    # Retrieves the bulk recipient file information from an envelope that has a bulk recipient.
-    # @param account_id The external account number (int) or account ID Guid.
-    # @param envelope_id The envelopeId Guid of the envelope being accessed.
-    # @param recipient_id The ID of the recipient being accessed.
-    # @param DocuSign_eSign::GetRecipientsOptions Options for modifying the behavior of the function.
-    # @return [Array<(BulkRecipientsResponse, Fixnum, Hash)>] BulkRecipientsResponse data, response status code and response headers
-    def get_recipients_with_http_info(account_id, envelope_id, recipient_id, options = DocuSign_eSign::GetRecipientsOptions.default)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_recipients ..."
-      end
-      # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_recipients" if account_id.nil?
-      # verify the required parameter 'envelope_id' is set
-      fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.get_recipients" if envelope_id.nil?
-      # verify the required parameter 'recipient_id' is set
-      fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.get_recipients" if recipient_id.nil?
-      # resource path
-      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)
-
-      # query parameters
-      query_params = {}
-      query_params[:'include_tabs'] = options.include_tabs if !options.include_tabs.nil?
-      query_params[:'start_position'] = options.start_position if !options.start_position.nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'BulkRecipientsResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Gets status information about bulk recipient batches.
-    # 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.
+    # Put/Update a specific bulk send batch status
+    # 
     # @param account_id The external account number (int) or account ID Guid.
-    # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
-    # @return [BulkEnvelopesResponse]
-    def list(account_id, options = DocuSign_eSign::ListOptions.default)
-      data, _status_code, _headers = list_with_http_info(account_id, options)
+    # @param bulk_send_batch_id 
+    # @param bulk_send_batch_request  (optional parameter)
+    # @return [BulkSendBatchStatus]
+    def update_bulk_send_batch_status(account_id, bulk_send_batch_id, bulk_send_batch_request)
+      data, _status_code, _headers = update_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id,  bulk_send_batch_request)
       return data
     end
 
-    # Gets status information about bulk recipient batches.
-    # 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.
+    # Put/Update a specific bulk send batch status
+    # 
     # @param account_id The external account number (int) or account ID Guid.
-    # @param DocuSign_eSign::ListOptions Options for modifying the behavior of the function.
-    # @return [Array<(BulkEnvelopesResponse, Fixnum, Hash)>] BulkEnvelopesResponse data, response status code and response headers
-    def list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default)
+    # @param bulk_send_batch_id 
+    # @param bulk_send_batch_request  (optional parameter)
+    # @return [Array<(BulkSendBatchStatus, Fixnum, Hash)>] BulkSendBatchStatus data, response status code and response headers
+    def update_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id, bulk_send_batch_request)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.list ..."
+        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_bulk_send_batch_status ..."
       end
       # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.list" if account_id.nil?
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_bulk_send_batch_status" if account_id.nil?
+      # verify the required parameter 'bulk_send_batch_id' is set
+      fail ArgumentError, "Missing the required parameter 'bulk_send_batch_id' when calling BulkEnvelopesApi.update_bulk_send_batch_status" if bulk_send_batch_id.nil?
       # resource path
-      local_var_path = "/v2.1/accounts/{accountId}/bulk_envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
+      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)
 
       # query parameters
       query_params = {}
-      query_params[:'count'] = options.count if !options.count.nil?
-      query_params[:'start_position'] = options.start_position if !options.start_position.nil?
 
       # header parameters
       header_params = {}
@@ -716,17 +600,17 @@ module DocuSign_eSign
       form_params = {}
 
       # http body (model)
-      post_body = nil
+      post_body = @api_client.object_to_http_body(bulk_send_batch_request)
       auth_names = []
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'BulkEnvelopesResponse')
+        :return_type => 'BulkSendBatchStatus')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: BulkEnvelopesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_bulk_send_batch_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -785,68 +669,5 @@ module DocuSign_eSign
       end
       return data, status_code, headers
     end
-
-    # Adds or replaces envelope bulk recipients.
-    # 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.
-    # @param account_id The external account number (int) or account ID GUID.
-    # @param envelope_id The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` 
-    # @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`.
-    # @param bulk_recipients_request  
-    # @return [BulkRecipientsSummaryResponse]
-    def update_recipients(account_id, envelope_id, recipient_id, bulk_recipients_request)
-      data, _status_code, _headers = update_recipients_with_http_info(account_id, envelope_id, recipient_id,  bulk_recipients_request)
-      return data
-    end
-
-    # Adds or replaces envelope bulk recipients.
-    # 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.
-    # @param account_id The external account number (int) or account ID GUID.
-    # @param envelope_id The envelope's GUID.   Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` 
-    # @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`.
-    # @param bulk_recipients_request  
-    # @return [Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>] BulkRecipientsSummaryResponse data, response status code and response headers
-    def update_recipients_with_http_info(account_id, envelope_id, recipient_id, bulk_recipients_request)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.update_recipients ..."
-      end
-      # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.update_recipients" if account_id.nil?
-      # verify the required parameter 'envelope_id' is set
-      fail ArgumentError, "Missing the required parameter 'envelope_id' when calling BulkEnvelopesApi.update_recipients" if envelope_id.nil?
-      # verify the required parameter 'recipient_id' is set
-      fail ArgumentError, "Missing the required parameter 'recipient_id' when calling BulkEnvelopesApi.update_recipients" if recipient_id.nil?
-      # verify the required parameter 'bulk_recipients_request' is set
-      fail ArgumentError, "Missing the required parameter 'bulk_recipients_request' when calling BulkEnvelopesApi.update_recipients" if bulk_recipients_request.nil?
-      # resource path
-      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)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['text/csv'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(bulk_recipients_request)
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'BulkRecipientsSummaryResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: BulkEnvelopesApi#update_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
   end
 end