@fastpix/fastpix-node 2.0.5 → 2.0.7

package/src/funcs/mediaGetClips.ts

@@ -46,23 +46,25 @@ import { Result } from "../types/fp.js";
  *
  * 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>
+ * Related guide: <a href="https://docs.fastpix.com/docs/create-clips-from-existing-media">Create clips from existing media</a>
  */
-export function mediaGetClips(
-  client: FastpixCore,
-  request: operations.GetMediaClipsRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.GetMediaClipsResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function mediaGetClips(
+  client: FastpixCore,
+  request: operations.GetMediaClipsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetMediaClipsResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -79,15 +81,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetMediaClipsResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.GetMediaClipsResponse,MyError
     >,
     APICall,
   ]
@@ -179,15 +173,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.GetMediaClipsResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.GetMediaClipsResponse,MyError
   >(
     M.json(200, operations.GetMediaClipsResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/mediaList.ts

@@ -40,21 +40,22 @@ import { Result } from "../types/fp.js";
  * #### Example
  * If you manage a video platform and need to review all uploaded media in your library to ensure that outdated or low-quality content isn’t being served, you can use this endpoint to retrieve a complete list of media. You can then filter, sort, or update items as needed.
  */
-export function mediaList(
-  client: FastpixCore,
-  request?: operations.ListMediaRequest | undefined,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.ListMediaResponse,
-    | FastpixError
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function mediaList(
+  client: FastpixCore,
+  request?: operations.ListMediaRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListMediaResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -71,15 +72,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.ListMediaResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.ListMediaResponse,MyError
     >,
     APICall,
   ]
@@ -165,15 +158,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListMediaResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.ListMediaResponse,MyError
   >(
     M.json(200, operations.ListMediaResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/mediaUpdateSourceAccess.ts

@@ -40,23 +40,24 @@ import { Result } from "../types/fp.js";
  * 2. Include the updated `sourceAccess` parameter in the request body.
  *
  * 3. You 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>
+ * 4. Webhook events: <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasourceready">video.media.source.ready</a>, <a href="https://docs.fastpix.com/docs/transform-media-events#videomediasourcedeleted">video.media.source.deleted</a>
  */
-export function mediaUpdateSourceAccess(
-  client: FastpixCore,
-  request: operations.UpdatedSourceAccessRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.UpdatedSourceAccessResponse,
-    | FastpixError
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function mediaUpdateSourceAccess(
+  client: FastpixCore,
+  request: operations.UpdatedSourceAccessRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.UpdatedSourceAccessResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -73,15 +74,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.UpdatedSourceAccessResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.UpdatedSourceAccessResponse,MyError
     >,
     APICall,
   ]
@@ -168,15 +161,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.UpdatedSourceAccessResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.UpdatedSourceAccessResponse,MyError
   >(
     M.json(200, operations.UpdatedSourceAccessResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/metricsGetTimeseriesData.ts

@@ -39,21 +39,23 @@ import { Result } from "../types/fp.js";
  * * **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.
  */
-export function metricsGetTimeseriesData(
-  client: FastpixCore,
-  request: operations.GetTimeseriesDataRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.GetTimeseriesDataResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function metricsGetTimeseriesData(
+  client: FastpixCore,
+  request: operations.GetTimeseriesDataRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetTimeseriesDataResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -70,15 +72,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetTimeseriesDataResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.GetTimeseriesDataResponse,MyError
     >,
     APICall,
   ]
@@ -173,15 +167,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.GetTimeseriesDataResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.GetTimeseriesDataResponse,MyError
   >(
     M.json(200, operations.GetTimeseriesDataResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/metricsListBreakdownValues.ts

@@ -35,7 +35,7 @@ import { Result } from "../types/fp.js";
  *
  * #### 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.
+ *   1. Before using this endpoint, you can call the <a href="https://docs.fastpix.com/reference/list_dimensions">List Dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
  *
  *   2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
  *
@@ -57,23 +57,25 @@ import { Result } from "../types/fp.js";
  *   * **totalPlayTime:** Total time spent playing the video, represented in milliseconds.
  *   * **field:** The grouping field value based on the groupBy parameter.
  *
- * Related guide: <a href="https://docs.fastpix.io/docs/metrics-overview">Understand data definitions</a>
+ * Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
  */
-export function metricsListBreakdownValues(
-  client: FastpixCore,
-  request: operations.ListBreakdownValuesRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.ListBreakdownValuesResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function metricsListBreakdownValues(
+  client: FastpixCore,
+  request: operations.ListBreakdownValuesRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListBreakdownValuesResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -196,15 +198,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListBreakdownValuesResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.ListBreakdownValuesResponse,MyError
   >(
     M.json(200, operations.ListBreakdownValuesResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/metricsListCompares.ts

@@ -44,29 +44,31 @@ import { Result } from "../types/fp.js";
  *
  * #### 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.
+ *   1. Before making a request to this endpoint, call the <a href="https://docs.fastpix.com/reference/list_dimensions">list dimensions</a> endpoint to obtain all available dimensions that can be used for comparison.
  *
  *   2. Send a `GET` request to this endpoint with the desired metrics specified in the query parameters.
  *
  *   3. You 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>
+ *   Related guide: <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#compare-metrics">Compare metrics in dashboard</a>
  */
-export function metricsListCompares(
-  client: FastpixCore,
-  request?: operations.ListComparisonValuesRequest | undefined,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.ListComparisonValuesResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function metricsListCompares(
+  client: FastpixCore,
+  request?: operations.ListComparisonValuesRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListComparisonValuesResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -83,15 +85,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.ListComparisonValuesResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.ListComparisonValuesResponse,MyError
     >,
     APICall,
   ]
@@ -181,15 +175,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListComparisonValuesResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.ListComparisonValuesResponse,MyError
   >(
     M.json(200, operations.ListComparisonValuesResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/metricsListOverallValues.ts

@@ -35,7 +35,7 @@ import { Result } from "../types/fp.js";
  *
  * #### 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.
+ *   1. Before using this endpoint, you can call the <a href="https://docs.fastpix.com/reference/list_dimensions">list dimensions</a> endpoint to retrieve all available dimensions that can be used in your query.
  *
  *   2. Send a `GET` request to this endpoint with the required `metricId` and other query parameters.
  *
@@ -50,23 +50,25 @@ import { Result } from "../types/fp.js";
  *   * **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>
+ *   Related guide: <a href="https://docs.fastpix.com/docs/metrics-overview">Understand data definitions</a>
  */
-export function metricsListOverallValues(
-  client: FastpixCore,
-  request: operations.ListOverallValuesRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.ListOverallValuesResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function metricsListOverallValues(
+  client: FastpixCore,
+  request: operations.ListOverallValuesRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListOverallValuesResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -83,15 +85,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.ListOverallValuesResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.ListOverallValuesResponse,MyError
     >,
     APICall,
   ]
@@ -184,15 +178,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListOverallValuesResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.ListOverallValuesResponse,MyError
   >(
     M.json(200, operations.ListOverallValuesResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/playbackCreate.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  * 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.
+ * 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.com/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.
  *
@@ -46,21 +46,23 @@ import { Result } from "../types/fp.js";
  * #### Example
  * A video streaming service generates playback IDs for each media file when users request to view specific content. The video player then uses the playback ID to stream the video.
  */
-export function playbackCreate(
-  client: FastpixCore,
-  request: operations.CreateMediaPlaybackIdRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.CreateMediaPlaybackIdResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function playbackCreate(
+  client: FastpixCore,
+  request: operations.CreateMediaPlaybackIdRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.CreateMediaPlaybackIdResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -77,15 +79,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.CreateMediaPlaybackIdResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.CreateMediaPlaybackIdResponse,MyError
     >,
     APICall,
   ]
@@ -172,15 +166,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateMediaPlaybackIdResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.CreateMediaPlaybackIdResponse,MyError
   >(
     M.json(201, operations.CreateMediaPlaybackIdResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/playbackDelete.ts

@@ -43,21 +43,23 @@ import { Result } from "../types/fp.js";
  *
  * 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.
  */
-export function playbackDelete(
-  client: FastpixCore,
-  request: operations.DeleteMediaPlaybackIdRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.DeleteMediaPlaybackIdResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function playbackDelete(
+  client: FastpixCore,
+  request: operations.DeleteMediaPlaybackIdRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.DeleteMediaPlaybackIdResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -74,15 +76,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.DeleteMediaPlaybackIdResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.DeleteMediaPlaybackIdResponse,MyError
     >,
     APICall,
   ]
@@ -173,15 +167,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.DeleteMediaPlaybackIdResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.DeleteMediaPlaybackIdResponse,MyError
   >(
     M.json(200, operations.DeleteMediaPlaybackIdResponse$inboundSchema),
     M.fail("4XX"),