module:api/GroupsApi

new module:api/GroupsApi(apiClient)

Source:

api/GroupsApi.js, line 41

Constructs a new GroupsApi.

Parameters:

Name	Type	Description
`apiClient`	module:ApiClient	Optional API client implementation to use, default to `module:ApiClient#instance` if unspecified.

Methods

createGroups(accountId, optsOrCallback, callback)

Source:

api/GroupsApi.js, line 73

Creates one or more groups for the account.
Creates one or more groups for the account.

Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the userSettings property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.

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
`groupInformation`	module:model/GroupInformation

callback

module:api/GroupsApi~createGroupsCallback

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

deleteBrands(accountId, groupId, optsOrCallback, callback)

Source:

api/GroupsApi.js, line 135

Deletes brand information from the requested group.
Deletes brand information from the requested group.

Parameters:

Name Type Description

accountId

String

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

groupId

String

The ID of the group being accessed.

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
`brandsRequest`	module:model/BrandsRequest

callback

module:api/GroupsApi~deleteBrandsCallback

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

deleteGroups(accountId, optsOrCallback, callback)

Source:

api/GroupsApi.js, line 271

Deletes an existing user group.
Deletes an existing user group.

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
`groupInformation`	module:model/GroupInformation

callback

module:api/GroupsApi~deleteGroupsCallback

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

deleteGroupUsers(accountId, groupId, optsOrCallback, callback)

Source:

api/GroupsApi.js, line 204

Deletes one or more users from a gro
Deletes one or more users from a group.

Parameters:

Name Type Description

accountId

String

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

groupId

String

The ID of the group being accessed.

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
`userInfoList`	module:model/UserInfoList

callback

module:api/GroupsApi~deleteGroupUsersCallback

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

getBrands(accountId, groupId, callback)

Source:

api/GroupsApi.js, line 331

Gets group brand ID Information.
Retrieves information about the brands associated with the requested group.

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`groupId`	String	The ID of the group being accessed.
`callback`	module:api/GroupsApi~getBrandsCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/GroupBrands`

listGroups(accountId, optsOrCallback, callback)

Source:

api/GroupsApi.js, line 466

Gets information about groups associated with the account.
Retrieves information about groups associated with the 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
`count`	String	Number of records to return. The number must be greater than 1 and less than or equal to 100.
`groupType`	String
`includeUsercount`	String
`searchText`	String
`startPosition`	String	Starting value for the list.

callback

module:api/GroupsApi~listGroupsCallback

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

listGroupUsers(accountId, groupId, optsOrCallback, callback)

Source:

api/GroupsApi.js, line 393

Gets a list of users in a group.
Retrieves a list of users in a group.

Parameters:

Name Type Description

accountId

String

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

groupId

String

The ID of the group being accessed.

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
`count`	String	Number of records to return. The number must be greater than 1 and less than or equal to 100.
`startPosition`	String	Starting value for the list.

callback

module:api/GroupsApi~listGroupUsersCallback

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

updateBrands(accountId, groupId, optsOrCallback, callback)

Source:

api/GroupsApi.js, line 533

Adds group brand ID information to a group.
Adds group brand ID information to a group.

Parameters:

Name Type Description

accountId

String

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

groupId

String

The ID of the group being accessed.

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
`brandsRequest`	module:model/BrandsRequest

callback

module:api/GroupsApi~updateBrandsCallback

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

updateGroups(accountId, optsOrCallback, callback)

Source:

api/GroupsApi.js, line 668

Updates the group information for a group.
Updates the group name and modifies, or sets, the permission profile for the group.

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
`groupInformation`	module:model/GroupInformation

callback

module:api/GroupsApi~updateGroupsCallback

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

updateGroupUsers(accountId, groupId, optsOrCallback, callback)

Source:

api/GroupsApi.js, line 601

Adds one or more users to an existing group.
Adds one or more users to an existing group.

Parameters:

Name Type Description

accountId

String

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

groupId

String

The ID of the group being accessed.

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
`userInfoList`	module:model/UserInfoList

callback

module:api/GroupsApi~updateGroupUsersCallback

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

Type Definitions

createGroupsCallback(error, data, If)

Source:

api/GroupsApi.js, line 54

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/GroupInformation	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.

deleteBrandsCallback(error, data, If)

Source:

api/GroupsApi.js, line 117

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/GroupBrands	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.

deleteGroupsCallback(error, data, If)

Source:

api/GroupsApi.js, line 254

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/GroupInformation	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.

deleteGroupUsersCallback(error, data, If)

Source:

api/GroupsApi.js, line 185

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UsersResponse	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.

getBrandsCallback(error, data, If)

Source:

api/GroupsApi.js, line 315

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/GroupBrands	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.

listGroupsCallback(error, data, If)

Source:

api/GroupsApi.js, line 445

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/GroupInformation	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.

listGroupUsersCallback(error, data, If)

Source:

api/GroupsApi.js, line 374

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UsersResponse	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.

updateBrandsCallback(error, data, If)

Source:

api/GroupsApi.js, line 515

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/GroupBrands	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.

updateGroupsCallback(error, data, If)

Source:

api/GroupsApi.js, line 651

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/GroupInformation	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.

updateGroupUsersCallback(error, data, If)

Source:

api/GroupsApi.js, line 583

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/UsersResponse	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.