Class: DocuSign_eSign::BulkProcessDataSendApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/bulk_process_data_send_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = BulkProcessDataSendApi.default) ⇒ BulkProcessDataSendApi

Returns a new instance of BulkProcessDataSendApi.



20
21
22
 
# File 'lib/docusign_esign/api/bulk_process_data_send_api.rb', line 20

def initialize(api_client = BulkProcessDataSendApi.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



18
19
20
 
# File 'lib/docusign_esign/api/bulk_process_data_send_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#create_bulk_process_request_to_queue(account_id, bulk_process_list_id, process_action, bulk_process_request) ⇒ BulkProcessResponse

Uses the specified bulk envelopes list to update the envelopes specified in the payload

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bulk_process_list_id
  • process_action
  • bulk_process_request (optional parameter)

Returns:



31
32
33
34
 
# File 'lib/docusign_esign/api/bulk_process_data_send_api.rb', line 31

def create_bulk_process_request_to_queue(, bulk_process_list_id, process_action, bulk_process_request)
  data, _status_code, _headers = create_bulk_process_request_to_queue_with_http_info(, bulk_process_list_id, process_action,  bulk_process_request)
  return data
end

#create_bulk_process_request_to_queue_with_http_info(account_id, bulk_process_list_id, process_action, bulk_process_request) ⇒ Array<(BulkProcessResponse, Fixnum, Hash)>

Uses the specified bulk envelopes list to update the envelopes specified in the payload

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bulk_process_list_id
  • process_action
  • bulk_process_request (optional parameter)

Returns:

  • (Array<(BulkProcessResponse, Fixnum, Hash)>) —

    BulkProcessResponse data, response status code and response headers



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/docusign_esign/api/bulk_process_data_send_api.rb', line 43

def create_bulk_process_request_to_queue_with_http_info(, bulk_process_list_id, process_action, bulk_process_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkProcessDataSendApi.create_bulk_process_request_to_queue ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataSendApi.create_bulk_process_request_to_queue" if .nil?
  # verify the required parameter 'bulk_process_list_id' is set
  fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataSendApi.create_bulk_process_request_to_queue" if bulk_process_list_id.nil?
  # verify the required parameter 'process_action' is set
  fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataSendApi.create_bulk_process_request_to_queue" if process_action.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}/send".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.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_process_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BulkProcessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkProcessDataSendApi#create_bulk_process_request_to_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_bulk_process_list(account_id, bulk_process_list_id, process_action) ⇒ BulkProcessResult

Deletes a specific bulk process list

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bulk_process_list_id
  • process_action

Returns:



89
90
91
92
 
# File 'lib/docusign_esign/api/bulk_process_data_send_api.rb', line 89

def delete_bulk_process_list(, bulk_process_list_id, process_action)
  data, _status_code, _headers = delete_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  return data
end

#delete_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action) ⇒ Array<(BulkProcessResult, Fixnum, Hash)>

Deletes a specific bulk process list

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bulk_process_list_id
  • process_action

Returns:

  • (Array<(BulkProcessResult, Fixnum, Hash)>) —

    BulkProcessResult data, response status code and response headers



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/docusign_esign/api/bulk_process_data_send_api.rb', line 100

def delete_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkProcessDataSendApi.delete_bulk_process_list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataSendApi.delete_bulk_process_list" if .nil?
  # verify the required parameter 'bulk_process_list_id' is set
  fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataSendApi.delete_bulk_process_list" if bulk_process_list_id.nil?
  # verify the required parameter 'process_action' is set
  fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataSendApi.delete_bulk_process_list" if process_action.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}/send".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.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 => 'BulkProcessResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkProcessDataSendApi#delete_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_process_list(account_id, bulk_process_list_id, process_action) ⇒ nil

Gets a specific bulk process list

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bulk_process_list_id
  • process_action

Returns:

  • (nil) 


146
147
148
149
 
# File 'lib/docusign_esign/api/bulk_process_data_send_api.rb', line 146

def get_bulk_process_list(, bulk_process_list_id, process_action)
  get_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  return nil
end

#get_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action) ⇒ Array<(nil, Fixnum, Hash)>

Gets a specific bulk process list

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bulk_process_list_id
  • process_action

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/docusign_esign/api/bulk_process_data_send_api.rb', line 157

def get_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkProcessDataSendApi.get_bulk_process_list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataSendApi.get_bulk_process_list" if .nil?
  # verify the required parameter 'bulk_process_list_id' is set
  fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataSendApi.get_bulk_process_list" if bulk_process_list_id.nil?
  # verify the required parameter 'process_action' is set
  fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataSendApi.get_bulk_process_list" if process_action.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}/send".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkProcessDataSendApi#get_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_bulk_process_list(account_id, bulk_process_list_id, process_action) ⇒ nil

Updates a specific bulk process list

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bulk_process_list_id
  • process_action

Returns:

  • (nil) 


202
203
204
205
 
# File 'lib/docusign_esign/api/bulk_process_data_send_api.rb', line 202

def update_bulk_process_list(, bulk_process_list_id, process_action)
  update_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  return nil
end

#update_bulk_process_list_with_http_info(account_id, bulk_process_list_id, process_action) ⇒ Array<(nil, Fixnum, Hash)>

Updates a specific bulk process list

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bulk_process_list_id
  • process_action

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/docusign_esign/api/bulk_process_data_send_api.rb', line 213

def update_bulk_process_list_with_http_info(, bulk_process_list_id, process_action)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkProcessDataSendApi.update_bulk_process_list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkProcessDataSendApi.update_bulk_process_list" if .nil?
  # verify the required parameter 'bulk_process_list_id' is set
  fail ArgumentError, "Missing the required parameter 'bulk_process_list_id' when calling BulkProcessDataSendApi.update_bulk_process_list" if bulk_process_list_id.nil?
  # verify the required parameter 'process_action' is set
  fail ArgumentError, "Missing the required parameter 'process_action' when calling BulkProcessDataSendApi.update_bulk_process_list" if process_action.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/bulk_process_data/actions/{processAction}/{bulkProcessListId}/send".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bulkProcessListId' + '}', bulk_process_list_id.to_s).sub('{' + 'processAction' + '}', process_action.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(:PUT, 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: BulkProcessDataSendApi#update_bulk_process_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end