docusign_esign 3.4.0 → 3.5.0.rc1

data/lib/docusign_esign/api/bulk_envelopes_api.rb

@@ -29,6 +29,24 @@ module DocuSign_eSign
     end
   end
 
+  class GetBulkSendBatchesOptions
+    # 
+    attr_accessor :batch_ids
+
+    # 
+    attr_accessor :count
+
+    # 
+    attr_accessor :start_position
+
+    # 
+    attr_accessor :status
+
+    def self.default
+      @@default ||= GetBulkSendBatchesOptions.new
+    end
+  end
+
   class GetRecipientsOptions
     # 
     attr_accessor :include_tabs
@@ -45,9 +63,6 @@ module DocuSign_eSign
     # The number of results to return. This can be 1 to 20.
     attr_accessor :count
 
-    # 
-    attr_accessor :include
-
     # 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 :start_position
 
@@ -393,6 +408,114 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Gets a specific bulk send batch status
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param bulk_send_batch_id 
+    # @return [BulkSendBatchStatus]
+    def get_bulk_send_batch_status(account_id, bulk_send_batch_id)
+      data, _status_code, _headers = get_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id)
+      return data
+    end
+
+    # Gets a specific bulk send batch status
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param bulk_send_batch_id 
+    # @return [Array<(BulkSendBatchStatus, Fixnum, Hash)>] BulkSendBatchStatus data, response status code and response headers
+    def get_bulk_send_batch_status_with_http_info(account_id, bulk_send_batch_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_batch_status ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_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.get_bulk_send_batch_status" if bulk_send_batch_id.nil?
+      # resource path
+      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 = {}
+
+      # 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 => 'BulkSendBatchStatus')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_bulk_send_batch_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of bulk send batch satuses initiated by account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param DocuSign_eSign::GetBulkSendBatchesOptions Options for modifying the behavior of the function.
+    # @return [BulkSendBatchSummaries]
+    def get_bulk_send_batches(account_id, options = DocuSign_eSign::GetBulkSendBatchesOptions.default)
+      data, _status_code, _headers = get_bulk_send_batches_with_http_info(account_id, options)
+      return data
+    end
+
+    # Returns a list of bulk send batch satuses initiated by account.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param DocuSign_eSign::GetBulkSendBatchesOptions Options for modifying the behavior of the function.
+    # @return [Array<(BulkSendBatchSummaries, Fixnum, Hash)>] BulkSendBatchSummaries data, response status code and response headers
+    def get_bulk_send_batches_with_http_info(account_id, options = DocuSign_eSign::GetBulkSendBatchesOptions.default)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_batches ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_bulk_send_batches" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
+
+      # query parameters
+      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[:'start_position'] = options.start_position if !options.start_position.nil?
+      query_params[:'status'] = options.status if !options.status.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 => 'BulkSendBatchSummaries')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_bulk_send_batches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Gets a specific bulk send list
     # 
     # @param account_id The external account number (int) or account ID Guid.
@@ -583,7 +706,6 @@ module DocuSign_eSign
       # query parameters
       query_params = {}
       query_params[:'count'] = options.count if !options.count.nil?
-      query_params[:'include'] = options.include if !options.include.nil?
       query_params[:'start_position'] = options.start_position if !options.start_position.nil?
 
       # header parameters

data/lib/docusign_esign/api/envelopes_api.rb

@@ -2330,6 +2330,58 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Delete the workflow definition for an envelope.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param envelope_id The envelopeId Guid of the envelope being accessed.
+    # @return [nil]
+    def delete_envelope_workflow_definition(account_id, envelope_id)
+      delete_envelope_workflow_definition_with_http_info(account_id, envelope_id)
+      return nil
+    end
+
+    # Delete the workflow definition for an envelope.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param envelope_id The envelopeId Guid of the envelope being accessed.
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_envelope_workflow_definition_with_http_info(account_id, envelope_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_envelope_workflow_definition ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if account_id.nil?
+      # verify the required parameter 'envelope_id' is set
+      fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.delete_envelope_workflow_definition" if envelope_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_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: EnvelopesApi#delete_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Deletes an envelope lock.
     # Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
     # @param account_id The external account number (int) or account ID Guid.
@@ -2554,6 +2606,58 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Delete the workflow definition for a template.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param template_id The ID of the template being accessed.
+    # @return [nil]
+    def delete_template_workflow_definition(account_id, template_id)
+      delete_template_workflow_definition_with_http_info(account_id, template_id)
+      return nil
+    end
+
+    # Delete the workflow definition for a template.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param template_id The ID of the template being accessed.
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_template_workflow_definition_with_http_info(account_id, template_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EnvelopesApi.delete_template_workflow_definition ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.delete_template_workflow_definition" if account_id.nil?
+      # verify the required parameter 'template_id' is set
+      fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.delete_template_workflow_definition" if template_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_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 = 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: EnvelopesApi#delete_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Deletes a template from a document in an existing envelope.
     # Deletes the specified template from a document in an existing envelope.
     # @param account_id The external account number (int) or account ID Guid.
@@ -3427,6 +3531,59 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Returns the workflow definition for an envelope.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param envelope_id The envelopeId Guid of the envelope being accessed.
+    # @return [Workflow]
+    def get_envelope_workflow_definition(account_id, envelope_id)
+      data, _status_code, _headers = get_envelope_workflow_definition_with_http_info(account_id, envelope_id)
+      return data
+    end
+
+    # Returns the workflow definition for an envelope.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param envelope_id The envelopeId Guid of the envelope being accessed.
+    # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
+    def get_envelope_workflow_definition_with_http_info(account_id, envelope_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EnvelopesApi.get_envelope_workflow_definition ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_envelope_workflow_definition" if account_id.nil?
+      # verify the required parameter 'envelope_id' is set
+      fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.get_envelope_workflow_definition" if envelope_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_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(: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 => 'Workflow')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EnvelopesApi#get_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Returns envelope form data for an existing envelope.
     # 
     # @param account_id The external account number (int) or account ID Guid.
@@ -4056,6 +4213,59 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Returns the workflow definition for a template.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param template_id The ID of the template being accessed.
+    # @return [Workflow]
+    def get_template_workflow_definition(account_id, template_id)
+      data, _status_code, _headers = get_template_workflow_definition_with_http_info(account_id, template_id)
+      return data
+    end
+
+    # Returns the workflow definition for a template.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param template_id The ID of the template being accessed.
+    # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
+    def get_template_workflow_definition_with_http_info(account_id, template_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EnvelopesApi.get_template_workflow_definition ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.get_template_workflow_definition" if account_id.nil?
+      # verify the required parameter 'template_id' is set
+      fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.get_template_workflow_definition" if template_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_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 = 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 => 'Workflow')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EnvelopesApi#get_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Gets the envelope audit events for an envelope.
     # Gets the envelope audit events for the specified envelope.
     # @param account_id The external account number (int) or account ID Guid.
@@ -5458,6 +5668,61 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Updates the envelope workflow definition for an envelope.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param envelope_id The envelopeId Guid of the envelope being accessed.
+    # @param workflow  (optional parameter)
+    # @return [Workflow]
+    def update_envelope_workflow_definition(account_id, envelope_id, workflow)
+      data, _status_code, _headers = update_envelope_workflow_definition_with_http_info(account_id, envelope_id,  workflow)
+      return data
+    end
+
+    # Updates the envelope workflow definition for an envelope.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param envelope_id The envelopeId Guid of the envelope being accessed.
+    # @param workflow  (optional parameter)
+    # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
+    def update_envelope_workflow_definition_with_http_info(account_id, envelope_id, workflow)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EnvelopesApi.update_envelope_workflow_definition ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_envelope_workflow_definition" if account_id.nil?
+      # verify the required parameter 'envelope_id' is set
+      fail ArgumentError, "Missing the required parameter 'envelope_id' when calling EnvelopesApi.update_envelope_workflow_definition" if envelope_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'envelopeId' + '}', envelope_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(workflow)
+      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 => 'Workflow')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EnvelopesApi#update_envelope_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates an envelope lock.
     # Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
     # @param account_id The external account number (int) or account ID Guid.
@@ -6082,5 +6347,60 @@ module DocuSign_eSign
       end
       return data, status_code, headers
     end
+
+    # Updates the workflow definition for a template.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param template_id The ID of the template being accessed.
+    # @param workflow  (optional parameter)
+    # @return [Workflow]
+    def update_template_workflow_definition(account_id, template_id, workflow)
+      data, _status_code, _headers = update_template_workflow_definition_with_http_info(account_id, template_id,  workflow)
+      return data
+    end
+
+    # Updates the workflow definition for a template.
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param template_id The ID of the template being accessed.
+    # @param workflow  (optional parameter)
+    # @return [Array<(Workflow, Fixnum, Hash)>] Workflow data, response status code and response headers
+    def update_template_workflow_definition_with_http_info(account_id, template_id, workflow)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EnvelopesApi.update_template_workflow_definition ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling EnvelopesApi.update_template_workflow_definition" if account_id.nil?
+      # verify the required parameter 'template_id' is set
+      fail ArgumentError, "Missing the required parameter 'template_id' when calling EnvelopesApi.update_template_workflow_definition" if template_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/templates/{templateId}/workflow".sub('{format}','json').sub('{' + 'accountId' + '}', account_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(workflow)
+      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 => 'Workflow')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EnvelopesApi#update_template_workflow_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end