@unified-api/typescript-sdk 2.85.48 → 2.85.50

package/src/sdk/models/shared/marketingreport.ts

@@ -13,36 +13,117 @@ import {
 } from "./marketingreportlink.js";
 
 export type MarketingReport = {
+  /**
+   * Number of abuse reports
+   */
   abuseReports?: number | undefined;
+  /**
+   * Associated campaign ID
+   */
   campaignId?: string | undefined;
+  /**
+   * Click rate (decimal)
+   */
   clickRate?: number | undefined;
+  /**
+   * Total clicks
+   */
   clicksTotal?: number | undefined;
+  /**
+   * Total emails sent
+   */
   emailsSent?: number | undefined;
+  /**
+   * End time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   endAt?: Date | undefined;
+  /**
+   * Forward count
+   */
   forwardsCount?: number | undefined;
+  /**
+   * Forwards opened
+   */
   forwardsOpens?: number | undefined;
+  /**
+   * Hard bounce count
+   */
   hardBounces?: number | undefined;
+  /**
+   * Open rate (decimal) excluding automated/bot/proxy opens
+   */
   humanOpenRate?: number | undefined;
+  /**
+   * Total opens excluding automated/bot/proxy (e.g. Apple Mail Privacy Protection) opens
+   */
   humanOpensTotal?: number | undefined;
+  /**
+   * Unique opens excluding automated/bot/proxy opens
+   */
   humanUniqueOpens?: number | undefined;
+  /**
+   * Unique identifier for the campaign report
+   */
   id?: string | undefined;
+  /**
+   * Last click timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   lastClickAt?: Date | undefined;
+  /**
+   * Last open timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   lastOpenAt?: Date | undefined;
   /**
    * URL-specific click data
    */
   links?: Array<MarketingReportLink> | undefined;
+  /**
+   * Associated list ID
+   */
   listId?: string | undefined;
+  /**
+   * Open rate (decimal)
+   */
   openRate?: number | undefined;
+  /**
+   * Total opens
+   */
   opensTotal?: number | undefined;
+  /**
+   * Raw data from integration
+   */
   raw?: { [k: string]: any } | undefined;
+  /**
+   * Send time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   sentAt?: Date | undefined;
+  /**
+   * Soft bounce count
+   */
   softBounces?: number | undefined;
+  /**
+   * Start time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   startAt?: Date | undefined;
+  /**
+   * Syntax error count
+   */
   syntaxErrors?: number | undefined;
+  /**
+   * Unique clicks
+   */
   uniqueClicks?: number | undefined;
+  /**
+   * Unique opens
+   */
   uniqueOpens?: number | undefined;
+  /**
+   * Unique subscriber clicks
+   */
   uniqueSubscriberClicks?: number | undefined;
+  /**
+   * Number of unsubscribes
+   */
   unsubscribed?: number | undefined;
 };
 

package/src/sdk/models/shared/marketingreportlink.ts

@@ -9,11 +9,29 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type MarketingReportLink = {
+  /**
+   * Percentage of total clicks
+   */
   clickPercentage?: number | undefined;
+  /**
+   * Last click timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   lastClickAt?: Date | undefined;
+  /**
+   * Total clicks on this link
+   */
   totalClicks?: number | undefined;
+  /**
+   * Percentage of unique clicks
+   */
   uniqueClickPercentage?: number | undefined;
+  /**
+   * Unique clicks on this link
+   */
   uniqueClicks?: number | undefined;
+  /**
+   * The URL
+   */
   url?: string | undefined;
 };
 

package/src/sdk/models/shared/messagingattachment.ts

@@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type MessagingAttachment = {
+  /**
+   * the inline attachment's content_id
+   */
   contentIdentifier?: string | undefined;
   contentType?: string | undefined;
   downloadUrl?: string | undefined;

package/src/sdk/models/shared/messagingchannel.ts

@@ -15,6 +15,9 @@ import {
 } from "./messagingmember.js";
 
 export type MessagingChannel = {
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
   description?: string | undefined;
   hasSubchannels?: boolean | undefined;
@@ -25,6 +28,9 @@ export type MessagingChannel = {
   name?: string | undefined;
   parentId?: string | undefined;
   raw?: { [k: string]: any } | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
   webUrl?: string | undefined;
 };

package/src/sdk/models/shared/messagingevent.ts

@@ -54,7 +54,13 @@ export type MessagingEventType = OpenEnum<typeof MessagingEventType>;
 export type MessagingEvent = {
   button?: PropertyMessagingEventButton | undefined;
   channel?: PropertyMessagingEventChannel | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
+  /**
+   * not used
+   */
   id?: string | undefined;
   isReplacingOriginal?: boolean | undefined;
   message?: PropertyMessagingEventMessage | undefined;

package/src/sdk/models/shared/messagingmember.ts

@@ -12,6 +12,9 @@ export type MessagingMember = {
   email?: string | undefined;
   imageUrl?: string | undefined;
   name?: string | undefined;
+  /**
+   * (reference to HrisEmployee)
+   */
   userId?: string | undefined;
 };
 

package/src/sdk/models/shared/messagingmessage.ts

@@ -52,9 +52,12 @@ export type MessagingMessage = {
   authorMember?: PropertyMessagingMessageAuthorMember | undefined;
   buttons?: Array<MessagingButton> | undefined;
   /**
-   * Represents the names of all channels to which the message is sent. Identifies the channels where the message is posted.
+   * Represents all channels to which the message is sent. Identifies the channels where the message is posted.  To send to the "Draft" channel/folder, use a channel ID "DRAFT".
    */
   channels?: Array<MessagingReference> | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
   /**
    * for email systems, this field represents the To value
@@ -74,12 +77,24 @@ export type MessagingMessage = {
   message?: string | undefined;
   messageHtml?: string | undefined;
   messageMarkdown?: string | undefined;
+  /**
+   * the opaque identifier for the first message in a thread
+   */
   messageThreadIdentifier?: string | undefined;
+  /**
+   * Represents the ID of the immediate predecessor message in the thread. Identifies a specific message to which the current message directly replies.
+   */
   parentId?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   reactions?: Array<MessagingReaction> | undefined;
+  /**
+   * eg. RFC822 MessageID
+   */
   reference?: string | undefined;
   subject?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
   webUrl?: string | undefined;
 };

package/src/sdk/models/shared/metadatametadata.ts

@@ -28,17 +28,26 @@ export const MetadataMetadataFormat = {
 export type MetadataMetadataFormat = OpenEnum<typeof MetadataMetadataFormat>;
 
 export type MetadataMetadata = {
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
   format?: MetadataMetadataFormat | undefined;
   id?: string | undefined;
   isRequired?: boolean | undefined;
   name: string;
+  /**
+   * This is the unified object type that this metadata is associated with. eg. crm_contact or coomerce_item
+   */
   objectType: string;
   objects?: { [k: string]: any } | undefined;
   options?: Array<string> | undefined;
   originalFormat?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   slug?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
 };
 

package/src/sdk/models/shared/notification.ts

@@ -39,17 +39,38 @@ export type Event = OpenEnum<typeof Event>;
  */
 export type Notification = {
   connectionId?: string | undefined;
+  /**
+   * The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
+  /**
+   * Longer description of this notification
+   */
   description?: string | undefined;
   event?: Event | undefined;
+  /**
+   * Unique identifier for this notification object
+   */
   id?: string | undefined;
   integrationName?: string | undefined;
   integrationType?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   sentAt?: Date | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
+  /**
+   * (reference to HrisEmployee)
+   */
   userId?: string | undefined;
   userName?: string | undefined;
   webhookId?: string | undefined;
+  /**
+   * (reference to KmsSpace)
+   */
   workspaceId?: string | undefined;
   workspaceName?: string | undefined;
 };

package/src/sdk/models/shared/paymentallocation.ts

@@ -10,6 +10,9 @@ import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * The type of object this payment was applied to
+ */
 export const PaymentAllocationObjectType = {
   Invoice: "INVOICE",
   Bill: "BILL",
@@ -18,16 +21,37 @@ export const PaymentAllocationObjectType = {
   Salesorder: "SALESORDER",
   Purchaseorder: "PURCHASEORDER",
 } as const;
+/**
+ * The type of object this payment was applied to
+ */
 export type PaymentAllocationObjectType = OpenEnum<
   typeof PaymentAllocationObjectType
 >;
 
 export type PaymentAllocation = {
+  /**
+   * Date and time when the payment was applied, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   allocatedAt?: Date | undefined;
+  /**
+   * The amount of the payment applied to this object
+   */
   amount?: number | undefined;
+  /**
+   * ISO 4217 currency code of the applied amount
+   */
   currency?: string | undefined;
+  /**
+   * The exchange rate at the time the payment was applied, for multi-currency
+   */
   exchangeRate?: number | undefined;
+  /**
+   * The id of the object this payment was applied to
+   */
   objectId?: string | undefined;
+  /**
+   * The type of object this payment was applied to
+   */
   objectType?: PaymentAllocationObjectType | undefined;
 };
 

package/src/sdk/models/shared/paymentlineitem.ts

@@ -9,22 +9,40 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PaymentLineitem = {
+  /**
+   * (reference to AccountingAccount)
+   */
   accountId?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
   discountAmount?: number | undefined;
   id?: string | undefined;
   itemDescription?: string | undefined;
+  /**
+   * (reference to CommerceItem)
+   */
   itemId?: string | undefined;
   itemName?: string | undefined;
   itemSku?: string | undefined;
   notes?: string | undefined;
+  /**
+   * new field
+   */
   refundAmount?: number | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   refundedAt?: Date | undefined;
   taxAmount?: number | undefined;
   taxrateId?: string | undefined;
   totalAmount?: number | undefined;
   unitAmount?: number | undefined;
   unitQuantity?: number | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
 };
 

package/src/sdk/models/shared/paymentlink.ts

@@ -16,7 +16,13 @@ import {
 
 export type PaymentLink = {
   amount?: number | undefined;
+  /**
+   * ID of the AccountingContact (reference to AccountingContact)
+   */
   contactId?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
   currency?: string | undefined;
   description?: string | undefined;
@@ -24,10 +30,19 @@ export type PaymentLink = {
   isActive?: boolean | undefined;
   isChargeableNow?: boolean | undefined;
   lineitems?: Array<PaymentLineitem> | undefined;
+  /**
+   * (reference to PaymentPayment)
+   */
   paymentId?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   successUrl?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
+  /**
+   * the payment link
+   */
   url?: string | undefined;
 };
 

package/src/sdk/models/shared/paymentpayment.ts

@@ -25,6 +25,9 @@ export const PaymentPaymentStatus = {
 } as const;
 export type PaymentPaymentStatus = OpenEnum<typeof PaymentPaymentStatus>;
 
+/**
+ * normalized tender category; the provider's original label stays in payment_method
+ */
 export const TenderType = {
   Card: "CARD",
   Cash: "CASH",
@@ -37,6 +40,9 @@ export const TenderType = {
   External: "EXTERNAL",
   Other: "OTHER",
 } as const;
+/**
+ * normalized tender category; the provider's original label stays in payment_method
+ */
 export type TenderType = OpenEnum<typeof TenderType>;
 
 export const PaymentPaymentType = {
@@ -46,34 +52,86 @@ export const PaymentPaymentType = {
 export type PaymentPaymentType = OpenEnum<typeof PaymentPaymentType>;
 
 export type PaymentPayment = {
+  /**
+   * (reference to AccountingAccount)
+   */
   accountId?: string | undefined;
   /**
    * What this payment was applied to (invoices, bills, credit memos, etc.). Replaces separate invoice/bill payment endpoints.
    */
   allocations?: Array<PaymentAllocation> | undefined;
+  /**
+   * references AccountingBill
+   */
   billId?: string | undefined;
   cardBrand?: string | undefined;
   cardLast4?: string | undefined;
+  /**
+   * dimension refs -> AccountingCategory
+   */
+  categoryIds?: Array<string> | undefined;
+  /**
+   * (reference to AccountingContact)
+   */
   contactId?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
   currency?: string | undefined;
+  /**
+   * POS terminal/register/device (hr device)
+   */
   deviceId?: string | undefined;
+  /**
+   * Exchange rate to the base/home currency at the payment date
+   */
+  exchangeRate?: number | undefined;
+  /**
+   * processing/processor fee
+   */
   feeAmount?: number | undefined;
   id?: string | undefined;
+  /**
+   * (reference to AccountingInvoice)
+   */
   invoiceId?: string | undefined;
   linkId?: string | undefined;
+  /**
+   * store/site where the payment was taken (commerce_location)
+   */
   locationId?: string | undefined;
+  /**
+   * total_amount minus fee_amount
+   */
+  netAmount?: number | undefined;
   notes?: string | undefined;
+  /**
+   * reference to an AccountingOrganization
+   */
   organizationId?: string | undefined;
+  /**
+   * Date and time the payment was made (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
+  paidAt?: Date | undefined;
   paymentMethod?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   reference?: string | undefined;
+  /**
+   * reference to an AccountingSalesorder, e.g. the POS order this payment settled
+   */
   salesorderId?: string | undefined;
   status?: PaymentPaymentStatus | undefined;
+  /**
+   * normalized tender category; the provider's original label stays in payment_method
+   */
   tenderType?: TenderType | undefined;
   tipAmount?: number | undefined;
   totalAmount?: number | undefined;
   type?: PaymentPaymentType | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
 };
 
@@ -127,18 +185,23 @@ export const PaymentPayment$inboundSchema: z.ZodType<
   bill_id: z.string().optional(),
   card_brand: z.string().optional(),
   card_last4: z.string().optional(),
+  category_ids: z.array(z.string()).optional(),
   contact_id: z.string().optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   currency: z.string().default("USD"),
   device_id: z.string().optional(),
+  exchange_rate: z.number().optional(),
   fee_amount: z.number().optional(),
   id: z.string().optional(),
   invoice_id: z.string().optional(),
   link_id: z.string().optional(),
   location_id: z.string().optional(),
+  net_amount: z.number().optional(),
   notes: z.string().optional(),
   organization_id: z.string().optional(),
+  paid_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
   payment_method: z.string().optional(),
   raw: z.record(z.any()).optional(),
   reference: z.string().optional(),
@@ -156,14 +219,18 @@ export const PaymentPayment$inboundSchema: z.ZodType<
     "bill_id": "billId",
     "card_brand": "cardBrand",
     "card_last4": "cardLast4",
+    "category_ids": "categoryIds",
     "contact_id": "contactId",
     "created_at": "createdAt",
     "device_id": "deviceId",
+    "exchange_rate": "exchangeRate",
     "fee_amount": "feeAmount",
     "invoice_id": "invoiceId",
     "link_id": "linkId",
     "location_id": "locationId",
+    "net_amount": "netAmount",
     "organization_id": "organizationId",
+    "paid_at": "paidAt",
     "payment_method": "paymentMethod",
     "salesorder_id": "salesorderId",
     "tender_type": "tenderType",
@@ -179,17 +246,21 @@ export type PaymentPayment$Outbound = {
   bill_id?: string | undefined;
   card_brand?: string | undefined;
   card_last4?: string | undefined;
+  category_ids?: Array<string> | undefined;
   contact_id?: string | undefined;
   created_at?: string | undefined;
   currency: string;
   device_id?: string | undefined;
+  exchange_rate?: number | undefined;
   fee_amount?: number | undefined;
   id?: string | undefined;
   invoice_id?: string | undefined;
   link_id?: string | undefined;
   location_id?: string | undefined;
+  net_amount?: number | undefined;
   notes?: string | undefined;
   organization_id?: string | undefined;
+  paid_at?: string | undefined;
   payment_method?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   reference?: string | undefined;
@@ -213,17 +284,21 @@ export const PaymentPayment$outboundSchema: z.ZodType<
   billId: z.string().optional(),
   cardBrand: z.string().optional(),
   cardLast4: z.string().optional(),
+  categoryIds: z.array(z.string()).optional(),
   contactId: z.string().optional(),
   createdAt: z.date().transform(v => v.toISOString()).optional(),
   currency: z.string().default("USD"),
   deviceId: z.string().optional(),
+  exchangeRate: z.number().optional(),
   feeAmount: z.number().optional(),
   id: z.string().optional(),
   invoiceId: z.string().optional(),
   linkId: z.string().optional(),
   locationId: z.string().optional(),
+  netAmount: z.number().optional(),
   notes: z.string().optional(),
   organizationId: z.string().optional(),
+  paidAt: z.date().transform(v => v.toISOString()).optional(),
   paymentMethod: z.string().optional(),
   raw: z.record(z.any()).optional(),
   reference: z.string().optional(),
@@ -240,14 +315,18 @@ export const PaymentPayment$outboundSchema: z.ZodType<
     billId: "bill_id",
     cardBrand: "card_brand",
     cardLast4: "card_last4",
+    categoryIds: "category_ids",
     contactId: "contact_id",
     createdAt: "created_at",
     deviceId: "device_id",
+    exchangeRate: "exchange_rate",
     feeAmount: "fee_amount",
     invoiceId: "invoice_id",
     linkId: "link_id",
     locationId: "location_id",
+    netAmount: "net_amount",
     organizationId: "organization_id",
+    paidAt: "paid_at",
     paymentMethod: "payment_method",
     salesorderId: "salesorder_id",
     tenderType: "tender_type",