@fastpix/fastpix-node 2.0.5 → 2.0.6

package/src/models/createmediarequest.ts

@@ -302,7 +302,7 @@ export type CreateMediaRequest = {
    * Add one input object at a time. For example, first add a **VideoInput** object.   If you also need a watermark, click **Add item** again and select **WatermarkInput**.   Repeat this process for **AudioInput** or **SubtitleInput** as needed. For a complete explanation of how media uploads from URL and processing work, refer to the
    *
    * @remarks
-   *         <a href="https://docs.fastpix.io/docs/video-on-demand-overview" target="_blank">FastPix Video on Demand Overview</a>.
+   *         <a href="https://docs.fastpix.com/docs/video-on-demand-overview" target="_blank">FastPix Video on Demand Overview</a>.
    */
   inputs: Array<SubtitleInput | WatermarkInput | AudioInput | PullVideoInput>;
   /**

package/src/models/deletesigningkeyresponse.ts

@@ -10,11 +10,22 @@ import { Result as SafeParseResult } from "../types/fp.js";
 import * as types from "../types/primitives.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
+export type DeleteSigningKeyResponseData = {
+  /**
+   * Human-readable confirmation message returned by the API on successful deletion.
+   */
+  message?: string | undefined;
+};
+
 export type DeleteSigningKeyResponse = {
   /**
    * Shows the request status. Returns true for success and false for failure.
    */
   success?: boolean | undefined;
+  /**
+   * Optional informational payload returned by the API on successful deletion.
+   */
+  data?: DeleteSigningKeyResponseData | undefined;
 };
 
 /** @internal */
@@ -23,6 +34,9 @@ export const DeleteSigningKeyResponse$inboundSchema: z.ZodMiniType<
   unknown
 > = z.object({
   success: types.optional(types.boolean()),
+  data: types.optional(
+    z.object({ message: types.optional(types.string()) }),
+  ),
 });
 
 export function deleteSigningKeyResponseFromJSON(

package/src/models/operations/directuploadvideomedia.ts

@@ -277,7 +277,7 @@ export type DirectUploadVideoMediaAccessRestrictions = {
  * @remarks
  * These settings define how the uploaded video is handled, including access control, resolution, DRM, and optional metadata.
  * For a complete explanation of how media uploads and processing work, refer to the
- * <a href="https://docs.fastpix.io/docs/video-on-demand-overview" target="_blank">FastPix Video on Demand Overview</a>.
+ * <a href="https://docs.fastpix.com/docs/video-on-demand-overview" target="_blank">FastPix Video on Demand Overview</a>.
  */
 export type PushMediaSettings = {
   /**
@@ -386,7 +386,7 @@ export type DirectUploadVideoMediaRequest = {
    * @remarks
    * These settings define how the uploaded video is handled, including access control, resolution, DRM, and optional metadata.
    * For a complete explanation of how media uploads and processing work, refer to the
-   * <a href="https://docs.fastpix.io/docs/video-on-demand-overview" target="_blank">FastPix Video on Demand Overview</a>.
+   * <a href="https://docs.fastpix.com/docs/video-on-demand-overview" target="_blank">FastPix Video on Demand Overview</a>.
    */
   pushMediaSettings?: PushMediaSettings | undefined;
 };

package/src/models/pullvideoinput.ts

@@ -184,7 +184,7 @@ export const PullVideoInput$outboundSchema: z.ZodMiniType<
   PullVideoInput
 > = z.object({
   type: z._default(z.string(), "video"),
-  url: z._default(z.string(), "https://static.fastpix.io/fp-sample-video.mp4"),
+  url: z._default(z.string(), "https://static.fastpix.com/fp-sample-video.mp4"),
   startTime: z.optional(z.int()),
   endTime: z.optional(z.int()),
   introUrl: z.optional(z.string()),

package/src/models/videotrackforgetall.ts

@@ -30,6 +30,10 @@ export type VideoTrackForGetAll = {
    * Track height denotes the range of height applicable to a specific track. Currently, this setting can be modified only for video tracks.
    */
   height?: number | undefined;
+  /**
+   * Frame rate quantifies the speed at which frames are displayed per second. It represents the range of frames available for a specific track. The indeterminable frame rate of the input file is indicated by a value of -1.
+   */
+  frameRate?: string | undefined;
   /**
    * Indicates the current state of the track. 'available' means the track has been processed successfully and is ready to be used or played.
    */
@@ -45,6 +49,7 @@ export const VideoTrackForGetAll$inboundSchema: z.ZodMiniType<
   type: types.optional(types.string()),
   width: types.optional(types.number()),
   height: types.optional(types.number()),
+  frameRate: types.optional(types.string()),
   status: types.optional(types.string()),
 });
 

package/src/models/views.ts

@@ -351,13 +351,13 @@ export type Views = {
    *
    * @remarks
    */
-  fpSDK?: string | null | undefined;
+  fpSdk?: string | null | undefined;
   /**
    * FastPix SDK Version specifies the version of the FastPix Player SDK integrated into the player.
    *
    * @remarks
    */
-  fpSDKVersion?: string | null | undefined;
+  fpSdkVersion?: string | null | undefined;
   /**
    * Represents a unique, anonymized identifier assigned to each viewer by the FastPix SDK. This ID helps correlate multiple playback sessions or events to the same viewer across sessions or devices without exposing any personal information.
    *
@@ -527,7 +527,7 @@ export type Views = {
    */
   playerSoftwareVersion?: string | null | undefined;
   /**
-   * Specifies the domain or source from which the player was loaded or embedded (for example, stream.fastpix.io or a customer’s custom domain). This helps identify the playback origin and differentiate between various deployment environments.
+   * Specifies the domain or source from which the player was loaded or embedded (for example, stream.fastpix.com or a customer’s custom domain). This helps identify the playback origin and differentiate between various deployment environments.
    *
    * @remarks
    */
@@ -994,8 +994,7 @@ export function eventFromJSON(
 }
 
 /** @internal */
-export const Views$inboundSchema: z.ZodMiniType<Views, unknown> = z.pipe(
-  z.object({
+export const Views$inboundSchema: z.ZodMiniType<Views, unknown> = z.object({
     asnId: z.optional(z.nullable(types.number())),
     asnName: z.optional(z.nullable(types.string())),
     averageBitrate: z.optional(z.nullable(types.number())),
@@ -1125,14 +1124,7 @@ export const Views$inboundSchema: z.ZodMiniType<Views, unknown> = z.pipe(
     watchTime: z.optional(z.nullable(types.number())),
     workspaceId: types.optional(types.string()),
     events: types.optional(z.array(z.lazy(() => Event$inboundSchema))),
-  }),
-  z.transform((v) => {
-    return remap$(v, {
-      "fpSdk": "fpSDK",
-      "fpSdkVersion": "fpSDKVersion",
-    });
-  }),
-);
+  });
 
 export function viewsFromJSON(
   jsonString: string,

package/src/models/viewslist.ts

@@ -5,7 +5,6 @@
  */
 
 import * as z from "zod/v4-mini";
-import { remap as remap$ } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import * as types from "../types/primitives.js";
@@ -60,6 +59,12 @@ export type ViewsList = {
    * @remarks
    */
   errorMessage?: string | null | undefined;
+  /**
+   * The unique identifier for the error that occurred during playback.
+   *
+   * @remarks
+   */
+  errorId?: string | null | undefined;
   /**
    * Country of the viewer.
    *
@@ -77,31 +82,25 @@ export type ViewsList = {
    *
    * @remarks
    */
-  qoeScore?: number | null | undefined;
+  QoeScore?: number | null | undefined;
 };
 
 /** @internal */
 export const ViewsList$inboundSchema: z.ZodMiniType<ViewsList, unknown> = z
-  .pipe(
-    z.object({
-      viewId: types.optional(types.string()),
-      operatingSystem: z.optional(z.nullable(types.string())),
-      application: z.optional(z.nullable(types.string())),
-      viewStartTime: z.optional(z.nullable(types.string())),
-      viewEndTime: z.optional(z.nullable(types.string())),
-      videoTitle: z.optional(z.nullable(types.string())),
-      errorCode: z.optional(z.nullable(types.string())),
-      errorMessage: z.optional(z.nullable(types.string())),
-      country: z.optional(z.nullable(types.string())),
-      viewWatchTime: z.optional(z.nullable(types.number())),
-      QoeScore: z.optional(z.nullable(types.number())),
-    }),
-    z.transform((v) => {
-      return remap$(v, {
-        "QoeScore": "qoeScore",
-      });
-    }),
-  );
+  .object({
+    viewId: types.optional(types.string()),
+    operatingSystem: z.optional(z.nullable(types.string())),
+    application: z.optional(z.nullable(types.string())),
+    viewStartTime: z.optional(z.nullable(types.string())),
+    viewEndTime: z.optional(z.nullable(types.string())),
+    videoTitle: z.optional(z.nullable(types.string())),
+    errorCode: z.optional(z.nullable(types.string())),
+    errorMessage: z.optional(z.nullable(types.string())),
+    errorId: z.optional(z.nullable(types.string())),
+    country: z.optional(z.nullable(types.string())),
+    viewWatchTime: z.optional(z.nullable(types.number())),
+    QoeScore: z.optional(z.nullable(types.number())),
+  });
 
 export function viewsListFromJSON(
   jsonString: string,

package/src/models/watermarkinput.ts

@@ -69,7 +69,7 @@ export type Placement = {
  * @remarks
  * The watermark is placed over the media content during processing.
  * For detailed setup steps and customization options, refer to the
- * <a href="https://docs.fastpix.io/docs/watermark-your-videos" target="_blank">FastPix Watermark Guide</a>.
+ * <a href="https://docs.fastpix.com/docs/watermark-your-videos" target="_blank">FastPix Watermark Guide</a>.
  */
 export type WatermarkInput = {
   /**

package/src/sdk/aifeatures.ts

@@ -23,11 +23,11 @@ export class AiFeatures extends ClientSDK {
    * 3. Include the `summaryLength` parameter, specify the desired length of the summary in words (for example, 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 includes 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.
+   * You can use the <a href="https://docs.fastpix.com/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>
+   * Related guide: <a href="https://docs.fastpix.com/docs/generate-video-summary">Video summary</a>
    */
   async updateSummary(
     request: operations.UpdateMediaSummaryRequest,
@@ -56,11 +56,11 @@ export class AiFeatures extends ClientSDK {
    * 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.
+   * You can use the <a href="https://docs.fastpix.com/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>
+   * Related guide: <a href="https://docs.fastpix.com/docs/generate-named-entities">Named entities</a>
    */
   async generateNamedEntities(
     request: operations.UpdateMediaNamedEntitiesRequest,

package/src/sdk/dimensions.ts

@@ -17,9 +17,9 @@ export class Dimensions extends ClientSDK {
    * @remarks
    * Retrieves a list of dimensions that can be used as query parameters across various data endpoints. Each dimension has a unique id that can be used to filter data effectively.
    *
-   * The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://docs.fastpix.io/reference/list_video_views">list video views</a> and <a href="https://docs.fastpix.io/reference/list_by_top_content">list by top content</a> endpoints to filter results based on specific criteria. For example, you can filter views by `browser_name`, `os_name`, `device_type`, and more.
+   * The dimensions retrieved from this endpoint can be used in conjunction with the <a href="https://docs.fastpix.com/reference/list_video_views">list video views</a> and <a href="https://docs.fastpix.com/reference/list_by_top_content">list by top content</a> endpoints to filter results based on specific criteria. For example, you can filter views by `browser_name`, `os_name`, `device_type`, and more.
    *
-   * Related guides: <a href="https://docs.fastpix.io/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a> ,   <a href="https://docs.fastpix.io/docs/user-passable-metadata-1">Use passable dimensions</a>
+   * Related guides: <a href="https://docs.fastpix.com/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a> ,   <a href="https://docs.fastpix.com/docs/user-passable-metadata-1">Use passable dimensions</a>
    */
   async list(
     options?: RequestOptions,
@@ -36,13 +36,13 @@ export class Dimensions extends ClientSDK {
    * @remarks
    * This endpoint returns the filter values associated with a specific dimension, along with the total number of video views for each value. For example, it can list all `browser_name` (dimension) and show how many views occurred for all available browsers like Chrome, Safari (filter values).
    *
-   * In order to use the <a href="https://docs.fastpix.io/docs/custom-business-metadata">Custom Dimensions</a>, you must enable them in the dashboard under settings option based on the plan you have opted for.
+   * In order to use the <a href="https://docs.fastpix.com/docs/custom-business-metadata">Custom Dimensions</a>, you must enable them in the dashboard under settings option based on the plan you have opted for.
    *
    * #### Example
    *
    * A developer wants to know how their video content performs across different browsers. By calling this endpoint for the `device_type` dimension, they can retrieve a breakdown of video views by each device (for example, Desktop, Mobile, Tablet). This data helps the developer understand where optimizations or troubleshooting is necessary.
    *
-   * Related guide: <a href="https://docs.fastpix.io/docs/understand-dashboard-ui#filters-and-timeframes">Filters and timespan</a>
+   * Related guide: <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#filters-and-timeframes">Filters and timespan</a>
    */
   async listFilterValues(
     request: operations.ListFilterValuesForDimensionRequest,

package/src/sdk/drmconfigurations.ts

@@ -26,7 +26,7 @@ export class DrmConfigurations extends ClientSDK {
    * **Example:**
    * A media service provider may retrieve DRM configuration for a workspace to create DRM content.
    *
-   * Related guide: <a href="https://docs.fastpix.io/docs/secure-playback-with-drm">Manage DRM configuration</a>
+   * Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-drm">Manage DRM configuration</a>
    */
   async list(
     request?: operations.GetDrmConfigurationRequest | undefined,
@@ -50,7 +50,7 @@ export class DrmConfigurations extends ClientSDK {
    * 1. Make a GET request to this endpoint, replacing `{drmConfigurationId}` with the UUID of the DRM configuration.
    * 2. The response contains the associated DRM configuration ID.
    *
-   * Related guide: <a href="https://docs.fastpix.io/docs/secure-playback-with-drm">Manage DRM configuration</a>
+   * Related guide: <a href="https://docs.fastpix.com/docs/secure-playback-with-drm">Manage DRM configuration</a>
    */
   async get(
     request: operations.GetDrmConfigurationByIdRequest,

package/src/sdk/errors.ts

@@ -28,7 +28,7 @@ export class Errors extends ClientSDK {
    * * **count:** The number of occurrences of the specific error.
    * * **code:** The error code associated with the specific error.
    *
-   * Related guide: <a href="https://docs.fastpix.io/docs/track-playback-errors">Troubleshoot errors</a>
+   * Related guide: <a href="https://docs.fastpix.com/docs/track-playback-errors">Troubleshoot errors</a>
    */
   async list(
     request?: operations.ListErrorsRequest | undefined,

package/src/sdk/inputvideo.ts

@@ -44,13 +44,13 @@ export class InputVideo extends ClientSDK {
    *
    * 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.
+   * 4. Use the id in subsequent API calls, such as checking the status of the media with the <a href="https://docs.fastpix.com/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, after the media file is created (but not yet processed or encoded), FastPix sends a `POST` request to your specified webhook URL with the event <a href="https://docs.fastpix.io/docs/media-events#videomediacreated">video.media.created</a>.
+   * FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, after the media file is created (but not yet processed or encoded), FastPix sends a `POST` request to your specified webhook URL with the event <a href="https://docs.fastpix.com/docs/media-events#videomediacreated">video.media.created</a>.
    *
-   * After processing completes, monitor 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 track the status of the media file.
+   * After processing completes, monitor the events <a href="https://docs.fastpix.com/docs/media-events#videomediaready">video.media.ready</a> and <a href="https://docs.fastpix.com/docs/media-events#videomediafailed">video.media.failed</a> to track the status of the media file.
    *
-   * Related guide: <a href="https://docs.fastpix.io/docs/upload-videos-from-url">Upload videos from URL</a>
+   * Related guide: <a href="https://docs.fastpix.com/docs/upload-videos-from-url">Upload videos from URL</a>
    */
   async create(
     request: models.CreateMediaRequest,
@@ -71,7 +71,7 @@ export class InputVideo extends ClientSDK {
    *
    * > **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).
+   * > 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.com/changelog/api-update-direct-upload-media-from-device).
    *
    * #### How it works
    *
@@ -79,19 +79,19 @@ export class InputVideo extends ClientSDK {
    *
    * 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 a PUT request. The API accepts the media file from your device and uploads it to the FastPix platform. (Refer to <a href="https://docs.fastpix.io/docs/upload-videos-directly#step-3-initiate-the-upload">Step 3: Initiate the upload</a> for complete instructions.)
+   * 3. Upload your video file to the provided url by making a PUT request. The API accepts the media file from your device and uploads it to the FastPix platform. (Refer to <a href="https://docs.fastpix.com/docs/upload-videos-directly#step-3-initiate-the-upload">Step 3: Initiate the upload</a> for complete instructions.)
    *
    * 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.
+   * After uploading, you can use the <a href="https://docs.fastpix.com/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>.
+   * To notify your application about the status of this API request check for the webhooks for <a href="https://docs.fastpix.com/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>
+   * Related guide: <a href="https://docs.fastpix.com/docs/upload-videos-directly">Upload videos directly</a>
    */
   async upload(
     request?: operations.DirectUploadVideoMediaRequest | undefined,

package/src/sdk/invideoai.ts

@@ -21,11 +21,11 @@ export class InVideoAI extends ClientSDK {
    * 2. Include the `moderation` object and provide the requried `type` parameter in the request body to specify the media type (for example, video/audio/av).
    * 4. The response contains 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.
+   * You can use the <a href="https://docs.fastpix.com/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>
+   * Related guide: <a href="https://docs.fastpix.com/docs/using-nsfw-and-profanity-filter-for-video-moderation">Moderate NSFW & Profanity</a>
    */
   async updateModeration(
     request: operations.UpdateMediaModerationRequest,

package/src/sdk/invideoaifeatures.ts

@@ -21,11 +21,11 @@ export class InVideoAIfeatures extends ClientSDK {
    * 2. Include the `chapters` parameter in the request body to enable.
    * 3. The response contains 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.
+   * You can use the <a href="https://docs.fastpix.com/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/docs/generate-video-chapters">Video chapters</a>
+   * Related guide: <a href="https://docs.fastpix.com/docs/generate-video-chapters">Video chapters</a>
    */
   async generateChapters(
     request: operations.UpdateMediaChaptersRequest,

package/src/sdk/livestreams.ts

@@ -30,7 +30,7 @@ export class LiveStreams extends ClientSDK {
    * #### Use case
    * Suppose you’re hosting a live gaming event and want to showcase key moments from the stream — such as top plays or final match highlights. You can use this endpoint to fetch all clips generated from that livestream, display them in your dashboard, or use them for post-event editing and sharing.
    *
-   * Related guide: <a href="https://docs.fastpix.io/docs/instant-live-clipping">Instant live clipping</a>
+   * Related guide: <a href="https://docs.fastpix.com/docs/instant-live-clipping">Instant live clipping</a>
    */
   async listClips(
     request: operations.ListLiveClipsRequest,
@@ -47,7 +47,7 @@ export class LiveStreams extends ClientSDK {
    * Create a new stream
    *
    * @remarks
-   * Creates a new <a href="https://docs.fastpix.io/docs/get-started-with-live-streaming">RTMPS</a> or <a href="https://docs.fastpix.io/docs/using-srt-to-live-stream">SRT</a> live stream in FastPix. When you create a stream, FastPix generates a unique `streamKey` and `srtSecret` that you can use with broadcasting software such as OBS to connect to FastPix RTMPS or SRT servers. Use SRT for live streaming in unstable network conditions, as it provides error correction and encryption for a more reliable and secure broadcast.
+   * Creates a new <a href="https://docs.fastpix.com/docs/get-started-with-live-streaming">RTMPS</a> or <a href="https://docs.fastpix.com/docs/using-srt-to-live-stream">SRT</a> live stream in FastPix. When you create a stream, FastPix generates a unique `streamKey` and `srtSecret` that you can use with broadcasting software such as OBS to connect to FastPix RTMPS or SRT servers. Use SRT for live streaming in unstable network conditions, as it provides error correction and encryption for a more reliable and secure broadcast.
    *
    * Leverage SRT for live streaming in environments with unstable networks, taking advantage of its error correction and encryption features for a resilient and secure broadcast.
    *
@@ -57,13 +57,13 @@ export class LiveStreams extends ClientSDK {
    *
    * 2. FastPix returns the stream details for both RTMPS and SRT configurations. These keys and IDs from the stream details are essential for connecting the broadcasting software to FastPix’s servers and transmitting the live stream to viewers.
    *
-   * 3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://docs.fastpix.io/docs/live-events#videolive_streamcreated">video.live_stream.created</a>.
+   * 3. After the live stream is created, FastPix sends a `POST` request to your specified webhook endpoint with the event <a href="https://docs.fastpix.com/docs/live-events#videolive_streamcreated">video.live_stream.created</a>.
    *
    * **Example:**
    *
    *   Imagine a gaming platform that allows users to live stream gameplay directly from their dashboard. The API creates a new stream, provides the necessary stream key, and sets it to "private" so that only specific viewers can access it.
    *
-   * Related guide: <a href="https://docs.fastpix.io/docs/how-to-livestream">How to live stream</a>
+   * Related guide: <a href="https://docs.fastpix.com/docs/how-to-livestream">How to live stream</a>
    */
   async create(
     request: models.CreateLiveStreamRequest,
@@ -103,13 +103,13 @@ export class LiveStreams extends ClientSDK {
    * @remarks
    * Permanently deletes a specified live stream from the workspace. If the stream is active, the encoder is disconnected and ingestion stops immediately. This action is irreversible, and any future playback attempts fail as a result.
    *
-   *   Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. 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.
+   *   Provide the `streamId` in the request to terminate active connections and remove the stream from the workspace. You can further look for <a href="https://docs.fastpix.com/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>
+   *   Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
    */
   async delete(
     request: operations.DeleteLiveStreamRequest,
@@ -136,7 +136,7 @@ export class LiveStreams extends ClientSDK {
    *
    * 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>
+   * Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
    */
   async enable(
     request: operations.EnableLiveStreamRequest,

package/src/sdk/managelivestream.ts

@@ -26,7 +26,7 @@ export class ManageLiveStream extends ClientSDK {
    *
    * 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>
+   * Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
    */
   async getViewerCount(
     request: operations.GetLiveStreamViewerCountByIdRequest,
@@ -48,7 +48,7 @@ export class ManageLiveStream extends ClientSDK {
    *
    *   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>
+   * Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
    */
   async get(
     request: operations.GetLiveStreamByIdRequest,
@@ -67,13 +67,13 @@ export class ManageLiveStream extends ClientSDK {
    * @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. After 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 returns the updated stream details. After the update, <a href="https://docs.fastpix.io/docs/live-events#videolive_streamupdated">video.live_stream.updated</a> webhook event notifies your system.
+   *   The updated stream parameters and the `streamId` needs to be shared in the request, and FastPix returns the updated stream details. After the update, <a href="https://docs.fastpix.com/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>
+   *   Related guide: <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
    */
   async update(
     request: operations.UpdateLiveStreamRequest,
@@ -98,7 +98,7 @@ export class ManageLiveStream extends ClientSDK {
    *
    * 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>
+   * Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
    */
   async disable(
     request: operations.DisableLiveStreamRequest,
@@ -125,7 +125,7 @@ export class ManageLiveStream extends ClientSDK {
    *
    * 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>
+   * Related guide <a href="https://docs.fastpix.com/docs/manage-streams">Manage streams</a>
    */
   async complete(
     request: operations.CompleteLiveStreamRequest,