import { ListPage } from '../models/ListPage'; import { Searchable } from '../models/Searchable'; import { Sortable } from '../models/Sortable'; import { Filters } from '../models/Filters'; import { UserGroup } from '../models/UserGroup'; import { UserGroupAssignment } from '../models/UserGroupAssignment'; import { PartialDeep } from '../models/PartialDeep'; import { RequiredDeep } from '../models/RequiredDeep'; import { RequestOptions } from '../models/RequestOptions'; declare class AdminUserGroups { private impersonating; /** * @ignore * not part of public api, don't include in generated docs */ constructor(); /** * Get a list of admin user groups. * Check out the {@link https://ordercloud.io/api-reference/seller/admin-user-groups/list|api docs} for more info * * @param listOptions.search Word or phrase to search for. * @param listOptions.searchOn Comma-delimited list of fields to search on. * @param listOptions.sortBy Comma-delimited list of fields to sort by. * @param listOptions.page Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. * @param listOptions.pageSize Number of results to return per page. Default: 20, max: 100. * @param listOptions.filters An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???' * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ List(listOptions?: { search?: string; searchOn?: Searchable<'AdminUserGroups.List'>; sortBy?: Sortable<'AdminUserGroups.List'>; page?: number; pageSize?: number; filters?: Filters; }, requestOptions?: RequestOptions): Promise>>; /** * Create a new admin user group. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. * Check out the {@link https://ordercloud.io/api-reference/seller/admin-user-groups/create|api docs} for more info * * @param userGroup Required fields: Name * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ Create(userGroup: UserGroup, requestOptions?: RequestOptions): Promise>; /** * Get a single admin user group. * Check out the {@link https://ordercloud.io/api-reference/seller/admin-user-groups/get|api docs} for more info * * @param userGroupID ID of the user group. * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ Get(userGroupID: string, requestOptions?: RequestOptions): Promise>; /** * Create or update an admin user group. If an object with the same ID already exists, it will be overwritten. * Check out the {@link https://ordercloud.io/api-reference/seller/admin-user-groups/save|api docs} for more info * * @param userGroupID ID of the user group. * @param userGroup Required fields: Name * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ Save(userGroupID: string, userGroup: UserGroup, requestOptions?: RequestOptions): Promise>; /** * Delete an admin user group. * Check out the {@link https://ordercloud.io/api-reference/seller/admin-user-groups/delete|api docs} for more info * * @param userGroupID ID of the user group. * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ Delete(userGroupID: string, requestOptions?: RequestOptions): Promise; /** * Partially update an admin user group. * Check out the {@link https://ordercloud.io/api-reference/seller/admin-user-groups/patch|api docs} for more info * * @param userGroupID ID of the user group. * @param userGroup * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ Patch(userGroupID: string, userGroup: PartialDeep, requestOptions?: RequestOptions): Promise>; /** * Delete an admin user group user assignment. * Check out the {@link https://ordercloud.io/api-reference/seller/admin-user-groups/delete-user-assignment|api docs} for more info * * @param userGroupID ID of the user group. * @param userID ID of the user. * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ DeleteUserAssignment(userGroupID: string, userID: string, requestOptions?: RequestOptions): Promise; /** * Get a list of admin user group user assignments. * Check out the {@link https://ordercloud.io/api-reference/seller/admin-user-groups/list-user-assignments|api docs} for more info * * @param listOptions.userGroupID ID of the user group. * @param listOptions.userID ID of the user. * @param listOptions.page Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation. * @param listOptions.pageSize Number of results to return per page. Default: 20, max: 100. * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ ListUserAssignments(listOptions?: { userGroupID?: string; userID?: string; page?: number; pageSize?: number; }, requestOptions?: RequestOptions): Promise>>; /** * Create or update an admin user group user assignment. * Check out the {@link https://ordercloud.io/api-reference/seller/admin-user-groups/save-user-assignment|api docs} for more info * * @param userGroupAssignment Required fields: UserGroupID, UserID * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation). * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request. * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs. */ SaveUserAssignment(userGroupAssignment: UserGroupAssignment, requestOptions?: RequestOptions): Promise; /** * @description * enables impersonation by calling the subsequent method with the stored impersonation token * * @example * AdminUserGroups.As().List() // lists AdminUserGroups using the impersonated users' token */ As(): this; } declare const _default: AdminUserGroups; export default _default;