@clientcasa/sdk 0.3.0 → 0.4.1

package/src/funcs/form-submissions-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 form submissions
+ *
+ * @remarks
+ * Answers are omitted from the list (returned as `null`); fetch a single submission to read them.
+ */
+export function formSubmissionsList(
+  client: ClientCasaCore,
+  security: operations.ListFormSubmissionsSecurity,
+  request?: operations.ListFormSubmissionsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListFormSubmissionsResponse,
+      | 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.ListFormSubmissionsSecurity,
+  request?: operations.ListFormSubmissionsRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListFormSubmissionsResponse,
+        | errors.ApiError
+        | ClientCasaError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        z.optional(operations.ListFormSubmissionsRequest$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/form-submissions")();
+
+  const query = encodeFormQuery({
+    "contactId": payload?.contactId,
+    "formId": payload?.formId,
+    "kind": payload?.kind,
+    "page": payload?.page,
+    "pageSize": payload?.pageSize,
+    "status": payload?.status,
+  });
+
+  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: "listFormSubmissions",
+    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.ListFormSubmissionsResponse,
+    | errors.ApiError
+    | ClientCasaError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListFormSubmissionsResponse$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.ListFormSubmissionsResponse,
+        | 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 = () =>
+      formSubmissionsList(
+        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/{proposals-get.ts → forms-and-agreements-get.ts}

@@ -31,14 +31,14 @@ import { Result } from "../types/fp.js";
 /**
  * Get a proposal
  */
-export function proposalsGet(
+export function formsAndAgreementsGet(
   client: ClientCasaCore,
-  security: operations.GetProposalSecurity,
-  request: operations.GetProposalRequest,
+  security: operations.GetClientDocumentSecurity,
+  request: operations.GetClientDocumentRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.Proposal,
+    models.ClientDocument,
     | errors.ApiError
     | ClientCasaError
     | ResponseValidationError
@@ -60,13 +60,13 @@ export function proposalsGet(
 
 async function $do(
   client: ClientCasaCore,
-  security: operations.GetProposalSecurity,
-  request: operations.GetProposalRequest,
+  security: operations.GetClientDocumentSecurity,
+  request: operations.GetClientDocumentRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      models.Proposal,
+      models.ClientDocument,
       | errors.ApiError
       | ClientCasaError
       | ResponseValidationError
@@ -82,7 +82,8 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => z.parse(operations.GetProposalRequest$outboundSchema, value),
+    (value) =>
+      z.parse(operations.GetClientDocumentRequest$outboundSchema, value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -97,7 +98,7 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-  const path = pathToFunc("/api/v1/proposals/{id}")(pathParams);
+  const path = pathToFunc("/api/v1/client-documents/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -123,7 +124,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getProposal",
+    operationID: "getClientDocument",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -177,7 +178,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    models.Proposal,
+    models.ClientDocument,
     | errors.ApiError
     | ClientCasaError
     | ResponseValidationError
@@ -188,7 +189,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, models.Proposal$inboundSchema),
+    M.json(200, models.ClientDocument$inboundSchema),
     M.jsonErr([401, 403, 404, 429], errors.ApiError$inboundSchema),
     M.jsonErr(500, errors.ApiError$inboundSchema),
     M.fail("4XX"),

package/src/funcs/{proposals-list.ts → forms-and-agreements-list.ts}

@@ -37,15 +37,15 @@ import {
 /**
  * List proposals
  */
-export function proposalsList(
+export function formsAndAgreementsList(
   client: ClientCasaCore,
-  security: operations.ListProposalsSecurity,
-  request?: operations.ListProposalsRequest | undefined,
+  security: operations.ListClientDocumentsSecurity,
+  request?: operations.ListClientDocumentsRequest | undefined,
   options?: RequestOptions,
 ): APIPromise<
   PageIterator<
     Result<
-      operations.ListProposalsResponse,
+      operations.ListClientDocumentsResponse,
       | errors.ApiError
       | ClientCasaError
       | ResponseValidationError
@@ -69,14 +69,14 @@ export function proposalsList(
 
 async function $do(
   client: ClientCasaCore,
-  security: operations.ListProposalsSecurity,
-  request?: operations.ListProposalsRequest | undefined,
+  security: operations.ListClientDocumentsSecurity,
+  request?: operations.ListClientDocumentsRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     PageIterator<
       Result<
-        operations.ListProposalsResponse,
+        operations.ListClientDocumentsResponse,
         | errors.ApiError
         | ClientCasaError
         | ResponseValidationError
@@ -96,7 +96,7 @@ async function $do(
     request,
     (value) =>
       z.parse(
-        z.optional(operations.ListProposalsRequest$outboundSchema),
+        z.optional(operations.ListClientDocumentsRequest$outboundSchema),
         value,
       ),
     "Input validation failed",
@@ -107,11 +107,11 @@ async function $do(
   const payload = parsed.value;
   const body = null;
 
-  const path = pathToFunc("/api/v1/proposals")();
+  const path = pathToFunc("/api/v1/client-documents")();
 
   const query = encodeFormQuery({
-    "archived": payload?.archived,
     "clientId": payload?.clientId,
+    "contactId": payload?.contactId,
     "page": payload?.page,
     "pageSize": payload?.pageSize,
     "status": payload?.status,
@@ -141,7 +141,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "listProposals",
+    operationID: "listClientDocuments",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -196,7 +196,7 @@ async function $do(
   };
 
   const [result, raw] = await M.match<
-    operations.ListProposalsResponse,
+    operations.ListClientDocumentsResponse,
     | errors.ApiError
     | ClientCasaError
     | ResponseValidationError
@@ -207,7 +207,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.ListProposalsResponse$inboundSchema, {
+    M.json(200, operations.ListClientDocumentsResponse$inboundSchema, {
       key: "Result",
     }),
     M.jsonErr([400, 401, 403, 429], errors.ApiError$inboundSchema),
@@ -228,7 +228,7 @@ async function $do(
   ): {
     next: Paginator<
       Result<
-        operations.ListProposalsResponse,
+        operations.ListClientDocumentsResponse,
         | errors.ApiError
         | ClientCasaError
         | ResponseValidationError
@@ -258,7 +258,7 @@ async function $do(
     }
 
     const nextVal = () =>
-      proposalsList(
+      formsAndAgreementsList(
         client,
         security,
         {

package/src/funcs/{inquiries-get.ts → forms-get.ts}

@@ -29,16 +29,16 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get an inquiry
+ * Get a form
  */
-export function inquiriesGet(
+export function formsGet(
   client: ClientCasaCore,
-  security: operations.GetInquirySecurity,
-  request: operations.GetInquiryRequest,
+  security: operations.GetFormSecurity,
+  request: operations.GetFormRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    models.Inquiry,
+    models.Form,
     | errors.ApiError
     | ClientCasaError
     | ResponseValidationError
@@ -60,13 +60,13 @@ export function inquiriesGet(
 
 async function $do(
   client: ClientCasaCore,
-  security: operations.GetInquirySecurity,
-  request: operations.GetInquiryRequest,
+  security: operations.GetFormSecurity,
+  request: operations.GetFormRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      models.Inquiry,
+      models.Form,
       | errors.ApiError
       | ClientCasaError
       | ResponseValidationError
@@ -82,7 +82,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => z.parse(operations.GetInquiryRequest$outboundSchema, value),
+    (value) => z.parse(operations.GetFormRequest$outboundSchema, value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -97,7 +97,7 @@ async function $do(
       charEncoding: "percent",
     }),
   };
-  const path = pathToFunc("/api/v1/inquiries/{id}")(pathParams);
+  const path = pathToFunc("/api/v1/forms/{id}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -123,7 +123,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getInquiry",
+    operationID: "getForm",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -177,7 +177,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    models.Inquiry,
+    models.Form,
     | errors.ApiError
     | ClientCasaError
     | ResponseValidationError
@@ -188,7 +188,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, models.Inquiry$inboundSchema),
+    M.json(200, models.Form$inboundSchema),
     M.jsonErr([401, 403, 404, 429], errors.ApiError$inboundSchema),
     M.jsonErr(500, errors.ApiError$inboundSchema),
     M.fail("4XX"),

package/src/funcs/{inquiries-list.ts → forms-list.ts}

@@ -35,17 +35,17 @@ import {
 } from "../types/operations.js";
 
 /**
- * List inquiries
+ * List forms
  */
-export function inquiriesList(
+export function formsList(
   client: ClientCasaCore,
-  security: operations.ListInquiriesSecurity,
-  request?: operations.ListInquiriesRequest | undefined,
+  security: operations.ListFormsSecurity,
+  request?: operations.ListFormsRequest | undefined,
   options?: RequestOptions,
 ): APIPromise<
   PageIterator<
     Result<
-      operations.ListInquiriesResponse,
+      operations.ListFormsResponse,
       | errors.ApiError
       | ClientCasaError
       | ResponseValidationError
@@ -69,14 +69,14 @@ export function inquiriesList(
 
 async function $do(
   client: ClientCasaCore,
-  security: operations.ListInquiriesSecurity,
-  request?: operations.ListInquiriesRequest | undefined,
+  security: operations.ListFormsSecurity,
+  request?: operations.ListFormsRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     PageIterator<
       Result<
-        operations.ListInquiriesResponse,
+        operations.ListFormsResponse,
         | errors.ApiError
         | ClientCasaError
         | ResponseValidationError
@@ -95,10 +95,7 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      z.parse(
-        z.optional(operations.ListInquiriesRequest$outboundSchema),
-        value,
-      ),
+      z.parse(z.optional(operations.ListFormsRequest$outboundSchema), value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -107,13 +104,13 @@ async function $do(
   const payload = parsed.value;
   const body = null;
 
-  const path = pathToFunc("/api/v1/inquiries")();
+  const path = pathToFunc("/api/v1/forms")();
 
   const query = encodeFormQuery({
+    "kind": payload?.kind,
     "page": payload?.page,
     "pageSize": payload?.pageSize,
-    "source": payload?.source,
-    "status": payload?.status,
+    "slug": payload?.slug,
   });
 
   const headers = new Headers(compactMap({
@@ -140,7 +137,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "listInquiries",
+    operationID: "listForms",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -195,7 +192,7 @@ async function $do(
   };
 
   const [result, raw] = await M.match<
-    operations.ListInquiriesResponse,
+    operations.ListFormsResponse,
     | errors.ApiError
     | ClientCasaError
     | ResponseValidationError
@@ -206,9 +203,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.ListInquiriesResponse$inboundSchema, {
-      key: "Result",
-    }),
+    M.json(200, operations.ListFormsResponse$inboundSchema, { key: "Result" }),
     M.jsonErr([400, 401, 403, 429], errors.ApiError$inboundSchema),
     M.jsonErr(500, errors.ApiError$inboundSchema),
     M.fail("4XX"),
@@ -227,7 +222,7 @@ async function $do(
   ): {
     next: Paginator<
       Result<
-        operations.ListInquiriesResponse,
+        operations.ListFormsResponse,
         | errors.ApiError
         | ClientCasaError
         | ResponseValidationError
@@ -257,7 +252,7 @@ async function $do(
     }
 
     const nextVal = () =>
-      inquiriesList(
+      formsList(
         client,
         security,
         {

package/src/funcs/invoices-create.ts

@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
  * Create an invoice
  *
  * @remarks
- * Status `paid`, `partial`, and `overdue` are system-derived from Payments and the due date; do not set them directly.
+ * Status `paid` and `partial` are system-derived from Payments; do not set them directly. `overdue` is not a status — it is a derived read-only boolean field (past due with a balance owing).
  */
 export function invoicesCreate(
   client: ClientCasaCore,

package/src/funcs/invoices-list.ts

@@ -108,6 +108,7 @@ async function $do(
 
   const query = encodeFormQuery({
     "clientId": payload?.clientId,
+    "overdue": payload?.overdue,
     "page": payload?.page,
     "pageSize": payload?.pageSize,
     "status": payload?.status,

package/src/funcs/milestones-create.ts

@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
  * Create a milestone
  *
  * @remarks
- * Milestones attach to either a project or a proposal — `parentType` + `parentId` are both required.
+ * Milestones attach to either a project or a form/agreement — `parentType` + `parentId` are both required.
  */
 export function milestonesCreate(
   client: ClientCasaCore,

package/src/hooks/types.ts

@@ -15,6 +15,7 @@ export type HookContext = {
   retryConfig: RetryConfig;
   resolvedSecurity: SecurityState | null;
   options: SDKOptions;
+  timeoutMs?: number;
 };
 
 export type Awaitable<T> = T | Promise<T>;