/** * SmartyMeet Dev03 API REST * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.1 * Contact: developer@smartymeet.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CreateRoleRequestBody, ListRoleUsersRelationship, RoleSchema, RolesSchema, UpdateRoleRequestBody, UsersSchema } from '../models/index'; export interface CreateRoleRequest { createRoleRequestBody: CreateRoleRequestBody; } export interface DeleteRoleRequest { roleId: string; permanentDelete?: DeleteRolePermanentDeleteEnum; } export interface ListRoleUsersRequest { roleId: string; } export interface ListRoleUsersRelationshipRequest { roleId: string; } export interface ListRolesRequest { filterStatus?: ListRolesFilterStatusEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface RoleOptionsRequest { roleId: string; } export interface RoleUsersOptionsRequest { roleId: string; } export interface RoleUsersRelationshipsOptionsRequest { roleId: string; } export interface ShowRoleRequest { roleId: string; } export interface UpdateRoleRequest { roleId: string; updateRoleRequestBody: UpdateRoleRequestBody; } /** * */ export declare class RolesApi extends runtime.BaseAPI { /** * Creates request options for createRole without sending the request */ createRoleRequestOpts(requestParameters: CreateRoleRequest): Promise; /** * Creates a new role in your account. ### Role\'s Attributes Here is a table that describes the attributes of the role object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the role. | | `status` | string | The current status of the role (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the role was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the role was last modified (ISO 8601 format). | * Create Role */ createRoleRaw(requestParameters: CreateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new role in your account. ### Role\'s Attributes Here is a table that describes the attributes of the role object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the role. | | `status` | string | The current status of the role (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the role was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the role was last modified (ISO 8601 format). | * Create Role */ createRole(requestParameters: CreateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteRole without sending the request */ deleteRoleRequestOpts(requestParameters: DeleteRoleRequest): Promise; /** * Deletes a role. Soft delete (default): flips the role\'s `status` to `archived`, keeping the row. Permanent delete (`?permanentDelete=true`): removes the row outright. System roles cannot be deleted either way. * Delete Role */ deleteRoleRaw(requestParameters: DeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Deletes a role. Soft delete (default): flips the role\'s `status` to `archived`, keeping the row. Permanent delete (`?permanentDelete=true`): removes the row outright. System roles cannot be deleted either way. * Delete Role */ deleteRole(requestParameters: DeleteRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listRoleUsers without sending the request */ listRoleUsersRequestOpts(requestParameters: ListRoleUsersRequest): Promise; /** * Returns a collection of user resources related to the specified role. ## JSON:API Relationship Info This endpoint provides the _related_ resources rather than only relationship linkages. * List Role Users */ listRoleUsersRaw(requestParameters: ListRoleUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of user resources related to the specified role. ## JSON:API Relationship Info This endpoint provides the _related_ resources rather than only relationship linkages. * List Role Users */ listRoleUsers(requestParameters: ListRoleUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listRoleUsersRelationship without sending the request */ listRoleUsersRelationshipRequestOpts(requestParameters: ListRoleUsersRelationshipRequest): Promise; /** * Returns the relationship object for the users associated with this role. ## JSON:API Relationship Endpoint This returns only the linkage data (`type` & `id`), plus optional links/meta. * List Role Users Relationship */ listRoleUsersRelationshipRaw(requestParameters: ListRoleUsersRelationshipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the relationship object for the users associated with this role. ## JSON:API Relationship Endpoint This returns only the linkage data (`type` & `id`), plus optional links/meta. * List Role Users Relationship */ listRoleUsersRelationship(requestParameters: ListRoleUsersRelationshipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listRoles without sending the request */ listRolesRequestOpts(requestParameters: ListRolesRequest): Promise; /** * Returns a collection of your account roles ## Overview Returns a collection of your account roles, sorted by the time they were inserted into the system in ascending order. ### Roles Endpoints Pagination The roles endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Roles */ listRolesRaw(requestParameters: ListRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account roles ## Overview Returns a collection of your account roles, sorted by the time they were inserted into the system in ascending order. ### Roles Endpoints Pagination The roles endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Roles */ listRoles(requestParameters?: ListRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for roleOptions without sending the request */ roleOptionsRequestOpts(requestParameters: RoleOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Role Options */ roleOptionsRaw(requestParameters: RoleOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Role Options */ roleOptions(requestParameters: RoleOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for roleUsersOptions without sending the request */ roleUsersOptionsRequestOpts(requestParameters: RoleUsersOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Role Users Options */ roleUsersOptionsRaw(requestParameters: RoleUsersOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Role Users Options */ roleUsersOptions(requestParameters: RoleUsersOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for roleUsersRelationshipsOptions without sending the request */ roleUsersRelationshipsOptionsRequestOpts(requestParameters: RoleUsersRelationshipsOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Role Users Relationships Options */ roleUsersRelationshipsOptionsRaw(requestParameters: RoleUsersRelationshipsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Role Users Relationships Options */ roleUsersRelationshipsOptions(requestParameters: RoleUsersRelationshipsOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for rolesOptions without sending the request */ rolesOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Roles Options */ rolesOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Roles Options */ rolesOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showRole without sending the request */ showRoleRequestOpts(requestParameters: ShowRoleRequest): Promise; /** * This endpoint retrieves details of a specific role from your account. You can view information such as name, and other relevant attributes of the role. * Show Role */ showRoleRaw(requestParameters: ShowRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific role from your account. You can view information such as name, and other relevant attributes of the role. * Show Role */ showRole(requestParameters: ShowRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateRole without sending the request */ updateRoleRequestOpts(requestParameters: UpdateRoleRequest): Promise; /** * This endpoint allows you to update details of a specific role in your account. You can modify information such as name, and other relevant attributes of the role. Only the fields provided in the request will be updated. * Update Role */ updateRoleRaw(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific role in your account. You can modify information such as name, and other relevant attributes of the role. Only the fields provided in the request will be updated. * Update Role */ updateRole(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const DeleteRolePermanentDeleteEnum: { readonly True: "true"; readonly False: "false"; }; export type DeleteRolePermanentDeleteEnum = typeof DeleteRolePermanentDeleteEnum[keyof typeof DeleteRolePermanentDeleteEnum]; /** * @export */ export declare const ListRolesFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListRolesFilterStatusEnum = typeof ListRolesFilterStatusEnum[keyof typeof ListRolesFilterStatusEnum]; //# sourceMappingURL=RolesApi.d.ts.map