new module:api/CustomergroupsApi(apiClient)
Constructs a new CustomergroupsApi.
Parameters:
Name | Type | Description |
---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, default to module:ApiClient#instance if unspecified. |
- Source:
Methods
customergroups1WithHttpInfo(body) → {Promise}
Customergroups Creates a new customer group that is a direct subgroup of a customergroup. Security: Permitted only for customer managers
Parameters:
Name | Type | Description |
---|---|---|
body |
module:models/UserGroup |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
customergroupsByGroupIdWithHttpInfo(groupId, opts) → {Promise}
getCustomerGroup Returns a customer group with a specific groupId. Security: Permitted only for customer managers
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
groupId |
String | Group identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/UserGroupOCC and HTTP response
- Type
- Promise
customergroupsMembersByGroupId1WithHttpInfo(groupId, body) → {Promise}
patchCustomerGroupsMembers Assigns user(s) to a customer group. Security: Permitted only for customer managers
Parameters:
Name | Type | Description |
---|---|---|
groupId |
String | Group identifier |
body |
module:models/MemberList |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
customergroupsMembersByGroupIdAndUserIdWithHttpInfo(groupId, userId) → {Promise}
deleteCustomerGroupsMember Removes user from a customer group. Security: Permitted only for customer managers
Parameters:
Name | Type | Description |
---|---|---|
groupId |
String | Group identifier |
userId |
String | User identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
customergroupsMembersByGroupIdWithHttpInfo(groupId, body) → {Promise}
putCustomerGroupsMembers Sets members for a user group. The list of existing members is overwritten with a new one. Security: Permitted only for customer managers
Parameters:
Name | Type | Description |
---|---|---|
groupId |
String | Group identifier |
body |
module:models/MemberList |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing HTTP response
- Type
- Promise
customergroupsWithHttpInfo(opts) → {Promise}
getCustomerGroups Returns all customer groups that are direct subgroups of a customergroup. Security: Permitted only for customer managers
Parameters:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/UserGroupList and HTTP response
- Type
- Promise
deleteCustomerGroupsMember(groupId, userId) → {Promise}
deleteCustomerGroupsMember Removes user from a customer group. Security: Permitted only for customer managers
Parameters:
Name | Type | Description |
---|---|---|
groupId |
String | Group identifier |
userId |
String | User identifier |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
getCustomerGroup(groupId, opts) → {Promise}
getCustomerGroup Returns a customer group with a specific groupId. Security: Permitted only for customer managers
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
groupId |
String | Group identifier |
||||||
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/UserGroupOCC
- Type
- Promise
getCustomerGroups(opts) → {Promise}
getCustomerGroups Returns all customer groups that are direct subgroups of a customergroup. Security: Permitted only for customer managers
Parameters:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
Object | Optional parameters Properties
|
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}, with data of type module:models/UserGroupList
- Type
- Promise
patchCustomerGroupsMembers(groupId, body) → {Promise}
patchCustomerGroupsMembers Assigns user(s) to a customer group. Security: Permitted only for customer managers
Parameters:
Name | Type | Description |
---|---|---|
groupId |
String | Group identifier |
body |
module:models/MemberList |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
postCustomerGroup(body) → {Promise}
Customergroups Creates a new customer group that is a direct subgroup of a customergroup. Security: Permitted only for customer managers
Parameters:
Name | Type | Description |
---|---|---|
body |
module:models/UserGroup |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise
putCustomerGroupsMembers(groupId, body) → {Promise}
putCustomerGroupsMembers Sets members for a user group. The list of existing members is overwritten with a new one. Security: Permitted only for customer managers
Parameters:
Name | Type | Description |
---|---|---|
groupId |
String | Group identifier |
body |
module:models/MemberList |
- Source:
Returns:
a Promise">www.promisejs.org/|Promise}
- Type
- Promise