Class: DocuSign_eSign::PowerFormsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = PowerFormsApi.default) ⇒ PowerFormsApi

Returns a new instance of PowerFormsApi.


63
64
65
# File 'lib/docusign_esign/api/power_forms_api.rb', line 63

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client


61
62
63
# File 'lib/docusign_esign/api/power_forms_api.rb', line 61

def api_client
  @api_client
end

Instance Method Details

#create_power_form(account_id, power_form) ⇒ PowerForm

Creates a new PowerForm.

Parameters:

  • account_id

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

  • power_form (optional parameter)

Returns:


72
73
74
75
# File 'lib/docusign_esign/api/power_forms_api.rb', line 72

def create_power_form(, power_form)
  data, _status_code, _headers = create_power_form_with_http_info(,  power_form)
  return data
end

#create_power_form_with_http_info(account_id, power_form) ⇒ Array<(PowerForm, Fixnum, Hash)>

Creates a new PowerForm.

Parameters:

  • account_id

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

  • power_form (optional parameter)

Returns:

  • (Array<(PowerForm, Fixnum, Hash)>)

    PowerForm data, response status code and response headers


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/docusign_esign/api/power_forms_api.rb', line 82

def create_power_form_with_http_info(, power_form)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PowerFormsApi.create_power_form ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.create_power_form" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/powerforms".sub('{format}','json').sub('{' + 'accountId' + '}', .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(power_form)
  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 => 'PowerForm')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PowerFormsApi#create_power_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_power_form(account_id, power_form_id) ⇒ nil

Delete a PowerForm.

Parameters:

  • account_id

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

  • power_form_id

Returns:

  • (nil)

123
124
125
126
# File 'lib/docusign_esign/api/power_forms_api.rb', line 123

def delete_power_form(, power_form_id)
  delete_power_form_with_http_info(, power_form_id)
  return nil
end

#delete_power_form_with_http_info(account_id, power_form_id) ⇒ Array<(nil, Fixnum, Hash)>

Delete a PowerForm.

Parameters:

  • account_id

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

  • power_form_id

Returns:

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

    nil, response status code and response headers


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/docusign_esign/api/power_forms_api.rb', line 133

def delete_power_form_with_http_info(, power_form_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PowerFormsApi.delete_power_form ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.delete_power_form" if .nil?
  # verify the required parameter 'power_form_id' is set
  fail ArgumentError, "Missing the required parameter 'power_form_id' when calling PowerFormsApi.delete_power_form" if power_form_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/powerforms/{powerFormId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'powerFormId' + '}', power_form_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: PowerFormsApi#delete_power_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_power_forms(account_id, power_forms_request) ⇒ PowerFormsResponse

Deletes one or more PowerForms

Parameters:

  • account_id

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

  • power_forms_request (optional parameter)

Returns:


175
176
177
178
# File 'lib/docusign_esign/api/power_forms_api.rb', line 175

def delete_power_forms(, power_forms_request)
  data, _status_code, _headers = delete_power_forms_with_http_info(,  power_forms_request)
  return data
end

#delete_power_forms_with_http_info(account_id, power_forms_request) ⇒ Array<(PowerFormsResponse, Fixnum, Hash)>

Deletes one or more PowerForms

Parameters:

  • account_id

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

  • power_forms_request (optional parameter)

Returns:

  • (Array<(PowerFormsResponse, Fixnum, Hash)>)

    PowerFormsResponse data, response status code and response headers


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
219
# File 'lib/docusign_esign/api/power_forms_api.rb', line 185

def delete_power_forms_with_http_info(, power_forms_request)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PowerFormsApi.delete_power_forms ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.delete_power_forms" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/powerforms".sub('{format}','json').sub('{' + 'accountId' + '}', .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(power_forms_request)
  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 => 'PowerFormsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PowerFormsApi#delete_power_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_power_form(account_id, power_form_id) ⇒ PowerForm

Returns a single PowerForm.

Parameters:

  • account_id

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

  • power_form_id

Returns:


226
227
228
229
# File 'lib/docusign_esign/api/power_forms_api.rb', line 226

def get_power_form(, power_form_id)
  data, _status_code, _headers = get_power_form_with_http_info(, power_form_id)
  return data
end

#get_power_form_data(account_id, power_form_id, options = DocuSign_eSign::GetPowerFormDataOptions.default) ⇒ PowerFormsFormDataResponse

Returns the form data associated with the usage of a PowerForm.

Parameters:

  • account_id

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

  • power_form_id
  • DocuSign_eSign::GetPowerFormDataOptions

    Options for modifying the behavior of the function.

Returns:


280
281
282
283
# File 'lib/docusign_esign/api/power_forms_api.rb', line 280

def get_power_form_data(, power_form_id, options = DocuSign_eSign::GetPowerFormDataOptions.default)
  data, _status_code, _headers = get_power_form_data_with_http_info(, power_form_id, options)
  return data
end

#get_power_form_data_with_http_info(account_id, power_form_id, options = DocuSign_eSign::GetPowerFormDataOptions.default) ⇒ Array<(PowerFormsFormDataResponse, Fixnum, Hash)>

Returns the form data associated with the usage of a PowerForm.

Parameters:

  • account_id

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

  • power_form_id
  • DocuSign_eSign::GetPowerFormDataOptions

    Options for modifying the behavior of the function.

Returns:

  • (Array<(PowerFormsFormDataResponse, Fixnum, Hash)>)

    PowerFormsFormDataResponse data, response status code and response headers


291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/docusign_esign/api/power_forms_api.rb', line 291

def get_power_form_data_with_http_info(, power_form_id, options = DocuSign_eSign::GetPowerFormDataOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PowerFormsApi.get_power_form_data ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.get_power_form_data" if .nil?
  # verify the required parameter 'power_form_id' is set
  fail ArgumentError, "Missing the required parameter 'power_form_id' when calling PowerFormsApi.get_power_form_data" if power_form_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'powerFormId' + '}', power_form_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'data_layout'] = options.data_layout if !options.data_layout.nil?
  query_params[:'from_date'] = options.from_date if !options.from_date.nil?
  query_params[:'to_date'] = options.to_date if !options.to_date.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 => 'PowerFormsFormDataResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PowerFormsApi#get_power_form_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_power_form_with_http_info(account_id, power_form_id) ⇒ Array<(PowerForm, Fixnum, Hash)>

Returns a single PowerForm.

Parameters:

  • account_id

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

  • power_form_id

Returns:

  • (Array<(PowerForm, Fixnum, Hash)>)

    PowerForm data, response status code and response headers


236
237
238
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
# File 'lib/docusign_esign/api/power_forms_api.rb', line 236

def get_power_form_with_http_info(, power_form_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PowerFormsApi.get_power_form ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.get_power_form" if .nil?
  # verify the required parameter 'power_form_id' is set
  fail ArgumentError, "Missing the required parameter 'power_form_id' when calling PowerFormsApi.get_power_form" if power_form_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/powerforms/{powerFormId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'powerFormId' + '}', power_form_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 => 'PowerForm')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PowerFormsApi#get_power_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_power_form_senders(account_id, options = DocuSign_eSign::ListPowerFormSendersOptions.default) ⇒ PowerFormSendersResponse

Returns the list of PowerForms available to the user.

Parameters:

  • account_id

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

  • DocuSign_eSign::ListPowerFormSendersOptions

    Options for modifying the behavior of the function.

Returns:


337
338
339
340
# File 'lib/docusign_esign/api/power_forms_api.rb', line 337

def list_power_form_senders(, options = DocuSign_eSign::ListPowerFormSendersOptions.default)
  data, _status_code, _headers = list_power_form_senders_with_http_info(, options)
  return data
end

#list_power_form_senders_with_http_info(account_id, options = DocuSign_eSign::ListPowerFormSendersOptions.default) ⇒ Array<(PowerFormSendersResponse, Fixnum, Hash)>

Returns the list of PowerForms available to the user.

Parameters:

  • account_id

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

  • DocuSign_eSign::ListPowerFormSendersOptions

    Options for modifying the behavior of the function.

Returns:

  • (Array<(PowerFormSendersResponse, Fixnum, Hash)>)

    PowerFormSendersResponse data, response status code and response headers


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
381
382
# File 'lib/docusign_esign/api/power_forms_api.rb', line 347

def list_power_form_senders_with_http_info(, options = DocuSign_eSign::ListPowerFormSendersOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PowerFormsApi.list_power_form_senders ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.list_power_form_senders" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/powerforms/senders".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PowerFormSendersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PowerFormsApi#list_power_form_senders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_power_forms(account_id, options = DocuSign_eSign::ListPowerFormsOptions.default) ⇒ PowerFormsResponse

Returns the list of PowerForms available to the user.

Parameters:

  • account_id

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

  • DocuSign_eSign::ListPowerFormsOptions

    Options for modifying the behavior of the function.

Returns:


389
390
391
392
# File 'lib/docusign_esign/api/power_forms_api.rb', line 389

def list_power_forms(, options = DocuSign_eSign::ListPowerFormsOptions.default)
  data, _status_code, _headers = list_power_forms_with_http_info(, options)
  return data
end

#list_power_forms_with_http_info(account_id, options = DocuSign_eSign::ListPowerFormsOptions.default) ⇒ Array<(PowerFormsResponse, Fixnum, Hash)>

Returns the list of PowerForms available to the user.

Parameters:

  • account_id

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

  • DocuSign_eSign::ListPowerFormsOptions

    Options for modifying the behavior of the function.

Returns:

  • (Array<(PowerFormsResponse, Fixnum, Hash)>)

    PowerFormsResponse data, response status code and response headers


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
# File 'lib/docusign_esign/api/power_forms_api.rb', line 399

def list_power_forms_with_http_info(, options = DocuSign_eSign::ListPowerFormsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PowerFormsApi.list_power_forms ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.list_power_forms" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/powerforms".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  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[:'to_date'] = options.to_date if !options.to_date.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 => 'PowerFormsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PowerFormsApi#list_power_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_power_form(account_id, power_form_id, power_form) ⇒ PowerForm

Creates a new PowerForm.

Parameters:

  • account_id

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

  • power_form_id
  • power_form (optional parameter)

Returns:


445
446
447
448
# File 'lib/docusign_esign/api/power_forms_api.rb', line 445

def update_power_form(, power_form_id, power_form)
  data, _status_code, _headers = update_power_form_with_http_info(, power_form_id,  power_form)
  return data
end

#update_power_form_with_http_info(account_id, power_form_id, power_form) ⇒ Array<(PowerForm, Fixnum, Hash)>

Creates a new PowerForm.

Parameters:

  • account_id

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

  • power_form_id
  • power_form (optional parameter)

Returns:

  • (Array<(PowerForm, Fixnum, Hash)>)

    PowerForm data, response status code and response headers


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
# File 'lib/docusign_esign/api/power_forms_api.rb', line 456

def update_power_form_with_http_info(, power_form_id, power_form)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PowerFormsApi.update_power_form ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.update_power_form" if .nil?
  # verify the required parameter 'power_form_id' is set
  fail ArgumentError, "Missing the required parameter 'power_form_id' when calling PowerFormsApi.update_power_form" if power_form_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/powerforms/{powerFormId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'powerFormId' + '}', power_form_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(power_form)
  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 => 'PowerForm')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PowerFormsApi#update_power_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end