module:api/SigningGroupsApi

module:api/SigningGroupsApi

new module:api/SigningGroupsApi(apiClient)

Source:

Constructs a new SigningGroupsApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use,
default to module:ApiClient#instance if unspecified.

Methods

createList(accountId, optsOrCallback, callback)

Source:

Creates a signing group.
Creates one or more signing groups.

Multiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups.

An account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members.

Signing groups can be used by any account user.

Parameters:
Name Type Description
accountId String

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

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
signingGroupInformation module:model/SigningGroupInformation
callback module:api/SigningGroupsApi~createListCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/SigningGroupInformation

deleteList(accountId, optsOrCallback, callback)

Source:

Deletes one or more signing groups.
Deletes one or more signing groups in the specified account.

Parameters:
Name Type Description
accountId String

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

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
signingGroupInformation module:model/SigningGroupInformation
callback module:api/SigningGroupsApi~deleteListCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/SigningGroupInformation

deleteUsers(accountId, signingGroupId, optsOrCallback, callback)

Source:

Deletes one or more members from a signing group.
Deletes one or more members from the specified signing group.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signingGroupId String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
signingGroupUsers module:model/SigningGroupUsers
callback module:api/SigningGroupsApi~deleteUsersCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/SigningGroupUsers

get(accountId, signingGroupId, callback)

Source:

Gets information about a signing group.
Retrieves information, including group member information, for the specified signing group.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signingGroupId String
callback module:api/SigningGroupsApi~getCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/SigningGroup

list(accountId, optsOrCallback, callback)

Source:

Gets a list of the Signing Groups in an account.
Retrieves a list of all signing groups in the specified account.

Parameters:
Name Type Description
accountId String

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

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
groupType String
includeUsers String

When set to true, the response includes the signing group members.
callback module:api/SigningGroupsApi~listCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/SigningGroupInformation

listUsers(accountId, signingGroupId, callback)

Source:

Gets a list of members in a Signing Group.
Retrieves the list of members in the specified Signing Group.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signingGroupId String
callback module:api/SigningGroupsApi~listUsersCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/SigningGroupUsers

update(accountId, signingGroupId, optsOrCallback, callback)

Source:

Updates a signing group.
Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signingGroupId String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
signingGroup module:model/SigningGroup
callback module:api/SigningGroupsApi~updateCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/SigningGroup

updateList(accountId, optsOrCallback, callback)

Source:

Updates signing group names.
Updates the name of one or more existing signing groups.

Parameters:
Name Type Description
accountId String

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

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
signingGroupInformation module:model/SigningGroupInformation
callback module:api/SigningGroupsApi~updateListCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/SigningGroupInformation

updateUsers(accountId, signingGroupId, optsOrCallback, callback)

Source:

Adds members to a signing group.
Adds one or more new members to a signing group. A signing group can have a maximum of 50 members.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signingGroupId String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
signingGroupUsers module:model/SigningGroupUsers
callback module:api/SigningGroupsApi~updateUsersCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/SigningGroupUsers

Type Definitions

createListCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createList operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/SigningGroupInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteListCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteList operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/SigningGroupInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteUsersCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteUsers operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/SigningGroupUsers

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the get operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/SigningGroup

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the list operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/SigningGroupInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listUsersCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listUsers operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/SigningGroupUsers

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the update operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/SigningGroup

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateListCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateList operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/SigningGroupInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateUsersCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateUsers operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/SigningGroupUsers

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.