@factify/sdk 0.3.6

package/src/models/components/updatedocumentresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Document, Document$inboundSchema } from "./document.js";
+
+/**
+ * UpdateDocumentResponse contains the updated document.
+ */
+export type UpdateDocumentResponse = {
+  /**
+   * Document represents a Factify document.
+   */
+  document?: Document | undefined;
+};
+
+/** @internal */
+export const UpdateDocumentResponse$inboundSchema: z.ZodMiniType<
+  UpdateDocumentResponse,
+  unknown
+> = z.object({
+  document: types.optional(Document$inboundSchema),
+});
+
+export function updateDocumentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateDocumentResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateDocumentResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateDocumentResponse' from JSON`,
+  );
+}

package/src/models/components/user.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { UserType, UserType$inboundSchema } from "./usertype.js";
+
+/**
+ * User represents a user or service account.
+ */
+export type User = {
+  /**
+   * Unique ID for the user or service account.
+   *
+   * @remarks
+   *  Pattern: user_[0-9a-hjkmnp-tv-z]{26} for users, svc_[0-9a-hjkmnp-tv-z]{26} for service accounts
+   */
+  id: string;
+  /**
+   * Display name of the user or service account.
+   */
+  name: string;
+  type: UserType;
+};
+
+/** @internal */
+export const User$inboundSchema: z.ZodMiniType<User, unknown> = z.object({
+  id: types.string(),
+  name: types.string(),
+  type: UserType$inboundSchema,
+});
+
+export function userFromJSON(
+  jsonString: string,
+): SafeParseResult<User, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => User$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'User' from JSON`,
+  );
+}

package/src/models/components/usertype.ts

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const UserType = {
+  UserAccount: "user_account",
+  ServiceAccount: "service_account",
+} as const;
+export type UserType = OpenEnum<typeof UserType>;
+
+/** @internal */
+export const UserType$inboundSchema: z.ZodMiniType<UserType, unknown> =
+  openEnums.inboundSchema(UserType);

package/src/models/components/version.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ProcessingStatus,
+  ProcessingStatus$inboundSchema,
+} from "./processingstatus.js";
+import { User, User$inboundSchema } from "./user.js";
+
+/**
+ * Version represents a document version.
+ */
+export type Version = {
+  /**
+   * Timestamp when version was created.
+   */
+  createdAt: Date;
+  /**
+   * User represents a user or service account.
+   */
+  createdBy: User;
+  /**
+   * Description of changes in this version.
+   */
+  description?: string | null | undefined;
+  /**
+   * Parent document ID.
+   *
+   * @remarks
+   *  Pattern: doc_[0-9a-hjkmnp-tv-z]{26}
+   */
+  documentId: string;
+  /**
+   * Unique ID for the version.
+   *
+   * @remarks
+   *  Pattern: ver_[0-9a-hjkmnp-tv-z]{26}
+   */
+  id: string;
+  processingStatus: ProcessingStatus;
+  /**
+   * Optional version title.
+   */
+  title?: string | null | undefined;
+  /**
+   * URL for accessing this version on Factify.
+   */
+  url: string;
+};
+
+/** @internal */
+export const Version$inboundSchema: z.ZodMiniType<Version, unknown> = z.pipe(
+  z.object({
+    created_at: types.date(),
+    created_by: User$inboundSchema,
+    description: z.optional(z.nullable(types.string())),
+    document_id: types.string(),
+    id: types.string(),
+    processing_status: ProcessingStatus$inboundSchema,
+    title: z.optional(z.nullable(types.string())),
+    url: types.string(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "created_by": "createdBy",
+      "document_id": "documentId",
+      "processing_status": "processingStatus",
+    });
+  }),
+);
+
+export function versionFromJSON(
+  jsonString: string,
+): SafeParseResult<Version, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Version$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Version' from JSON`,
+  );
+}

package/src/models/components/versionref.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * VersionRef is a lightweight reference to a version.
+ */
+export type VersionRef = {
+  /**
+   * Version ID.
+   *
+   * @remarks
+   *  Pattern: ver_[0-9a-hjkmnp-tv-z]{26}
+   */
+  id: string;
+};
+
+/** @internal */
+export const VersionRef$inboundSchema: z.ZodMiniType<VersionRef, unknown> = z
+  .object({
+    id: types.string(),
+  });
+
+export function versionRefFromJSON(
+  jsonString: string,
+): SafeParseResult<VersionRef, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VersionRef$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VersionRef' from JSON`,
+  );
+}

package/src/models/errors/error.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+import { FactifyError } from "./factifyerror.js";
+
+/**
+ * Invalid request parameters
+ */
+export type ErrorTData = {
+  error: components.ErrorT;
+  httpMeta: components.HTTPMetadata;
+};
+
+/**
+ * Invalid request parameters
+ */
+export class ErrorT extends FactifyError {
+  error: components.ErrorT;
+
+  /** The original data that was passed to this error instance. */
+  data$: ErrorTData;
+
+  constructor(
+    err: ErrorTData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "ErrorT";
+  }
+}
+
+/** @internal */
+export const ErrorT$inboundSchema: z.ZodMiniType<ErrorT, unknown> = z.pipe(
+  z.object({
+    error: z.lazy(() => components.ErrorT$inboundSchema),
+    HttpMeta: components.HTTPMetadata$inboundSchema,
+    request$: z.custom<Request>(x => x instanceof Request),
+    response$: z.custom<Response>(x => x instanceof Response),
+    body$: z.string(),
+  }),
+  z.transform((v) => {
+    const remapped = remap$(v, {
+      "HttpMeta": "httpMeta",
+    });
+
+    return new ErrorT(remapped, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  }),
+);

package/src/models/errors/factifydefaulterror.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { FactifyError } from "./factifyerror.js";
+
+/** The fallback error class if no more specific error class is matched */
+export class FactifyDefaultError extends FactifyError {
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : ". ";
+    let bodyDisplay = body;
+    if (body.length > 10000) {
+      const truncated = body.substring(0, 10000);
+      const remaining = body.length - 10000;
+      bodyDisplay = `${truncated}...and ${remaining} more chars`;
+    }
+    message += `Body: ${bodyDisplay}`;
+    message = message.trim();
+    super(message, httpMeta);
+    this.name = "FactifyDefaultError";
+  }
+}

package/src/models/errors/factifyerror.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class FactifyError extends Error {
+  /** HTTP meta data */
+  public readonly httpMeta: {
+    response: Response;
+    request: Request;
+    body: string;
+  };
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.httpMeta = httpMeta;
+
+    this.name = "FactifyError";
+  }
+}

package/src/models/errors/httpclienterrors.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Base class for all HTTP errors.
+ */
+export class HTTPClientError extends Error {
+  /** The underlying cause of the error. */
+  override readonly cause: unknown;
+  override name = "HTTPClientError";
+  constructor(message: string, opts?: { cause?: unknown }) {
+    let msg = message;
+    if (opts?.cause) {
+      msg += `: ${opts.cause}`;
+    }
+
+    super(msg, opts);
+    // In older runtimes, the cause field would not have been assigned through
+    // the super() call.
+    if (typeof this.cause === "undefined") {
+      this.cause = opts?.cause;
+    }
+  }
+}
+
+/**
+ * An error to capture unrecognised or unexpected errors when making HTTP calls.
+ */
+export class UnexpectedClientError extends HTTPClientError {
+  override name = "UnexpectedClientError";
+}
+
+/**
+ * An error that is raised when any inputs used to create a request are invalid.
+ */
+export class InvalidRequestError extends HTTPClientError {
+  override name = "InvalidRequestError";
+}
+
+/**
+ * An error that is raised when a HTTP request was aborted by the client error.
+ */
+export class RequestAbortedError extends HTTPClientError {
+  override readonly name = "RequestAbortedError";
+}
+
+/**
+ * An error that is raised when a HTTP request timed out due to an AbortSignal
+ * signal timeout.
+ */
+export class RequestTimeoutError extends HTTPClientError {
+  override readonly name = "RequestTimeoutError";
+}
+
+/**
+ * An error that is raised when a HTTP client is unable to make a request to
+ * a server.
+ */
+export class ConnectionError extends HTTPClientError {
+  override readonly name = "ConnectionError";
+}

package/src/models/errors/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./error.js";
+export * from "./factifydefaulterror.js";
+export * from "./factifyerror.js";
+export * from "./httpclienterrors.js";
+export * from "./responsevalidationerror.js";
+export * from "./sdkvalidationerror.js";

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4/core";
+import { FactifyError } from "./factifyerror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends FactifyError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.$ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4/core";
+
+export class SDKValidationError extends Error {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
+  constructor(message: string, cause: unknown, rawValue: unknown) {
+    super(`${message}: ${cause}`);
+    this.name = "SDKValidationError";
+    this.cause = cause;
+    this.rawValue = rawValue;
+    this.rawMessage = message;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.$ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}
+
+export function formatZodError(err: z.$ZodError): string {
+  return z.prettifyError(err);
+}

package/src/models/operations/attachdocumentpolicy.ts

@@ -0,0 +1,133 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * AttachPolicyRequest specifies a policy to attach to a document.
+ */
+export type AttachPolicyRequest = {
+  /**
+   * Policy ID to attach.
+   *
+   * @remarks
+   *  Pattern: pol_[0-9a-hjkmnp-tv-z]{26}
+   */
+  policyId: string;
+};
+
+export type AttachDocumentPolicyRequest = {
+  /**
+   * Document ID.
+   *
+   * @remarks
+   *  Pattern: doc_[0-9a-hjkmnp-tv-z]{26}
+   */
+  documentId: string;
+  body: AttachPolicyRequest;
+};
+
+export type AttachDocumentPolicyResponse = {
+  httpMeta: components.HTTPMetadata;
+  /**
+   * Success
+   */
+  documentPolicy?: components.DocumentPolicy | undefined;
+  headers: { [k: string]: Array<string> };
+};
+
+/** @internal */
+export type AttachPolicyRequest$Outbound = {
+  policy_id: string;
+};
+
+/** @internal */
+export const AttachPolicyRequest$outboundSchema: z.ZodMiniType<
+  AttachPolicyRequest$Outbound,
+  AttachPolicyRequest
+> = z.pipe(
+  z.object({
+    policyId: z.string(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      policyId: "policy_id",
+    });
+  }),
+);
+
+export function attachPolicyRequestToJSON(
+  attachPolicyRequest: AttachPolicyRequest,
+): string {
+  return JSON.stringify(
+    AttachPolicyRequest$outboundSchema.parse(attachPolicyRequest),
+  );
+}
+
+/** @internal */
+export type AttachDocumentPolicyRequest$Outbound = {
+  document_id: string;
+  body: AttachPolicyRequest$Outbound;
+};
+
+/** @internal */
+export const AttachDocumentPolicyRequest$outboundSchema: z.ZodMiniType<
+  AttachDocumentPolicyRequest$Outbound,
+  AttachDocumentPolicyRequest
+> = z.pipe(
+  z.object({
+    documentId: z.string(),
+    body: z.lazy(() => AttachPolicyRequest$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      documentId: "document_id",
+    });
+  }),
+);
+
+export function attachDocumentPolicyRequestToJSON(
+  attachDocumentPolicyRequest: AttachDocumentPolicyRequest,
+): string {
+  return JSON.stringify(
+    AttachDocumentPolicyRequest$outboundSchema.parse(
+      attachDocumentPolicyRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const AttachDocumentPolicyResponse$inboundSchema: z.ZodMiniType<
+  AttachDocumentPolicyResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    HttpMeta: components.HTTPMetadata$inboundSchema,
+    DocumentPolicy: types.optional(components.DocumentPolicy$inboundSchema),
+    Headers: z._default(z.record(z.string(), z.array(z.string())), {}),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "HttpMeta": "httpMeta",
+      "DocumentPolicy": "documentPolicy",
+      "Headers": "headers",
+    });
+  }),
+);
+
+export function attachDocumentPolicyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AttachDocumentPolicyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AttachDocumentPolicyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AttachDocumentPolicyResponse' from JSON`,
+  );
+}