docusign_esign 3.12.0 → 3.19.0

data/lib/docusign_esign/api/notary_api.rb

@@ -46,7 +46,7 @@ module DocuSign_eSign
     end
 
     # Add a notary to the system
-    # 
+    # Registers the current user as a notary.
     # @param notary  (optional parameter)
     # @return [Notary]
     def create_notary(notary)
@@ -55,7 +55,7 @@ module DocuSign_eSign
     end
 
     # Add a notary to the system
-    # 
+    # Registers the current user as a notary.
     # @param notary  (optional parameter)
     # @return [Array<(Notary, Fixnum, Hash)>] Notary data, response status code and response headers
     def create_notary_with_http_info(notary)
@@ -93,7 +93,7 @@ module DocuSign_eSign
     end
 
     # Add a notary jurisdiction to the system
-    # 
+    # Creates a jurisdiction object.
     # @param notary_jurisdiction  (optional parameter)
     # @return [NotaryJurisdiction]
     def create_notary_jurisdictions(notary_jurisdiction)
@@ -102,7 +102,7 @@ module DocuSign_eSign
     end
 
     # Add a notary jurisdiction to the system
-    # 
+    # Creates a jurisdiction object.
     # @param notary_jurisdiction  (optional parameter)
     # @return [Array<(NotaryJurisdiction, Fixnum, Hash)>] NotaryJurisdiction data, response status code and response headers
     def create_notary_jurisdictions_with_http_info(notary_jurisdiction)
@@ -140,7 +140,7 @@ module DocuSign_eSign
     end
 
     # Delete a notary jurisdiction a specified user.
-    # 
+    # Deletes the specified jurisdiction.
     # @param jurisdiction_id 
     # @return [nil]
     def delete_notary_jurisdiction(jurisdiction_id)
@@ -149,7 +149,7 @@ module DocuSign_eSign
     end
 
     # Delete a notary jurisdiction a specified user.
-    # 
+    # Deletes the specified jurisdiction.
     # @param jurisdiction_id 
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def delete_notary_jurisdiction_with_http_info(jurisdiction_id)
@@ -188,7 +188,7 @@ module DocuSign_eSign
     end
 
     # Get notary settings for a user
-    # 
+    # Gets settings for a notary user. The current user must be a notary.
     # @param DocuSign_eSign::GetNotaryOptions Options for modifying the behavior of the function.
     # @return [NotaryResult]
     def get_notary(options = DocuSign_eSign::GetNotaryOptions.default)
@@ -197,7 +197,7 @@ module DocuSign_eSign
     end
 
     # Get notary settings for a user
-    # 
+    # Gets settings for a notary user. The current user must be a notary.
     # @param DocuSign_eSign::GetNotaryOptions Options for modifying the behavior of the function.
     # @return [Array<(NotaryResult, Fixnum, Hash)>] NotaryResult data, response status code and response headers
     def get_notary_with_http_info(options = DocuSign_eSign::GetNotaryOptions.default)
@@ -236,7 +236,7 @@ module DocuSign_eSign
     end
 
     # Get notary a jurisdiction for a user
-    # 
+    # Gets a jurisdiction object for the current user.  The following restrictions apply:  - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for. 
     # @param jurisdiction_id 
     # @return [NotaryJurisdiction]
     def get_notary_jurisdiction(jurisdiction_id)
@@ -245,7 +245,7 @@ module DocuSign_eSign
     end
 
     # Get notary a jurisdiction for a user
-    # 
+    # Gets a jurisdiction object for the current user.  The following restrictions apply:  - The current user must be a notary. - The &#x60;jurisdictionId&#x60; must be a jurisdiction that the notary is registered for. 
     # @param jurisdiction_id 
     # @return [Array<(NotaryJurisdiction, Fixnum, Hash)>] NotaryJurisdiction data, response status code and response headers
     def get_notary_jurisdiction_with_http_info(jurisdiction_id)
@@ -333,7 +333,7 @@ module DocuSign_eSign
     end
 
     # Get notary jurisdictions for a user
-    # 
+    # Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.
     # @return [NotaryJurisdictionList]
     def get_notary_jurisdictions()
       data, _status_code, _headers = get_notary_jurisdictions_with_http_info()
@@ -341,7 +341,7 @@ module DocuSign_eSign
     end
 
     # Get notary jurisdictions for a user
-    # 
+    # Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.
     # @return [Array<(NotaryJurisdictionList, Fixnum, Hash)>] NotaryJurisdictionList data, response status code and response headers
     def get_notary_jurisdictions_with_http_info()
       if @api_client.config.debugging
@@ -428,7 +428,7 @@ module DocuSign_eSign
     end
 
     # Update a notary
-    # 
+    # Updates notary information for the current user.
     # @param notary  (optional parameter)
     # @return [Notary]
     def update_notary(notary)
@@ -437,7 +437,7 @@ module DocuSign_eSign
     end
 
     # Update a notary
-    # 
+    # Updates notary information for the current user.
     # @param notary  (optional parameter)
     # @return [Array<(Notary, Fixnum, Hash)>] Notary data, response status code and response headers
     def update_notary_with_http_info(notary)
@@ -475,7 +475,7 @@ module DocuSign_eSign
     end
 
     # Update a notary jurisdiction
-    # 
+    # Updates the jurisdiction information about a notary.  The following restrictions apply:  - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`.  The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change.  For example, assume `getNotaryJurisdiction` returns this:  ``` {     \"jurisdiction\": {         \"jurisdictionId\": \"15\",         \"name\": \"Iowa\",         \"county\": \"\",         \"enabled\": \"true\",         \"countyInSeal\": \"false\",         \"commissionIdInSeal\": \"true\",         \"stateNameInSeal\": \"true\",         \"notaryPublicInSeal\": \"true\",         \"allowSystemCreatedSeal\": \"true\",         \"allowUserUploadedSeal\": \"false\"     },     \"commissionId\": \"123456\",     \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\",     \"registeredName\": \"Bob Notary\",     \"county\": \"Adams\",     \"sealType\": \"system_created\" } ```  If you want to change the name of the notary from \"Bob Notary\" to \"Robert Notary\", your request body would be:  ``` {     \"jurisdiction\": {         \"jurisdictionId\": \"15\",         \"name\": \"Iowa\",         \"county\": \"\",         \"enabled\": \"true\",         \"countyInSeal\": \"false\",         \"commissionIdInSeal\": \"true\",         \"stateNameInSeal\": \"true\",         \"notaryPublicInSeal\": \"true\",         \"allowSystemCreatedSeal\": \"true\",         \"allowUserUploadedSeal\": \"false\"     },     \"commissionId\": \"123456\",     \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\",     \"registeredName\": \"Robert Notary\",     \"county\": \"Adams\",     \"sealType\": \"system_created\" } ``` 
     # @param jurisdiction_id 
     # @param notary_jurisdiction  (optional parameter)
     # @return [NotaryJurisdiction]
@@ -485,7 +485,7 @@ module DocuSign_eSign
     end
 
     # Update a notary jurisdiction
-    # 
+    # Updates the jurisdiction information about a notary.  The following restrictions apply:  - The current user must be a notary. - The &#x60;jurisdictionId&#x60; path parameter must be a jurisdiction that the notary is registered for. - The &#x60;jurisdictionId&#x60; path parameter must match the request body&#39;s &#x60;jurisdiction.jurisdictionId&#x60;.  The request body must have a full &#x60;jurisdiction&#x60; object for the jurisdiction property. The best way to do this is to use &#x60;getNotaryJurisdiction&#x60; to obtain the current values and update the properties you want to change.  For example, assume &#x60;getNotaryJurisdiction&#x60; returns this:  &#x60;&#x60;&#x60; {     \&quot;jurisdiction\&quot;: {         \&quot;jurisdictionId\&quot;: \&quot;15\&quot;,         \&quot;name\&quot;: \&quot;Iowa\&quot;,         \&quot;county\&quot;: \&quot;\&quot;,         \&quot;enabled\&quot;: \&quot;true\&quot;,         \&quot;countyInSeal\&quot;: \&quot;false\&quot;,         \&quot;commissionIdInSeal\&quot;: \&quot;true\&quot;,         \&quot;stateNameInSeal\&quot;: \&quot;true\&quot;,         \&quot;notaryPublicInSeal\&quot;: \&quot;true\&quot;,         \&quot;allowSystemCreatedSeal\&quot;: \&quot;true\&quot;,         \&quot;allowUserUploadedSeal\&quot;: \&quot;false\&quot;     },     \&quot;commissionId\&quot;: \&quot;123456\&quot;,     \&quot;commissionExpiration\&quot;: \&quot;2020-08-31T07:00:00.0000000Z\&quot;,     \&quot;registeredName\&quot;: \&quot;Bob Notary\&quot;,     \&quot;county\&quot;: \&quot;Adams\&quot;,     \&quot;sealType\&quot;: \&quot;system_created\&quot; } &#x60;&#x60;&#x60;  If you want to change the name of the notary from \&quot;Bob Notary\&quot; to \&quot;Robert Notary\&quot;, your request body would be:  &#x60;&#x60;&#x60; {     \&quot;jurisdiction\&quot;: {         \&quot;jurisdictionId\&quot;: \&quot;15\&quot;,         \&quot;name\&quot;: \&quot;Iowa\&quot;,         \&quot;county\&quot;: \&quot;\&quot;,         \&quot;enabled\&quot;: \&quot;true\&quot;,         \&quot;countyInSeal\&quot;: \&quot;false\&quot;,         \&quot;commissionIdInSeal\&quot;: \&quot;true\&quot;,         \&quot;stateNameInSeal\&quot;: \&quot;true\&quot;,         \&quot;notaryPublicInSeal\&quot;: \&quot;true\&quot;,         \&quot;allowSystemCreatedSeal\&quot;: \&quot;true\&quot;,         \&quot;allowUserUploadedSeal\&quot;: \&quot;false\&quot;     },     \&quot;commissionId\&quot;: \&quot;123456\&quot;,     \&quot;commissionExpiration\&quot;: \&quot;2020-08-31T07:00:00.0000000Z\&quot;,     \&quot;registeredName\&quot;: \&quot;Robert Notary\&quot;,     \&quot;county\&quot;: \&quot;Adams\&quot;,     \&quot;sealType\&quot;: \&quot;system_created\&quot; } &#x60;&#x60;&#x60; 
     # @param jurisdiction_id 
     # @param notary_jurisdiction  (optional parameter)
     # @return [Array<(NotaryJurisdiction, Fixnum, Hash)>] NotaryJurisdiction data, response status code and response headers

data/lib/docusign_esign/api/organizations_api.rb

@@ -26,8 +26,8 @@ module DocuSign_eSign
     # @param organization_id 
     # @param report_correlation_id 
     # @return [nil]
-    def delete_report(organization_id, report_correlation_id)
-      delete_report_with_http_info(organization_id, report_correlation_id)
+    def get_report_v2(organization_id, report_correlation_id)
+      get_report_v2_with_http_info(organization_id, report_correlation_id)
       return nil
     end
 
@@ -36,68 +36,16 @@ module DocuSign_eSign
     # @param organization_id 
     # @param report_correlation_id 
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def delete_report_with_http_info(organization_id, report_correlation_id)
+    def get_report_v2_with_http_info(organization_id, report_correlation_id)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: OrganizationsApi.delete_report ..."
+        @api_client.config.logger.debug "Calling API: OrganizationsApi.get_report_v2 ..."
       end
       # verify the required parameter 'organization_id' is set
-      fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.delete_report" if organization_id.nil?
+      fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_report_v2" if organization_id.nil?
       # verify the required parameter 'report_correlation_id' is set
-      fail ArgumentError, "Missing the required parameter 'report_correlation_id' when calling OrganizationsApi.delete_report" if report_correlation_id.nil?
+      fail ArgumentError, "Missing the required parameter 'report_correlation_id' when calling OrganizationsApi.get_report_v2" if report_correlation_id.nil?
       # resource path
-      local_var_path = "/v2.1/organization_reporting/{organizationId}/reports/{reportCorrelationId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'reportCorrelationId' + '}', report_correlation_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)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: OrganizationsApi#delete_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Retrieves org level report by correlation id and site.
-    # 
-    # @param organization_id 
-    # @param report_correlation_id 
-    # @return [nil]
-    def get_report(organization_id, report_correlation_id)
-      get_report_with_http_info(organization_id, report_correlation_id)
-      return nil
-    end
-
-    # Retrieves org level report by correlation id and site.
-    # 
-    # @param organization_id 
-    # @param report_correlation_id 
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def get_report_with_http_info(organization_id, report_correlation_id)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: OrganizationsApi.get_report ..."
-      end
-      # verify the required parameter 'organization_id' is set
-      fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_report" if organization_id.nil?
-      # verify the required parameter 'report_correlation_id' is set
-      fail ArgumentError, "Missing the required parameter 'report_correlation_id' when calling OrganizationsApi.get_report" if report_correlation_id.nil?
-      # resource path
-      local_var_path = "/v2.1/organization_reporting/{organizationId}/reports/{reportCorrelationId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'reportCorrelationId' + '}', report_correlation_id.to_s)
+      local_var_path = "/v2.1/organization_reporting/{organizationId}/reportsv2/{reportCorrelationId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'reportCorrelationId' + '}', report_correlation_id.to_s)
 
       # query parameters
       query_params = {}
@@ -120,7 +68,7 @@ module DocuSign_eSign
         :body => post_body,
         :auth_names => auth_names)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: OrganizationsApi#get_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: OrganizationsApi#get_report_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/docusign_esign/api/power_forms_api.rb

@@ -47,6 +47,12 @@ module DocuSign_eSign
     # 
     attr_accessor :order_by
 
+    # 
+    attr_accessor :search_fields
+
+    # 
+    attr_accessor :search_text
+
     # 
     attr_accessor :to_date
 
@@ -64,7 +70,7 @@ module DocuSign_eSign
     end
 
     # Creates a new PowerForm.
-    # 
+    # This method creates a new PowerForm.  You create a PowerForm from an existing DocuSign [template](/docs/esign-rest-api/reference/templates/templates/create/), based on the `templateId` in the request body.   PowerForms that you create from a template are referred to as *web PowerForms*.  **Note:** The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API.  **Note:** A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm *initiator*.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.   ### Signing modes  You can use one of the following signing modes for a PowerForm:  **`email`**  This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.  Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`.  When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code.  Example: `activateonly=1`  **`direct`**  This mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process.  Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check).  **Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.  ### Redirect URLs  You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed).  ### More information  For more information about creating PowerForms, see [Create a PowerForm](https://support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).  
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_form  (optional parameter)
     # @return [PowerForm]
@@ -74,7 +80,7 @@ module DocuSign_eSign
     end
 
     # Creates a new PowerForm.
-    # 
+    # This method creates a new PowerForm.  You create a PowerForm from an existing DocuSign [template](/docs/esign-rest-api/reference/templates/templates/create/), based on the `templateId` in the request body.   PowerForms that you create from a template are referred to as *web PowerForms*.  **Note:** The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API.  **Note:** A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm *initiator*.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.   ### Signing modes  You can use one of the following signing modes for a PowerForm:  **`email`**  This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.  Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`.  When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code.  Example: `activateonly=1`  **`direct`**  This mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process.  Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check).  **Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.  ### Redirect URLs  You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed).  ### More information  For more information about creating PowerForms, see [Create a PowerForm](https://support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).  
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_form  (optional parameter)
     # @return [Array<(PowerForm, Fixnum, Hash)>] PowerForm data, response status code and response headers
@@ -115,7 +121,7 @@ module DocuSign_eSign
     end
 
     # Delete a PowerForm.
-    # 
+    # This method deletes a PowerForm.
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_form_id 
     # @return [nil]
@@ -125,7 +131,7 @@ module DocuSign_eSign
     end
 
     # Delete a PowerForm.
-    # 
+    # This method deletes a PowerForm.
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_form_id 
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -167,7 +173,7 @@ module DocuSign_eSign
     end
 
     # Deletes one or more PowerForms
-    # 
+    # This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_forms_request  (optional parameter)
     # @return [PowerFormsResponse]
@@ -177,7 +183,7 @@ module DocuSign_eSign
     end
 
     # Deletes one or more PowerForms
-    # 
+    # This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the &#x60;powerFormId&#x60;.
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_forms_request  (optional parameter)
     # @return [Array<(PowerFormsResponse, Fixnum, Hash)>] PowerFormsResponse data, response status code and response headers
@@ -218,7 +224,7 @@ module DocuSign_eSign
     end
 
     # Returns a single PowerForm.
-    # 
+    # This method returns detailed information about a specific PowerForm.
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_form_id 
     # @return [PowerForm]
@@ -228,7 +234,7 @@ module DocuSign_eSign
     end
 
     # Returns a single PowerForm.
-    # 
+    # This method returns detailed information about a specific PowerForm.
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_form_id 
     # @return [Array<(PowerForm, Fixnum, Hash)>] PowerForm data, response status code and response headers
@@ -271,7 +277,7 @@ module DocuSign_eSign
     end
 
     # Returns the form data associated with the usage of a PowerForm.
-    # 
+    # This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.  You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values:   - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format  **Note:** Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_form_id 
     # @param DocuSign_eSign::GetPowerFormDataOptions Options for modifying the behavior of the function.
@@ -282,7 +288,7 @@ module DocuSign_eSign
     end
 
     # Returns the form data associated with the usage of a PowerForm.
-    # 
+    # This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm.  You specify the format in which you want to retrieve the data in the &#x60;Accept&#x60; header. This header accepts the following values:   - &#x60;application/json&#x60;: JSON format - &#x60;application/xml&#x60;: XML format - &#x60;text/csv&#x60;: Comma-separated value (CSV) format  **Note:** Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_form_id 
     # @param DocuSign_eSign::GetPowerFormDataOptions Options for modifying the behavior of the function.
@@ -329,7 +335,7 @@ module DocuSign_eSign
     end
 
     # Returns the list of PowerForms available to the user.
-    # 
+    # This method returns a list of users who have sent PowerForms.
     # @param account_id The external account number (int) or account ID Guid.
     # @param DocuSign_eSign::ListPowerFormSendersOptions Options for modifying the behavior of the function.
     # @return [PowerFormSendersResponse]
@@ -339,7 +345,7 @@ module DocuSign_eSign
     end
 
     # Returns the list of PowerForms available to the user.
-    # 
+    # This method returns a list of users who have sent PowerForms.
     # @param account_id The external account number (int) or account ID Guid.
     # @param DocuSign_eSign::ListPowerFormSendersOptions Options for modifying the behavior of the function.
     # @return [Array<(PowerFormSendersResponse, Fixnum, Hash)>] PowerFormSendersResponse data, response status code and response headers
@@ -381,7 +387,7 @@ module DocuSign_eSign
     end
 
     # Returns the list of PowerForms available to the user.
-    # 
+    # This method returns a list of PowerForms that are available to the user.
     # @param account_id The external account number (int) or account ID Guid.
     # @param DocuSign_eSign::ListPowerFormsOptions Options for modifying the behavior of the function.
     # @return [PowerFormsResponse]
@@ -391,7 +397,7 @@ module DocuSign_eSign
     end
 
     # Returns the list of PowerForms available to the user.
-    # 
+    # This method returns a list of PowerForms that are available to the user.
     # @param account_id The external account number (int) or account ID Guid.
     # @param DocuSign_eSign::ListPowerFormsOptions Options for modifying the behavior of the function.
     # @return [Array<(PowerFormsResponse, Fixnum, Hash)>] PowerFormsResponse data, response status code and response headers
@@ -409,6 +415,8 @@ module DocuSign_eSign
       query_params[:'from_date'] = options.from_date if !options.from_date.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_fields'] = options.search_fields if !options.search_fields.nil?
+      query_params[:'search_text'] = options.search_text if !options.search_text.nil?
       query_params[:'to_date'] = options.to_date if !options.to_date.nil?
 
       # header parameters
@@ -436,7 +444,7 @@ module DocuSign_eSign
     end
 
     # Creates a new PowerForm.
-    # 
+    # This method updates an existing PowerForm.
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_form_id 
     # @param power_form  (optional parameter)
@@ -447,7 +455,7 @@ module DocuSign_eSign
     end
 
     # Creates a new PowerForm.
-    # 
+    # This method updates an existing PowerForm.
     # @param account_id The external account number (int) or account ID Guid.
     # @param power_form_id 
     # @param power_form  (optional parameter)

data/lib/docusign_esign/api/templates_api.rb

@@ -361,7 +361,7 @@ module DocuSign_eSign
     end
 
     # Provides a URL to start an edit view of the Template UI
-    # 
+    # This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.
     # @param account_id The external account number (int) or account ID Guid.
     # @param template_id The ID of the template being accessed.
     # @param return_url_request  (optional parameter)
@@ -372,7 +372,7 @@ module DocuSign_eSign
     end
 
     # Provides a URL to start an edit view of the Template UI
-    # 
+    # This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.
     # @param account_id The external account number (int) or account ID Guid.
     # @param template_id The ID of the template being accessed.
     # @param return_url_request  (optional parameter)
@@ -639,7 +639,7 @@ module DocuSign_eSign
     end
 
     # Post Responsive HTML Preview for a document in a template.
-    # 
+    # Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending.  The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -651,7 +651,7 @@ module DocuSign_eSign
     end
 
     # Post Responsive HTML Preview for a document in a template.
-    # 
+    # Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending.  The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -698,7 +698,7 @@ module DocuSign_eSign
     end
 
     # Adds the tabs to a tempate
-    # 
+    # Adds tabs to the document specified by `documentId` in the template specified by `templateId`.  In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/templates/templatedocumenttabs/create/#definition__templatetabs_prefilltabs), your request body might look like this:  ``` {   \"prefillTabs\": {     \"textTabs\": [       {         \"value\": \"a prefill text tab\",         \"pageNumber\": \"1\",         \"documentId\": \"1\",         \"xPosition\": 316,         \"yPosition\": 97       }     ]   } } ``` 
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -710,7 +710,7 @@ module DocuSign_eSign
     end
 
     # Adds the tabs to a tempate
-    # 
+    # Adds tabs to the document specified by `documentId` in the template specified by `templateId`.  In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/templates/templatedocumenttabs/create/#definition__templatetabs_prefilltabs), your request body might look like this:  ``` {   \"prefillTabs\": {     \"textTabs\": [       {         \"value\": \"a prefill text tab\",         \"pageNumber\": \"1\",         \"documentId\": \"1\",         \"xPosition\": 316,         \"yPosition\": 97       }     ]   } } ``` 
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -757,7 +757,7 @@ module DocuSign_eSign
     end
 
     # Provides a URL to start a recipient view of the Envelope UI
-    # 
+    # This method returns a URL for a template recipient preview  in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.  For more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
     # @param account_id The external account number (int) or account ID Guid.
     # @param template_id The ID of the template being accessed.
     # @param recipient_preview_request  (optional parameter)
@@ -768,7 +768,7 @@ module DocuSign_eSign
     end
 
     # Provides a URL to start a recipient view of the Envelope UI
-    # 
+    # This method returns a URL for a template recipient preview  in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.  For more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
     # @param account_id The external account number (int) or account ID Guid.
     # @param template_id The ID of the template being accessed.
     # @param recipient_preview_request  (optional parameter)
@@ -812,7 +812,7 @@ module DocuSign_eSign
     end
 
     # Get Responsive HTML Preview for all documents in a template.
-    # 
+    # Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending.  The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
     # @param account_id The external account number (int) or account ID Guid.
     # @param template_id The ID of the template being accessed.
     # @param document_html_definition  (optional parameter)
@@ -823,7 +823,7 @@ module DocuSign_eSign
     end
 
     # Get Responsive HTML Preview for all documents in a template.
-    # 
+    # Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending.  The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
     # @param account_id The external account number (int) or account ID Guid.
     # @param template_id The ID of the template being accessed.
     # @param document_html_definition  (optional parameter)
@@ -1442,7 +1442,7 @@ module DocuSign_eSign
     end
 
     # Deletes tabs from an envelope document
-    # 
+    # Deletes tabs from the document specified by `documentId` in the template specified by `templateId`. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -1454,7 +1454,7 @@ module DocuSign_eSign
     end
 
     # Deletes tabs from an envelope document
-    # 
+    # Deletes tabs from the document specified by `documentId` in the template specified by `templateId`. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -1685,7 +1685,7 @@ module DocuSign_eSign
     end
 
     # Returns tabs on the document.
-    # 
+    # Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.  
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -1697,7 +1697,7 @@ module DocuSign_eSign
     end
 
     # Returns tabs on the document.
-    # 
+    # Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.  
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -1851,7 +1851,7 @@ module DocuSign_eSign
     end
 
     # Returns tabs on the specified page.
-    # 
+    # Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param page_number The page number being accessed.
@@ -1863,7 +1863,7 @@ module DocuSign_eSign
     end
 
     # Returns tabs on the specified page.
-    # 
+    # Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param page_number The page number being accessed.
@@ -1912,7 +1912,7 @@ module DocuSign_eSign
     end
 
     # Returns document page image(s) based on input.
-    # 
+    # Returns images of the pages in a template document for display based on the parameters that you specify.
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -1924,7 +1924,7 @@ module DocuSign_eSign
     end
 
     # Returns document page image(s) based on input.
-    # 
+    # Returns images of the pages in a template document for display based on the parameters that you specify.
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -2624,65 +2624,6 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
-    # Adds or replaces the bulk recipients list in a template.
-    # Updates the bulk recipients in a template 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 recipient_id The ID of the recipient being accessed.
-    # @param template_id The ID of the template being accessed.
-    # @param bulk_recipients_request  (optional parameter)
-    # @return [BulkRecipientsSummaryResponse]
-    def update_bulk_recipients(account_id, recipient_id, template_id, bulk_recipients_request)
-      data, _status_code, _headers = update_bulk_recipients_with_http_info(account_id, recipient_id, template_id,  bulk_recipients_request)
-      return data
-    end
-
-    # Adds or replaces the bulk recipients list in a template.
-    # Updates the bulk recipients in a template 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 recipient_id The ID of the recipient being accessed.
-    # @param template_id The ID of the template being accessed.
-    # @param bulk_recipients_request  (optional parameter)
-    # @return [Array<(BulkRecipientsSummaryResponse, Fixnum, Hash)>] BulkRecipientsSummaryResponse data, response status code and response headers
-    def update_bulk_recipients_with_http_info(account_id, recipient_id, template_id, bulk_recipients_request)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: TemplatesApi.update_bulk_recipients ..."
-      end
-      # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling TemplatesApi.update_bulk_recipients" if account_id.nil?
-      # verify the required parameter 'recipient_id' is set
-      fail ArgumentError, "Missing the required parameter 'recipient_id' when calling TemplatesApi.update_bulk_recipients" if recipient_id.nil?
-      # verify the required parameter 'template_id' is set
-      fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.update_bulk_recipients" if template_id.nil?
-      # resource path
-      local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientId' + '}', recipient_id.to_s).sub('{' + 'templateId' + '}', template_id.to_s)
-
-      # 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 = @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: TemplatesApi#update_bulk_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Updates envelope custom fields in a template.
     # Updates the custom fields in a template.  Each custom field used in a template must have a unique name.
     # @param account_id The external account number (int) or account ID Guid.
@@ -3201,7 +3142,7 @@ module DocuSign_eSign
     end
 
     # Updates the tabs for a template
-    # 
+    # Updates tabs in the document specified by `documentId` in the template specified by `templateId`. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.
@@ -3213,7 +3154,7 @@ module DocuSign_eSign
     end
 
     # Updates the tabs for a template
-    # 
+    # Updates tabs in the document specified by &#x60;documentId&#x60; in the template specified by &#x60;templateId&#x60;. 
     # @param account_id The external account number (int) or account ID Guid.
     # @param document_id The ID of the document being accessed.
     # @param template_id The ID of the template being accessed.