@fastpix/fastpix-node 2.0.2 → 2.0.4

package/src/funcs/viewsListTopContent.ts

@@ -0,0 +1,198 @@
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
+
+import * as z from "zod/v4-mini";
+import { FastpixCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { FastpixError } from "../models/errors/fastpixerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List by top content
+ *
+ * @remarks
+ * Retrieves a list of the top video views that fall within the specified filters and have been completed within a defined timespan. It lets you to identify the most popular content based on viewer interactions.
+ *
+ * #### How it works
+ *
+ *   1. Send a `GET` request to this endpoint with the desired query parameters.
+ *
+ *   2. Specify the timespan for which you want to retrieve the top content using the `timespan[]` parameter.
+ *
+ *   3. Filter the views based on dimensions such as browser, device, video title, etc., using the `filterby[]` parameter.
+ *
+ *   4. You can use `Limit` to control number of top views returned.
+ *
+ *   5. You receive a response containing the list of top video views matching the specified criteria.
+ *
+ *   Related guide: <a href="https://docs.fastpix.io/page/how-to-get-top-performing-content">Get top-performing content</a>
+ */
+export function viewsListTopContent(
+  client: FastpixCore,
+  request?: operations.ListByTopContentRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListByTopContentResponse,
+    | FastpixError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: FastpixCore,
+  request?: operations.ListByTopContentRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ListByTopContentResponse,
+      | FastpixError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        z.optional(operations.ListByTopContentRequest$outboundSchema),
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/data/viewlist/top-content")();
+
+  const query = encodeFormQuery({
+    "filterby[]": payload?.["filterby[]"],
+    "limit": payload?.limit,
+    "timespan[]": payload?.["timespan[]"],
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "list_by_top_content",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1000,
+          maxInterval: 10000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes
+      || ["408", "429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    operations.ListByTopContentResponse,
+    | FastpixError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListByTopContentResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+    M.json("default", operations.ListByTopContentResponse$inboundSchema),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/hooks/hooks.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 import { SDKOptions } from "../lib/config.js";
 import { RequestInput } from "../lib/http.js";
@@ -16,6 +20,8 @@ import {
   SDKInitHook,
 } from "./types.js";
 
+import { initHooks } from "./registration.js";
+
 export class SDKHooks implements Hooks {
   sdkInitHooks: SDKInitHook[] = [];
   beforeCreateRequestHooks: BeforeCreateRequestHook[] = [];
@@ -43,6 +49,7 @@ export class SDKHooks implements Hooks {
         this.registerAfterErrorHook(hook);
       }
     }
+    initHooks(this);
   }
 
   registerSDKInitHook(hook: SDKInitHook) {

package/src/hooks/index.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 export * from "./hooks.js";
 export * from "./types.js";

package/src/hooks/registration.ts

@@ -0,0 +1,14 @@
+import { Hooks } from "./types.js";
+
+/*
+ * This file is only ever generated once on the first generation and then is free to be modified.
+ * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them
+ * in this file or in separate files in the hooks folder.
+ */
+
+// @ts-expect-error remove this line when you add your first hook and hooks is used
+export function initHooks(hooks: Hooks) {
+  // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook
+  // with an instance of a hook that implements that specific Hook interface
+  // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance
+}

package/src/hooks/types.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 import { SDKOptions } from "../lib/config.js";
 import { RequestInput } from "../lib/http.js";

package/src/index.ts

@@ -1,3 +1,9 @@
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
+
 export * from "./lib/config.js";
 export * as files from "./lib/files.js";
 export { HTTPClient } from "./lib/http.js";

package/src/lib/base64.ts

@@ -1,6 +1,10 @@
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
-
-import * as z from "zod";
+import * as z from "zod/v4-mini";
 
 export function bytesToBase64(u8arr: Uint8Array): string {
   return btoa(String.fromCodePoint(...u8arr));
@@ -26,10 +30,12 @@ export function stringFromBase64(b64str: string): string {
   return stringFromBytes(bytesFromBase64(b64str));
 }
 
-export const zodOutbound = z
-  .instanceof(Uint8Array)
-  .or(z.string().transform(stringToBytes));
+export const zodOutbound = z.union([
+  z.custom<Uint8Array>(x => x instanceof Uint8Array),
+  z.pipe(z.string(), z.transform(stringToBytes)),
+]);
 
-export const zodInbound = z
-  .instanceof(Uint8Array)
-  .or(z.string().transform(bytesFromBase64));
+export const zodInbound = z.union([
+  z.custom<Uint8Array>(x => x instanceof Uint8Array),
+  z.pipe(z.string(), z.transform(bytesFromBase64)),
+]);

package/src/lib/config.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 import * as models from "../models/index.js";
 import { HTTPClient } from "./http.js";
@@ -63,8 +67,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "2.0.0",
-  genVersion: "2.714.0",
+  sdkVersion: "2.0.4",
+  genVersion: "2.781.2",
   userAgent:
-    "@fastpix/fastpix-node",
+    "fastpix-sdk/typescript 2.0.4 2.781.2 1.0.0 @fastpix/fastpix-node",
 } as const;

package/src/lib/dlv.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 /*
 MIT License

package/src/lib/encodings.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 import { bytesToBase64 } from "./base64.js";
 import { isPlainObject } from "./is-plain-object.js";
@@ -100,8 +104,9 @@ export function encodeLabel(
       });
       encValue = mapped?.join("").slice(1);
     } else {
-      const k =
-        options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : "";
+      const k = options?.explode && isPlainObject(value)
+        ? `${encodeString(pk)}=`
+        : "";
       encValue = `${k}${encodeValue(pv)}`;
     }
 
@@ -424,6 +429,7 @@ export function queryJoin(...args: (string | undefined)[]): string {
 type QueryEncoderOptions = {
   explode?: boolean;
   charEncoding?: "percent" | "none";
+  allowEmptyValue?: string[];
 };
 
 type QueryEncoder = (
@@ -438,7 +444,7 @@ type BulkQueryEncoder = (
 ) => string;
 
 export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
-  const bulkEncode = function (
+  const bulkEncode = function(
     values: Record<string, unknown>,
     options?: QueryEncoderOptions,
   ): string {
@@ -448,7 +454,19 @@ export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
       charEncoding: options?.charEncoding ?? "percent",
     };
 
+    const allowEmptySet = new Set(options?.allowEmptyValue ?? []);
+
     const encoded = Object.entries(values).map(([key, value]) => {
+      if (allowEmptySet.has(key)) {
+        if (
+          value === undefined
+          || value === null
+          || value === ""
+          || (Array.isArray(value) && value.length === 0)
+        ) {
+          return `${encodeURIComponent(key)}=`;
+        }
+      }
       return f(key, value, opts);
     });
     return queryJoin(...encoded);
@@ -475,6 +493,10 @@ export function appendForm(
     fd.append(key, value, fileName);
   } else if (value instanceof Blob) {
     fd.append(key, value);
+  } else if (Array.isArray(value)) {
+    value.forEach((v) => {
+      appendForm(fd, key, v);
+    });
   } else {
     fd.append(key, String(value));
   }

package/src/lib/env.ts

@@ -1,9 +1,12 @@
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
-
+import * as z from "zod/v4-mini";
 import { dlv } from "./dlv.js";
 
-import * as z from "zod";
-
 export interface Env {
   FASTPIX_USERNAME?: string | undefined;
   FASTPIX_PASSWORD?: string | undefined;
@@ -11,13 +14,25 @@ export interface Env {
   FASTPIX_DEBUG?: boolean | undefined;
 }
 
-export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
-  FASTPIX_USERNAME: z.string().optional(),
-  FASTPIX_PASSWORD: z.string().optional(),
+export const envSchema: z.ZodMiniType<Env, unknown> = z.object({
+  FASTPIX_USERNAME: z.optional(z.string()),
+  FASTPIX_PASSWORD: z.optional(z.string()),
 
-  FASTPIX_DEBUG: z.coerce.boolean().optional(),
+  FASTPIX_DEBUG: z.optional(z.coerce.boolean()),
 });
 
+/**
+ * Checks for the existence of the Deno global object to determine the environment.
+ * @returns {boolean} True if the runtime is Deno, false otherwise.
+ */
+function isDeno() {
+  if ("Deno" in globalThis) {
+    return true;
+  }
+
+  return false;
+}
+
 let envMemo: Env | undefined = undefined;
 /**
  * Reads and validates environment variables.
@@ -27,9 +42,14 @@ export function env(): Env {
     return envMemo;
   }
 
-  envMemo = envSchema.parse(
-    dlv(globalThis, "process.env") ?? dlv(globalThis, "Deno.env") ?? {},
-  );
+  let envObject: Record<string, unknown> = {};
+  if (isDeno()) {
+    envObject = (globalThis as any).Deno?.env?.toObject?.() ?? {};
+  } else {
+    envObject = dlv(globalThis, "process.env") ?? {};
+  }
+
+  envMemo = envSchema.parse(envObject);
   return envMemo;
 }
 

package/src/lib/files.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 /**
  * Consumes a stream and returns a concatenated array buffer. Useful in

package/src/lib/http.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 export type Fetcher = (
   input: RequestInfo | URL,

package/src/lib/is-plain-object.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 /*
 MIT License

package/src/lib/logger.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 export interface Logger {
   group(label?: string): void;

package/src/lib/matchers.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 import { FastpixDefaultError } from "../models/errors/fastpixdefaulterror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";

package/src/lib/primitives.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 class InvariantError extends Error {
   constructor(message: string) {

package/src/lib/retries.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 import { isConnectionError, isTimeoutError } from "./http.js";
 

package/src/lib/schemas.ts

@@ -1,13 +1,10 @@
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
-
-import {
-  output,
-  ZodEffects,
-  ZodError,
-  ZodObject,
-  ZodRawShape,
-  ZodTypeAny,
-} from "zod";
+import * as z from "zod/v4-mini";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { ERR, OK, Result } from "../types/fp.js";
 
@@ -24,7 +21,7 @@ export function parse<Inp, Out>(
   try {
     return fn(rawValue);
   } catch (err) {
-    if (err instanceof ZodError) {
+    if (err instanceof z.core.$ZodError) {
       throw new SDKValidationError(errorMessage, err, rawValue);
     }
     throw err;
@@ -49,41 +46,51 @@ export function safeParse<Inp, Out>(
 }
 
 export function collectExtraKeys<
-  Shape extends ZodRawShape,
-  Catchall extends ZodTypeAny,
+  Shape extends z.core.$ZodShape,
+  Catchall extends z.ZodMiniType,
   K extends string,
+  Optional extends boolean,
 >(
-  obj: ZodObject<Shape, "strip", Catchall>,
+  obj: z.ZodMiniObject<Shape, z.core.$catchall<Catchall>>,
   extrasKey: K,
-  optional: boolean,
-): ZodEffects<
-  typeof obj,
-  & output<ZodObject<Shape, "strict">>
-  & {
-    [k in K]: Record<string, output<Catchall>>;
-  }
-> {
-  return obj.transform((val) => {
-    const extras: Record<string, output<Catchall>> = {};
-    const { shape } = obj;
-    for (const [key] of Object.entries(val)) {
-      if (key in shape) {
-        continue;
+  optional: Optional,
+): z.ZodMiniPipe<
+  z.ZodMiniObject<Shape, z.core.$catchall<Catchall>>,
+  z.ZodMiniTransform<
+    & z.output<z.ZodMiniObject<Shape, z.core.$strip>>
+    & (Optional extends false ? {
+        [k in K]: Record<string, z.output<Catchall>>;
       }
+      : {
+        [k in K]?: Record<string, z.output<Catchall>> | undefined;
+      }),
+    z.output<z.ZodMiniObject<Shape, z.core.$catchall<Catchall>>>
+  >
+> {
+  return z.pipe(
+    obj,
+    z.transform((val: any) => {
+      const extras: Record<string, z.output<Catchall>> = {};
+      const { shape } = obj;
+      for (const [key] of Object.entries(val)) {
+        if (key in shape) {
+          continue;
+        }
 
-      const v = val[key];
-      if (typeof v === "undefined") {
-        continue;
-      }
+        const v = val[key];
+        if (typeof v === "undefined") {
+          continue;
+        }
 
-      extras[key] = v;
-      delete val[key];
-    }
+        extras[key] = v;
+        delete val[key];
+      }
 
-    if (optional && Object.keys(extras).length === 0) {
-      return val;
-    }
+      if (optional && Object.keys(extras).length === 0) {
+        return val;
+      }
 
-    return { ...val, [extrasKey]: extras };
-  });
+      return { ...val, [extrasKey]: extras };
+    }),
+  );
 }

package/src/lib/sdks.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 import { SDKHooks } from "../hooks/hooks.js";
 import { HookContext } from "../hooks/types.js";

package/src/lib/security.ts

@@ -1,4 +1,8 @@
-
+/*
+* This file is auto-generated.
+ * Do not edit this file manually.
+ * Your changes will be overwritten during the next generation.
+ */
 
 import * as models from "../models/index.js";
 import { env } from "./env.js";