@linode/api-v4/lib/delivery/streams.d.ts

JavaScript wrapper around the Linode APIv4

import type { Filter, ResourcePage as Page, Params } from '../types';
import type { CreateStreamPayload, Stream, UpdateStreamPayload } from './types';
/**
 * Returns all the information about a specified Stream.
 *
 * @param streamId { number } The ID of the Stream to access.
 *
 */
export declare const getStream: (streamId: number) => Promise<Stream>;
/**
 * Returns a paginated list of Streams.
 *
 */
export declare const getStreams: (params?: Params, filter?: Filter) => Promise<Page<Stream>>;
/**
 * Adds a new Stream.
 *
 * @param data { object } Data for type, label, etc.
 */
export declare const createStream: (data: CreateStreamPayload) => Promise<Stream>;
/**
 * Updates a Stream.
 *
 * @param streamId { number } The ID of the Stream.
 * @param data { object } Options for type, status, etc.
 */
export declare const updateStream: (streamId: number, data: UpdateStreamPayload) => Promise<Stream>;
/**
 * Deletes a Stream.
 *
 * @param streamId { number } The ID of the Stream.
 */
export declare const deleteStream: (streamId: number) => Promise<{}>;
//# sourceMappingURL=streams.d.ts.map