import { x as ApiCallOptions } from "./chunks/auth-types-DjJJgiRF.js";
//#region src/public/rest/roles.d.ts
type CreateRole = {
  /** Selection of scopes to assign to role */assignedScopes?: string[]; /** Role description */
  description?: string; /** Role name, needs to be unique */
  name: string;
};
/**
 * An error object describing the error.
 */
type Error = {
  /** The error code. */code: string; /** A human-readable explanation specific to this occurrence of the problem. */
  detail?: string; /** Additional properties relating to the error. */
  meta?: unknown; /** References to the source of the error. */
  source?: {
    /** The URI query parameter that caused the error. */parameter?: string; /** A JSON Pointer to the property that caused the error. */
    pointer?: string;
  }; /** Summary of the problem. */
  title: string;
};
/**
 * The error response object describing the error from the handling of an HTTP request.
 * @example
 * {
 *   errors: [
 *     {
 *       code: "IDENTITIES-10402",
 *       title: "Not Found"
 *     }
 *   ],
 *   traceId: "0000000000000000200ba0714061b982"
 * }
 */
type Errors = {
  /** An array of errors related to the operation. */errors?: Error[]; /** A unique identifier for tracing the error. */
  traceId?: string;
};
/**
 * Contains pagination links
 */
type Links = {
  /** Link to the next page of items */next?: {
    href: string;
  }; /** Link to the previous page of items */
  prev?: {
    href: string;
  }; /** Link to the current page of items */
  self: {
    href: string;
  };
};
type ListRolesResult = {
  /** An array of roles. */data: Role[]; /** Contains pagination links */
  links: Links; /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
  totalResults?: number;
};
/**
 * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
 */
type PatchRole = {
  op: "replace" | "add" | "remove-value";
  path: "/name" | "/description" | "/assignedScopes" | "/assignedScopes/-";
  value: string | string[];
};
/**
 * An array of JSON Patch documents
 * @example
 * [
 *   {
 *     op: "replace",
 *     path: "/name",
 *     value: "Role1"
 *   },
 *   {
 *     op: "replace",
 *     path: "/assignedScopes",
 *     value: [
 *       "knowledgebase"
 *     ]
 *   },
 *   {
 *     op: "add",
 *     path: "/assignedScopes/-",
 *     value: "knowledgebase"
 *   },
 *   {
 *     op: "remove-value",
 *     path: "/assignedScopes",
 *     value: "knowledgebase"
 *   },
 *   {
 *     op: "replace",
 *     path: "/description",
 *     value: "My custom role description"
 *   }
 * ]
 */
type PatchRoles = PatchRole[];
type Role = {
  /** Selection of scopes added to this Role */assignedScopes?: string[]; /** Indicate if role can be deleted */
  readonly canDelete?: boolean; /** Indicate if role can be edited by tenant (Shown as Profile in MC) */
  readonly canEdit?: boolean; /** The timestamp for when the role was created. */
  createdAt: string; /** Id of user that created role */
  readonly createdBy?: string; /** Descriptive text for the role. */
  description: string;
  /** @deprecated
   * DEPRECATED. Use userEntitlementType instead for impact of roles on user entitlements with a capacity-based subscription. */
  readonly fullUser?: boolean; /** The unique identifier for the role. */
  readonly id: string; /** The timestamp for when the role was last updated. */
  lastUpdatedAt: string; /** The level of access associated to the role. */
  level?: "admin" | "user"; /** Contains links for the role. */
  links: {
    self: {
      /** Link to the role. */href: string;
    };
  }; /** The name of the role. */
  name: string; /** An array of permissions associated with the role. */
  permissions?: string[]; /** The tenant unique identifier associated with the given Role. */
  tenantId: string; /** The type of role. */
  type: "default" | "custom"; /** Id of user that last updated this role */
  readonly updatedBy?: string; /** Indicate whether this role will trigger promotion of a user from a basic to a full user on tenants with a capacity-based subscription. Does not apply to tenants with a user-based subscription. Returns fullUser if it will trigger promotion. */
  readonly userEntitlementType?: string;
};
/**
 * Returns a list of roles using cursor-based pagination.
 *
 * @param query an object with query parameters
 * @throws GetRolesHttpError
 */
declare function getRoles(query: {
  /** The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax. All conditional statements within this query parameter are case insensitive. */filter?: string; /** The number of roles to retrieve. */
  limit?: number; /** The next page cursor. */
  next?: string; /** The previous page cursor. */
  prev?: string; /** Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. */
  sort?: string; /** Determines wether to return a count of the total records matched in the query. Defaults to false. */
  totalResults?: boolean;
}, options?: ApiCallOptions): Promise<GetRolesHttpResponse>;
type GetRolesHttpResponse = {
  data: ListRolesResult;
  headers: Headers;
  status: 200;
  prev?: (options?: ApiCallOptions) => Promise<GetRolesHttpResponse>;
  next?: (options?: ApiCallOptions) => Promise<GetRolesHttpResponse>;
};
type GetRolesHttpError = {
  data: Errors;
  headers: Headers;
  status: 400 | 401 | 429 | 500;
};
/**
 * Creates a custom role. Role names must be unique, and there is a maximum of 500 custom roles per tenant. Requestor must be assigned the `TenantAdmin` role.
 *
 * @param body an object with the body content
 * @throws CreateRoleHttpError
 */
declare function createRole(body: CreateRole, options?: ApiCallOptions): Promise<CreateRoleHttpResponse>;
type CreateRoleHttpResponse = {
  data: Role;
  headers: Headers;
  status: 201;
};
type CreateRoleHttpError = {
  data: Errors;
  headers: Headers;
  status: 400 | 401 | 403 | 429 | 500;
};
/**
 * Deletes the requested role. Role can only be deleted if it has been unassigned from all users and groups. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
 *
 * @param id The unique identifier for the role.
 * @throws DeleteRoleHttpError
 */
declare function deleteRole(id: string, options?: ApiCallOptions): Promise<DeleteRoleHttpResponse>;
type DeleteRoleHttpResponse = {
  data: void;
  headers: Headers;
  status: 204;
};
type DeleteRoleHttpError = {
  data: Errors;
  headers: Headers;
  status: 400 | 401 | 403 | 429 | 500;
};
/**
 * Returns the requested role.
 *
 * @param id The unique identifier for the role.
 * @throws GetRoleHttpError
 */
declare function getRole(id: string, options?: ApiCallOptions): Promise<GetRoleHttpResponse>;
type GetRoleHttpResponse = {
  data: Role;
  headers: Headers;
  status: 200;
};
type GetRoleHttpError = {
  data: Errors;
  headers: Headers;
  status: 404 | 429 | 500;
};
/**
 * Updates the requested role. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
 *
 * @param id The unique identifier for the role.
 * @param body an object with the body content
 * @throws PatchRoleHttpError
 */
declare function patchRole(id: string, body: PatchRoles, options?: ApiCallOptions): Promise<PatchRoleHttpResponse>;
type PatchRoleHttpResponse = {
  data: void;
  headers: Headers;
  status: 204;
};
type PatchRoleHttpError = {
  data: Errors;
  headers: Headers;
  status: 400 | 401 | 403 | 404 | 429 | 500;
};
/**
 * Clears the cache for roles api requests.
 */
declare function clearCache(): void;
type RolesAPI = {
  /**
   * Returns a list of roles using cursor-based pagination.
   *
   * @param query an object with query parameters
   * @throws GetRolesHttpError
   */
  getRoles: typeof getRoles;
  /**
   * Creates a custom role. Role names must be unique, and there is a maximum of 500 custom roles per tenant. Requestor must be assigned the `TenantAdmin` role.
   *
   * @param body an object with the body content
   * @throws CreateRoleHttpError
   */
  createRole: typeof createRole;
  /**
   * Deletes the requested role. Role can only be deleted if it has been unassigned from all users and groups. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
   *
   * @param id The unique identifier for the role.
   * @throws DeleteRoleHttpError
   */
  deleteRole: typeof deleteRole;
  /**
   * Returns the requested role.
   *
   * @param id The unique identifier for the role.
   * @throws GetRoleHttpError
   */
  getRole: typeof getRole;
  /**
   * Updates the requested role. Only applicable to roles of type `custom`. Requestor must be assigned the `TenantAdmin` role.
   *
   * @param id The unique identifier for the role.
   * @param body an object with the body content
   * @throws PatchRoleHttpError
   */
  patchRole: typeof patchRole;
  /**
   * Clears the cache for roles api requests.
   */
  clearCache: typeof clearCache;
};
/**
 * Functions for the roles api
 */
declare const rolesExport: RolesAPI;
//#endregion
export { CreateRole, CreateRoleHttpError, CreateRoleHttpResponse, DeleteRoleHttpError, DeleteRoleHttpResponse, Error, Errors, GetRoleHttpError, GetRoleHttpResponse, GetRolesHttpError, GetRolesHttpResponse, Links, ListRolesResult, PatchRole, PatchRoleHttpError, PatchRoleHttpResponse, PatchRoles, Role, RolesAPI, clearCache, createRole, rolesExport as default, deleteRole, getRole, getRoles, patchRole };