userplex/resources/users.d.ts

The official TypeScript library for the Userplex API

import { APIResource } from "../core/resource.js";
import { APIPromise } from "../core/api-promise.js";
import { RequestOptions } from "../internal/request-options.js";
export declare class Users extends APIResource {
    /**
     * Creates or updates an end user in InstantDB with the provided information.
     * Requires a valid API key for authentication.
     */
    identify(body: UserIdentifyParams, options?: RequestOptions): APIPromise<UserIdentifyResponse>;
}
export interface UserIdentifyResponse {
    /**
     * Whether the operation was successful
     */
    success: boolean;
    /**
     * The identified user ID
     */
    userId: string;
}
export interface UserIdentifyParams {
    /**
     * User email address
     */
    email: string;
    /**
     * User full name
     */
    name: string;
    /**
     * Unique identifier for the user
     */
    userId: string;
    /**
     * Additional user properties
     */
    properties?: {
        [key: string]: unknown;
    };
}
export declare namespace Users {
    export { type UserIdentifyResponse as UserIdentifyResponse, type UserIdentifyParams as UserIdentifyParams };
}
//# sourceMappingURL=users.d.ts.map