@unkey/api/dist/esm/funcs/identitiesUpdateIdentity.d.ts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.

import { UnkeyCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { UnkeyError } from "../models/errors/unkeyerror.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
 * Update Identity
 *
 * @remarks
 * Update an identity's metadata and rate limits. Only specified fields are modified - others remain unchanged.
 *
 * Perfect for subscription changes, plan upgrades, or updating user information. Changes take effect immediately.
 *
 * > **Important**
 * > Requires `identity.*.update_identity` permission
 * > Rate limit changes propagate within 30 seconds
 *
 * If set, this operation will use {@link Security.rootKey} from the global security.
 */
export declare function identitiesUpdateIdentity(client: UnkeyCore, request: components.V2IdentitiesUpdateIdentityRequestBody, options?: RequestOptions): APIPromise<Result<components.V2IdentitiesUpdateIdentityResponseBody, errors.BadRequestErrorResponse | errors.UnauthorizedErrorResponse | errors.ForbiddenErrorResponse | errors.NotFoundErrorResponse | errors.TooManyRequestsErrorResponse | errors.InternalServerErrorResponse | UnkeyError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=identitiesUpdateIdentity.d.ts.map