@clientcasa/sdk 0.7.0 → 0.7.2

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

package/src/models/sale.ts

@@ -0,0 +1,124 @@
+/*
+ * 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 Channel = {
+  Pos: "pos",
+  Manual: "manual",
+  Stripe: "stripe",
+  Shopify: "shopify",
+  Etsy: "etsy",
+  SquareImport: "square-import",
+  Api: "api",
+} as const;
+export type Channel = OpenEnum<typeof Channel>;
+
+export const SaleStatus = {
+  Completed: "completed",
+  Refunded: "refunded",
+  PartiallyRefunded: "partially-refunded",
+  Voided: "voided",
+} as const;
+export type SaleStatus = OpenEnum<typeof SaleStatus>;
+
+export type Sale = {
+  /**
+   * UUID v4
+   */
+  id: string;
+  saleNumber: string;
+  /**
+   * UUID v4
+   */
+  businessId: string | null;
+  /**
+   * UUID v4
+   */
+  clientId: string | null;
+  /**
+   * UUID v4
+   */
+  contactId: string | null;
+  channel: Channel;
+  externalId: string | null;
+  saleDate: Date;
+  currency: string;
+  status: SaleStatus;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  voidedAt: Date | null;
+  voidReason: string | null;
+  taxJurisdiction: string | null;
+  taxInclusive: boolean;
+  subtotal: number | null;
+  discountPercent: number | null;
+  discountAmount: number | null;
+  taxRate: number | null;
+  taxAmount: number | null;
+  total: number | null;
+  amountRefunded: number;
+  notes: string | null;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  createdAt: Date;
+  /**
+   * ISO 8601 timestamp (UTC)
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const Channel$inboundSchema: z.ZodMiniType<Channel, unknown> = openEnums
+  .inboundSchema(Channel);
+
+/** @internal */
+export const SaleStatus$inboundSchema: z.ZodMiniType<SaleStatus, unknown> =
+  openEnums.inboundSchema(SaleStatus);
+
+/** @internal */
+export const Sale$inboundSchema: z.ZodMiniType<Sale, unknown> = z.object({
+  id: types.string(),
+  saleNumber: types.string(),
+  businessId: types.nullable(types.string()),
+  clientId: types.nullable(types.string()),
+  contactId: types.nullable(types.string()),
+  channel: Channel$inboundSchema,
+  externalId: types.nullable(types.string()),
+  saleDate: types.date(),
+  currency: types.string(),
+  status: SaleStatus$inboundSchema,
+  voidedAt: types.nullable(types.date()),
+  voidReason: types.nullable(types.string()),
+  taxJurisdiction: types.nullable(types.string()),
+  taxInclusive: types.boolean(),
+  subtotal: types.nullable(types.number()),
+  discountPercent: types.nullable(types.number()),
+  discountAmount: types.nullable(types.number()),
+  taxRate: types.nullable(types.number()),
+  taxAmount: types.nullable(types.number()),
+  total: types.nullable(types.number()),
+  amountRefunded: types.number(),
+  notes: types.nullable(types.string()),
+  createdAt: types.date(),
+  updatedAt: types.date(),
+});
+
+export function saleFromJSON(
+  jsonString: string,
+): SafeParseResult<Sale, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Sale$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Sale' from JSON`,
+  );
+}

package/src/models/webhook-create.ts

@@ -13,7 +13,6 @@ export const WebhookCreateEvent = {
   InvoicePaymentFailed: "invoice_payment_failed",
   InvoiceDisputed: "invoice_disputed",
   InvoicePaymentReminder: "invoice_payment_reminder",
-  InvoiceViewed: "invoice_viewed",
   PaymentReceived: "payment_received",
   PaymentRefunded: "payment_refunded",
   PaymentApplied: "payment_applied",
@@ -38,6 +37,7 @@ export const WebhookCreateEvent = {
   ClientWon: "client_won",
   ClientLost: "client_lost",
   LeadStatusChanged: "lead_status_changed",
+  InvoiceViewed: "invoice_viewed",
   MilestoneApproaching: "milestone_approaching",
   TimerRunningReminder: "timer_running_reminder",
   ContractSent: "contract_sent",
@@ -48,12 +48,12 @@ export const WebhookCreateEvent = {
   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",
@@ -62,6 +62,19 @@ export const WebhookCreateEvent = {
   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 WebhookCreateEvent = ClosedEnum<typeof WebhookCreateEvent>;
 

package/src/models/webhook-update.ts

@@ -13,7 +13,6 @@ export const WebhookUpdateEvent = {
   InvoicePaymentFailed: "invoice_payment_failed",
   InvoiceDisputed: "invoice_disputed",
   InvoicePaymentReminder: "invoice_payment_reminder",
-  InvoiceViewed: "invoice_viewed",
   PaymentReceived: "payment_received",
   PaymentRefunded: "payment_refunded",
   PaymentApplied: "payment_applied",
@@ -38,6 +37,7 @@ export const WebhookUpdateEvent = {
   ClientWon: "client_won",
   ClientLost: "client_lost",
   LeadStatusChanged: "lead_status_changed",
+  InvoiceViewed: "invoice_viewed",
   MilestoneApproaching: "milestone_approaching",
   TimerRunningReminder: "timer_running_reminder",
   ContractSent: "contract_sent",
@@ -48,12 +48,12 @@ export const WebhookUpdateEvent = {
   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",
@@ -62,6 +62,19 @@ export const WebhookUpdateEvent = {
   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 WebhookUpdateEvent = ClosedEnum<typeof WebhookUpdateEvent>;
 

package/src/models/webhook.ts

@@ -18,7 +18,6 @@ export const WebhookEvent = {
   InvoicePaymentFailed: "invoice_payment_failed",
   InvoiceDisputed: "invoice_disputed",
   InvoicePaymentReminder: "invoice_payment_reminder",
-  InvoiceViewed: "invoice_viewed",
   PaymentReceived: "payment_received",
   PaymentRefunded: "payment_refunded",
   PaymentApplied: "payment_applied",
@@ -43,6 +42,7 @@ export const WebhookEvent = {
   ClientWon: "client_won",
   ClientLost: "client_lost",
   LeadStatusChanged: "lead_status_changed",
+  InvoiceViewed: "invoice_viewed",
   MilestoneApproaching: "milestone_approaching",
   TimerRunningReminder: "timer_running_reminder",
   ContractSent: "contract_sent",
@@ -53,12 +53,12 @@ export const WebhookEvent = {
   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",
@@ -67,6 +67,19 @@ export const WebhookEvent = {
   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 WebhookEvent = OpenEnum<typeof WebhookEvent>;
 

package/src/sdk/sales.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { salesGet } from "../funcs/sales-get.js";
+import { salesList } from "../funcs/sales-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 Sales extends ClientSDK {
+  /**
+   * List sales
+   */
+  async list(
+    security: operations.ListSalesSecurity,
+    request?: operations.ListSalesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<PageIterator<operations.ListSalesResponse, { page: number }>> {
+    return unwrapResultIterator(salesList(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get a sale
+   */
+  async get(
+    security: operations.GetSaleSecurity,
+    request: operations.GetSaleRequest,
+    options?: RequestOptions,
+  ): Promise<models.Sale> {
+    return unwrapAsync(salesGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -20,6 +20,7 @@ import { Milestones } from "./milestones.js";
 import { Payments } from "./payments.js";
 import { Payouts } from "./payouts.js";
 import { Projects } from "./projects.js";
+import { Sales } from "./sales.js";
 import { TimeEntries } from "./time-entries.js";
 import { TimelineItems } from "./timeline-items.js";
 import { Transactions } from "./transactions.js";
@@ -88,6 +89,11 @@ export class ClientCasa extends ClientSDK {
     return (this._payouts ??= new Payouts(this._options));
   }
 
+  private _sales?: Sales;
+  get sales(): Sales {
+    return (this._sales ??= new Sales(this._options));
+  }
+
   private _timeEntries?: TimeEntries;
   get timeEntries(): TimeEntries {
     return (this._timeEntries ??= new TimeEntries(this._options));