@fastpix/fastpix-node 1.0.2 → 2.0.1

package/dist/commonjs/sdk/inputvideo.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputVideo = void 0;
+const inputVideoCreateMedia_js_1 = require("../funcs/inputVideoCreateMedia.js");
+const inputVideoDirectUploadVideoMedia_js_1 = require("../funcs/inputVideoDirectUploadVideoMedia.js");
+const sdks_js_1 = require("../lib/sdks.js");
+const fp_js_1 = require("../types/fp.js");
+class InputVideo extends sdks_js_1.ClientSDK {
+    /**
+     * Create media from URL
+     *
+     * @remarks
+     * This endpoint allows developers or users to create a new video or audio media in FastPix using a publicly accessible URL. FastPix will fetch the media from the provided URL, process it, and store it on the platform for use.
+     *
+     * #### Public URL requirement:
+     *
+     *   The provided URL must be publicly accessible and should point to a video stored in one of the following supported formats: .m4v, .ogv, .mpeg, .mov, .3gp, .f4v, .rm, .ts, .wtv, .avi, .mp4, .wmv, .webm, .mts, .vob, .mxf, asf, m2ts
+     *
+     * #### Supported storage types:
+     *
+     * The URL can originate from various cloud storage services or content delivery networks (CDNs) such as:
+     *
+     * * **Amazon S3:** URLs from Amazon's Simple Storage Service.
+     *
+     * * **Google Cloud Storage:** URLs from Google Cloud's storage solution.
+     *
+     * * **Azure Blob Storage:** URLs from Microsoft's Azure storage.
+     *
+     * * **Public CDNs:** URLs from public content delivery networks that host video files.
+     *
+     * Upon successful creation, the API returns an `id` that should be retained for future operations related to this media.
+     *
+     * #### How it works
+     *
+     * 1. Send a POST request to this endpoint with the media URL (typically a video or audio file) and optional media settings.
+     *
+     * 2. FastPix uploads the video from the provided URL to its storage.
+     *
+     * 3. Receive a response containing the unique id for the newly created media item.
+     *
+     * 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://docs.fastpix.io/reference/get-media">Get Media by ID</a> endpoint to determine when the media is ready for playback.
+     *
+     * FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, once the media file is created (but not yet processed or encoded), we'll shoot a `POST` message to the address you give us with the webhook event <a href="https://docs.fastpix.io/docs/media-events#videomediacreated">video.media.created</a>.
+     *
+     * Once processing is done you can look for the events <a href="https://docs.fastpix.io/docs/media-events#/videomediaready">video.media.ready<a/> and <a href="https://docs.fastpix.io/docs/media-events#videomediafailed">video.media.failed</a> to see the status of your new media file.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/upload-videos-from-url">Upload videos from URL</a>
+     */
+    async createMedia(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, inputVideoCreateMedia_js_1.inputVideoCreateMedia)(this, request, options));
+    }
+    /**
+     * Upload media from device
+     *
+     * @remarks
+     * This endpoint enables accelerated uploads of large media files directly from your local device to FastPix for processing and storage.
+     *
+     * > **PLEASE NOTE**
+     * >
+     * > This version now supports uploads with no file size limitations and offers faster uploads. The previous endpoint (which had a 500MB size limit) is now deprecated. You can find details in the [changelog](https://docs.fastpix.io/changelog/api-update-direct-upload-media-from-device).
+     *
+     * #### How it works
+     *
+     * 1. Send a POST request to this endpoint with optional media settings.
+     *
+     * 2. The response includes an `uploadId` and a signed `url` for direct video file upload.
+     *
+     * 3. Upload your video file to the provided `url` by making `PUT` request. The API accepts the media file from the device and uploads it to the FastPix platform.
+     *
+     * 4. Once uploaded, the media undergoes processing and is assigned a unique ID for tracking. Retain this `uploadId` for any future operations related to this upload.
+     *
+     * After uploading, you can use the <a href="https://docs.fastpix.io/reference/get-media">Get Media by ID</a> endpoint to check the status of the uploaded media asset and see if it has transitioned to a `ready` status for playback.
+     *
+     * To notify your application about the status of this API request check for the webhooks for <a href="https://docs.fastpix.io/docs/webhooks-collection#media-related-events">media related events</a>.
+     *
+     * #### Example
+     *
+     * A social media platform allows users to upload video content directly from their phones or computers. This endpoint facilitates the upload process. For example, if you are developing a video-sharing app where users can upload short clips from their mobile devices, this endpoint enables them to select a video, upload it to the platform.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/upload-videos-directly">Upload videos directly</a>
+     */
+    async directUploadVideoMedia(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, inputVideoDirectUploadVideoMedia_js_1.inputVideoDirectUploadVideoMedia)(this, request, options));
+    }
+}
+exports.InputVideo = InputVideo;
+//# sourceMappingURL=inputvideo.js.map

package/dist/commonjs/sdk/inputvideo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inputvideo.js","sourceRoot":"","sources":["../../../src/sdk/inputvideo.ts"],"names":[],"mappings":";;;AAAA,gFAA0E;AAC1E,sGAAgG;AAChG,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,UAAW,SAAQ,mBAAS;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,KAAK,CAAC,WAAW,CACf,OAAkC,EAClC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAA8D,EAC9D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sEAAgC,EACjD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA5FD,gCA4FC"}

package/dist/commonjs/sdk/invideoaifeatures.d.ts

@@ -0,0 +1,83 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+export declare class InVideoAIFeatures extends ClientSDK {
+    /**
+     * Generate video summary
+     *
+     * @remarks
+     * This endpoint allows you to generate the summary for an existing media.
+     *
+     * #### How it works
+     * 1. Send a PATCH request to this endpoint, replacing `<mediaId>` with the unique ID of the media for which you wish to generate a summary.
+     * 2. Include the `generate` parameter in the request body.
+     * 3. Include the `summaryLength` parameter, specify the desired length of the summary in words (e.g., 120 words), this determines how concise or detailed the summary will be. If no specific summary length is provided, the default length will be 100 words.
+     * 4. The response will include the updated media data and confirmation of the changes applied.
+     *
+     * You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaisummaryready">video.mediaAI.summary.ready</a> webhook event to track and notify about the summary generation.
+     *
+     * **Use case**: This is particularly useful when a user uploads a video and later chooses to generate a summary without needing to re-upload the video.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/generate-video-summary">Video summary</a>
+     */
+    updateMediaSummary(request: operations.UpdateMediaSummaryRequest, options?: RequestOptions): Promise<operations.UpdateMediaSummaryResponse>;
+    /**
+     * Generate video chapters
+     *
+     * @remarks
+     * This endpoint enables you to generate chapters for an existing media file.
+     *
+     * #### How it works
+     * 1. Make a `PATCH` request to this endpoint, replacing `<mediaId>` with the ID of the media for which you want to generate chapters.
+     * 2. Include the `chapters` parameter in the request body to enable.
+     * 3. The response will contain the updated media data, confirming the changes made.
+     *
+     * You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation.
+     *
+     * **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/reference/update-media-chapters">Video chapters</a>
+     */
+    updateMediaChapters(request: operations.UpdateMediaChaptersRequest, options?: RequestOptions): Promise<operations.UpdateMediaChaptersResponse>;
+    /**
+     * Generate named entities
+     *
+     * @remarks
+     * This endpoint allows you to extract named entities from an existing media.
+     * Named Entity Recognition (NER) is a fundamental natural language processing (NLP) technique that identifies and classifies key information (entities) in text into predefined categories. For instance:
+     *
+     *   - Organizations (e.g., "Microsoft", "United Nations")
+     *   - Locations (e.g., "Paris", "Mount Everest")
+     *   - Product names (e.g., "iPhone", "Coca-Cola")
+     *
+     * #### How it works
+     * 1. Make a PATCH request to this endpoint, replacing `<mediaId>` with the ID of the media you want to extract named-entities.
+     * 2. Include the `namedEntities` parameter in the request body to enable.
+     * 3. Receive a response containing the updated media data, confirming the changes made.
+     *
+     * You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaainamedentitiesready">video.mediaAI.named-entities.ready</a> webhook event to track and notify about the named entities extraction.
+     *
+     * **Use case:** If a user uploads a video and later decides to enable named entity extraction without re-uploading the entire video.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/generate-named-entities">Named entities</a>
+     */
+    updateMediaNamedEntities(request: operations.UpdateMediaNamedEntitiesRequest, options?: RequestOptions): Promise<operations.UpdateMediaNamedEntitiesResponse>;
+    /**
+     * Enable video moderation
+     *
+     * @remarks
+     * This endpoint enables moderation features, such as NSFW and profanity filtering, to detect inappropriate content in existing media.
+     *
+     * #### How it works
+     * 1. Make a PATCH request to this endpoint, replacing `<mediaId>` with the ID of the media you want to update.
+     * 2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (e.g., video/audio/av).
+     * 4. The response will contain the updated media data, confirming the changes made.
+     *
+     * You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results.
+     *
+     * **Use case:** This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/using-nsfw-and-profanity-filter-for-video-moderation">Moderate NSFW & Profanity</a>
+     */
+    updateMediaModeration(request: operations.UpdateMediaModerationRequest, options?: RequestOptions): Promise<operations.UpdateMediaModerationResponse>;
+}
+//# sourceMappingURL=invideoaifeatures.d.ts.map

package/dist/commonjs/sdk/invideoaifeatures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invideoaifeatures.d.ts","sourceRoot":"","sources":["../../../src/sdk/invideoaifeatures.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C;;;;;;;;;;;;;;;;;OAiBG;IACG,kBAAkB,CACtB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC;IAQjD;;;;;;;;;;;;;;;;OAgBG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,gCAAgC,CAAC;IAQvD;;;;;;;;;;;;;;;;OAgBG;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAOrD"}

package/dist/commonjs/sdk/invideoaifeatures.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InVideoAIFeatures = void 0;
+const inVideoAIFeaturesUpdateMediaChapters_js_1 = require("../funcs/inVideoAIFeaturesUpdateMediaChapters.js");
+const inVideoAIFeaturesUpdateMediaModeration_js_1 = require("../funcs/inVideoAIFeaturesUpdateMediaModeration.js");
+const inVideoAIFeaturesUpdateMediaNamedEntities_js_1 = require("../funcs/inVideoAIFeaturesUpdateMediaNamedEntities.js");
+const inVideoAIFeaturesUpdateMediaSummary_js_1 = require("../funcs/inVideoAIFeaturesUpdateMediaSummary.js");
+const sdks_js_1 = require("../lib/sdks.js");
+const fp_js_1 = require("../types/fp.js");
+class InVideoAIFeatures extends sdks_js_1.ClientSDK {
+    /**
+     * Generate video summary
+     *
+     * @remarks
+     * This endpoint allows you to generate the summary for an existing media.
+     *
+     * #### How it works
+     * 1. Send a PATCH request to this endpoint, replacing `<mediaId>` with the unique ID of the media for which you wish to generate a summary.
+     * 2. Include the `generate` parameter in the request body.
+     * 3. Include the `summaryLength` parameter, specify the desired length of the summary in words (e.g., 120 words), this determines how concise or detailed the summary will be. If no specific summary length is provided, the default length will be 100 words.
+     * 4. The response will include the updated media data and confirmation of the changes applied.
+     *
+     * You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaisummaryready">video.mediaAI.summary.ready</a> webhook event to track and notify about the summary generation.
+     *
+     * **Use case**: This is particularly useful when a user uploads a video and later chooses to generate a summary without needing to re-upload the video.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/generate-video-summary">Video summary</a>
+     */
+    async updateMediaSummary(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, inVideoAIFeaturesUpdateMediaSummary_js_1.inVideoAIFeaturesUpdateMediaSummary)(this, request, options));
+    }
+    /**
+     * Generate video chapters
+     *
+     * @remarks
+     * This endpoint enables you to generate chapters for an existing media file.
+     *
+     * #### How it works
+     * 1. Make a `PATCH` request to this endpoint, replacing `<mediaId>` with the ID of the media for which you want to generate chapters.
+     * 2. Include the `chapters` parameter in the request body to enable.
+     * 3. The response will contain the updated media data, confirming the changes made.
+     *
+     * You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaichaptersready">video.mediaAI.chapters.ready</a> webhook event to track and notify about the chapters generation.
+     *
+     * **Use case:** This is particularly useful when a user uploads a video and later decides to enable chapters without re-uploading the entire video.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/reference/update-media-chapters">Video chapters</a>
+     */
+    async updateMediaChapters(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, inVideoAIFeaturesUpdateMediaChapters_js_1.inVideoAIFeaturesUpdateMediaChapters)(this, request, options));
+    }
+    /**
+     * Generate named entities
+     *
+     * @remarks
+     * This endpoint allows you to extract named entities from an existing media.
+     * Named Entity Recognition (NER) is a fundamental natural language processing (NLP) technique that identifies and classifies key information (entities) in text into predefined categories. For instance:
+     *
+     *   - Organizations (e.g., "Microsoft", "United Nations")
+     *   - Locations (e.g., "Paris", "Mount Everest")
+     *   - Product names (e.g., "iPhone", "Coca-Cola")
+     *
+     * #### How it works
+     * 1. Make a PATCH request to this endpoint, replacing `<mediaId>` with the ID of the media you want to extract named-entities.
+     * 2. Include the `namedEntities` parameter in the request body to enable.
+     * 3. Receive a response containing the updated media data, confirming the changes made.
+     *
+     * You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaainamedentitiesready">video.mediaAI.named-entities.ready</a> webhook event to track and notify about the named entities extraction.
+     *
+     * **Use case:** If a user uploads a video and later decides to enable named entity extraction without re-uploading the entire video.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/generate-named-entities">Named entities</a>
+     */
+    async updateMediaNamedEntities(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, inVideoAIFeaturesUpdateMediaNamedEntities_js_1.inVideoAIFeaturesUpdateMediaNamedEntities)(this, request, options));
+    }
+    /**
+     * Enable video moderation
+     *
+     * @remarks
+     * This endpoint enables moderation features, such as NSFW and profanity filtering, to detect inappropriate content in existing media.
+     *
+     * #### How it works
+     * 1. Make a PATCH request to this endpoint, replacing `<mediaId>` with the ID of the media you want to update.
+     * 2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (e.g., video/audio/av).
+     * 4. The response will contain the updated media data, confirming the changes made.
+     *
+     * You can use the <a href="https://docs.fastpix.io/docs/ai-events#videomediaaimoderationready">video.mediaAI.moderation.ready</a> webhook event to track and notify about the detected moderation results.
+     *
+     * **Use case:** This is particularly useful when a user uploads a video and later decides to enable moderation detection without the need to re-upload it.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/using-nsfw-and-profanity-filter-for-video-moderation">Moderate NSFW & Profanity</a>
+     */
+    async updateMediaModeration(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, inVideoAIFeaturesUpdateMediaModeration_js_1.inVideoAIFeaturesUpdateMediaModeration)(this, request, options));
+    }
+}
+exports.InVideoAIFeatures = InVideoAIFeatures;
+//# sourceMappingURL=invideoaifeatures.js.map

package/dist/commonjs/sdk/invideoaifeatures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invideoaifeatures.js","sourceRoot":"","sources":["../../../src/sdk/invideoaifeatures.ts"],"names":[],"mappings":";;;AAAA,8GAAwG;AACxG,kHAA4G;AAC5G,wHAAkH;AAClH,4GAAsG;AACtG,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,iBAAkB,SAAQ,mBAAS;IAC9C;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4EAAmC,EACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8EAAoC,EACrD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAmD,EACnD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wFAAyC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAgD,EAChD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,kFAAsC,EACvD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAtHD,8CAsHC"}

package/dist/commonjs/sdk/liveplayback.d.ts

@@ -0,0 +1,39 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+export declare class LivePlayback extends ClientSDK {
+    /**
+     * Create a playbackId
+     *
+     * @remarks
+     * Generates a new playback ID for the live stream, allowing viewers to access the stream through this ID. The playback ID can be shared with viewers for direct access to the live broadcast.
+     *
+     *   By calling this endpoint with the `streamId`, FastPix returns a unique `playbackId`, which can be used to stream the live content.
+     *
+     *   #### Example
+     *
+     *   A media platform needs to distribute a unique playback ID to users for an exclusive live concert. The platform can also embed the stream on various partner websites.
+     */
+    createPlaybackIdOfStream(request: operations.CreatePlaybackIdOfStreamRequest, options?: RequestOptions): Promise<models.PlaybackIdSuccessResponse>;
+    /**
+     * Delete a playbackId
+     *
+     * @remarks
+     * Deletes a previously created playback ID for a live stream. This will prevent any new viewers from accessing the stream through the playback ID, though current viewers will be able to continue watching for a limited time before being disconnected. By providing the `playbackId`, FastPix deletes the ID and ensures new playback requests will fail.
+     *
+     * #### Example
+     * A streaming service wants to prevent new users from joining a live stream that is nearing its end. The host can delete the playback ID to ensure no one can join the stream or replay it once it ends.
+     */
+    deletePlaybackIdOfStream(request: operations.DeletePlaybackIdOfStreamRequest, options?: RequestOptions): Promise<models.LiveStreamDeleteResponse>;
+    /**
+     * Get playbackId details
+     *
+     * @remarks
+     * Retrieves details about a previously created playback ID. If you provide the distinct `playbackId` that was given back to you in the previous stream or <a href="https://docs.fastpix.io/reference/create-playbackid-of-stream">create playbackId</a> request, FastPix will provide the relevant playback details such as the access policy.
+     *
+     * #### Example
+     * A developer needs to confirm the access policy of the playback ID to ensure whether the stream is public or private for viewers.
+     */
+    getLiveStreamPlaybackId(request: operations.GetLiveStreamPlaybackIdRequest, options?: RequestOptions): Promise<models.PlaybackIdSuccessResponse>;
+}
+//# sourceMappingURL=liveplayback.d.ts.map

package/dist/commonjs/sdk/liveplayback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveplayback.d.ts","sourceRoot":"","sources":["../../../src/sdk/liveplayback.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,YAAa,SAAQ,SAAS;IACzC;;;;;;;;;;;OAWG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAAC;IAQ5C;;;;;;;;OAQG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,+BAA+B,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC;IAQ3C;;;;;;;;OAQG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAAC;CAO7C"}

package/dist/commonjs/sdk/liveplayback.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LivePlayback = void 0;
+const livePlaybackCreatePlaybackIdOfStream_js_1 = require("../funcs/livePlaybackCreatePlaybackIdOfStream.js");
+const livePlaybackDeletePlaybackIdOfStream_js_1 = require("../funcs/livePlaybackDeletePlaybackIdOfStream.js");
+const livePlaybackGetLiveStreamPlaybackId_js_1 = require("../funcs/livePlaybackGetLiveStreamPlaybackId.js");
+const sdks_js_1 = require("../lib/sdks.js");
+const fp_js_1 = require("../types/fp.js");
+class LivePlayback extends sdks_js_1.ClientSDK {
+    /**
+     * Create a playbackId
+     *
+     * @remarks
+     * Generates a new playback ID for the live stream, allowing viewers to access the stream through this ID. The playback ID can be shared with viewers for direct access to the live broadcast.
+     *
+     *   By calling this endpoint with the `streamId`, FastPix returns a unique `playbackId`, which can be used to stream the live content.
+     *
+     *   #### Example
+     *
+     *   A media platform needs to distribute a unique playback ID to users for an exclusive live concert. The platform can also embed the stream on various partner websites.
+     */
+    async createPlaybackIdOfStream(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, livePlaybackCreatePlaybackIdOfStream_js_1.livePlaybackCreatePlaybackIdOfStream)(this, request, options));
+    }
+    /**
+     * Delete a playbackId
+     *
+     * @remarks
+     * Deletes a previously created playback ID for a live stream. This will prevent any new viewers from accessing the stream through the playback ID, though current viewers will be able to continue watching for a limited time before being disconnected. By providing the `playbackId`, FastPix deletes the ID and ensures new playback requests will fail.
+     *
+     * #### Example
+     * A streaming service wants to prevent new users from joining a live stream that is nearing its end. The host can delete the playback ID to ensure no one can join the stream or replay it once it ends.
+     */
+    async deletePlaybackIdOfStream(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, livePlaybackDeletePlaybackIdOfStream_js_1.livePlaybackDeletePlaybackIdOfStream)(this, request, options));
+    }
+    /**
+     * Get playbackId details
+     *
+     * @remarks
+     * Retrieves details about a previously created playback ID. If you provide the distinct `playbackId` that was given back to you in the previous stream or <a href="https://docs.fastpix.io/reference/create-playbackid-of-stream">create playbackId</a> request, FastPix will provide the relevant playback details such as the access policy.
+     *
+     * #### Example
+     * A developer needs to confirm the access policy of the playback ID to ensure whether the stream is public or private for viewers.
+     */
+    async getLiveStreamPlaybackId(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, livePlaybackGetLiveStreamPlaybackId_js_1.livePlaybackGetLiveStreamPlaybackId)(this, request, options));
+    }
+}
+exports.LivePlayback = LivePlayback;
+//# sourceMappingURL=liveplayback.js.map

package/dist/commonjs/sdk/liveplayback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveplayback.js","sourceRoot":"","sources":["../../../src/sdk/liveplayback.ts"],"names":[],"mappings":";;;AAAA,8GAAwG;AACxG,8GAAwG;AACxG,4GAAsG;AACtG,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,YAAa,SAAQ,mBAAS;IACzC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAmD,EACnD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8EAAoC,EACrD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAmD,EACnD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8EAAoC,EACrD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAkD,EAClD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4EAAmC,EACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA/DD,oCA+DC"}

package/dist/commonjs/sdk/managelivestream.d.ts

@@ -0,0 +1,123 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+export declare class ManageLiveStream extends ClientSDK {
+    /**
+     * Get all live streams
+     *
+     * @remarks
+     * Retrieves a list of all live streams associated with the current workspace. It provides an overview of both current and past live streams, including details like `streamId`, `metadata`, `status`, `createdAt` and more.
+     *
+     * #### How it works
+     *
+     * Use the access token and secret key related to the workspace in the request header. When called, the API provides a paginated response containing all the live streams in that specific workspace. This is helpful for retrieving a large volume of streams and managing content in bulk.
+     */
+    getAllStreams(request?: operations.GetAllStreamsRequest | undefined, options?: RequestOptions): Promise<models.GetStreamsResponse>;
+    /**
+     * Get stream views by ID
+     *
+     * @remarks
+     * This endpoint retrieves the current number of viewers watching a specific live stream, identified by its unique `streamId`.
+     *
+     * The viewer count is an **approximate value**, optimized for performance. It provides a near-real-time estimate of how many clients are actively watching the stream. This approach ensures high efficiency, especially when the stream is being watched at large scale across multiple devices or platforms.
+     *
+     * #### Example
+     *
+     * Suppose a content creator is hosting a live concert and wants to display the number of live viewers on their dashboard. This endpoint can be queried to show up-to-date viewer statistics.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
+     */
+    getLiveStreamViewerCountById(request: operations.GetLiveStreamViewerCountByIdRequest, options?: RequestOptions): Promise<models.ViewsCountResponse>;
+    /**
+     * Get stream by ID
+     *
+     * @remarks
+     * This endpoint retrieves details about a specific live stream by its unique `streamId`. It includes data such as the stream’s `status` (idle, preparing, active, disabled), `metadata` (title, description), and more.
+     * #### Example
+     *
+     *   Suppose a news agency is broadcasting a live event and wants to track the configurations set for the live stream while also checking the stream's status.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
+     */
+    getLiveStreamById(request: operations.GetLiveStreamByIdRequest, options?: RequestOptions): Promise<models.LivestreamgetResponse>;
+    /**
+     * Delete a stream
+     *
+     * @remarks
+     * Permanently removes a specified live stream from the workspace. If the stream is still active, the encoder will be disconnected, and the ingestion will stop. This action cannot be undone, and any future playback attempts will fail.
+     *
+     *   By providing the `streamId`, the API will terminate any active connections to the stream and remove it from the list of available live streams. You can further look for <a href="https://docs.fastpix.io/docs/live-events#videolive_streamdeleted">video.live_stream.deleted</a> webhook to notify your system about the status.
+     *
+     *   #### Example
+     *
+     *   For an online concert platform, a trial stream was mistakenly made public. The event manager deletes the stream before the concert begins to avoid confusion among viewers.
+     *
+     *   Related guide: <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
+     */
+    deleteLiveStream(request: operations.DeleteLiveStreamRequest, options?: RequestOptions): Promise<models.LiveStreamDeleteResponse>;
+    /**
+     * Update a stream
+     *
+     * @remarks
+     * This endpoint allows you to modify the parameters of an existing live stream, such as its `metadata` (title, description) or the `reconnectWindow`. It’s useful for making changes to a stream that has already been created but not yet ended. Once the live stream is disabled, you cannot update a stream.
+     *
+     *   The updated stream parameters and the `streamId` needs to be shared in the request, and FastPix will return the updated stream details. Once updated, <a href="https://docs.fastpix.io/docs/live-events#videolive_streamupdated">video.live_stream.updated</a> webhook event notifies your system.
+     *
+     *  #### Example
+     *
+     *  A host realizes they need to extend the reconnect window for their live stream in case they lose connection temporarily during the event. Or suppose during a multi-day online conference, the event organizers need to update the stream title to reflect the next day's session while keeping the same stream ID for continuity.
+     *
+     *   Related guide: <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
+     */
+    updateLiveStream(request: operations.UpdateLiveStreamRequest, options?: RequestOptions): Promise<models.PatchResponseDTO>;
+    /**
+     * Enable a stream
+     *
+     * @remarks
+     * This endpoint allows you to enable a livestream by transitioning its status from `disabled` to `idle`. Once enabled, the stream becomes available and ready to accept an incoming broadcast from a streaming tool.
+     *
+     * Streams on the trial plan cannot be re-enabled if they are in the `disabled` state.
+     *
+     * The `livestreamId` must be provided in the path, and the stream must not already be in an enabled state (`idle`, `preparing`, or `active`).
+     *
+     * #### Example
+     *
+     * A creator disables a livestream to pause it temporarily. Later, they decide to continue the session. By calling this endpoint with the stream's ID, they can re-enable and restart the same livestream.
+     *
+     * Related guide <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
+     */
+    enableLiveStream(request: operations.EnableLiveStreamRequest, options?: RequestOptions): Promise<models.LiveStreamDeleteResponse>;
+    /**
+     * Disable a stream
+     *
+     * @remarks
+     * This endpoint disables a livestream by setting its status to `disabled`. Use this to stop a livestream when it's no longer needed or should be taken offline intentionally.
+     *
+     * A disabled stream can later be re-enabled using the enable endpoint — however, if you're on a trial plan, re-enabling is not allowed once the stream is disabled.
+     *
+     * #### Example
+     *
+     * A speaker finishes their live session and wants to prevent the stream from being mistakenly started again. By calling this endpoint, the stream is transitioned to a `disabled` state, ensuring it's permanently stopped (unless re-enabled on a paid plan).
+     *
+     * Related guide <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
+     */
+    disableLiveStream(request: operations.DisableLiveStreamRequest, options?: RequestOptions): Promise<models.LiveStreamDeleteResponse>;
+    /**
+     * Complete a stream
+     *
+     * @remarks
+     * This endpoint marks a livestream as completed by stopping the active stream and transitioning its status to `idle`. It is typically used after a livestream session has ended.
+     *
+     * This operation only works when the stream is in the `active` state.
+     *
+     * Completing a stream can help finalize the session and trigger post-processing events like VOD generation.
+     *
+     * #### Example
+     *
+     * A virtual event ends, and the system or host needs to close the livestream to prevent further streaming. This endpoint ensures the livestream status is changed from `active` to `idle`, indicating it's officially completed.
+     *
+     * Related guide <a href="https://docs.fastpix.io/docs/manage-streams">Manage streams</a>
+     */
+    completeLiveStream(request: operations.CompleteLiveStreamRequest, options?: RequestOptions): Promise<models.LiveStreamDeleteResponse>;
+}
+//# sourceMappingURL=managelivestream.d.ts.map

package/dist/commonjs/sdk/managelivestream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"managelivestream.d.ts","sourceRoot":"","sources":["../../../src/sdk/managelivestream.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,gBAAiB,SAAQ,SAAS;IAC7C;;;;;;;;;OASG;IACG,aAAa,CACjB,OAAO,CAAC,EAAE,UAAU,CAAC,oBAAoB,GAAG,SAAS,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC;IAQrC;;;;;;;;;;;;;OAaG;IACG,4BAA4B,CAChC,OAAO,EAAE,UAAU,CAAC,mCAAmC,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC;IAQrC;;;;;;;;;;OAUG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;IAQxC;;;;;;;;;;;;;OAaG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC;IAQ3C;;;;;;;;;;;;;OAaG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;IAQnC;;;;;;;;;;;;;;;OAeG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC;IAQ3C;;;;;;;;;;;;;OAaG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC;IAQ3C;;;;;;;;;;;;;;;OAeG;IACG,kBAAkB,CACtB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC;CAO5C"}