@clientcasa/sdk 0.7.0 → 0.7.1

package/src/funcs/sales-list.ts

@@ -0,0 +1,277 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { ClientCasaCore } from "../core.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 sales
+ */
+export function salesList(
+  client: ClientCasaCore,
+  security: operations.ListSalesSecurity,
+  request?: operations.ListSalesRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListSalesResponse,
+      | 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.ListSalesSecurity,
+  request?: operations.ListSalesRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListSalesResponse,
+        | errors.ApiError
+        | ClientCasaError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(z.optional(operations.ListSalesRequest$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/sales")();
+
+  const query = encodeFormQuery({
+    "businessId": payload?.businessId,
+    "channel": payload?.channel,
+    "clientId": payload?.clientId,
+    "page": payload?.page,
+    "pageSize": payload?.pageSize,
+    "saleDateFrom": payload?.saleDateFrom,
+    "saleDateTo": payload?.saleDateTo,
+    "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: "listSales",
+    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.ListSalesResponse,
+    | errors.ApiError
+    | ClientCasaError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListSalesResponse$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.ListSalesResponse,
+        | 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 = (responseData as { data: unknown }).data;
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.pageSize ?? 25;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      salesList(
+        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/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.7.0",
-  genVersion: "2.932.15",
-  userAgent: "speakeasy-sdk/typescript 0.7.0 2.932.15 1.0.0 @clientcasa/sdk",
+  sdkVersion: "0.7.1",
+  genVersion: "2.933.0",
+  userAgent: "speakeasy-sdk/typescript 0.7.1 2.933.0 1.0.0 @clientcasa/sdk",
 } as const;

package/src/models/index.ts

@@ -64,6 +64,8 @@ export * from "./project-create.js";
 export * from "./project-list.js";
 export * from "./project-update.js";
 export * from "./project.js";
+export * from "./sale-list.js";
+export * from "./sale.js";
 export * from "./security.js";
 export * from "./time-entry-create.js";
 export * from "./time-entry-list.js";

package/src/models/operations/get-sale.ts

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

package/src/models/operations/index.ts

@@ -52,6 +52,7 @@ export * from "./get-milestone.js";
 export * from "./get-payment.js";
 export * from "./get-payout.js";
 export * from "./get-project.js";
+export * from "./get-sale.js";
 export * from "./get-time-entry.js";
 export * from "./get-timeline-item.js";
 export * from "./get-transaction.js";
@@ -74,6 +75,7 @@ export * from "./list-milestones.js";
 export * from "./list-payments.js";
 export * from "./list-payouts.js";
 export * from "./list-projects.js";
+export * from "./list-sales.js";
 export * from "./list-time-entries.js";
 export * from "./list-timeline-items.js";
 export * from "./list-transactions.js";

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

@@ -43,6 +43,10 @@ export type ListPaymentsRequest = {
    * UUID v4
    */
   invoiceId?: string | undefined;
+  /**
+   * UUID v4
+   */
+  saleId?: string | undefined;
   status?: ListPaymentsStatus | undefined;
   kind?: ListPaymentsKind | undefined;
 };
@@ -90,6 +94,7 @@ export type ListPaymentsRequest$Outbound = {
   pageSize: number;
   clientId?: string | undefined;
   invoiceId?: string | undefined;
+  saleId?: string | undefined;
   status?: string | undefined;
   kind?: string | undefined;
 };
@@ -103,6 +108,7 @@ export const ListPaymentsRequest$outboundSchema: z.ZodMiniType<
   pageSize: z._default(z.int(), 25),
   clientId: z.optional(z.string()),
   invoiceId: z.optional(z.string()),
+  saleId: z.optional(z.string()),
   status: z.optional(ListPaymentsStatus$outboundSchema),
   kind: z.optional(ListPaymentsKind$outboundSchema),
 });

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

@@ -0,0 +1,159 @@
+/*
+ * 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 ListSalesSecurity = {
+  apiKey?: string | undefined;
+  bearer?: string | undefined;
+};
+
+export const ListSalesStatus = {
+  Completed: "completed",
+  Refunded: "refunded",
+  PartiallyRefunded: "partially-refunded",
+  Voided: "voided",
+} as const;
+export type ListSalesStatus = ClosedEnum<typeof ListSalesStatus>;
+
+export const Channel = {
+  Pos: "pos",
+  Manual: "manual",
+  Stripe: "stripe",
+  Shopify: "shopify",
+  Etsy: "etsy",
+  SquareImport: "square-import",
+  Api: "api",
+} as const;
+export type Channel = ClosedEnum<typeof Channel>;
+
+export type ListSalesRequest = {
+  page?: number | undefined;
+  pageSize?: number | undefined;
+  status?: ListSalesStatus | undefined;
+  channel?: Channel | undefined;
+  /**
+   * UUID v4
+   */
+  clientId?: string | undefined;
+  /**
+   * UUID v4
+   */
+  businessId?: string | undefined;
+  saleDateFrom?: Date | undefined;
+  saleDateTo?: Date | undefined;
+};
+
+export type ListSalesResponse = {
+  result: models.SaleList;
+};
+
+/** @internal */
+export type ListSalesSecurity$Outbound = {
+  apiKey?: string | undefined;
+  bearer?: string | undefined;
+};
+
+/** @internal */
+export const ListSalesSecurity$outboundSchema: z.ZodMiniType<
+  ListSalesSecurity$Outbound,
+  ListSalesSecurity
+> = z.object({
+  apiKey: z.optional(z.string()),
+  bearer: z.optional(z.string()),
+});
+
+export function listSalesSecurityToJSON(
+  listSalesSecurity: ListSalesSecurity,
+): string {
+  return JSON.stringify(
+    ListSalesSecurity$outboundSchema.parse(listSalesSecurity),
+  );
+}
+
+/** @internal */
+export const ListSalesStatus$outboundSchema: z.ZodMiniEnum<
+  typeof ListSalesStatus
+> = z.enum(ListSalesStatus);
+
+/** @internal */
+export const Channel$outboundSchema: z.ZodMiniEnum<typeof Channel> = z.enum(
+  Channel,
+);
+
+/** @internal */
+export type ListSalesRequest$Outbound = {
+  page: number;
+  pageSize: number;
+  status?: string | undefined;
+  channel?: string | undefined;
+  clientId?: string | undefined;
+  businessId?: string | undefined;
+  saleDateFrom?: string | undefined;
+  saleDateTo?: string | undefined;
+};
+
+/** @internal */
+export const ListSalesRequest$outboundSchema: z.ZodMiniType<
+  ListSalesRequest$Outbound,
+  ListSalesRequest
+> = z.object({
+  page: z._default(z.int(), 1),
+  pageSize: z._default(z.int(), 25),
+  status: z.optional(ListSalesStatus$outboundSchema),
+  channel: z.optional(Channel$outboundSchema),
+  clientId: z.optional(z.string()),
+  businessId: z.optional(z.string()),
+  saleDateFrom: z.optional(
+    z.pipe(
+      z.date(),
+      z.transform(v => v.toISOString().slice(0, "YYYY-MM-DD".length)),
+    ),
+  ),
+  saleDateTo: z.optional(
+    z.pipe(
+      z.date(),
+      z.transform(v => v.toISOString().slice(0, "YYYY-MM-DD".length)),
+    ),
+  ),
+});
+
+export function listSalesRequestToJSON(
+  listSalesRequest: ListSalesRequest,
+): string {
+  return JSON.stringify(
+    ListSalesRequest$outboundSchema.parse(listSalesRequest),
+  );
+}
+
+/** @internal */
+export const ListSalesResponse$inboundSchema: z.ZodMiniType<
+  ListSalesResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    Result: models.SaleList$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "Result": "result",
+    });
+  }),
+);
+
+export function listSalesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSalesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSalesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSalesResponse' from JSON`,
+  );
+}

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

@@ -23,7 +23,6 @@ export const Event = {
   InvoicePaymentFailed: "invoice_payment_failed",
   InvoiceDisputed: "invoice_disputed",
   InvoicePaymentReminder: "invoice_payment_reminder",
-  InvoiceViewed: "invoice_viewed",
   PaymentReceived: "payment_received",
   PaymentRefunded: "payment_refunded",
   PaymentApplied: "payment_applied",
@@ -48,6 +47,7 @@ export const Event = {
   ClientWon: "client_won",
   ClientLost: "client_lost",
   LeadStatusChanged: "lead_status_changed",
+  InvoiceViewed: "invoice_viewed",
   MilestoneApproaching: "milestone_approaching",
   TimerRunningReminder: "timer_running_reminder",
   ContractSent: "contract_sent",
@@ -58,12 +58,12 @@ export const Event = {
   ContractCompleted: "contract_completed",
   ContractExpired: "contract_expired",
   ContractVoided: "contract_voided",
+  FormSubmissionCompleted: "form_submission_completed",
   SmartFileSent: "smart_file_sent",
   SmartFileViewed: "smart_file_viewed",
   SmartFileAccepted: "smart_file_accepted",
   SmartFileCompleted: "smart_file_completed",
   SmartFileExpired: "smart_file_expired",
-  FormSubmissionCompleted: "form_submission_completed",
   SubscriptionPaymentFailed: "subscription_payment_failed",
   PayoutPaid: "payout_paid",
   PayoutFailed: "payout_failed",
@@ -72,6 +72,19 @@ export const Event = {
   EventDayArchived: "event_day_archived",
   TimelineItemCompleted: "timeline_item_completed",
   TimelineReminderSent: "timeline_reminder_sent",
+  InvoiceRefunded: "invoice_refunded",
+  ContractAmended: "contract_amended",
+  ReceiptViewed: "receipt_viewed",
+  FollowUpDue: "follow_up_due",
+  PaymentProcessing: "payment_processing",
+  ClientReply: "client_reply",
+  ClientRevisionRequested: "client_revision_requested",
+  EmailDeliveryFailed: "email_delivery_failed",
+  SaleCompleted: "sale_completed",
+  SaleRefunded: "sale_refunded",
+  SaleVoided: "sale_voided",
+  SaleReceiptSent: "sale_receipt_sent",
+  SaleViewed: "sale_viewed",
 } as const;
 export type Event = ClosedEnum<typeof Event>;
 

package/src/models/payment.ts

@@ -53,6 +53,10 @@ export type Payment = {
    * UUID v4
    */
   invoiceId: string | null;
+  /**
+   * UUID v4
+   */
+  saleId: string | null;
   amount: number;
   currency: string;
   receivedDate: Date;
@@ -101,6 +105,7 @@ export const Payment$inboundSchema: z.ZodMiniType<Payment, unknown> = z.object({
   id: types.string(),
   clientId: types.nullable(types.string()),
   invoiceId: types.nullable(types.string()),
+  saleId: types.nullable(types.string()),
   amount: types.number(),
   currency: types.string(),
   receivedDate: types.date(),

package/src/models/sale-list.ts

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