@medusajs/types/dist/api-key/mutations/api-key.d.ts

Medusa Types definition

import { ApiKeyType } from "../common";
/**
 * The API key to be created.
 */
export interface CreateApiKeyDTO {
    /**
     * The title of the API key.
     */
    title: string;
    /**
     * The type of the API key.
     */
    type: ApiKeyType;
    /**
     * Who created the API key.
     * If the API key type is `secret`, the user can use the created API key's token to authenticate
     * as explained in the [API Reference](https://docs.medusajs.com/api/admin#2-api-token).
     */
    created_by: string;
}
/**
 * The attributes in the API key to be created or updated.
 */
export interface UpsertApiKeyDTO {
    /**
     * The ID of the API key.
     */
    id?: string;
    /**
     * The title of the API key.
     */
    title?: string;
    /**
     * The type of the API key. Required only when creating an API key.
     */
    type?: ApiKeyType;
    /**
     * Who created the API key. It's only
     * usable and required when creating an API key.
     */
    created_by?: string;
}
/**
 * The attributes to update in the API key.
 */
export interface UpdateApiKeyDTO {
    /**
     * The title of the API key.
     */
    title?: string;
}
/**
 * The details of revoking an API key.
 */
export interface RevokeApiKeyDTO {
    /**
     * Who revoked the API key.
     */
    revoked_by: string;
    /**
     * When to revoke the API key (time in seconds).
     */
    revoke_in?: number;
}
//# sourceMappingURL=api-key.d.ts.map