@clientcasa/sdk 0.4.0 → 0.5.0

package/src/models/client-update.ts

@@ -4,6 +4,11 @@
 
 import * as z from "zod/v4-mini";
 import { ClosedEnum } from "../types/enums.js";
+import {
+  ClientTaxSettings,
+  ClientTaxSettings$Outbound,
+  ClientTaxSettings$outboundSchema,
+} from "./client-tax-settings.js";
 
 export const ClientUpdateStatus = {
   New: "new",
@@ -20,6 +25,8 @@ export type ClientUpdate = {
   name?: string | undefined;
   status?: ClientUpdateStatus | undefined;
   notes?: string | undefined;
+  taxSettings?: ClientTaxSettings | undefined;
+  invoiceRemindersEnabled?: boolean | undefined;
 };
 
 /** @internal */
@@ -32,6 +39,8 @@ export type ClientUpdate$Outbound = {
   name?: string | undefined;
   status: string;
   notes?: string | undefined;
+  taxSettings?: ClientTaxSettings$Outbound | undefined;
+  invoiceRemindersEnabled?: boolean | undefined;
 };
 
 /** @internal */
@@ -42,6 +51,8 @@ export const ClientUpdate$outboundSchema: z.ZodMiniType<
   name: z.optional(z.string()),
   status: z._default(ClientUpdateStatus$outboundSchema, "active"),
   notes: z.optional(z.string()),
+  taxSettings: z.optional(ClientTaxSettings$outboundSchema),
+  invoiceRemindersEnabled: z.optional(z.boolean()),
 });
 
 export function clientUpdateToJSON(clientUpdate: ClientUpdate): string {

package/src/models/client.ts

@@ -8,6 +8,10 @@ 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 {
+  ClientTaxSettings,
+  ClientTaxSettings$inboundSchema,
+} from "./client-tax-settings.js";
 import { SDKValidationError } from "./errors/sdk-validation-error.js";
 
 export const ClientStatus = {
@@ -21,6 +25,20 @@ export const ClientStatus = {
 } as const;
 export type ClientStatus = OpenEnum<typeof ClientStatus>;
 
+export const RecurringBillingStatus = {
+  Active: "active",
+  PastDue: "past_due",
+  Paused: "paused",
+  Suspended: "suspended",
+  PendingSetup: "pending_setup",
+} as const;
+export type RecurringBillingStatus = OpenEnum<typeof RecurringBillingStatus>;
+
+export type RecurringBilling = {
+  status: RecurringBillingStatus;
+  nextBillingDate: Date | null;
+};
+
 export type Client = {
   /**
    * UUID v4
@@ -29,6 +47,13 @@ export type Client = {
   name: string;
   status: ClientStatus;
   notes: string | null;
+  taxSettings: ClientTaxSettings;
+  invoiceRemindersEnabled: boolean;
+  recurringBilling: RecurringBilling | null;
+  /**
+   * UUID v4
+   */
+  sourceSubmissionId: string | null;
   /**
    * ISO 8601 timestamp (UTC)
    */
@@ -43,12 +68,43 @@ export type Client = {
 export const ClientStatus$inboundSchema: z.ZodMiniType<ClientStatus, unknown> =
   openEnums.inboundSchema(ClientStatus);
 
+/** @internal */
+export const RecurringBillingStatus$inboundSchema: z.ZodMiniType<
+  RecurringBillingStatus,
+  unknown
+> = openEnums.inboundSchema(RecurringBillingStatus);
+
+/** @internal */
+export const RecurringBilling$inboundSchema: z.ZodMiniType<
+  RecurringBilling,
+  unknown
+> = z.object({
+  status: RecurringBillingStatus$inboundSchema,
+  nextBillingDate: types.nullable(types.date()),
+});
+
+export function recurringBillingFromJSON(
+  jsonString: string,
+): SafeParseResult<RecurringBilling, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RecurringBilling$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RecurringBilling' from JSON`,
+  );
+}
+
 /** @internal */
 export const Client$inboundSchema: z.ZodMiniType<Client, unknown> = z.object({
   id: types.string(),
   name: types.string(),
   status: ClientStatus$inboundSchema,
   notes: types.nullable(types.string()),
+  taxSettings: ClientTaxSettings$inboundSchema,
+  invoiceRemindersEnabled: types.boolean(),
+  recurringBilling: types.nullable(
+    z.lazy(() => RecurringBilling$inboundSchema),
+  ),
+  sourceSubmissionId: types.nullable(types.string()),
   createdAt: types.date(),
   updatedAt: types.date(),
 });

package/src/models/document-version-list.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 {
+  DocumentVersion,
+  DocumentVersion$inboundSchema,
+} from "./document-version.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import {
+  PaginationMeta,
+  PaginationMeta$inboundSchema,
+} from "./pagination-meta.js";
+
+export type DocumentVersionList = {
+  data: Array<DocumentVersion>;
+  pagination: PaginationMeta;
+};
+
+/** @internal */
+export const DocumentVersionList$inboundSchema: z.ZodMiniType<
+  DocumentVersionList,
+  unknown
+> = z.object({
+  data: z.array(DocumentVersion$inboundSchema),
+  pagination: PaginationMeta$inboundSchema,
+});
+
+export function documentVersionListFromJSON(
+  jsonString: string,
+): SafeParseResult<DocumentVersionList, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DocumentVersionList$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DocumentVersionList' from JSON`,
+  );
+}

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

@@ -19,7 +19,6 @@ export const InvoiceStatus = {
   Sent: "sent",
   Partial: "partial",
   Paid: "paid",
-  Overdue: "overdue",
   Void: "void",
 } as const;
 export type InvoiceStatus = OpenEnum<typeof InvoiceStatus>;
@@ -50,6 +49,14 @@ export type Invoice = {
   total: number;
   amountPaid: number;
   balanceDue: number;
+  /**
+   * 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;
   /**
@@ -91,6 +98,8 @@ export const Invoice$inboundSchema: z.ZodMiniType<Invoice, unknown> = z.object({
   total: types.number(),
   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

@@ -20,11 +20,22 @@ export const ListInvoicesStatus = {
   Sent: "sent",
   Partial: "partial",
   Paid: "paid",
-  Overdue: "overdue",
   Void: "void",
 } as const;
 export type ListInvoicesStatus = ClosedEnum<typeof ListInvoicesStatus>;
 
+/**
+ * Filter by the derived overdue condition. `true` → sent/partial invoices past their due date; `false` → everything else. (Replaces the removed `status=overdue` filter.)
+ */
+export const Overdue = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * Filter by the derived overdue condition. `true` → sent/partial invoices past their due date; `false` → everything else. (Replaces the removed `status=overdue` filter.)
+ */
+export type Overdue = ClosedEnum<typeof Overdue>;
+
 export type ListInvoicesRequest = {
   page?: number | undefined;
   pageSize?: number | undefined;
@@ -33,6 +44,14 @@ export type ListInvoicesRequest = {
    */
   clientId?: string | undefined;
   status?: ListInvoicesStatus | undefined;
+  /**
+   * 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 = {
@@ -67,12 +86,19 @@ export const ListInvoicesStatus$outboundSchema: z.ZodMiniEnum<
   typeof ListInvoicesStatus
 > = z.enum(ListInvoicesStatus);
 
+/** @internal */
+export const Overdue$outboundSchema: z.ZodMiniEnum<typeof Overdue> = z.enum(
+  Overdue,
+);
+
 /** @internal */
 export type ListInvoicesRequest$Outbound = {
   page: number;
   pageSize: number;
   clientId?: string | undefined;
   status?: string | undefined;
+  overdue?: string | undefined;
+  supersedesInvoice?: string | undefined;
 };
 
 /** @internal */
@@ -84,6 +110,8 @@ export const ListInvoicesRequest$outboundSchema: z.ZodMiniType<
   pageSize: z._default(z.int(), 25),
   clientId: z.optional(z.string()),
   status: z.optional(ListInvoicesStatus$outboundSchema),
+  overdue: z.optional(Overdue$outboundSchema),
+  supersedesInvoice: z.optional(z.string()),
 });
 
 export function listInvoicesRequestToJSON(