@datocms/cma-client/dist/types/generated/resources/Role.d.ts

JS client for DatoCMS REST Content Management API

import BaseResource from '../../BaseResource';
import type * as ApiTypes from '../ApiTypes';
import type * as RawApiTypes from '../RawApiTypes';
export default class Role extends BaseResource {
    static readonly TYPE: "role";
    /**
     * Create a new role
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/create
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    create(body: ApiTypes.RoleCreateSchema): Promise<ApiTypes.Role>;
    /**
     * Create a new role
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/create
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    rawCreate(body: RawApiTypes.RoleCreateSchema): Promise<RawApiTypes.RoleCreateTargetSchema>;
    /**
     * Update a role
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/update
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    update(roleId: string | ApiTypes.RoleData, body: ApiTypes.RoleUpdateSchema): Promise<ApiTypes.Role>;
    /**
     * Update a role
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/update
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    rawUpdate(roleId: string, body: RawApiTypes.RoleUpdateSchema): Promise<RawApiTypes.RoleUpdateTargetSchema>;
    /**
     * List all roles
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/instances
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    list(): Promise<ApiTypes.RoleInstancesTargetSchema>;
    /**
     * List all roles
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/instances
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    rawList(): Promise<RawApiTypes.RoleInstancesTargetSchema>;
    /**
     * Retrieve a role
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/self
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    find(roleId: string | ApiTypes.RoleData): Promise<ApiTypes.Role>;
    /**
     * Retrieve a role
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/self
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    rawFind(roleId: string): Promise<RawApiTypes.RoleSelfTargetSchema>;
    /**
     * Delete a role
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/destroy
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    destroy(roleId: string | ApiTypes.RoleData): Promise<ApiTypes.Role>;
    /**
     * Delete a role
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/destroy
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    rawDestroy(roleId: string): Promise<RawApiTypes.RoleDestroyTargetSchema>;
    /**
     * Duplicate a role
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/duplicate
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    duplicate(roleId: string | ApiTypes.RoleData): Promise<ApiTypes.Role>;
    /**
     * Duplicate a role
     *
     * Read more: https://www.datocms.com/docs/content-management-api/resources/role/duplicate
     *
     * @throws {ApiError}
     * @throws {TimeoutError}
     */
    rawDuplicate(roleId: string): Promise<RawApiTypes.RoleDuplicateTargetSchema>;
}