@clientcasa/sdk 0.4.1 → 0.5.0

package/src/funcs/document-versions-list.ts

@@ -0,0 +1,284 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { ClientCasaCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 { resolveSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { ClientCasaError } from "../models/errors/client-casa-error.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * 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.
+ */
+export function documentVersionsList(
+  client: ClientCasaCore,
+  security: operations.ListDocumentVersionsSecurity,
+  request?: operations.ListDocumentVersionsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListDocumentVersionsResponse,
+      | errors.ApiError
+      | ClientCasaError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { page: number }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    security,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ClientCasaCore,
+  security: operations.ListDocumentVersionsSecurity,
+  request?: operations.ListDocumentVersionsRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListDocumentVersionsResponse,
+        | errors.ApiError
+        | ClientCasaError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        z.optional(operations.ListDocumentVersionsRequest$outboundSchema),
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/api/v1/document-versions")();
+
+  const query = encodeFormQuery({
+    "contractId": payload?.contractId,
+    "documentId": payload?.documentId,
+    "documentType": payload?.documentType,
+    "invoiceId": payload?.invoiceId,
+    "page": payload?.page,
+    "pageSize": payload?.pageSize,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const requestSecurity = resolveSecurity(
+    [
+      {
+        fieldName: "x-api-key",
+        type: "apiKey:header",
+        value: security?.apiKey,
+      },
+    ],
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.bearer,
+      },
+    ],
+  );
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listDocumentVersions",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 30000,
+          exponent: 1.5,
+          maxElapsedTime: 30000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "5XX"],
+  };
+
+  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 [haltIterator(requestRes), { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.ListDocumentVersionsResponse,
+    | errors.ApiError
+    | ClientCasaError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListDocumentVersionsResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr([400, 401, 403, 429], errors.ApiError$inboundSchema),
+    M.jsonErr(500, errors.ApiError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.ListDocumentVersionsResponse,
+        | errors.ApiError
+        | ClientCasaError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { page: number };
+  } => {
+    const page = request?.page ?? 1;
+    const nextPage = page + 1;
+
+    if (!responseData) {
+      return { next: () => null };
+    }
+    const results = dlv(responseData, "data");
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.pageSize ?? 25;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      documentVersionsList(
+        client,
+        security,
+        {
+          ...request!,
+          page: nextPage,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { page: nextPage } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}

package/src/funcs/invoices-list.ts

@@ -112,6 +112,7 @@ async function $do(
     "page": payload?.page,
     "pageSize": payload?.pageSize,
     "status": payload?.status,
+    "supersedesInvoice": payload?.supersedesInvoice,
   });
 
   const headers = new Headers(compactMap({

package/src/lib/config.ts

@@ -61,7 +61,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.4.1",
-  genVersion: "2.900.0",
-  userAgent: "speakeasy-sdk/typescript 0.4.1 2.900.0 1.0.0 @clientcasa/sdk",
+  sdkVersion: "0.5.0",
+  genVersion: "2.900.1",
+  userAgent: "speakeasy-sdk/typescript 0.5.0 2.900.1 1.0.0 @clientcasa/sdk",
 } as const;

package/src/lib/sdks.ts

@@ -132,27 +132,55 @@ export class ClientSDK {
     if (path) {
       baseURL.pathname = baseURL.pathname.replace(/\/+$/, "") + "/";
       reqURL = new URL(path, baseURL);
+      if (!reqURL.search && baseURL.search) {
+        reqURL.search = baseURL.search;
+      }
     } else {
       reqURL = baseURL;
     }
     reqURL.hash = "";
 
-    let finalQuery = query || "";
-
-    const secQuery: string[] = [];
-    for (const [k, v] of Object.entries(security?.queryParams || {})) {
-      const q = encodeForm(k, v, { charEncoding: "percent" });
-      if (typeof q !== "undefined") {
-        secQuery.push(q);
+    // Appends already-encoded query pairs to a query string, replacing any
+    // existing pairs with the same key so later sources take precedence.
+    const mergeQuery = (current: string, additions: string): string => {
+      if (!additions) {
+        return current;
       }
-    }
-    if (secQuery.length) {
-      finalQuery += `&${secQuery.join("&")}`;
-    }
+      const additionKeys = new Set(
+        additions
+          .split("&")
+          .filter((pair) => pair !== "")
+          .map((pair) => pair.split("=")[0] ?? ""),
+      );
+      const kept = current.split("&").filter((pair) => {
+        return pair !== "" && !additionKeys.has(pair.split("=")[0] ?? "");
+      });
+      return [...kept, additions].join("&");
+    };
+
+    const encodeQueryRecord = (record: Record<string, unknown>): string => {
+      return Object.entries(record)
+        .map(([k, v]) => {
+          if (v == null) {
+            return undefined;
+          }
+          const value = v;
+          return encodeForm(k, value, {
+            explode: Array.isArray(value),
+            charEncoding: "percent",
+          });
+        })
+        .filter((pair): pair is string => typeof pair !== "undefined")
+        .join("&");
+    };
+
+    const finalQuery = [
+      query || "",
+      encodeQueryRecord(security?.queryParams || {}),
+    ].reduce(mergeQuery, reqURL.search.slice(1));
 
     if (finalQuery) {
-      const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery;
-      reqURL.search = `?${q}`;
+      reqURL.search = `?${finalQuery}`;
     }
 
     const headers = new Headers(opHeaders);

package/src/models/client-create.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 ClientCreateStatus = {
   New: "new",
@@ -20,6 +25,8 @@ export type ClientCreate = {
   name: string;
   status?: ClientCreateStatus | undefined;
   notes?: string | undefined;
+  taxSettings?: ClientTaxSettings | undefined;
+  invoiceRemindersEnabled?: boolean | undefined;
 };
 
 /** @internal */
@@ -32,6 +39,8 @@ export type ClientCreate$Outbound = {
   name: string;
   status: string;
   notes?: string | undefined;
+  taxSettings?: ClientTaxSettings$Outbound | undefined;
+  invoiceRemindersEnabled?: boolean | undefined;
 };
 
 /** @internal */
@@ -42,6 +51,8 @@ export const ClientCreate$outboundSchema: z.ZodMiniType<
   name: z.string(),
   status: z._default(ClientCreateStatus$outboundSchema, "active"),
   notes: z.optional(z.string()),
+  taxSettings: z.optional(ClientTaxSettings$outboundSchema),
+  invoiceRemindersEnabled: z.optional(z.boolean()),
 });
 
 export function clientCreateToJSON(clientCreate: ClientCreate): string {

package/src/models/client-tax-settings.ts

@@ -0,0 +1,58 @@
+/*
+ * 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/sdk-validation-error.js";
+
+export type ClientTaxSettings = {
+  defaultTaxable: boolean;
+  overrideTaxRate: boolean;
+  taxRate: number | null;
+};
+
+/** @internal */
+export const ClientTaxSettings$inboundSchema: z.ZodMiniType<
+  ClientTaxSettings,
+  unknown
+> = z.object({
+  defaultTaxable: types.boolean(),
+  overrideTaxRate: types.boolean(),
+  taxRate: types.nullable(types.number()),
+});
+/** @internal */
+export type ClientTaxSettings$Outbound = {
+  defaultTaxable: boolean;
+  overrideTaxRate: boolean;
+  taxRate: number | null;
+};
+
+/** @internal */
+export const ClientTaxSettings$outboundSchema: z.ZodMiniType<
+  ClientTaxSettings$Outbound,
+  ClientTaxSettings
+> = z.object({
+  defaultTaxable: z.boolean(),
+  overrideTaxRate: z.boolean(),
+  taxRate: z.nullable(z.number()),
+});
+
+export function clientTaxSettingsToJSON(
+  clientTaxSettings: ClientTaxSettings,
+): string {
+  return JSON.stringify(
+    ClientTaxSettings$outboundSchema.parse(clientTaxSettings),
+  );
+}
+export function clientTaxSettingsFromJSON(
+  jsonString: string,
+): SafeParseResult<ClientTaxSettings, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ClientTaxSettings$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ClientTaxSettings' from JSON`,
+  );
+}

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`,
+  );
+}