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.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#create_power_form(account_id, power_form) ⇒ PowerForm

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?](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](support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).

Parameters:

  • account_id —

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

  • power_form (optional parameter)

Returns:



83
84
85
86
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 83

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. 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 &#x60;templateId&#x60; 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: **&#x60;email&#x60;** This mode verifies the recipient&#39;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 &#x60;activateonly&#x60; flag to the PowerForm URL and set it to true by passing in the value &#x60;1&#x60;. 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: &#x60;activateonly&#x3D;1&#x60; **&#x60;direct&#x60;** 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 &#x60;direct&#x60; signing mode does not verify the recipient&#39;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&#39;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, &#x60;enablePowerFormDirect&#x60; must be true to use &#x60;direct&#x60; as the &#x60;signingMode&#x60;. ### 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?](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](support.docusign.com/en/guides/ndse-user-guide-create-a-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



93
94
95
96
97
98
99
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
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 93

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. This method deletes a PowerForm.

Parameters:

  • account_id —

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

  • power_form_id

Returns:

  • (nil) 


134
135
136
137
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 134

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. This method deletes 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



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
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 144

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 This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the ‘powerFormId`.

Parameters:

  • account_id —

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

  • power_forms_request (optional parameter)

Returns:



186
187
188
189
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 186

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 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;.

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 196

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. This method returns detailed information about a specific PowerForm.

Parameters:

  • account_id —

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

  • power_form_id

Returns:



237
238
239
240
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 237

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. 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.

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:



291
292
293
294
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 291

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. 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.

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



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
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 302

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. This method returns detailed information about a specific 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



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

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. This method returns a list of users who have sent PowerForms.

Parameters:

  • account_id —

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

  • DocuSign_eSign::ListPowerFormSendersOptions —

    Options for modifying the behavior of the function.

Returns:



348
349
350
351
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 348

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. This method returns a list of users who have sent PowerForms.

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



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
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 358

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. This method returns a list of PowerForms that are 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:



400
401
402
403
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 400

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. This method returns a list of PowerForms that are 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



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
449
450
451
452
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 410

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[:'count'] = options.count if !options.count.nil?
  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[:'start_position'] = options.start_position if !options.start_position.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. This method updates an existing PowerForm.

Parameters:

  • account_id —

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

  • power_form_id
  • power_form (optional parameter)

Returns:



460
461
462
463
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 460

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. This method updates an existing 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



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/docusign_esign/api/power_forms_api.rb', line 471

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