import Base, { MaybeRaw } from "../../../../../Base"; import { PaginatedResponse, SearchParams } from "../../../../../interfaces/global"; import { SingleStreamPatchOrder, Stream, StreamPatchActive, StreamPatchOrder } from "../../../../../interfaces/high5/space/event/stream"; import { High5Design } from "./design"; export declare class High5Stream extends Base { get design(): High5Design; private _design?; /** * Retrieves all Streams of an Event which match the provided search filter(s). Will return all Streams if no filter is provided. * @param orgName Name of the organization * @param spaceName Name of the space * @param eventName Name of the event * @param filters (optional) Array of search filters * @param sorting (optional) Sorting object * @param limit (optional) Max number of results (1-100; defaults to 25) * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0) * @returns Object containing an array of streams as well as the total number of results found in the database (independent of limit and page) */ searchStreams({ orgName, spaceName, eventName, filters, sorting, limit, page, }: SearchParams & { orgName: string; spaceName: string; eventName: string; }, raw?: { raw: R; }): Promise>>; /** * Retrieves a Stream by its ID. * @param orgName Name of the organization * @param spaceName Name of the space * @param eventName Name of the event * @param streamId ID of the stream * @returns The requested stream */ getStream(orgName: string, spaceName: string, eventName: string, streamId: string, raw?: { raw: R; }): Promise>; /** * Creates a new Stream for the specified Event. * @param orgName Name of the organization * @param spaceName Name of the space * @param eventName Name of the event * @param name Name for the new stream * @returns The created stream */ createStream(orgName: string, spaceName: string, eventName: string, name: string, raw?: { raw: R; }): Promise>; /** * Duplicate a Stream for the specified Event. * @param orgName Name of the organization * @param spaceName Name of the space * @param eventName Name of the event * @param name Name for the new stream * @param sourceStreamId ID for the stream to duplicate * @returns The created stream */ duplicateStream(orgName: string, spaceName: string, eventName: string, name: string, sourceStreamId: string, raw?: { raw: R; }): Promise>; /** * Patches the order of Streams for an Event. * @param orgName Name of the organization * @param spaceName Name of the space * @param eventName Name of the event * @param StreamPatchOrder List of all event streams with their new order * @returns Array of updated Streams */ patchStreamOrderMulti(orgName: string, spaceName: string, eventName: string, streamList: StreamPatchOrder[], raw?: { raw: R; }): Promise>; /** * Activate or deactivate a stream * @param orgName Name of the organization * @param spaceName Name of the space * @param eventName Name of the event * @param streamId ID of the stream * @param StreamPatchActive Object defining if stream should be active or inactive * @returns Details of the updated stream */ patchStreamState(orgName: string, spaceName: string, eventName: string, streamId: string, streamPatchActive: StreamPatchActive, raw?: { raw: R; }): Promise>; /** * Moves a Stream up or down in the existing Streams order. * @param orgName Name of the organization * @param spaceName Name of the space * @param eventName Name of the event * @param streamId ID of the stream * @param SingleStreamPatchOrder Object defining if stream should move up or down * @returns Array of updated Streams */ patchStreamOrder(orgName: string, spaceName: string, eventName: string, streamId: string, singleStreamPatchOrder: SingleStreamPatchOrder, raw?: { raw: R; }): Promise>; /** * Rename a stream * @param orgName Name of the organization * @param spaceName Name of the space * @param eventName Name of the event * @param streamId ID of the stream * @param name New name of the stream * @returns Updated stream */ renameStream(orgName: string, spaceName: string, eventName: string, streamId: string, name: string, raw?: { raw: R; }): Promise>; /** * Moves a Stream to another event. * * @param orgName Name of the organization * @param spaceName Name of the space * @param eventName Name of the event * @param streamId ID of the stream * @param newEventName Name of the new event * @param [name] (optional) New name for stream. Is the new event already has a stream with the same name as this one, this parameter is mandatory. * @param [order] (optional) Order the stream should have in the new event * @returns Updated Stream */ moveStream(orgName: string, spaceName: string, eventName: string, streamId: string, newEventName: string, name?: string, order?: number, raw?: { raw: R; }): Promise>; /** * Deletes a Stream by its ID. * @param orgName Name of the organization * @param spaceName Name of the space * @param eventName Name of the event * @param streamId ID of the stream */ deleteStream(orgName: string, spaceName: string, eventName: string, streamId: string, raw?: { raw: R; }): Promise>; protected getEndpoint(endpoint: string): string; }