@fastpix/fastpix-node 1.0.1 → 2.0.0

package/dist/commonjs/sdk/managevideos.js

@@ -0,0 +1,383 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManageVideos = void 0;
+const manageVideosAddMediaTrack_js_1 = require("../funcs/manageVideosAddMediaTrack.js");
+const manageVideosCancelUpload_js_1 = require("../funcs/manageVideosCancelUpload.js");
+const manageVideosDeleteMedia_js_1 = require("../funcs/manageVideosDeleteMedia.js");
+const manageVideosDeleteMediaTrack_js_1 = require("../funcs/manageVideosDeleteMediaTrack.js");
+const manageVideosGenerateSubtitleTrack_js_1 = require("../funcs/manageVideosGenerateSubtitleTrack.js");
+const manageVideosGetMedia_js_1 = require("../funcs/manageVideosGetMedia.js");
+const manageVideosGetMediaClips_js_1 = require("../funcs/manageVideosGetMediaClips.js");
+const manageVideosListLiveClips_js_1 = require("../funcs/manageVideosListLiveClips.js");
+const manageVideosListMedia_js_1 = require("../funcs/manageVideosListMedia.js");
+const manageVideosListUploads_js_1 = require("../funcs/manageVideosListUploads.js");
+const manageVideosRetrieveMediaInputInfo_js_1 = require("../funcs/manageVideosRetrieveMediaInputInfo.js");
+const manageVideosUpdatedMedia_js_1 = require("../funcs/manageVideosUpdatedMedia.js");
+const manageVideosUpdatedMp4Support_js_1 = require("../funcs/manageVideosUpdatedMp4Support.js");
+const manageVideosUpdatedSourceAccess_js_1 = require("../funcs/manageVideosUpdatedSourceAccess.js");
+const manageVideosUpdateMediaTrack_js_1 = require("../funcs/manageVideosUpdateMediaTrack.js");
+const sdks_js_1 = require("../lib/sdks.js");
+const fp_js_1 = require("../types/fp.js");
+class ManageVideos extends sdks_js_1.ClientSDK {
+    /**
+     * Get list of all media
+     *
+     * @remarks
+     * This endpoint returns a list of all media files uploaded to FastPix within a specific workspace. Each media entry contains data such as the media `id`, `createdAt`, `status`, `type` and more. It allows you to retrieve an overview of your media assets, making it easier to manage and review them.
+     *
+     * #### 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 media items in that specific workspace. This is helpful for retrieving a large volume of media and managing content in bulk.
+     *
+     * #### Example
+     * You're managing a video platform and need to check all the uploaded media in your library to ensure no outdated or low-quality content is being served. Using this endpoint, you can retrieve a complete list of media, allowing you to filter, sort, or update items as needed.
+     */
+    async listMedia(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosListMedia_js_1.manageVideosListMedia)(this, request, options));
+    }
+    /**
+     * Get all clips of a live stream
+     *
+     * @remarks
+     * Retrieves a list of all media clips generated from a specific livestream. Each media entry includes metadata such as the clip media IDs, and other relevant details. A media clip is a segmented portion of an original media file (source live stream). Clips are often created for various purposes such as previews, highlights, or customized edits.
+     * #### How it works
+     * To use this endpoint, provide the `livestreamId` as a parameter. The API then returns a paginated list of clipped media items created from that livestream. Pagination ensures optimal performance and usability when dealing with a large number of media files, making it easier to organize and manage content in bulk.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/instant-live-clipping">Instant live clipping</a>
+     */
+    async listLiveClips(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosListLiveClips_js_1.manageVideosListLiveClips)(this, request, options));
+    }
+    /**
+     * Get a media by ID
+     *
+     * @remarks
+     * By calling this endpoint, you can retrieve detailed information about a specific media item, including its current `status` and a `playbackId`. This is particularly useful for retrieving specific media details when managing large content libraries.
+     *
+     * #### How it works
+     *
+     * 1. Make a GET request to this endpoint, using the `<mediaId>` received after uploading the media file.
+     *
+     * 2. Receive a response that includes details about the media:
+     *
+     * * `status` Indicates whether the media is still `preparing` or has transitioned to `ready`.
+     *
+     * * The `playbackId` is a unique identifier that allows you to stream the media once it is `ready`. You can construct the stream URL in this format: `https://stream.fastpix.io/<playbackId>.m3u8`
+     *
+     * #### Example
+     *
+     * Suppose your platform provides users with an interface where they can manage their uploaded content. A user requests detailed information about a specific video to see if it has been fully processed and is available for playback. Using the media ID, you can fetch the information from FastPix and display it in the user's dashboard.
+     */
+    async getMedia(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosGetMedia_js_1.manageVideosGetMedia)(this, request, options));
+    }
+    /**
+     * Update a media by ID
+     *
+     * @remarks
+     * This endpoint allows you to update specific parameters of an existing media file. You can modify the key-value pairs of the metadata that were provided in the payload during the creation of media from a URL or when uploading the media directly from device.
+     *
+     * #### How it works
+     *
+     * 1. Make a PATCH request to this endpoint, replacing `<mediaId>` with the unique ID (`uploadId` or `id`) of the media received after uploading to FastPix.
+     *
+     * 2. Include the updated parameters in the request body.
+     *
+     * 3. Receive a response containing the updated media data, confirming the changes made.
+     *
+     * Once you have made the update request, you can also look for the webhook event <a href="https://docs.fastpix.io/docs/media-events#videomediaupdated">video.media.updated</a> to notify your system about update status.
+     *
+     * #### Example
+     * Imagine a scenario where a user uploads a video and later realizes they need to change the title, add a new description or tags. You can use this endpoint to update the media metadata without having to re-upload the entire video.
+     */
+    async updatedMedia(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosUpdatedMedia_js_1.manageVideosUpdatedMedia)(this, request, options));
+    }
+    /**
+     * Delete a media by ID
+     *
+     * @remarks
+     * This endpoint allows you to permanently delete a a specific video or audio media file along with all associated data. If you wish to remove a media from FastPix storage, use this endpoint with the `mediaId` (either `uploadId` or `id`) received during the media's creation or upload.
+     *
+     * #### How it works
+     *
+     * 1. Make a DELETE request to this endpoint, replacing `<mediaId>` with the `uploadId` or the `id` of the media you want to delete.
+     *
+     * 2. Since this action is irreversible, ensure that you no longer need the media before proceeding. Once deleted, the media cannot be retrieved or played back.
+     *
+     * 3. Webhook event to look for: <a href="https://docs.fastpix.io/docs/media-events#videomediadeleted">video.media.deleted</a>
+     *
+     * #### Example
+     * A user on a video-sharing platform decides to remove an old video from their profile, or suppose you're running a content moderation system, and one of the videos uploaded by a user violates your platform's policies. Using this endpoint, the media is permanently deleted from your library, ensuring it's no longer accessible or viewable by other users.
+     */
+    async deleteMedia(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosDeleteMedia_js_1.manageVideosDeleteMedia)(this, request, options));
+    }
+    /**
+     * Add audio / subtitle track
+     *
+     * @remarks
+     * This endpoint allows you to add an audio or subtitle track to an existing media file using its `mediaId`. You need to provide the track `url` along with its `type` (audio or subtitle), `languageName` and `languageCode` in the request payload.
+     *
+     * #### How it works
+     *
+     * 1. Send a POST request to this endpoint, replacing `{mediaId}` with the media ID (`uploadId` or `id`).
+     *
+     * 2. Provide the necessary details in the request body.
+     *
+     * 3. Receive a response containing a unique track ID and the details of the newly added track.
+     *
+     * #### Webhook events
+     *
+     * 1. After successfully adding a track, your system will receive the webhook event <a href="https://docs.fastpix.io/docs/transform-media-events#videomediatrackcreated">video.media.track.created</a>.
+     *
+     * 2. Once the track is processed and ready, you will receive the webhook event <a href="https://docs.fastpix.io/docs/transform-media-events#videomediatrackready">video.media.track.ready</a>.
+     *
+     * 3. Finally, an update event <a href="https://docs.fastpix.io/docs/media-events#videomediaupdated">video.media.updated</a> will notify your system about the media's updated status.
+     *
+     * #### Example
+     * Suppose you have a video uploaded to the FastPix platform, and you want to add an Italian audio track to it. By calling this API, you can attach an external audio file (https://static.fastpix.io/music-1.mp3) to the media file. Similarly, if you need to add subtitles in different languages, you can specify type: `subtitle` with the corresponding subtitle `url`, `languageCode` and `languageName`.
+     *
+     * Related guides: <a href="https://docs.fastpix.io/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.io/docs/manage-audio-tracks">Add own audio tracks</a>
+     */
+    async addMediaTrack(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosAddMediaTrack_js_1.manageVideosAddMediaTrack)(this, request, options));
+    }
+    /**
+     * Cancel ongoing upload
+     *
+     * @remarks
+     * This endpoint allows you to cancel ongoing upload by its `uploadId`. Once cancelled, the upload will be marked as cancelled. Use this if a user aborts an upload or if you want to programmatically stop an in-progress upload.
+     *
+     * #### How it works
+     *
+     * 1. Make a PUT request to this endpoint, replacing `{uploadId}` with the unique upload ID received after starting the upload.
+     * 2. The response will confirm the cancellation and provide the status of the upload.
+     *
+     * #### Webhook Events
+     *
+     * Once the upload is cancelled, you will receive the webhook event <a href="https://docs.fastpix.io/docs/media-events#videomediauploadcancelled-event">video.media.upload.cancelled</a>.
+     *
+     * #### Example
+     *
+     * Suppose a user starts uploading a large video file but decides to cancel before completion. By calling this API, you can immediately stop the upload and free up resources.
+     */
+    async cancelUpload(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosCancelUpload_js_1.manageVideosCancelUpload)(this, request, options));
+    }
+    /**
+     * Update audio / subtitle track
+     *
+     * @remarks
+     * This endpoint allows you to update an existing audio or subtitle track associated with a media file. When updating a track, you must provide the new track `url`, `languageName`, and `languageCode`, ensuring all three parameters are included in the request.
+     *
+     * #### How it works
+     *
+     * 1. Send a PATCH request to this endpoint, replacing `{mediaId}` with the media ID, and `{trackId}` with the ID of the track you want to update.
+     *
+     * 2. Provide the necessary details in the request body.
+     *
+     * 3. Receive a response confirming the track update.
+     *
+     * #### Webhook Events
+     *
+     * After updating a track, your system will receive webhook notifications:
+     *
+     * 1. After successfully updating a track, your system will receive the webhook event <a href="https://docs.fastpix.io/docs/transform-media-events#videomediatrackupdated">video.media.track.updated</a>.
+     *
+     * 2. Once the new track is processed and ready, you will receive the webhook event <a href="https://docs.fastpix.io/docs/transform-media-events#videomediatrackready">video.media.track.ready</a>.
+     *
+     * 3. Once the media file is updated with the new track details, a <a href="https://docs.fastpix.io/docs/media-events#videomediaupdated">video.media.updated</a> event will be triggered.
+     *
+     * #### Example
+     * Suppose you previously added a French subtitle track to a video but now need to update it with a different file. By calling this API, you can replace the existing subtitle file (.vtt) with a new one while keeping the same track ID. This is useful when:
+     *
+     *   - The original track file has errors and needs correction.
+     *   - You want to improve subtitle translations or replace an audio track with a better-quality version.
+     *
+     * Related guides: <a href="https://docs.fastpix.io/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.io/docs/manage-audio-tracks">Add own audio tracks</a>
+     */
+    async updateMediaTrack(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosUpdateMediaTrack_js_1.manageVideosUpdateMediaTrack)(this, request, options));
+    }
+    /**
+     * Delete audio / subtitle track
+     *
+     * @remarks
+     * This endpoint allows you to delete an existing audio or subtitle track from a media file. Once deleted, the track will no longer be available for playback.
+     *
+     * #### How it works
+     *
+     * 1. Send a DELETE request to this endpoint, replacing `{mediaId}` with the media ID, and `{trackId}` with the ID of the track you want to remove.
+     *
+     * 2. The track will be deleted from the media file, and you will receive a confirmation response.
+     *
+     * #### Webhook events
+     *
+     * 1. After successfully deleting a track, your system will receive the webhook event **video.media.track.deleted**.
+     *
+     * 2. Once the media file is updated to reflect the track removal, a <a href="https://docs.fastpix.io/docs/media-events#videomediaupdated">video.media.updated</a> event will be triggered.
+     *
+     * #### Example
+     * Suppose you uploaded an audio track in Italian for a video but later realize it's incorrect or no longer needed. By calling this API, you can remove the specific track while keeping the rest of the media file unchanged. This is useful when:
+     *
+     *   - A track was mistakenly added and needs to be removed.
+     *   - The content owner requests the removal of a specific subtitle or audio track.
+     *   - A new version of the track will be uploaded to replace the existing one.
+     *
+     * Related guides: <a href="https://docs.fastpix.io/docs/manage-subtitle-tracks">Add own subtitle tracks</a>, <a href="https://docs.fastpix.io/docs/manage-audio-tracks">Add own audio tracks</a>
+     */
+    async deleteMediaTrack(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosDeleteMediaTrack_js_1.manageVideosDeleteMediaTrack)(this, request, options));
+    }
+    /**
+     * Generate track subtitle
+     *
+     * @remarks
+     * This endpoint allows you to generate subtitles for an existing audio track in a media file. By calling this API, you can generate subtitles automatically using speech recognition
+     *
+     * #### How it works
+     *
+     * 1. Send a `POST` request to this endpoint, replacing `{mediaId}` with the media ID and `{trackId}` with the track ID.
+     *
+     * 2. Provide the necessary details in the request body, including the languageName and languageCode.
+     *
+     * 3. Receive a response containing a unique subtitle track ID and its details.
+     *
+     * #### Webhook Events
+     *
+     * 1. Once the subtitle track is generated and ready, you will receive the webhook event <a href="https://docs.fastpix.io/docs/transform-media-events#videomediasubtitlegeneratedready">video.media.subtitle.generated.ready</a>.
+     *
+     * 2. Finally, an update event <a href="https://docs.fastpix.io/docs/media-events#videomediaupdated">video.media.updated</a> will notify your system about the media's updated status.
+     *
+     * </br> Related guide: <a href="https://docs.fastpix.io/docs/add-auto-generated-subtitles-to-videos">Add auto-generated subtitles</a>
+     */
+    async generateSubtitleTrack(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosGenerateSubtitleTrack_js_1.manageVideosGenerateSubtitleTrack)(this, request, options));
+    }
+    /**
+     * Update the source access of a media by ID
+     *
+     * @remarks
+     * This endpoint allows you to update the `sourceAccess` setting of an existing media file. The `sourceAccess` parameter determines whether the original media file is accessible or restricted. Setting this to `true` enables access to the media source, while setting it to `false` restricts access.
+     *
+     * #### 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 updated `sourceAccess` parameter in the request body.
+     *
+     * 3. Receive a response confirming the update to the media's source access status.
+     * 4. Webhook events: <a href="https://docs.fastpix.io/docs/transform-media-events#videomediasourceready">video.media.source.ready</a>, <a href="https://docs.fastpix.io/docs/transform-media-events#videomediasourcedeleted">video.media.source.deleted</a>
+     */
+    async updatedSourceAccess(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosUpdatedSourceAccess_js_1.manageVideosUpdatedSourceAccess)(this, request, options));
+    }
+    /**
+     * Update the mp4Support of a media by ID
+     *
+     * @remarks
+     * This endpoint allows you to update the `mp4Support` setting of an existing media file using its media ID. You can specify the MP4 support level, such as `none`, `capped_4k`, `audioOnly`, or a combination of `audioOnly`, `capped_4k`, in the request payload.
+     *
+     * #### How it works
+     *
+     * 1. Send a PATCH request to this endpoint, replacing `{mediaId}` with the media ID.
+     *
+     * 2. Provide the desired `mp4Support` value in the request body.
+     *
+     * 3. Receive a response confirming the update, including the media's updated MP4 support status.
+     *
+     * #### MP4 Support Options
+     *
+     * - `none` – MP4 support is disabled for this media.
+     *
+     * - `capped_4k` – The media will have mp4 renditions up to 4K resolution.
+     *
+     * - `audioOnly` – The media will generate an m4a file containing only the audio track.
+     *
+     * - `audioOnly,capped_4k` – The media will have both an audio-only m4a file and mp4 renditions up to 4K resolution.
+     *
+     * #### Webhook events
+     *
+     * - <a href="https://docs.fastpix.io/docs/transform-media-events#videomediamp4supportready">video.media.mp4Support.ready</a> – Triggered when the MP4 support setting is successfully updated.
+     *
+     * #### Example
+     * Suppose you have a video uploaded to the FastPix platform, and you want to allow users to download the video in MP4 format. By setting "mp4Support": "capped_4k", the system will generate an MP4 rendition of the video up to 4K resolution, making it available for download via the stream URL(`https://stream.fastpix.io/{playbackId}/{capped-4k.mp4 | audio.m4a}`).
+     * If you want users to stream only the audio from the media file, you can set "mp4Support": "audioOnly". This will provide an audio-only stream URL that allows users to listen to the media without video.
+     * By setting "mp4Support": "audioOnly,capped_4k", both options will be enabled. Users will be able to download the MP4 video and also stream just the audio version of the media.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/mp4-support-for-offline-viewing">Use MP4 support for offline viewing</a>
+     */
+    async updatedMp4Support(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosUpdatedMp4Support_js_1.manageVideosUpdatedMp4Support)(this, request, options));
+    }
+    /**
+     * Get info of media inputs
+     *
+     * @remarks
+     * Allows you to retrieve detailed information about the media inputs associated with a specific media item. You can use this endpoint to verify the media file's input URL, track creation status, and container format. The `mediaId` (either `uploadId` or `id`) must be provided to fetch the information.
+     *
+     * #### How it works
+     *
+     * Upon making a `GET` request with the mediaId, FastPix returns a response with:
+     *
+     * * The public storage input `url` of the uploaded media file.
+     *
+     * * Information about the `tracks` associated with the media, including both video and audio tracks, indicating whether they have been successfully created.
+     *
+     * * The format of the uploaded media file container (e.g., MP4, MKV).
+     *
+     * This endpoint is particularly useful for ensuring that all necessary tracks (video and audio) have been correctly associated with the media during the upload or media creation process.
+     */
+    async retrieveMediaInputInfo(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosRetrieveMediaInputInfo_js_1.manageVideosRetrieveMediaInputInfo)(this, request, options));
+    }
+    /**
+     * Get all unused upload URLs
+     *
+     * @remarks
+     * This endpoint retrieves a paginated list of all unused upload signed URLs within your organization. It provides comprehensive metadata including upload IDs, creation dates, status, and URLs, helping you manage your media resources efficiently.
+     *
+     * An unused upload URL is a signed URL that gets generated when an user initiates upload but never completed the upload process. This can happen due to reasons like network issues, manual cancellation of upload, browser/app crashes or session timeouts.These URLs remain in the system as "unused" since they were created but never resulted in a successful media file upload.
+     *
+     * #### How it works
+     *
+     *  - The endpoint returns metadata for all unused upload URLs in your organization's library.
+     *  - Results are paginated to manage large datasets effectively.
+     *  - Signed URLs expire after 24 hours from creation.
+     *  - Each entry includes full metadata about the unused upload.
+     *
+     * #### Example
+     *
+     * A video management team for a media organization regularly uploads content to their system but often forgets to delete or utilize unused uploads. These unused uploads, which have signed URLs that expire after 24 hours, need to be managed efficiently. By using this API, they can retrieve metadata for all unused uploads, identify expired signed URLs, and decide whether to regenerate URLs, reuse the uploads, or delete them.
+     */
+    async listUploads(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosListUploads_js_1.manageVideosListUploads)(this, request, options));
+    }
+    /**
+     * Get all clips of a media
+     *
+     * @remarks
+     * This endpoint retrieves a list of all media clips associated with a given source media ID. It helps in organizing and managing media's efficiently by providing metadata, including clip media IDs and other relevant details.
+     *
+     * A media clip is a segmented portion of an original media file (source media). Clips are often created for various purposes such as previews, highlights, or customized edits. This API allows you to fetch all such clips linked to a specific source media, making it easier to track and manage clips.
+     *
+     * #### How it works
+     *
+     * - The endpoint returns metadata for all media clips associated with the given `sourceMediaId`.
+     * - Results are paginated to efficiently handle large datasets.
+     * - Each entry includes detailed metadata such as media `id`, `duration`, and `status`.
+     * - Helps in organizing clips effectively by providing structured information.
+     *
+     * #### Example
+     *
+     * Imagine you're managing a video editing platform where users upload full-length videos and create short clips for social media sharing. To keep track of all clips linked to a particular video, you call this API with the sourceMediaId. The response provides a list of all associated clips, allowing you to manage, edit, or repurpose them as needed.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/create-clips-from-existing-media">Create clips from existing media</a>
+     */
+    async getMediaClips(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, manageVideosGetMediaClips_js_1.manageVideosGetMediaClips)(this, request, options));
+    }
+}
+exports.ManageVideos = ManageVideos;
+//# sourceMappingURL=managevideos.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"managevideos.js","sourceRoot":"","sources":["../../../src/sdk/managevideos.ts"],"names":[],"mappings":";;;AAAA,wFAAkF;AAClF,sFAAgF;AAChF,oFAA8E;AAC9E,8FAAwF;AACxF,wGAAkG;AAClG,8EAAwE;AACxE,wFAAkF;AAClF,wFAAkF;AAClF,gFAA0E;AAC1E,oFAA8E;AAC9E,0GAAoG;AACpG,sFAAgF;AAChF,gGAA0F;AAC1F,oGAA8F;AAC9F,8FAAwF;AACxF,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,YAAa,SAAQ,mBAAS;IACzC;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,SAAS,CACb,OAAiD,EACjD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,QAAQ,CACZ,OAAmC,EACnC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8CAAoB,EACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,YAAY,CAChB,OAAuC,EACvC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,WAAW,CACf,OAAsC,EACtC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,YAAY,CAChB,OAAuC,EACvC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAgD,EAChD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wEAAiC,EAClD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oEAA+B,EAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gEAA6B,EAC9C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAiD,EACjD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0EAAkC,EACnD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,WAAW,CACf,OAAmD,EACnD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oDAAuB,EACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA/dD,oCA+dC"}

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

@@ -0,0 +1,84 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+export declare class Metrics extends ClientSDK {
+    /**
+     * List breakdown values
+     *
+     * @remarks
+     * Retrieves breakdown values for a specified metric and timespan, allowing you to analyze the performance of your content based on various dimensions. It provides insights into how different factors contribute to the overall metrics.
+     *
+     * #### How it works
+     *
+     *   1. Before using this endpoint, you can call the <a href="https://docs.fastpix.io/reference/list_dimensions">List Dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
+     *
+     *   2. Make a `GET` request to this endpoint with the required `metricId` and other query parameters.
+     *
+     *   3. Receive a response containing the breakdown values for the specified metric, grouped and filtered according to your parameters.
+     *
+     *   4. Upon successful retrieval, the response will include the breakdown values based on the specified parameters. Note that the time values ( `totalWatchTime` and `totalPlayingTime` ) are in milliseconds.
+     *
+     * #### Example
+     *
+     * A developer wants to analyze how watch time varies across different device types. By calling this endpoint for the `playing_time` metric and filtering by `device_type`, they can understand how engagement differs between mobile, desktop, and tablet users. This data will guide optimization efforts for different platforms.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/metrics-overview">Understand data definitions</a>
+     */
+    listBreakdownValues(request: operations.ListBreakdownValuesRequest, options?: RequestOptions): Promise<operations.ListBreakdownValuesResponse>;
+    /**
+     * List overall values
+     *
+     * @remarks
+     * Retrieves overall values for a specified metric, providing summary statistics that help you understand the performance of your content. The response includes key metrics such as `totalWatchTime`, `uniqueViews`, `totalPlayTime` and `totalViews`.
+     *
+     * #### How it works
+     *
+     *   1. Before using this endpoint, you can call the <a href="https://docs.fastpix.io/reference/list_dimensions">list dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
+     *
+     *   2. Make a `GET` request to this endpoint with the required `metricId` and other query parameters.
+     *
+     *   3. Receive a response containing the overall values for the specified metric, which may vary based on the applied filters.
+     *
+     * #### Key fields in response
+     *
+     *   * **value:** The specific metric value calculated based on the applied filters.
+     *   * **totalWatchTime:** Total time watched across all views, represented in milliseconds.
+     *   * **uniqueViews:** The count of unique viewers who interacted with the content.
+     *   * **totalViews:** The total number of views recorded.
+     *   * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
+     *   * **globalValue:** A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan. This value is not affected by specific filters.
+     *
+     *   Related guide: <a href="https://docs.fastpix.io/docs/metrics-overview">Understand data definitions</a>
+     */
+    listOverallValues(request: operations.ListOverallValuesRequest, options?: RequestOptions): Promise<operations.ListOverallValuesResponse>;
+    /**
+     * Get timeseries data
+     *
+     * @remarks
+     * This endpoint retrieves timeseries data for a specified metric, providing insights into how the metric values change over time. The response includes an array of data points, each representing the metric's value at specific intervals.
+     *
+     * Each data point contains the following fields:
+     *
+     * * **intervalTime:** The timestamp for the data point indicating when the metric value was recorded.
+     * * **metricValue:** The value of the specified metric at the given interval, reflecting the performance or engagement level during that time.
+     * * **numberOfViews:** The total number of views recorded during that interval, providing context for the metric value.
+     */
+    getTimeseriesData(request: operations.GetTimeseriesDataRequest, options?: RequestOptions): Promise<operations.GetTimeseriesDataResponse>;
+    /**
+     * List comparison values
+     *
+     * @remarks
+     * This endpoint allows you to compare multiple metrics across specified dimensions. You can specify the metrics you want to compare in the query parameters, and the response will include the relevant metrics for the specified dimensions.
+     *
+     * #### How it works
+     *
+     *   1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.io/reference/list_dimensions">list dimensions</a> endpoint to obtain all available dimensions that can be used for comparison.
+     *
+     *   2. Make a `GET` request to this endpoint with the desired metrics specified in the query parameters.
+     *
+     *   3. Receive a response containing the comparison values for the specified metrics across the selected dimensions.
+     *
+     *   Related guide: <a href="https://docs.fastpix.io/docs/understand-dashboard-ui#compare-metrics">Compare metrics in dashboard</a>
+     */
+    listComparisonValues(request: operations.ListComparisonValuesRequest, options?: RequestOptions): Promise<operations.ListComparisonValuesResponse>;
+}
+//# sourceMappingURL=metrics.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../../../src/sdk/metrics.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,OAAQ,SAAQ,SAAS;IACpC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAQhD;;;;;;;;;;;OAWG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAQhD;;;;;;;;;;;;;;;OAeG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,4BAA4B,CAAC;CAOpD"}

package/dist/commonjs/sdk/metrics.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Metrics = void 0;
+const metricsGetTimeseriesData_js_1 = require("../funcs/metricsGetTimeseriesData.js");
+const metricsListBreakdownValues_js_1 = require("../funcs/metricsListBreakdownValues.js");
+const metricsListComparisonValues_js_1 = require("../funcs/metricsListComparisonValues.js");
+const metricsListOverallValues_js_1 = require("../funcs/metricsListOverallValues.js");
+const sdks_js_1 = require("../lib/sdks.js");
+const fp_js_1 = require("../types/fp.js");
+class Metrics extends sdks_js_1.ClientSDK {
+    /**
+     * List breakdown values
+     *
+     * @remarks
+     * Retrieves breakdown values for a specified metric and timespan, allowing you to analyze the performance of your content based on various dimensions. It provides insights into how different factors contribute to the overall metrics.
+     *
+     * #### How it works
+     *
+     *   1. Before using this endpoint, you can call the <a href="https://docs.fastpix.io/reference/list_dimensions">List Dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
+     *
+     *   2. Make a `GET` request to this endpoint with the required `metricId` and other query parameters.
+     *
+     *   3. Receive a response containing the breakdown values for the specified metric, grouped and filtered according to your parameters.
+     *
+     *   4. Upon successful retrieval, the response will include the breakdown values based on the specified parameters. Note that the time values ( `totalWatchTime` and `totalPlayingTime` ) are in milliseconds.
+     *
+     * #### Example
+     *
+     * A developer wants to analyze how watch time varies across different device types. By calling this endpoint for the `playing_time` metric and filtering by `device_type`, they can understand how engagement differs between mobile, desktop, and tablet users. This data will guide optimization efforts for different platforms.
+     *
+     * Related guide: <a href="https://docs.fastpix.io/docs/metrics-overview">Understand data definitions</a>
+     */
+    async listBreakdownValues(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, metricsListBreakdownValues_js_1.metricsListBreakdownValues)(this, request, options));
+    }
+    /**
+     * List overall values
+     *
+     * @remarks
+     * Retrieves overall values for a specified metric, providing summary statistics that help you understand the performance of your content. The response includes key metrics such as `totalWatchTime`, `uniqueViews`, `totalPlayTime` and `totalViews`.
+     *
+     * #### How it works
+     *
+     *   1. Before using this endpoint, you can call the <a href="https://docs.fastpix.io/reference/list_dimensions">list dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
+     *
+     *   2. Make a `GET` request to this endpoint with the required `metricId` and other query parameters.
+     *
+     *   3. Receive a response containing the overall values for the specified metric, which may vary based on the applied filters.
+     *
+     * #### Key fields in response
+     *
+     *   * **value:** The specific metric value calculated based on the applied filters.
+     *   * **totalWatchTime:** Total time watched across all views, represented in milliseconds.
+     *   * **uniqueViews:** The count of unique viewers who interacted with the content.
+     *   * **totalViews:** The total number of views recorded.
+     *   * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
+     *   * **globalValue:** A global metric value that reflects the overall performance of the specified metric across the entire dataset for the given timespan. This value is not affected by specific filters.
+     *
+     *   Related guide: <a href="https://docs.fastpix.io/docs/metrics-overview">Understand data definitions</a>
+     */
+    async listOverallValues(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, metricsListOverallValues_js_1.metricsListOverallValues)(this, request, options));
+    }
+    /**
+     * Get timeseries data
+     *
+     * @remarks
+     * This endpoint retrieves timeseries data for a specified metric, providing insights into how the metric values change over time. The response includes an array of data points, each representing the metric's value at specific intervals.
+     *
+     * Each data point contains the following fields:
+     *
+     * * **intervalTime:** The timestamp for the data point indicating when the metric value was recorded.
+     * * **metricValue:** The value of the specified metric at the given interval, reflecting the performance or engagement level during that time.
+     * * **numberOfViews:** The total number of views recorded during that interval, providing context for the metric value.
+     */
+    async getTimeseriesData(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, metricsGetTimeseriesData_js_1.metricsGetTimeseriesData)(this, request, options));
+    }
+    /**
+     * List comparison values
+     *
+     * @remarks
+     * This endpoint allows you to compare multiple metrics across specified dimensions. You can specify the metrics you want to compare in the query parameters, and the response will include the relevant metrics for the specified dimensions.
+     *
+     * #### How it works
+     *
+     *   1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.io/reference/list_dimensions">list dimensions</a> endpoint to obtain all available dimensions that can be used for comparison.
+     *
+     *   2. Make a `GET` request to this endpoint with the desired metrics specified in the query parameters.
+     *
+     *   3. Receive a response containing the comparison values for the specified metrics across the selected dimensions.
+     *
+     *   Related guide: <a href="https://docs.fastpix.io/docs/understand-dashboard-ui#compare-metrics">Compare metrics in dashboard</a>
+     */
+    async listComparisonValues(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, metricsListComparisonValues_js_1.metricsListComparisonValues)(this, request, options));
+    }
+}
+exports.Metrics = Metrics;
+//# sourceMappingURL=metrics.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/sdk/metrics.ts"],"names":[],"mappings":";;;AAAA,sFAAgF;AAChF,0FAAoF;AACpF,4FAAsF;AACtF,sFAAgF;AAChF,4CAA2D;AAE3D,0CAA6C;AAE7C,MAAa,OAAQ,SAAQ,mBAAS;IACpC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4DAA2B,EAC5C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAvHD,0BAuHC"}

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

@@ -0,0 +1,56 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+export declare class Playback extends ClientSDK {
+    /**
+     * Create a playback ID
+     *
+     * @remarks
+     * You can create a new playback ID for a specific media asset. If you have already retrieved an existing `playbackId` using the <a href="https://docs.fastpix.io/reference/get-media">Get Media by ID</a> endpoint for a media asset, you can use this endpoint to generate a new playback ID with a specified access policy.
+     *
+     * If you want to create a private playback ID for a media asset that already has a public playback ID, this endpoint also allows you to do so by specifying the desired access policy.
+     *
+     * #### How it works
+     *
+     * 1. Make a `POST` request to this endpoint, replacing `<mediaId>` with the `uploadId` or `id` of the media asset.
+     *
+     * 2. Include the `accessPolicy` in the request body with `private` or `public` as the value.
+     *
+     * 3. Receive a response containing the newly created playback ID with the requested access level.
+     *
+     * #### Example
+     * A video streaming service generates playback IDs for each media file when users request to view specific content. The playback ID is then used by the video player to stream the video.
+     */
+    createMediaPlaybackId(request: operations.CreateMediaPlaybackIdRequest, options?: RequestOptions): Promise<operations.CreateMediaPlaybackIdResponse>;
+    /**
+     * Delete a playback ID
+     *
+     * @remarks
+     * This endpoint allows you to remove a specific playback ID associated with a media asset. Deleting a `playbackId` will revoke access to the media content linked to that ID.
+     *
+     * #### How it works
+     *
+     * 1. Make a `DELETE` request to this endpoint, replacing `<mediaId>` with the unique ID of the media asset from which you want to delete the playback ID.
+     *
+     * 2. Specify the `playbackId` you wish to delete in the request body.
+     *
+     * #### Example
+     *
+     * Your platform offers limited-time access to premium content. When the subscription expires, you can revoke access to the content by deleting the associated playback ID, preventing users from streaming the video further.
+     */
+    deleteMediaPlaybackId(request: operations.DeleteMediaPlaybackIdRequest, options?: RequestOptions): Promise<operations.DeleteMediaPlaybackIdResponse>;
+    /**
+     * Get a playback ID
+     *
+     * @remarks
+     * This endpoint retrieves details about a specific playback ID associated with a media asset. This endpoint is commonly used to check the access policy (e.g., public or private) with the specific playback ID.
+     *
+     * **How it works:**
+     * 1. Make a GET request to the endpoint, replacing `{mediaId}` with the `id` of the media, and `{playbackId}` with the specific playback ID.
+     * 2. Useful for auditing or validation before granting playback access in your application.
+     *
+     * **Example:**
+     * A media platform might use this endpoint to verify if a playback ID is public or private before embedding the video in a frontend player or allowing access to a restricted group.
+     */
+    getPlaybackId(request: operations.GetPlaybackIdRequest, options?: RequestOptions): Promise<operations.GetPlaybackIdResponse>;
+}
+//# sourceMappingURL=playback.d.ts.map