Documentation

ConnectApi
in package

ConnectApi 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
createConfiguration()  : ConnectCustomConfiguration
Operation createConfiguration
createConfigurationWithHttpInfo()  : array<string|int, mixed>
Operation createConfigurationWithHttpInfo
createConnectOAuthConfig()  : ConnectOAuthConfig
Operation createConnectOAuthConfig
createConnectOAuthConfigWithHttpInfo()  : array<string|int, mixed>
Operation createConnectOAuthConfigWithHttpInfo
deleteConfiguration()  : mixed
Operation deleteConfiguration
deleteConfigurationWithHttpInfo()  : array<string|int, mixed>
Operation deleteConfigurationWithHttpInfo
deleteConnectOAuthConfig()  : mixed
Operation deleteConnectOAuthConfig
deleteConnectOAuthConfigWithHttpInfo()  : array<string|int, mixed>
Operation deleteConnectOAuthConfigWithHttpInfo
deleteEventFailureLog()  : ConnectDeleteFailureResult
Operation deleteEventFailureLog
deleteEventFailureLogWithHttpInfo()  : array<string|int, mixed>
Operation deleteEventFailureLogWithHttpInfo
deleteEventLog()  : mixed
Operation deleteEventLog
deleteEventLogs()  : mixed
Operation deleteEventLogs
deleteEventLogsWithHttpInfo()  : array<string|int, mixed>
Operation deleteEventLogsWithHttpInfo
deleteEventLogWithHttpInfo()  : array<string|int, mixed>
Operation deleteEventLogWithHttpInfo
deleteMobileNotifiers()  : MobileNotifierConfigurationInformation
Operation deleteMobileNotifiers
deleteMobileNotifiersWithHttpInfo()  : array<string|int, mixed>
Operation deleteMobileNotifiersWithHttpInfo
getApiClient()  : ApiClient
Get API client
getConfiguration()  : ConnectConfigResults
Operation getConfiguration
getConfigurationWithHttpInfo()  : array<string|int, mixed>
Operation getConfigurationWithHttpInfo
getConnectAllUsers()  : IntegratedConnectUserInfoList
Operation getConnectAllUsers
getConnectAllUsersWithHttpInfo()  : array<string|int, mixed>
Operation getConnectAllUsersWithHttpInfo
getConnectOAuthConfig()  : ConnectOAuthConfig
Operation getConnectOAuthConfig
getConnectOAuthConfigWithHttpInfo()  : array<string|int, mixed>
Operation getConnectOAuthConfigWithHttpInfo
getEventLog()  : ConnectLog
Operation getEventLog
getEventLogWithHttpInfo()  : array<string|int, mixed>
Operation getEventLogWithHttpInfo
listConfigurations()  : ConnectConfigResults
Operation listConfigurations
listConfigurationsWithHttpInfo()  : array<string|int, mixed>
Operation listConfigurationsWithHttpInfo
listEventFailureLogs()  : ConnectLogs
Operation listEventFailureLogs
listEventFailureLogsWithHttpInfo()  : array<string|int, mixed>
Operation listEventFailureLogsWithHttpInfo
listEventLogs()  : ConnectLogs
Operation listEventLogs
listEventLogsWithHttpInfo()  : array<string|int, mixed>
Operation listEventLogsWithHttpInfo
listMobileNotifiers()  : MobileNotifierConfigurationInformation
Operation listMobileNotifiers
listMobileNotifiersWithHttpInfo()  : array<string|int, mixed>
Operation listMobileNotifiersWithHttpInfo
listUsers()  : IntegratedUserInfoList
Operation listUsers
listUsersWithHttpInfo()  : array<string|int, mixed>
Operation listUsersWithHttpInfo
retryEventForEnvelope()  : ConnectFailureResults
Operation retryEventForEnvelope
retryEventForEnvelopes()  : ConnectFailureResults
Operation retryEventForEnvelopes
retryEventForEnvelopesWithHttpInfo()  : array<string|int, mixed>
Operation retryEventForEnvelopesWithHttpInfo
retryEventForEnvelopeWithHttpInfo()  : array<string|int, mixed>
Operation retryEventForEnvelopeWithHttpInfo
setApiClient()  : self
Set the API client
updateConfiguration()  : ConnectCustomConfiguration
Operation updateConfiguration
updateConfigurationWithHttpInfo()  : array<string|int, mixed>
Operation updateConfigurationWithHttpInfo
updateConnectOAuthConfig()  : ConnectOAuthConfig
Operation updateConnectOAuthConfig
updateConnectOAuthConfigWithHttpInfo()  : array<string|int, mixed>
Operation updateConnectOAuthConfigWithHttpInfo
updateMobileNotifiers()  : MobileNotifierConfigurationInformation
Operation updateMobileNotifiers
updateMobileNotifiersWithHttpInfo()  : array<string|int, mixed>
Operation updateMobileNotifiersWithHttpInfo
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

createConfiguration()

Operation createConfiguration

public createConfiguration(string|null $account_id[, ConnectCustomConfiguration $connect_custom_configuration = null ]) : ConnectCustomConfiguration

Creates a connect configuration for the specified account.

Parameters
$account_id : string|null

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

$connect_custom_configuration : ConnectCustomConfiguration = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ConnectCustomConfiguration

createConfigurationWithHttpInfo()

Operation createConfigurationWithHttpInfo

public createConfigurationWithHttpInfo(string|null $account_id[, ConnectCustomConfiguration $connect_custom_configuration = null ]) : array<string|int, mixed>

Creates a connect configuration for the specified account.

Parameters
$account_id : string|null

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

$connect_custom_configuration : ConnectCustomConfiguration = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

createConnectOAuthConfig()

Operation createConnectOAuthConfig

public createConnectOAuthConfig(string|null $account_id[, ConnectOAuthConfig $connect_o_auth_config = null ]) : ConnectOAuthConfig

Sets the Connect OAuth Config for the account.

Parameters
$account_id : string|null

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

$connect_o_auth_config : ConnectOAuthConfig = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ConnectOAuthConfig

createConnectOAuthConfigWithHttpInfo()

Operation createConnectOAuthConfigWithHttpInfo

public createConnectOAuthConfigWithHttpInfo(string|null $account_id[, ConnectOAuthConfig $connect_o_auth_config = null ]) : array<string|int, mixed>

Sets the Connect OAuth Config for the account.

Parameters
$account_id : string|null

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

$connect_o_auth_config : ConnectOAuthConfig = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

deleteConfiguration()

Operation deleteConfiguration

public deleteConfiguration(string|null $account_id, string|null $connect_id) : mixed

Deletes the specified connect configuration.

Parameters
$account_id : string|null

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

$connect_id : string|null

The ID of the custom Connect configuration being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteConfigurationWithHttpInfo()

Operation deleteConfigurationWithHttpInfo

public deleteConfigurationWithHttpInfo(string|null $account_id, string|null $connect_id) : array<string|int, mixed>

Deletes the specified connect configuration.

Parameters
$account_id : string|null

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

$connect_id : string|null

The ID of the custom Connect configuration being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

deleteConnectOAuthConfig()

Operation deleteConnectOAuthConfig

public deleteConnectOAuthConfig(string|null $account_id) : mixed

Sets the Connect OAuth Config for the account.

Parameters
$account_id : string|null

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

Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteConnectOAuthConfigWithHttpInfo()

Operation deleteConnectOAuthConfigWithHttpInfo

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

Sets the Connect OAuth Config for the account.

Parameters
$account_id : string|null

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

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

deleteEventFailureLog()

Operation deleteEventFailureLog

public deleteEventFailureLog(string|null $account_id, string|null $failure_id) : ConnectDeleteFailureResult

Deletes a Connect failure log entry.

Parameters
$account_id : string|null

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

$failure_id : string|null

The ID of the failed connect log entry.

Tags
throws
ApiException

on non-2xx response

Return values
ConnectDeleteFailureResult

deleteEventFailureLogWithHttpInfo()

Operation deleteEventFailureLogWithHttpInfo

public deleteEventFailureLogWithHttpInfo(string|null $account_id, string|null $failure_id) : array<string|int, mixed>

Deletes a Connect failure log entry.

Parameters
$account_id : string|null

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

$failure_id : string|null

The ID of the failed connect log entry.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

deleteEventLog()

Operation deleteEventLog

public deleteEventLog(string|null $account_id, string|null $log_id) : mixed

Deletes a specified Connect log entry.

Parameters
$account_id : string|null

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

$log_id : string|null

The ID of the connect log entry

Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteEventLogs()

Operation deleteEventLogs

public deleteEventLogs(string|null $account_id) : mixed

Gets a list of Connect log entries.

Parameters
$account_id : string|null

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

Tags
throws
ApiException

on non-2xx response

Return values
mixed

deleteEventLogsWithHttpInfo()

Operation deleteEventLogsWithHttpInfo

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

Gets a list of Connect log entries.

Parameters
$account_id : string|null

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

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

deleteEventLogWithHttpInfo()

Operation deleteEventLogWithHttpInfo

public deleteEventLogWithHttpInfo(string|null $account_id, string|null $log_id) : array<string|int, mixed>

Deletes a specified Connect log entry.

Parameters
$account_id : string|null

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

$log_id : string|null

The ID of the connect log entry

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

deleteMobileNotifiers()

Operation deleteMobileNotifiers

public deleteMobileNotifiers(string|null $account_id[, MobileNotifierConfigurationInformation $mobile_notifier_configuration_information = null ]) : MobileNotifierConfigurationInformation

Reserved

Parameters
$account_id : string|null

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

$mobile_notifier_configuration_information : MobileNotifierConfigurationInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
MobileNotifierConfigurationInformation

deleteMobileNotifiersWithHttpInfo()

Operation deleteMobileNotifiersWithHttpInfo

public deleteMobileNotifiersWithHttpInfo(string|null $account_id[, MobileNotifierConfigurationInformation $mobile_notifier_configuration_information = null ]) : array<string|int, mixed>

Reserved

Parameters
$account_id : string|null

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

$mobile_notifier_configuration_information : MobileNotifierConfigurationInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

getConfiguration()

Operation getConfiguration

public getConfiguration(string|null $account_id, string|null $connect_id) : ConnectConfigResults

Get a Connect Configuration Information

Parameters
$account_id : string|null

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

$connect_id : string|null

The ID of the custom Connect configuration being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
ConnectConfigResults

getConfigurationWithHttpInfo()

Operation getConfigurationWithHttpInfo

public getConfigurationWithHttpInfo(string|null $account_id, string|null $connect_id) : array<string|int, mixed>

Get a Connect Configuration Information

Parameters
$account_id : string|null

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

$connect_id : string|null

The ID of the custom Connect configuration being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

getConnectAllUsers()

Operation getConnectAllUsers

public getConnectAllUsers(string|null $account_id, string|null $connect_id[, GetConnectAllUsersOptions $options = null ]) : IntegratedConnectUserInfoList

Returns all users from the configured Connect service.

Parameters
$account_id : string|null

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

$connect_id : string|null

The ID of the custom Connect configuration being accessed.

$options : GetConnectAllUsersOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
IntegratedConnectUserInfoList

getConnectAllUsersWithHttpInfo()

Operation getConnectAllUsersWithHttpInfo

public getConnectAllUsersWithHttpInfo(string|null $account_id, string|null $connect_id[, GetConnectAllUsersOptions $options = null ]) : array<string|int, mixed>

Returns all users from the configured Connect service.

Parameters
$account_id : string|null

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

$connect_id : string|null

The ID of the custom Connect configuration being accessed.

$options : GetConnectAllUsersOptions = 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\IntegratedConnectUserInfoList, HTTP status code, HTTP response headers (array of strings)

getConnectOAuthConfig()

Operation getConnectOAuthConfig

public getConnectOAuthConfig(string|null $account_id) : ConnectOAuthConfig

Sets the Connect OAuth Config for the account.

Parameters
$account_id : string|null

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

Tags
throws
ApiException

on non-2xx response

Return values
ConnectOAuthConfig

getConnectOAuthConfigWithHttpInfo()

Operation getConnectOAuthConfigWithHttpInfo

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

Sets the Connect OAuth Config for the account.

Parameters
$account_id : string|null

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

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

getEventLog()

Operation getEventLog

public getEventLog(string|null $account_id, string|null $log_id[, GetEventLogOptions $options = null ]) : ConnectLog

Get the specified Connect log entry.

Parameters
$account_id : string|null

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

$log_id : string|null

The ID of the connect log entry

$options : GetEventLogOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
ConnectLog

getEventLogWithHttpInfo()

Operation getEventLogWithHttpInfo

public getEventLogWithHttpInfo(string|null $account_id, string|null $log_id[, GetEventLogOptions $options = null ]) : array<string|int, mixed>

Get the specified Connect log entry.

Parameters
$account_id : string|null

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

$log_id : string|null

The ID of the connect log entry

$options : GetEventLogOptions = 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\ConnectLog, HTTP status code, HTTP response headers (array of strings)

listConfigurations()

Operation listConfigurations

public listConfigurations(string|null $account_id) : ConnectConfigResults

Get Connect Configuration Information

Parameters
$account_id : string|null

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

Tags
throws
ApiException

on non-2xx response

Return values
ConnectConfigResults

listConfigurationsWithHttpInfo()

Operation listConfigurationsWithHttpInfo

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

Get Connect Configuration Information

Parameters
$account_id : string|null

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

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

listEventFailureLogs()

Operation listEventFailureLogs

public listEventFailureLogs(string|null $account_id[, ListEventFailureLogsOptions $options = null ]) : ConnectLogs

Gets the Connect failure log information.

Parameters
$account_id : string|null

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

$options : ListEventFailureLogsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
ConnectLogs

listEventFailureLogsWithHttpInfo()

Operation listEventFailureLogsWithHttpInfo

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

Gets the Connect failure log information.

Parameters
$account_id : string|null

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

$options : ListEventFailureLogsOptions = 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\ConnectLogs, HTTP status code, HTTP response headers (array of strings)

listEventLogs()

Operation listEventLogs

public listEventLogs(string|null $account_id[, ListEventLogsOptions $options = null ]) : ConnectLogs

Gets the Connect log.

Parameters
$account_id : string|null

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

$options : ListEventLogsOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
ConnectLogs

listEventLogsWithHttpInfo()

Operation listEventLogsWithHttpInfo

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

Gets the Connect log.

Parameters
$account_id : string|null

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

$options : ListEventLogsOptions = 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\ConnectLogs, HTTP status code, HTTP response headers (array of strings)

listMobileNotifiersWithHttpInfo()

Operation listMobileNotifiersWithHttpInfo

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

Reserved

Parameters
$account_id : string|null

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

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

listUsers()

Operation listUsers

public listUsers(string|null $account_id, string|null $connect_id[, ListUsersOptions $options = null ]) : IntegratedUserInfoList

Returns users from the configured Connect service.

Parameters
$account_id : string|null

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

$connect_id : string|null

The ID of the custom Connect configuration being accessed.

$options : ListUsersOptions = null

for modifying the behavior of the function. (optional)

Tags
throws
ApiException

on non-2xx response

Return values
IntegratedUserInfoList

listUsersWithHttpInfo()

Operation listUsersWithHttpInfo

public listUsersWithHttpInfo(string|null $account_id, string|null $connect_id[, ListUsersOptions $options = null ]) : array<string|int, mixed>

Returns users from the configured Connect service.

Parameters
$account_id : string|null

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

$connect_id : string|null

The ID of the custom Connect configuration being accessed.

$options : ListUsersOptions = 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\IntegratedUserInfoList, HTTP status code, HTTP response headers (array of strings)

retryEventForEnvelope()

Operation retryEventForEnvelope

public retryEventForEnvelope(string|null $account_id, string|null $envelope_id) : ConnectFailureResults

Republishes Connect information for the specified envelope.

Parameters
$account_id : string|null

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

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
ConnectFailureResults

retryEventForEnvelopes()

Operation retryEventForEnvelopes

public retryEventForEnvelopes(string|null $account_id[, ConnectFailureFilter $connect_failure_filter = null ]) : ConnectFailureResults

Republishes Connect information for multiple envelopes.

Parameters
$account_id : string|null

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

$connect_failure_filter : ConnectFailureFilter = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ConnectFailureResults

retryEventForEnvelopesWithHttpInfo()

Operation retryEventForEnvelopesWithHttpInfo

public retryEventForEnvelopesWithHttpInfo(string|null $account_id[, ConnectFailureFilter $connect_failure_filter = null ]) : array<string|int, mixed>

Republishes Connect information for multiple envelopes.

Parameters
$account_id : string|null

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

$connect_failure_filter : ConnectFailureFilter = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

retryEventForEnvelopeWithHttpInfo()

Operation retryEventForEnvelopeWithHttpInfo

public retryEventForEnvelopeWithHttpInfo(string|null $account_id, string|null $envelope_id) : array<string|int, mixed>

Republishes Connect information for the specified envelope.

Parameters
$account_id : string|null

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

$envelope_id : string|null

The envelopeId Guid of the envelope being accessed.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ConnectFailureResults, 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

updateConfiguration()

Operation updateConfiguration

public updateConfiguration(string|null $account_id[, ConnectCustomConfiguration $connect_custom_configuration = null ]) : ConnectCustomConfiguration

Updates a specified Connect configuration.

Parameters
$account_id : string|null

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

$connect_custom_configuration : ConnectCustomConfiguration = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ConnectCustomConfiguration

updateConfigurationWithHttpInfo()

Operation updateConfigurationWithHttpInfo

public updateConfigurationWithHttpInfo(string|null $account_id[, ConnectCustomConfiguration $connect_custom_configuration = null ]) : array<string|int, mixed>

Updates a specified Connect configuration.

Parameters
$account_id : string|null

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

$connect_custom_configuration : ConnectCustomConfiguration = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

updateConnectOAuthConfig()

Operation updateConnectOAuthConfig

public updateConnectOAuthConfig(string|null $account_id[, ConnectOAuthConfig $connect_o_auth_config = null ]) : ConnectOAuthConfig

Updates the existing Connect OAuth Config for the account.

Parameters
$account_id : string|null

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

$connect_o_auth_config : ConnectOAuthConfig = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
ConnectOAuthConfig

updateConnectOAuthConfigWithHttpInfo()

Operation updateConnectOAuthConfigWithHttpInfo

public updateConnectOAuthConfigWithHttpInfo(string|null $account_id[, ConnectOAuthConfig $connect_o_auth_config = null ]) : array<string|int, mixed>

Updates the existing Connect OAuth Config for the account.

Parameters
$account_id : string|null

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

$connect_o_auth_config : ConnectOAuthConfig = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

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

updateMobileNotifiers()

Operation updateMobileNotifiers

public updateMobileNotifiers(string|null $account_id[, MobileNotifierConfigurationInformation $mobile_notifier_configuration_information = null ]) : MobileNotifierConfigurationInformation

Reserved

Parameters
$account_id : string|null

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

$mobile_notifier_configuration_information : MobileNotifierConfigurationInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
MobileNotifierConfigurationInformation

updateMobileNotifiersWithHttpInfo()

Operation updateMobileNotifiersWithHttpInfo

public updateMobileNotifiersWithHttpInfo(string|null $account_id[, MobileNotifierConfigurationInformation $mobile_notifier_configuration_information = null ]) : array<string|int, mixed>

Reserved

Parameters
$account_id : string|null

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

$mobile_notifier_configuration_information : MobileNotifierConfigurationInformation = null

(optional)

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\MobileNotifierConfigurationInformation, 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