@fastpix/fastpix-node 1.0.1 → 2.0.0

package/src/models/viewsbytopcontentdetails.ts

@@ -0,0 +1,82 @@
+import * as z from "zod";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Retrieves a list of the top video views
+ */
+export type ViewsByTopContentDetails = {
+  /**
+   * Title of the video
+   */
+  videoTitle?: string | undefined;
+  /**
+   * Total count of view sessions for a paricular video content.
+   */
+  views?: number | undefined;
+  /**
+   * Total count of unique video viewers for particular video content.
+   */
+  uniqueViews?: number | undefined;
+};
+
+/** @internal */
+export const ViewsByTopContentDetails$inboundSchema: z.ZodType<
+  ViewsByTopContentDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  videoTitle: z.string().optional(),
+  views: z.number().int().optional(),
+  uniqueViews: z.number().int().optional(),
+});
+
+/** @internal */
+export type ViewsByTopContentDetails$Outbound = {
+  videoTitle?: string | undefined;
+  views?: number | undefined;
+  uniqueViews?: number | undefined;
+};
+
+/** @internal */
+export const ViewsByTopContentDetails$outboundSchema: z.ZodType<
+  ViewsByTopContentDetails$Outbound,
+  z.ZodTypeDef,
+  ViewsByTopContentDetails
+> = z.object({
+  videoTitle: z.string().optional(),
+  views: z.number().int().optional(),
+  uniqueViews: z.number().int().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ViewsByTopContentDetails$ {
+  /** @deprecated use `ViewsByTopContentDetails$inboundSchema` instead. */
+  export const inboundSchema = ViewsByTopContentDetails$inboundSchema;
+  /** @deprecated use `ViewsByTopContentDetails$outboundSchema` instead. */
+  export const outboundSchema = ViewsByTopContentDetails$outboundSchema;
+  /** @deprecated use `ViewsByTopContentDetails$Outbound` instead. */
+  export type Outbound = ViewsByTopContentDetails$Outbound;
+}
+
+export function viewsByTopContentDetailsToJSON(
+  viewsByTopContentDetails: ViewsByTopContentDetails,
+): string {
+  return JSON.stringify(
+    ViewsByTopContentDetails$outboundSchema.parse(viewsByTopContentDetails),
+  );
+}
+
+export function viewsByTopContentDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<ViewsByTopContentDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ViewsByTopContentDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ViewsByTopContentDetails' from JSON`,
+  );
+}

package/src/models/viewscountresponse.ts

@@ -0,0 +1,136 @@
+import * as z from "zod";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Contains the view count details.
+ */
+export type ViewsCountResponseData = {
+  /**
+   * Number of views for the stream or resource.
+   */
+  views?: number | undefined;
+};
+
+export type ViewsCountResponse = {
+  /**
+   * Indicates whether the request was successful or not.
+   */
+  success?: boolean | undefined;
+  /**
+   * Contains the view count details.
+   */
+  data?: ViewsCountResponseData | undefined;
+};
+
+/** @internal */
+export const ViewsCountResponseData$inboundSchema: z.ZodType<
+  ViewsCountResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  views: z.number().int().optional(),
+});
+
+/** @internal */
+export type ViewsCountResponseData$Outbound = {
+  views?: number | undefined;
+};
+
+/** @internal */
+export const ViewsCountResponseData$outboundSchema: z.ZodType<
+  ViewsCountResponseData$Outbound,
+  z.ZodTypeDef,
+  ViewsCountResponseData
+> = z.object({
+  views: z.number().int().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ViewsCountResponseData$ {
+  /** @deprecated use `ViewsCountResponseData$inboundSchema` instead. */
+  export const inboundSchema = ViewsCountResponseData$inboundSchema;
+  /** @deprecated use `ViewsCountResponseData$outboundSchema` instead. */
+  export const outboundSchema = ViewsCountResponseData$outboundSchema;
+  /** @deprecated use `ViewsCountResponseData$Outbound` instead. */
+  export type Outbound = ViewsCountResponseData$Outbound;
+}
+
+export function viewsCountResponseDataToJSON(
+  viewsCountResponseData: ViewsCountResponseData,
+): string {
+  return JSON.stringify(
+    ViewsCountResponseData$outboundSchema.parse(viewsCountResponseData),
+  );
+}
+
+export function viewsCountResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ViewsCountResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ViewsCountResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ViewsCountResponseData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ViewsCountResponse$inboundSchema: z.ZodType<
+  ViewsCountResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.boolean().optional(),
+  data: z.lazy(() => ViewsCountResponseData$inboundSchema).optional(),
+});
+
+/** @internal */
+export type ViewsCountResponse$Outbound = {
+  success?: boolean | undefined;
+  data?: ViewsCountResponseData$Outbound | undefined;
+};
+
+/** @internal */
+export const ViewsCountResponse$outboundSchema: z.ZodType<
+  ViewsCountResponse$Outbound,
+  z.ZodTypeDef,
+  ViewsCountResponse
+> = z.object({
+  success: z.boolean().optional(),
+  data: z.lazy(() => ViewsCountResponseData$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ViewsCountResponse$ {
+  /** @deprecated use `ViewsCountResponse$inboundSchema` instead. */
+  export const inboundSchema = ViewsCountResponse$inboundSchema;
+  /** @deprecated use `ViewsCountResponse$outboundSchema` instead. */
+  export const outboundSchema = ViewsCountResponse$outboundSchema;
+  /** @deprecated use `ViewsCountResponse$Outbound` instead. */
+  export type Outbound = ViewsCountResponse$Outbound;
+}
+
+export function viewsCountResponseToJSON(
+  viewsCountResponse: ViewsCountResponse,
+): string {
+  return JSON.stringify(
+    ViewsCountResponse$outboundSchema.parse(viewsCountResponse),
+  );
+}
+
+export function viewsCountResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ViewsCountResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ViewsCountResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ViewsCountResponse' from JSON`,
+  );
+}

package/src/models/viewslist.ts

@@ -0,0 +1,171 @@
+import * as z from "zod";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type ViewsList = {
+  /**
+   * The unique identifier for the viewing session of the user.
+   *
+   * @remarks
+   */
+  viewId: string;
+  /**
+   * Operating System signifies the software platform utilized by the viewer
+   *
+   * @remarks
+   */
+  operatingSystem: string | null;
+  /**
+   * The browser name of the viewer.
+   *
+   * @remarks
+   */
+  application: string | null;
+  /**
+   * The start timestamp of the video view.
+   *
+   * @remarks
+   */
+  viewStartTime: string | null;
+  /**
+   * The end timestamp of the video view.
+   *
+   * @remarks
+   */
+  viewEndTime: string | null;
+  /**
+   * The title of the Video.
+   *
+   * @remarks
+   */
+  videoTitle: string | null;
+  /**
+   * The code which represents specific issues or failures that occur during playback. These can be implementation specific.
+   *
+   * @remarks
+   */
+  errorCode?: string | null | undefined;
+  /**
+   * The notifications or messages that inform users or developers about issues or failures that have occurred during the playback representing error codes.
+   *
+   * @remarks
+   */
+  errorMessage?: string | null | undefined;
+  /**
+   * The unique identifier which identifies each type of error that occurs.
+   *
+   * @remarks
+   */
+  errorId?: number | null | undefined;
+  /**
+   * Country of the viewer.
+   *
+   * @remarks
+   */
+  country: string | null;
+  /**
+   * The watch time represents the time spent watching the video including staruptime, playback time ,buffering time.
+   *
+   * @remarks
+   */
+  viewWatchTime?: number | null | undefined;
+  /**
+   * The viewer experience encapsulated in the form of score while watching the video.
+   *
+   * @remarks
+   */
+  qoeScore?: number | null | undefined;
+};
+
+/** @internal */
+export const ViewsList$inboundSchema: z.ZodType<
+  ViewsList,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  viewId: z.string(),
+  operatingSystem: z.nullable(z.string()),
+  application: z.nullable(z.string()),
+  viewStartTime: z.nullable(z.string()),
+  viewEndTime: z.nullable(z.string()),
+  videoTitle: z.nullable(z.string()),
+  errorCode: z.nullable(z.string()).optional(),
+  errorMessage: z.nullable(z.string()).optional(),
+  errorId: z.nullable(z.number().int()).optional(),
+  country: z.nullable(z.string()),
+  viewWatchTime: z.nullable(z.number()).optional(),
+  QoeScore: z.nullable(z.number()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "QoeScore": "qoeScore",
+  });
+});
+
+/** @internal */
+export type ViewsList$Outbound = {
+  viewId: string;
+  operatingSystem: string | null;
+  application: string | null;
+  viewStartTime: string | null;
+  viewEndTime: string | null;
+  videoTitle: string | null;
+  errorCode?: string | null | undefined;
+  errorMessage?: string | null | undefined;
+  errorId?: number | null | undefined;
+  country: string | null;
+  viewWatchTime?: number | null | undefined;
+  QoeScore?: number | null | undefined;
+};
+
+/** @internal */
+export const ViewsList$outboundSchema: z.ZodType<
+  ViewsList$Outbound,
+  z.ZodTypeDef,
+  ViewsList
+> = z.object({
+  viewId: z.string(),
+  operatingSystem: z.nullable(z.string()),
+  application: z.nullable(z.string()),
+  viewStartTime: z.nullable(z.string()),
+  viewEndTime: z.nullable(z.string()),
+  videoTitle: z.nullable(z.string()),
+  errorCode: z.nullable(z.string()).optional(),
+  errorMessage: z.nullable(z.string()).optional(),
+  errorId: z.nullable(z.number().int()).optional(),
+  country: z.nullable(z.string()),
+  viewWatchTime: z.nullable(z.number()).optional(),
+  qoeScore: z.nullable(z.number()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    qoeScore: "QoeScore",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ViewsList$ {
+  /** @deprecated use `ViewsList$inboundSchema` instead. */
+  export const inboundSchema = ViewsList$inboundSchema;
+  /** @deprecated use `ViewsList$outboundSchema` instead. */
+  export const outboundSchema = ViewsList$outboundSchema;
+  /** @deprecated use `ViewsList$Outbound` instead. */
+  export type Outbound = ViewsList$Outbound;
+}
+
+export function viewsListToJSON(viewsList: ViewsList): string {
+  return JSON.stringify(ViewsList$outboundSchema.parse(viewsList));
+}
+
+export function viewsListFromJSON(
+  jsonString: string,
+): SafeParseResult<ViewsList, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ViewsList$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ViewsList' from JSON`,
+  );
+}

package/src/models/watermarkinput.ts

@@ -0,0 +1,268 @@
+import * as z from "zod";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Type of overlay (currently only supports 'watermark').
+ */
+export const WatermarkInputType = {
+  Watermark: "watermark",
+} as const;
+/**
+ * Type of overlay (currently only supports 'watermark').
+ */
+export type WatermarkInputType = ClosedEnum<typeof WatermarkInputType>;
+
+/**
+ * Horizontal alignment of the watermark.
+ */
+export const XAlign = {
+  Left: "left",
+  Center: "center",
+  Right: "right",
+} as const;
+/**
+ * Horizontal alignment of the watermark.
+ */
+export type XAlign = ClosedEnum<typeof XAlign>;
+
+/**
+ * Vertical alignment of the watermark.
+ */
+export const YAlign = {
+  Top: "top",
+  Middle: "middle",
+  Bottom: "bottom",
+} as const;
+/**
+ * Vertical alignment of the watermark.
+ */
+export type YAlign = ClosedEnum<typeof YAlign>;
+
+export type Placement = {
+  /**
+   * Horizontal alignment of the watermark.
+   */
+  xAlign?: XAlign | undefined;
+  /**
+   * Horizontal margin from the edge of the video.
+   */
+  xMargin?: string | undefined;
+  /**
+   * Vertical alignment of the watermark.
+   */
+  yAlign?: YAlign | undefined;
+  /**
+   * Vertical margin from the edge of the video.
+   */
+  yMargin?: string | undefined;
+};
+
+export type WatermarkInput = {
+  /**
+   * Type of overlay (currently only supports 'watermark').
+   */
+  type?: WatermarkInputType | undefined;
+  /**
+   * URL of the watermark image.
+   */
+  url?: string | undefined;
+  placement?: Placement | undefined;
+  /**
+   * Width of the watermark in percentage or pixels.
+   */
+  width?: string | undefined;
+  /**
+   * Height of the watermark in percentage or pixels.
+   */
+  height?: string | undefined;
+  /**
+   * Opacity of the watermark in percentage.
+   */
+  opacity?: string | undefined;
+};
+
+/** @internal */
+export const WatermarkInputType$inboundSchema: z.ZodNativeEnum<
+  typeof WatermarkInputType
+> = z.nativeEnum(WatermarkInputType);
+
+/** @internal */
+export const WatermarkInputType$outboundSchema: z.ZodNativeEnum<
+  typeof WatermarkInputType
+> = WatermarkInputType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WatermarkInputType$ {
+  /** @deprecated use `WatermarkInputType$inboundSchema` instead. */
+  export const inboundSchema = WatermarkInputType$inboundSchema;
+  /** @deprecated use `WatermarkInputType$outboundSchema` instead. */
+  export const outboundSchema = WatermarkInputType$outboundSchema;
+}
+
+/** @internal */
+export const XAlign$inboundSchema: z.ZodNativeEnum<typeof XAlign> = z
+  .nativeEnum(XAlign);
+
+/** @internal */
+export const XAlign$outboundSchema: z.ZodNativeEnum<typeof XAlign> =
+  XAlign$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace XAlign$ {
+  /** @deprecated use `XAlign$inboundSchema` instead. */
+  export const inboundSchema = XAlign$inboundSchema;
+  /** @deprecated use `XAlign$outboundSchema` instead. */
+  export const outboundSchema = XAlign$outboundSchema;
+}
+
+/** @internal */
+export const YAlign$inboundSchema: z.ZodNativeEnum<typeof YAlign> = z
+  .nativeEnum(YAlign);
+
+/** @internal */
+export const YAlign$outboundSchema: z.ZodNativeEnum<typeof YAlign> =
+  YAlign$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace YAlign$ {
+  /** @deprecated use `YAlign$inboundSchema` instead. */
+  export const inboundSchema = YAlign$inboundSchema;
+  /** @deprecated use `YAlign$outboundSchema` instead. */
+  export const outboundSchema = YAlign$outboundSchema;
+}
+
+/** @internal */
+export const Placement$inboundSchema: z.ZodType<
+  Placement,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  xAlign: XAlign$inboundSchema.optional(),
+  xMargin: z.string().optional(),
+  yAlign: YAlign$inboundSchema.optional(),
+  yMargin: z.string().optional(),
+});
+
+/** @internal */
+export type Placement$Outbound = {
+  xAlign?: string | undefined;
+  xMargin?: string | undefined;
+  yAlign?: string | undefined;
+  yMargin?: string | undefined;
+};
+
+/** @internal */
+export const Placement$outboundSchema: z.ZodType<
+  Placement$Outbound,
+  z.ZodTypeDef,
+  Placement
+> = z.object({
+  xAlign: XAlign$outboundSchema.optional(),
+  xMargin: z.string().optional(),
+  yAlign: YAlign$outboundSchema.optional(),
+  yMargin: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Placement$ {
+  /** @deprecated use `Placement$inboundSchema` instead. */
+  export const inboundSchema = Placement$inboundSchema;
+  /** @deprecated use `Placement$outboundSchema` instead. */
+  export const outboundSchema = Placement$outboundSchema;
+  /** @deprecated use `Placement$Outbound` instead. */
+  export type Outbound = Placement$Outbound;
+}
+
+export function placementToJSON(placement: Placement): string {
+  return JSON.stringify(Placement$outboundSchema.parse(placement));
+}
+
+export function placementFromJSON(
+  jsonString: string,
+): SafeParseResult<Placement, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Placement$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Placement' from JSON`,
+  );
+}
+
+/** @internal */
+export const WatermarkInput$inboundSchema: z.ZodType<
+  WatermarkInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: WatermarkInputType$inboundSchema.optional(),
+  url: z.string().optional(),
+  placement: z.lazy(() => Placement$inboundSchema).optional(),
+  width: z.string().optional(),
+  height: z.string().optional(),
+  opacity: z.string().optional(),
+});
+
+/** @internal */
+export type WatermarkInput$Outbound = {
+  type?: string | undefined;
+  url?: string | undefined;
+  placement?: Placement$Outbound | undefined;
+  width?: string | undefined;
+  height?: string | undefined;
+  opacity?: string | undefined;
+};
+
+/** @internal */
+export const WatermarkInput$outboundSchema: z.ZodType<
+  WatermarkInput$Outbound,
+  z.ZodTypeDef,
+  WatermarkInput
+> = z.object({
+  type: WatermarkInputType$outboundSchema.optional(),
+  url: z.string().optional(),
+  placement: z.lazy(() => Placement$outboundSchema).optional(),
+  width: z.string().optional(),
+  height: z.string().optional(),
+  opacity: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WatermarkInput$ {
+  /** @deprecated use `WatermarkInput$inboundSchema` instead. */
+  export const inboundSchema = WatermarkInput$inboundSchema;
+  /** @deprecated use `WatermarkInput$outboundSchema` instead. */
+  export const outboundSchema = WatermarkInput$outboundSchema;
+  /** @deprecated use `WatermarkInput$Outbound` instead. */
+  export type Outbound = WatermarkInput$Outbound;
+}
+
+export function watermarkInputToJSON(watermarkInput: WatermarkInput): string {
+  return JSON.stringify(WatermarkInput$outboundSchema.parse(watermarkInput));
+}
+
+export function watermarkInputFromJSON(
+  jsonString: string,
+): SafeParseResult<WatermarkInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WatermarkInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WatermarkInput' from JSON`,
+  );
+}

package/src/sdk/dimensions.ts

@@ -0,0 +1,51 @@
+import { dimensionsListDimensions } from "../funcs/dimensionsListDimensions.js";
+import { dimensionsListFilterValuesForDimension } from "../funcs/dimensionsListFilterValuesForDimension.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Dimensions extends ClientSDK {
+  /**
+   * List the dimensions
+   *
+   * @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.
+   *
+   * 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>
+   */
+  async listDimensions(
+    options?: RequestOptions,
+  ): Promise<operations.ListDimensionsResponse> {
+    return unwrapAsync(dimensionsListDimensions(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * List the filter values for a dimension
+   *
+   * @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.
+   *
+   * #### 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 (e.g., Desktop, Mobile, Tablet). This data will help the developer understand where optimizations or troubleshooting may be necessary.
+   *
+   * Related guide: <a href="https://docs.fastpix.io/docs/understand-dashboard-ui#filters-and-timeframes">Filters and timeframes</a>
+   */
+  async listFilterValuesForDimension(
+    request: operations.ListFilterValuesForDimensionRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListFilterValuesForDimensionResponse> {
+    return unwrapAsync(dimensionsListFilterValuesForDimension(
+      this,
+      request,
+      options,
+    ));
+  }
+}