Documentation

PowerFormsApi
in package

PowerFormsApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Table of Contents

$apiClient  : ApiClient
API Client
__construct()  : void
Constructor
createPowerForm()  : PowerForm
Operation createPowerForm
createPowerFormWithHttpInfo()  : array<string|int, mixed>
Operation createPowerFormWithHttpInfo
deletePowerForm()  : mixed
Operation deletePowerForm
deletePowerForms()  : PowerFormsResponse
Operation deletePowerForms
deletePowerFormsWithHttpInfo()  : array<string|int, mixed>
Operation deletePowerFormsWithHttpInfo
deletePowerFormWithHttpInfo()  : array<string|int, mixed>
Operation deletePowerFormWithHttpInfo
getApiClient()  : ApiClient
Get API client
getPowerForm()  : PowerForm
Operation getPowerForm
getPowerFormData()  : PowerFormsFormDataResponse
Operation getPowerFormData
getPowerFormDataWithHttpInfo()  : array<string|int, mixed>
Operation getPowerFormDataWithHttpInfo
getPowerFormWithHttpInfo()  : array<string|int, mixed>
Operation getPowerFormWithHttpInfo
listPowerForms()  : PowerFormsResponse
Operation listPowerForms
listPowerFormSenders()  : PowerFormSendersResponse
Operation listPowerFormSenders
listPowerFormSendersWithHttpInfo()  : array<string|int, mixed>
Operation listPowerFormSendersWithHttpInfo
listPowerFormsWithHttpInfo()  : array<string|int, mixed>
Operation listPowerFormsWithHttpInfo
setApiClient()  : self
Set the API client
updatePowerForm()  : PowerForm
Operation updatePowerForm
updatePowerFormWithHttpInfo()  : array<string|int, mixed>
Operation updatePowerFormWithHttpInfo
updateResourcePath()  : string
Update $resourcePath with $

Properties

Methods

__construct()

Constructor

public __construct([ApiClient|null $apiClient = null ]) : void
Parameters
$apiClient : ApiClient|null = null

The api client to use

Return values
void

createPowerForm()

Operation createPowerForm

public createPowerForm(string|null $account_id[, PowerForm $power_form = null ]) : PowerForm

Creates a new PowerForm.

Parameters
$account_id : string|null

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

$power_form : PowerForm = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
PowerForm

createPowerFormWithHttpInfo()

Operation createPowerFormWithHttpInfo

public createPowerFormWithHttpInfo(string|null $account_id[, PowerForm $power_form = null ]) : array<string|int, mixed>

Creates a new PowerForm.

Parameters
$account_id : string|null

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

$power_form : PowerForm = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\PowerForm, HTTP status code, HTTP response headers (array of strings)

deletePowerForm()

Operation deletePowerForm

public deletePowerForm(string|null $account_id, string|null $power_form_id) : mixed

Delete a PowerForm.

Parameters
$account_id : string|null

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

$power_form_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
mixed

deletePowerFormsWithHttpInfo()

Operation deletePowerFormsWithHttpInfo

public deletePowerFormsWithHttpInfo(string|null $account_id[, PowerFormsRequest $power_forms_request = null ]) : array<string|int, mixed>

Deletes one or more PowerForms

Parameters
$account_id : string|null

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

$power_forms_request : PowerFormsRequest = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\PowerFormsResponse, HTTP status code, HTTP response headers (array of strings)

deletePowerFormWithHttpInfo()

Operation deletePowerFormWithHttpInfo

public deletePowerFormWithHttpInfo(string|null $account_id, string|null $power_form_id) : array<string|int, mixed>

Delete a PowerForm.

Parameters
$account_id : string|null

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

$power_form_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

getPowerForm()

Operation getPowerForm

public getPowerForm(string|null $account_id, string|null $power_form_id) : PowerForm

Returns a single PowerForm.

Parameters
$account_id : string|null

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

$power_form_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
PowerForm

getPowerFormData()

Operation getPowerFormData

public getPowerFormData(string|null $account_id, string|null $power_form_id[, GetPowerFormDataOptions $options = null ]) : PowerFormsFormDataResponse

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

Parameters
$account_id : string|null

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

$power_form_id : string|null
$options : GetPowerFormDataOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
PowerFormsFormDataResponse

getPowerFormDataWithHttpInfo()

Operation getPowerFormDataWithHttpInfo

public getPowerFormDataWithHttpInfo(string|null $account_id, string|null $power_form_id[, GetPowerFormDataOptions $options = null ]) : array<string|int, mixed>

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

Parameters
$account_id : string|null

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

$power_form_id : string|null
$options : GetPowerFormDataOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\PowerFormsFormDataResponse, HTTP status code, HTTP response headers (array of strings)

getPowerFormWithHttpInfo()

Operation getPowerFormWithHttpInfo

public getPowerFormWithHttpInfo(string|null $account_id, string|null $power_form_id) : array<string|int, mixed>

Returns a single PowerForm.

Parameters
$account_id : string|null

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

$power_form_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\PowerForm, HTTP status code, HTTP response headers (array of strings)

listPowerForms()

Operation listPowerForms

public listPowerForms(string|null $account_id[, ListPowerFormsOptions $options = null ]) : PowerFormsResponse

Returns the list of PowerForms available to the user.

Parameters
$account_id : string|null

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

$options : ListPowerFormsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
PowerFormsResponse

listPowerFormSenders()

Operation listPowerFormSenders

public listPowerFormSenders(string|null $account_id[, ListPowerFormSendersOptions $options = null ]) : PowerFormSendersResponse

Returns the list of PowerForms available to the user.

Parameters
$account_id : string|null

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

$options : ListPowerFormSendersOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
PowerFormSendersResponse

listPowerFormSendersWithHttpInfo()

Operation listPowerFormSendersWithHttpInfo

public listPowerFormSendersWithHttpInfo(string|null $account_id[, ListPowerFormSendersOptions $options = null ]) : array<string|int, mixed>

Returns the list of PowerForms available to the user.

Parameters
$account_id : string|null

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

$options : ListPowerFormSendersOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\PowerFormSendersResponse, HTTP status code, HTTP response headers (array of strings)

listPowerFormsWithHttpInfo()

Operation listPowerFormsWithHttpInfo

public listPowerFormsWithHttpInfo(string|null $account_id[, ListPowerFormsOptions $options = null ]) : array<string|int, mixed>

Returns the list of PowerForms available to the user.

Parameters
$account_id : string|null

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

$options : ListPowerFormsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\PowerFormsResponse, HTTP status code, HTTP response headers (array of strings)

setApiClient()

Set the API client

public setApiClient(ApiClient $apiClient) : self
Parameters
$apiClient : ApiClient

set the API client

Return values
self

updatePowerForm()

Operation updatePowerForm

public updatePowerForm(string|null $account_id, string|null $power_form_id[, PowerForm $power_form = null ]) : PowerForm

Creates a new PowerForm.

Parameters
$account_id : string|null

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

$power_form_id : string|null
$power_form : PowerForm = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
PowerForm

updatePowerFormWithHttpInfo()

Operation updatePowerFormWithHttpInfo

public updatePowerFormWithHttpInfo(string|null $account_id, string|null $power_form_id[, PowerForm $power_form = null ]) : array<string|int, mixed>

Creates a new PowerForm.

Parameters
$account_id : string|null

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

$power_form_id : string|null
$power_form : PowerForm = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\PowerForm, HTTP status code, HTTP response headers (array of strings)

updateResourcePath()

Update $resourcePath with $

public updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
$resourcePath : string

the resource path to use

$baseName : string

the base name param

$paramName : string

the parameter name

Return values
string

Search results