@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
31 lines • 1.28 kB
TypeScript
import type { JoomlaClient } from '../client';
import type { UserGroupsParams, UserGroupsResponse } from '../schemas';
type ExecuteRequest = JoomlaClient['executeRequest'];
/**
* Creates the userGroups resource methods
* OpenAPI Path: /usergroups → userGroups.*
* @description User groups management operations
*/
export declare function createUserGroupsResource(executeRequest: ExecuteRequest): {
/**
* List user groups - /usergroups GET
* @fullPath api.joomla.userGroups.list
* @service joomla
* @domain user-management
* @dataMethod userGroupsData.list
* @discoverable true
*/
list: (params?: UserGroupsParams) => Promise<UserGroupsResponse>;
};
/**
* Creates the userGroupsData resource methods (data-only versions)
*/
export declare function createUserGroupsDataResource(userGroups: ReturnType<typeof createUserGroupsResource>): {
list: (params?: UserGroupsParams) => Promise<import("zod").objectOutputType<{
id: import("zod").ZodNumber;
}, import("zod").ZodTypeAny, "passthrough">[]>;
};
export type UserGroupsResource = ReturnType<typeof createUserGroupsResource>;
export type UserGroupsDataResource = ReturnType<typeof createUserGroupsDataResource>;
export {};
//# sourceMappingURL=user-groups.d.ts.map