Alokai

CustomerGroupsApiFactory

CustomerGroupsApi - factory interface

Signature

CustomerGroupsApiFactory: (
	configuration?: Configuration,
	basePath?: string,
	axios?: AxiosInstance
) => {
    createCustomerGroup(baseSiteId: string,
	userGroup: UserGroup,
	options?: any): AxiosPromise<void>;
    getCustomerGroup(baseSiteId: string,
	groupId: string,
	fields?: string,
	options?: any): AxiosPromise<UserGroup>;
    getCustomerGroups(baseSiteId: string,
	currentPage?: number,
	fields?: string,
	pageSize?: number,
	options?: any): AxiosPromise<UserGroupList>;
    removeUsersFromCustomerGroup(baseSiteId: string,
	groupId: string,
	userId: string,
	options?: any): AxiosPromise<void>;
    replaceUsersForCustomerGroup(baseSiteId: string,
	groupId: string,
	memberList: MemberList,
	options?: any): AxiosPromise<void>;
    updateCustomerGroupWithUsers(baseSiteId: string,
	groupId: string,
	memberList: MemberList,
	options?: any): AxiosPromise<void>;
}

Parameters

NameRequiredTypeDescription
configurationOptionalConfiguration
basePathOptionalstring
axiosOptionalAxiosInstance

Referenced Types

On this page