cloudflare
Version:
The official TypeScript library for the Cloudflare API
86 lines • 2.46 kB
TypeScript
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as KeysAPI from 'cloudflare/resources/stream/keys';
export declare class Keys extends APIResource {
/**
* 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.
*/
create(params: KeyCreateParams, options?: Core.RequestOptions): Core.APIPromise<Keys>;
/**
* Deletes signing keys and revokes all signed URLs generated with the key.
*/
delete(identifier: string, params: KeyDeleteParams, options?: Core.RequestOptions): Core.APIPromise<KeyDeleteResponse>;
/**
* Lists the video ID and creation date and time when a signing key was created.
*/
get(params: KeyGetParams, options?: Core.RequestOptions): Core.APIPromise<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 = unknown | string;
export type KeyGetResponse = Array<KeyGetResponse.KeyGetResponseItem>;
export declare namespace KeyGetResponse {
interface KeyGetResponseItem {
/**
* Identifier
*/
id?: string;
/**
* The date and time a signing key was created.
*/
created?: string;
}
}
export interface KeyCreateParams {
/**
* Path param: Identifier
*/
account_id: string;
/**
* Body param:
*/
body: unknown;
}
export interface KeyDeleteParams {
/**
* Path param: Identifier
*/
account_id: string;
/**
* Body param:
*/
body: unknown;
}
export interface KeyGetParams {
/**
* Identifier
*/
account_id: string;
}
export declare namespace Keys {
export import Keys = KeysAPI.Keys;
export import KeyDeleteResponse = KeysAPI.KeyDeleteResponse;
export import KeyGetResponse = KeysAPI.KeyGetResponse;
export import KeyCreateParams = KeysAPI.KeyCreateParams;
export import KeyDeleteParams = KeysAPI.KeyDeleteParams;
export import KeyGetParams = KeysAPI.KeyGetParams;
}
//# sourceMappingURL=keys.d.ts.map