@clientcasa/sdk 0.4.1 → 0.5.0

package/src/models/document-version.ts

@@ -0,0 +1,175 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export const DocumentType = {
+  SmartFile: "smart-file",
+  Invoice: "invoice",
+  StandaloneContract: "standalone-contract",
+} as const;
+export type DocumentType = OpenEnum<typeof DocumentType>;
+
+export type DocumentRef = {
+  relationTo: string;
+  value: string;
+};
+
+export const VersionStatus = {
+  Issued: "issued",
+  Superseded: "superseded",
+  Voided: "voided",
+} as const;
+export type VersionStatus = OpenEnum<typeof VersionStatus>;
+
+export const AcceptedBy = {
+  Client: "client",
+  Operator: "operator",
+  Signing: "signing",
+  Backfill: "backfill",
+} as const;
+export type AcceptedBy = OpenEnum<typeof AcceptedBy>;
+
+export type DocumentVersion = {
+  /**
+   * UUID v4
+   */
+  id: string;
+  documentType: DocumentType;
+  /**
+   * UUID v4
+   */
+  documentId: string | null;
+  documentRef: DocumentRef | null;
+  versionNumber: number;
+  subVersionNumber: number;
+  versionStatus: VersionStatus;
+  contentHash: string;
+  currency: string;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  issuedAt: Date | null;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  viewedAt: Date | null;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  acceptedAt: Date | null;
+  acceptedBy: AcceptedBy | null;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  supersededAt: Date | null;
+  /**
+   * UUID v4
+   */
+  supersededByVersionId: string | null;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  voidedAt: Date | null;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  quoteConvertedAt: Date | null;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  expiresAt: Date | null;
+  /**
+   * UUID v4
+   */
+  engagementProjectId: string | null;
+  /**
+   * UUID v4
+   */
+  parentVersionId: string | null;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  createdAt: Date;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const DocumentType$inboundSchema: z.ZodMiniType<DocumentType, unknown> =
+  openEnums.inboundSchema(DocumentType);
+
+/** @internal */
+export const DocumentRef$inboundSchema: z.ZodMiniType<DocumentRef, unknown> = z
+  .object({
+    relationTo: types.string(),
+    value: types.string(),
+  });
+
+export function documentRefFromJSON(
+  jsonString: string,
+): SafeParseResult<DocumentRef, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DocumentRef$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DocumentRef' from JSON`,
+  );
+}
+
+/** @internal */
+export const VersionStatus$inboundSchema: z.ZodMiniType<
+  VersionStatus,
+  unknown
+> = openEnums.inboundSchema(VersionStatus);
+
+/** @internal */
+export const AcceptedBy$inboundSchema: z.ZodMiniType<AcceptedBy, unknown> =
+  openEnums.inboundSchema(AcceptedBy);
+
+/** @internal */
+export const DocumentVersion$inboundSchema: z.ZodMiniType<
+  DocumentVersion,
+  unknown
+> = z.object({
+  id: types.string(),
+  documentType: DocumentType$inboundSchema,
+  documentId: types.nullable(types.string()),
+  documentRef: types.nullable(z.lazy(() => DocumentRef$inboundSchema)),
+  versionNumber: types.number(),
+  subVersionNumber: types.number(),
+  versionStatus: VersionStatus$inboundSchema,
+  contentHash: types.string(),
+  currency: types.string(),
+  issuedAt: types.nullable(types.date()),
+  viewedAt: types.nullable(types.date()),
+  acceptedAt: types.nullable(types.date()),
+  acceptedBy: types.nullable(AcceptedBy$inboundSchema),
+  supersededAt: types.nullable(types.date()),
+  supersededByVersionId: types.nullable(types.string()),
+  voidedAt: types.nullable(types.date()),
+  quoteConvertedAt: types.nullable(types.date()),
+  expiresAt: types.nullable(types.date()),
+  engagementProjectId: types.nullable(types.string()),
+  parentVersionId: types.nullable(types.string()),
+  createdAt: types.date(),
+  updatedAt: types.date(),
+});
+
+export function documentVersionFromJSON(
+  jsonString: string,
+): SafeParseResult<DocumentVersion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DocumentVersion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DocumentVersion' from JSON`,
+  );
+}

package/src/models/index.ts

@@ -15,6 +15,7 @@ export * from "./client-create.js";
 export * from "./client-document-list.js";
 export * from "./client-document.js";
 export * from "./client-list.js";
+export * from "./client-tax-settings.js";
 export * from "./client-update.js";
 export * from "./client.js";
 export * from "./contact-create.js";
@@ -25,6 +26,8 @@ export * from "./contract-create.js";
 export * from "./contract-list.js";
 export * from "./contract-update.js";
 export * from "./contract.js";
+export * from "./document-version-list.js";
+export * from "./document-version.js";
 export * from "./form-list.js";
 export * from "./form-submission-answer.js";
 export * from "./form-submission-list.js";

package/src/models/invoice.ts

@@ -53,6 +53,10 @@ export type Invoice = {
    * Derived (read-only): true when the invoice is past its due date with a balance still owing (status is sent or partial). Not a stored status.
    */
   overdue: boolean;
+  /**
+   * Read-only: the voided invoice this one was issued to correct (void & reissue). Null otherwise. To find the forward link — the corrected invoice that replaced a given one — list with `?supersedesInvoice={id}`.
+   */
+  supersedesInvoice: string | null;
   paymentTerms: string | null;
   notes: string | null;
   /**
@@ -95,6 +99,7 @@ export const Invoice$inboundSchema: z.ZodMiniType<Invoice, unknown> = z.object({
   amountPaid: types.number(),
   balanceDue: types.number(),
   overdue: types.boolean(),
+  supersedesInvoice: types.nullable(types.string()),
   paymentTerms: types.nullable(types.string()),
   notes: types.nullable(types.string()),
   paidAt: types.nullable(types.date()),

package/src/models/operations/get-document-version.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type GetDocumentVersionSecurity = {
+  apiKey?: string | undefined;
+  bearer?: string | undefined;
+};
+
+export type GetDocumentVersionRequest = {
+  /**
+   * UUID v4
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetDocumentVersionSecurity$Outbound = {
+  apiKey?: string | undefined;
+  bearer?: string | undefined;
+};
+
+/** @internal */
+export const GetDocumentVersionSecurity$outboundSchema: z.ZodMiniType<
+  GetDocumentVersionSecurity$Outbound,
+  GetDocumentVersionSecurity
+> = z.object({
+  apiKey: z.optional(z.string()),
+  bearer: z.optional(z.string()),
+});
+
+export function getDocumentVersionSecurityToJSON(
+  getDocumentVersionSecurity: GetDocumentVersionSecurity,
+): string {
+  return JSON.stringify(
+    GetDocumentVersionSecurity$outboundSchema.parse(getDocumentVersionSecurity),
+  );
+}
+
+/** @internal */
+export type GetDocumentVersionRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetDocumentVersionRequest$outboundSchema: z.ZodMiniType<
+  GetDocumentVersionRequest$Outbound,
+  GetDocumentVersionRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getDocumentVersionRequestToJSON(
+  getDocumentVersionRequest: GetDocumentVersionRequest,
+): string {
+  return JSON.stringify(
+    GetDocumentVersionRequest$outboundSchema.parse(getDocumentVersionRequest),
+  );
+}

package/src/models/operations/index.ts

@@ -31,6 +31,7 @@ export * from "./get-client-document.js";
 export * from "./get-client.js";
 export * from "./get-contact.js";
 export * from "./get-contract.js";
+export * from "./get-document-version.js";
 export * from "./get-form-submission.js";
 export * from "./get-form.js";
 export * from "./get-invoice.js";
@@ -47,6 +48,7 @@ export * from "./list-client-documents.js";
 export * from "./list-clients.js";
 export * from "./list-contacts.js";
 export * from "./list-contracts.js";
+export * from "./list-document-versions.js";
 export * from "./list-form-submissions.js";
 export * from "./list-forms.js";
 export * from "./list-invoices.js";

package/src/models/operations/list-document-versions.ts

@@ -0,0 +1,132 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
+import * as models from "../index.js";
+
+export type ListDocumentVersionsSecurity = {
+  apiKey?: string | undefined;
+  bearer?: string | undefined;
+};
+
+export const DocumentType = {
+  SmartFile: "smart-file",
+  Invoice: "invoice",
+  StandaloneContract: "standalone-contract",
+} as const;
+export type DocumentType = ClosedEnum<typeof DocumentType>;
+
+export type ListDocumentVersionsRequest = {
+  page?: number | undefined;
+  pageSize?: number | undefined;
+  documentType?: DocumentType | undefined;
+  /**
+   * Filter to a smart-file (client-document) id.
+   */
+  documentId?: string | undefined;
+  /**
+   * Filter to an invoice id.
+   */
+  invoiceId?: string | undefined;
+  /**
+   * Filter to a standalone-contract id.
+   */
+  contractId?: string | undefined;
+};
+
+export type ListDocumentVersionsResponse = {
+  result: models.DocumentVersionList;
+};
+
+/** @internal */
+export type ListDocumentVersionsSecurity$Outbound = {
+  apiKey?: string | undefined;
+  bearer?: string | undefined;
+};
+
+/** @internal */
+export const ListDocumentVersionsSecurity$outboundSchema: z.ZodMiniType<
+  ListDocumentVersionsSecurity$Outbound,
+  ListDocumentVersionsSecurity
+> = z.object({
+  apiKey: z.optional(z.string()),
+  bearer: z.optional(z.string()),
+});
+
+export function listDocumentVersionsSecurityToJSON(
+  listDocumentVersionsSecurity: ListDocumentVersionsSecurity,
+): string {
+  return JSON.stringify(
+    ListDocumentVersionsSecurity$outboundSchema.parse(
+      listDocumentVersionsSecurity,
+    ),
+  );
+}
+
+/** @internal */
+export const DocumentType$outboundSchema: z.ZodMiniEnum<typeof DocumentType> = z
+  .enum(DocumentType);
+
+/** @internal */
+export type ListDocumentVersionsRequest$Outbound = {
+  page: number;
+  pageSize: number;
+  documentType?: string | undefined;
+  documentId?: string | undefined;
+  invoiceId?: string | undefined;
+  contractId?: string | undefined;
+};
+
+/** @internal */
+export const ListDocumentVersionsRequest$outboundSchema: z.ZodMiniType<
+  ListDocumentVersionsRequest$Outbound,
+  ListDocumentVersionsRequest
+> = z.object({
+  page: z._default(z.int(), 1),
+  pageSize: z._default(z.int(), 25),
+  documentType: z.optional(DocumentType$outboundSchema),
+  documentId: z.optional(z.string()),
+  invoiceId: z.optional(z.string()),
+  contractId: z.optional(z.string()),
+});
+
+export function listDocumentVersionsRequestToJSON(
+  listDocumentVersionsRequest: ListDocumentVersionsRequest,
+): string {
+  return JSON.stringify(
+    ListDocumentVersionsRequest$outboundSchema.parse(
+      listDocumentVersionsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListDocumentVersionsResponse$inboundSchema: z.ZodMiniType<
+  ListDocumentVersionsResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    Result: models.DocumentVersionList$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "Result": "result",
+    });
+  }),
+);
+
+export function listDocumentVersionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDocumentVersionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDocumentVersionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDocumentVersionsResponse' from JSON`,
+  );
+}

package/src/models/operations/list-invoices.ts

@@ -48,6 +48,10 @@ export type ListInvoicesRequest = {
    * Filter by the derived overdue condition. `true` → sent/partial invoices past their due date; `false` → everything else. (Replaces the removed `status=overdue` filter.)
    */
   overdue?: Overdue | undefined;
+  /**
+   * Return the invoice that supersedes (replaces) the given invoice id — the forward void→reissue link.
+   */
+  supersedesInvoice?: string | undefined;
 };
 
 export type ListInvoicesResponse = {
@@ -94,6 +98,7 @@ export type ListInvoicesRequest$Outbound = {
   clientId?: string | undefined;
   status?: string | undefined;
   overdue?: string | undefined;
+  supersedesInvoice?: string | undefined;
 };
 
 /** @internal */
@@ -106,6 +111,7 @@ export const ListInvoicesRequest$outboundSchema: z.ZodMiniType<
   clientId: z.optional(z.string()),
   status: z.optional(ListInvoicesStatus$outboundSchema),
   overdue: z.optional(Overdue$outboundSchema),
+  supersedesInvoice: z.optional(z.string()),
 });
 
 export function listInvoicesRequestToJSON(

package/src/sdk/document-versions.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentVersionsGet } from "../funcs/document-versions-get.js";
+import { documentVersionsList } from "../funcs/document-versions-list.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class DocumentVersions extends ClientSDK {
+  /**
+   * List document versions
+   *
+   * @remarks
+   * Read-only audit trail of issued document versions across smart-files, invoices, and standalone contracts. Checkpoints (internal draft edit-history) are never returned. Frozen content and client access tokens are not exposed.
+   */
+  async list(
+    security: operations.ListDocumentVersionsSecurity,
+    request?: operations.ListDocumentVersionsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListDocumentVersionsResponse, { page: number }>
+  > {
+    return unwrapResultIterator(documentVersionsList(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a document version
+   */
+  async get(
+    security: operations.GetDocumentVersionSecurity,
+    request: operations.GetDocumentVersionRequest,
+    options?: RequestOptions,
+  ): Promise<models.DocumentVersion> {
+    return unwrapAsync(documentVersionsGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -8,6 +8,7 @@ import { CatalogItems } from "./catalog-items.js";
 import { Clients } from "./clients.js";
 import { Contacts } from "./contacts.js";
 import { Contracts } from "./contracts.js";
+import { DocumentVersions } from "./document-versions.js";
 import { FormSubmissions } from "./form-submissions.js";
 import { FormsAndAgreements } from "./forms-and-agreements.js";
 import { Forms } from "./forms.js";
@@ -51,6 +52,11 @@ export class ClientCasa extends ClientSDK {
     return (this._formsAndAgreements ??= new FormsAndAgreements(this._options));
   }
 
+  private _documentVersions?: DocumentVersions;
+  get documentVersions(): DocumentVersions {
+    return (this._documentVersions ??= new DocumentVersions(this._options));
+  }
+
   private _forms?: Forms;
   get forms(): Forms {
     return (this._forms ??= new Forms(this._options));