cloudflare/resources/stream/keys.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { PagePromise, SinglePage } from "../../core/pagination.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseKeys extends APIResource {
    static readonly _key: readonly ['stream', 'keys'];
    /**
     * Creates an RSA private key in PEM and JWK formats. Key files are only displayed
     * once after creation. Keys are created, used, and deleted independently of
     * videos, and every key can sign any video.
     *
     * @example
     * ```ts
     * const keys = await client.stream.keys.create({
     *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * });
     * ```
     */
    create(params: KeyCreateParams, options?: RequestOptions): APIPromise<Keys>;
    /**
     * Deletes signing keys and revokes all signed URLs generated with the key.
     *
     * @example
     * ```ts
     * const key = await client.stream.keys.delete(
     *   '023e105f4ecef8ad9ca31a8372d0c353',
     *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * );
     * ```
     */
    delete(identifier: string, params: KeyDeleteParams, options?: RequestOptions): APIPromise<KeyDeleteResponse>;
    /**
     * Lists the video ID and creation date and time when a signing key was created.
     *
     * @example
     * ```ts
     * // Automatically fetches more pages as needed.
     * for await (const keyGetResponse of client.stream.keys.get({
     *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     * })) {
     *   // ...
     * }
     * ```
     */
    get(params: KeyGetParams, options?: RequestOptions): PagePromise<KeyGetResponsesSinglePage, KeyGetResponse>;
}
export declare class Keys extends BaseKeys {
}
export type KeyGetResponsesSinglePage = SinglePage<KeyGetResponse>;
export interface Keys {
    /**
     * Identifier.
     */
    id?: string;
    /**
     * The date and time a signing key was created.
     */
    created?: string;
    /**
     * The signing key in JWK format.
     */
    jwk?: string;
    /**
     * The signing key in PEM format.
     */
    pem?: string;
}
export type KeyDeleteResponse = string;
export interface KeyGetResponse {
    /**
     * Identifier.
     */
    id?: string;
    /**
     * The date and time a signing key was created.
     */
    created?: string;
    /**
     * The unique identifier for the signing key.
     */
    key_id?: string;
}
export interface KeyCreateParams {
    /**
     * Identifier.
     */
    account_id: string;
}
export interface KeyDeleteParams {
    /**
     * Identifier.
     */
    account_id: string;
}
export interface KeyGetParams {
    /**
     * Identifier.
     */
    account_id: string;
}
export declare namespace Keys {
    export { type Keys as Keys, type KeyDeleteResponse as KeyDeleteResponse, type KeyGetResponse as KeyGetResponse, type KeyGetResponsesSinglePage as KeyGetResponsesSinglePage, type KeyCreateParams as KeyCreateParams, type KeyDeleteParams as KeyDeleteParams, type KeyGetParams as KeyGetParams, };
}
//# sourceMappingURL=keys.d.mts.map