Class: SignWell::BulkSendApi

Inherits:
Object
  • Object
show all
Defined in:
lib/signwell_sdk/api/bulk_send_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BulkSendApi 



19
20
21
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_bulk_send(create_bulk_send_request, opts = {}) ⇒ nil

Create Bulk Send Creates a bulk send, and it validates the CSV file before creating the bulk send.



27
28
29
30
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 27

def create_bulk_send(create_bulk_send_request, opts = {})
  create_bulk_send_with_http_info(create_bulk_send_request, opts)
  nil
end

#create_bulk_send_with_http_info(create_bulk_send_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create Bulk Send Creates a bulk send, and it validates the CSV file before creating the bulk send.



37
38
39
40
41
42
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
82
83
84
85
86
87
88
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 37

def create_bulk_send_with_http_info(create_bulk_send_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkSendApi.create_bulk_send ...'
  end
  # verify the required parameter 'create_bulk_send_request' is set
  if @api_client.config.client_side_validation && create_bulk_send_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_bulk_send_request' when calling BulkSendApi.create_bulk_send"
  end
  # resource path
  local_var_path = '/api/v1/bulk_sends'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_bulk_send_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"BulkSendApi.create_bulk_send",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkSendApi#create_bulk_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_send(id, opts = {}) ⇒ nil

Get Bulk Send Returns information about the Bulk Send.



95
96
97
98
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 95

def get_bulk_send(id, opts = {})
  get_bulk_send_with_http_info(id, opts)
  nil
end

#get_bulk_send_csv_template(template_ids, opts = {}) ⇒ File

Get Bulk Send CSV Template Fetches a CSV template that corresponds to the provided document template IDs. CSV templates are blank CSV files that have columns containing required and optional data that can be sent when creating a bulk send. Fields can be referenced by the field label. Example: [placeholder name]_[field label] could be something like customer_address or signer_company_name (if 'Customer' and 'Signer' were placeholder names for templates set up in SignWell).

Options Hash (opts):

  • :base64 (String) 


159
160
161
162
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 159

def get_bulk_send_csv_template(template_ids, opts = {})
  data, _status_code, _headers = get_bulk_send_csv_template_with_http_info(template_ids, opts)
  data
end

#get_bulk_send_csv_template_with_http_info(template_ids, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get Bulk Send CSV Template Fetches a CSV template that corresponds to the provided document template IDs. CSV templates are blank CSV files that have columns containing required and optional data that can be sent when creating a bulk send. Fields can be referenced by the field label. Example: [placeholder name]_[field label] could be something like customer_address or signer_company_name (if 'Customer' and 'Signer' were placeholder names for templates set up in SignWell).

Options Hash (opts):

  • :base64 (String) 


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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 170

def get_bulk_send_csv_template_with_http_info(template_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkSendApi.get_bulk_send_csv_template ...'
  end
  # verify the required parameter 'template_ids' is set
  if @api_client.config.client_side_validation && template_ids.nil?
    fail ArgumentError, "Missing the required parameter 'template_ids' when calling BulkSendApi.get_bulk_send_csv_template"
  end
  # resource path
  local_var_path = '/api/v1/bulk_sends/csv_template'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'template_ids[]'] = @api_client.build_collection_param(template_ids, :multi)
  query_params[:'base64'] = opts[:'base64'] if !opts[:'base64'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"BulkSendApi.get_bulk_send_csv_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkSendApi#get_bulk_send_csv_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_send_documents(id, opts = {}) ⇒ nil

Get Bulk Send Documents Returns information about the Bulk Send.

Options Hash (opts):

  • :limit (Integer) — default: default to 10
  • :page (Integer) — default: default to 1 


227
228
229
230
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 227

def get_bulk_send_documents(id, opts = {})
  get_bulk_send_documents_with_http_info(id, opts)
  nil
end

#get_bulk_send_documents_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get Bulk Send Documents Returns information about the Bulk Send.

Options Hash (opts):

  • :limit (Integer) — default: default to 10
  • :page (Integer) — default: default to 1 


239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 239

def get_bulk_send_documents_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkSendApi.get_bulk_send_documents ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling BulkSendApi.get_bulk_send_documents"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 50
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BulkSendApi.get_bulk_send_documents, must be smaller than or equal to 50.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BulkSendApi.get_bulk_send_documents, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling BulkSendApi.get_bulk_send_documents, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/v1/bulk_sends/{id}/documents'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"BulkSendApi.get_bulk_send_documents",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkSendApi#get_bulk_send_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_bulk_send_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get Bulk Send Returns information about the Bulk Send.



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
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 105

def get_bulk_send_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkSendApi.get_bulk_send ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling BulkSendApi.get_bulk_send"
  end
  # resource path
  local_var_path = '/api/v1/bulk_sends/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"BulkSendApi.get_bulk_send",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkSendApi#get_bulk_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_bulk_sends(opts = {}) ⇒ nil

List Bulk Sendings Returns information about the Bulk Send.

Options Hash (opts):

  • :user_email (String)
  • :limit (Integer) — default: default to 10
  • :page (Integer) — default: default to 1
  • :api_application_id (String) 


309
310
311
312
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 309

def list_bulk_sends(opts = {})
  list_bulk_sends_with_http_info(opts)
  nil
end

#list_bulk_sends_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

List Bulk Sendings Returns information about the Bulk Send.

Options Hash (opts):

  • :user_email (String)
  • :limit (Integer) — default: default to 10
  • :page (Integer) — default: default to 1
  • :api_application_id (String) 


322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 322

def list_bulk_sends_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkSendApi.list_bulk_sends ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 50
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BulkSendApi.list_bulk_sends, must be smaller than or equal to 50.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling BulkSendApi.list_bulk_sends, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling BulkSendApi.list_bulk_sends, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/v1/bulk_sends'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_email'] = opts[:'user_email'] if !opts[:'user_email'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'api_application_id'] = opts[:'api_application_id'] if !opts[:'api_application_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"BulkSendApi.list_bulk_sends",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkSendApi#list_bulk_sends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_bulk_send_csv(bulk_send_csv_request, opts = {}) ⇒ nil

Validate Bulk Send CSV Validates a Bulk Send CSV file before creating the Bulk Send. It will check the structure of the CSV and the data it contains, and return any errors found.



387
388
389
390
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 387

def validate_bulk_send_csv(bulk_send_csv_request, opts = {})
  validate_bulk_send_csv_with_http_info(bulk_send_csv_request, opts)
  nil
end

#validate_bulk_send_csv_with_http_info(bulk_send_csv_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Validate Bulk Send CSV Validates a Bulk Send CSV file before creating the Bulk Send. It will check the structure of the CSV and the data it contains, and return any errors found.



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/signwell_sdk/api/bulk_send_api.rb', line 397

def validate_bulk_send_csv_with_http_info(bulk_send_csv_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BulkSendApi.validate_bulk_send_csv ...'
  end
  # verify the required parameter 'bulk_send_csv_request' is set
  if @api_client.config.client_side_validation && bulk_send_csv_request.nil?
    fail ArgumentError, "Missing the required parameter 'bulk_send_csv_request' when calling BulkSendApi.validate_bulk_send_csv"
  end
  # resource path
  local_var_path = '/api/v1/bulk_sends/validate_csv'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bulk_send_csv_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"BulkSendApi.validate_bulk_send_csv",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkSendApi#validate_bulk_send_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end