@apideck/unify 0.18.0 → 0.20.0

package/src/models/components/address.ts

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * The type of address.
  */
-export const Type = {
+export const AddressType = {
   Primary: "primary",
   Secondary: "secondary",
   Home: "home",
@@ -24,7 +24,7 @@ export const Type = {
 /**
  * The type of address.
  */
-export type Type = ClosedEnum<typeof Type>;
+export type AddressType = ClosedEnum<typeof AddressType>;
 
 export type Address = {
   /**
@@ -34,7 +34,7 @@ export type Address = {
   /**
    * The type of address.
    */
-  type?: Type | null | undefined;
+  type?: AddressType | null | undefined;
   /**
    * The address string. Some APIs don't provide structured address data.
    */
@@ -126,30 +126,29 @@ export type Address = {
 };
 
 /** @internal */
-export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
-  Type,
-);
+export const AddressType$inboundSchema: z.ZodNativeEnum<typeof AddressType> = z
+  .nativeEnum(AddressType);
 
 /** @internal */
-export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
-  Type$inboundSchema;
+export const AddressType$outboundSchema: z.ZodNativeEnum<typeof AddressType> =
+  AddressType$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace Type$ {
-  /** @deprecated use `Type$inboundSchema` instead. */
-  export const inboundSchema = Type$inboundSchema;
-  /** @deprecated use `Type$outboundSchema` instead. */
-  export const outboundSchema = Type$outboundSchema;
+export namespace AddressType$ {
+  /** @deprecated use `AddressType$inboundSchema` instead. */
+  export const inboundSchema = AddressType$inboundSchema;
+  /** @deprecated use `AddressType$outboundSchema` instead. */
+  export const outboundSchema = AddressType$outboundSchema;
 }
 
 /** @internal */
 export const Address$inboundSchema: z.ZodType<Address, z.ZodTypeDef, unknown> =
   z.object({
     id: z.nullable(z.string()).optional(),
-    type: z.nullable(Type$inboundSchema).optional(),
+    type: z.nullable(AddressType$inboundSchema).optional(),
     string: z.nullable(z.string()).optional(),
     name: z.nullable(z.string()).optional(),
     line1: z.nullable(z.string()).optional(),
@@ -217,7 +216,7 @@ export const Address$outboundSchema: z.ZodType<
   Address
 > = z.object({
   id: z.nullable(z.string()).optional(),
-  type: z.nullable(Type$outboundSchema).optional(),
+  type: z.nullable(AddressType$outboundSchema).optional(),
   string: z.nullable(z.string()).optional(),
   name: z.nullable(z.string()).optional(),
   line1: z.nullable(z.string()).optional(),

package/src/models/components/balancesheetfilter.ts

@@ -25,6 +25,8 @@ export type PeriodType = ClosedEnum<typeof PeriodType>;
 export type BalanceSheetFilter = {
   /**
    * The start date of the period to include in the resource.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   startDate?: string | undefined;
   /**

package/src/models/components/bill.ts

@@ -206,6 +206,10 @@ export type Bill = {
    * Discount percentage applied to this transaction.
    */
   discountPercentage?: number | null | undefined;
+  /**
+   * URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.
+   */
+  sourceDocumentUrl?: string | null | undefined;
   /**
    * A list of linked tracking categories.
    */
@@ -346,6 +350,10 @@ export type BillInput = {
    * Discount percentage applied to this transaction.
    */
   discountPercentage?: number | null | undefined;
+  /**
+   * URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.
+   */
+  sourceDocumentUrl?: string | null | undefined;
   /**
    * A list of linked tracking categories.
    */
@@ -417,6 +425,7 @@ export const Bill$inboundSchema: z.ZodType<Bill, z.ZodTypeDef, unknown> = z
     accounting_by_row: z.nullable(z.boolean()).optional(),
     bank_account: BankAccount$inboundSchema.optional(),
     discount_percentage: z.nullable(z.number()).optional(),
+    source_document_url: z.nullable(z.string()).optional(),
     tracking_categories: z.nullable(
       z.array(z.nullable(LinkedTrackingCategory$inboundSchema)),
     ).optional(),
@@ -453,6 +462,7 @@ export const Bill$inboundSchema: z.ZodType<Bill, z.ZodTypeDef, unknown> = z
       "accounting_by_row": "accountingByRow",
       "bank_account": "bankAccount",
       "discount_percentage": "discountPercentage",
+      "source_document_url": "sourceDocumentUrl",
       "tracking_categories": "trackingCategories",
       "updated_by": "updatedBy",
       "created_by": "createdBy",
@@ -498,6 +508,7 @@ export type Bill$Outbound = {
   accounting_by_row?: boolean | null | undefined;
   bank_account?: BankAccount$Outbound | undefined;
   discount_percentage?: number | null | undefined;
+  source_document_url?: string | null | undefined;
   tracking_categories?:
     | Array<LinkedTrackingCategory$Outbound | null>
     | null
@@ -549,6 +560,7 @@ export const Bill$outboundSchema: z.ZodType<Bill$Outbound, z.ZodTypeDef, Bill> =
     accountingByRow: z.nullable(z.boolean()).optional(),
     bankAccount: BankAccount$outboundSchema.optional(),
     discountPercentage: z.nullable(z.number()).optional(),
+    sourceDocumentUrl: z.nullable(z.string()).optional(),
     trackingCategories: z.nullable(
       z.array(z.nullable(LinkedTrackingCategory$outboundSchema)),
     ).optional(),
@@ -581,6 +593,7 @@ export const Bill$outboundSchema: z.ZodType<Bill$Outbound, z.ZodTypeDef, Bill> =
       accountingByRow: "accounting_by_row",
       bankAccount: "bank_account",
       discountPercentage: "discount_percentage",
+      sourceDocumentUrl: "source_document_url",
       trackingCategories: "tracking_categories",
       updatedBy: "updated_by",
       createdBy: "created_by",
@@ -655,6 +668,7 @@ export const BillInput$inboundSchema: z.ZodType<
   accounting_by_row: z.nullable(z.boolean()).optional(),
   bank_account: BankAccount$inboundSchema.optional(),
   discount_percentage: z.nullable(z.number()).optional(),
+  source_document_url: z.nullable(z.string()).optional(),
   tracking_categories: z.nullable(
     z.array(z.nullable(LinkedTrackingCategory$inboundSchema)),
   ).optional(),
@@ -681,6 +695,7 @@ export const BillInput$inboundSchema: z.ZodType<
     "accounting_by_row": "accountingByRow",
     "bank_account": "bankAccount",
     "discount_percentage": "discountPercentage",
+    "source_document_url": "sourceDocumentUrl",
     "tracking_categories": "trackingCategories",
     "row_version": "rowVersion",
     "custom_fields": "customFields",
@@ -719,6 +734,7 @@ export type BillInput$Outbound = {
   accounting_by_row?: boolean | null | undefined;
   bank_account?: BankAccount$Outbound | undefined;
   discount_percentage?: number | null | undefined;
+  source_document_url?: string | null | undefined;
   tracking_categories?:
     | Array<LinkedTrackingCategory$Outbound | null>
     | null
@@ -766,6 +782,7 @@ export const BillInput$outboundSchema: z.ZodType<
   accountingByRow: z.nullable(z.boolean()).optional(),
   bankAccount: BankAccount$outboundSchema.optional(),
   discountPercentage: z.nullable(z.number()).optional(),
+  sourceDocumentUrl: z.nullable(z.string()).optional(),
   trackingCategories: z.nullable(
     z.array(z.nullable(LinkedTrackingCategory$outboundSchema)),
   ).optional(),
@@ -792,6 +809,7 @@ export const BillInput$outboundSchema: z.ZodType<
     accountingByRow: "accounting_by_row",
     bankAccount: "bank_account",
     discountPercentage: "discount_percentage",
+    sourceDocumentUrl: "source_document_url",
     trackingCategories: "tracking_categories",
     rowVersion: "row_version",
     customFields: "custom_fields",

package/src/models/components/billpayment.ts

@@ -138,7 +138,7 @@ export type BillPayment = {
    */
   currencyRate?: number | null | undefined;
   /**
-   * The total amount of the transaction
+   * The total amount of the transaction or record
    */
   totalAmount: number | null;
   /**
@@ -259,7 +259,7 @@ export type BillPaymentInput = {
    */
   currencyRate?: number | null | undefined;
   /**
-   * The total amount of the transaction
+   * The total amount of the transaction or record
    */
   totalAmount: number | null;
   /**

package/src/models/components/contact.ts

@@ -60,7 +60,7 @@ import {
 /**
  * The type of the contact.
  */
-export const ContactType = {
+export const Type = {
   Customer: "customer",
   Supplier: "supplier",
   Employee: "employee",
@@ -69,7 +69,7 @@ export const ContactType = {
 /**
  * The type of the contact.
  */
-export type ContactType = ClosedEnum<typeof ContactType>;
+export type Type = ClosedEnum<typeof Type>;
 
 /**
  * The gender of the contact.
@@ -100,7 +100,7 @@ export type Contact = {
   /**
    * The type of the contact.
    */
-  type?: ContactType | null | undefined;
+  type?: Type | null | undefined;
   /**
    * The company the contact is associated with.
    */
@@ -239,7 +239,7 @@ export type ContactInput = {
   /**
    * The type of the contact.
    */
-  type?: ContactType | null | undefined;
+  type?: Type | null | undefined;
   /**
    * The company the contact is associated with.
    */
@@ -343,22 +343,23 @@ export type ContactInput = {
 };
 
 /** @internal */
-export const ContactType$inboundSchema: z.ZodNativeEnum<typeof ContactType> = z
-  .nativeEnum(ContactType);
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
 
 /** @internal */
-export const ContactType$outboundSchema: z.ZodNativeEnum<typeof ContactType> =
-  ContactType$inboundSchema;
+export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
+  Type$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace ContactType$ {
-  /** @deprecated use `ContactType$inboundSchema` instead. */
-  export const inboundSchema = ContactType$inboundSchema;
-  /** @deprecated use `ContactType$outboundSchema` instead. */
-  export const outboundSchema = ContactType$outboundSchema;
+export namespace Type$ {
+  /** @deprecated use `Type$inboundSchema` instead. */
+  export const inboundSchema = Type$inboundSchema;
+  /** @deprecated use `Type$outboundSchema` instead. */
+  export const outboundSchema = Type$outboundSchema;
 }
 
 /** @internal */
@@ -388,7 +389,7 @@ export const Contact$inboundSchema: z.ZodType<Contact, z.ZodTypeDef, unknown> =
     id: z.string().optional(),
     name: z.nullable(z.string()),
     owner_id: z.nullable(z.string()).optional(),
-    type: z.nullable(ContactType$inboundSchema).optional(),
+    type: z.nullable(Type$inboundSchema).optional(),
     company_id: z.nullable(z.string()).optional(),
     company_name: z.nullable(z.string()).optional(),
     lead_id: z.nullable(z.string()).optional(),
@@ -517,7 +518,7 @@ export const Contact$outboundSchema: z.ZodType<
   id: z.string().optional(),
   name: z.nullable(z.string()),
   ownerId: z.nullable(z.string()).optional(),
-  type: z.nullable(ContactType$outboundSchema).optional(),
+  type: z.nullable(Type$outboundSchema).optional(),
   companyId: z.nullable(z.string()).optional(),
   companyName: z.nullable(z.string()).optional(),
   leadId: z.nullable(z.string()).optional(),
@@ -618,7 +619,7 @@ export const ContactInput$inboundSchema: z.ZodType<
 > = z.object({
   name: z.nullable(z.string()),
   owner_id: z.nullable(z.string()).optional(),
-  type: z.nullable(ContactType$inboundSchema).optional(),
+  type: z.nullable(Type$inboundSchema).optional(),
   company_id: z.nullable(z.string()).optional(),
   company_name: z.nullable(z.string()).optional(),
   lead_id: z.nullable(z.string()).optional(),
@@ -717,7 +718,7 @@ export const ContactInput$outboundSchema: z.ZodType<
 > = z.object({
   name: z.nullable(z.string()),
   ownerId: z.nullable(z.string()).optional(),
-  type: z.nullable(ContactType$outboundSchema).optional(),
+  type: z.nullable(Type$outboundSchema).optional(),
   companyId: z.nullable(z.string()).optional(),
   companyName: z.nullable(z.string()).optional(),
   leadId: z.nullable(z.string()).optional(),

package/src/models/components/customersfilter.ts

@@ -49,6 +49,10 @@ export type CustomersFilter = {
    */
   status?: CustomersFilterStatus | null | undefined;
   updatedSince?: Date | undefined;
+  /**
+   * Supplier ID of customer to search for
+   */
+  supplierId?: string | undefined;
 };
 
 /** @internal */
@@ -87,6 +91,7 @@ export const CustomersFilter$inboundSchema: z.ZodType<
   updated_since: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ).optional(),
+  supplier_id: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "company_name": "companyName",
@@ -94,6 +99,7 @@ export const CustomersFilter$inboundSchema: z.ZodType<
     "first_name": "firstName",
     "last_name": "lastName",
     "updated_since": "updatedSince",
+    "supplier_id": "supplierId",
   });
 });
 
@@ -106,6 +112,7 @@ export type CustomersFilter$Outbound = {
   email?: string | undefined;
   status?: string | null | undefined;
   updated_since?: string | undefined;
+  supplier_id?: string | undefined;
 };
 
 /** @internal */
@@ -121,6 +128,7 @@ export const CustomersFilter$outboundSchema: z.ZodType<
   email: z.string().optional(),
   status: z.nullable(CustomersFilterStatus$outboundSchema).optional(),
   updatedSince: z.date().transform(v => v.toISOString()).optional(),
+  supplierId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     companyName: "company_name",
@@ -128,6 +136,7 @@ export const CustomersFilter$outboundSchema: z.ZodType<
     firstName: "first_name",
     lastName: "last_name",
     updatedSince: "updated_since",
+    supplierId: "supplier_id",
   });
 });
 

package/src/models/components/index.ts

@@ -411,6 +411,8 @@ export * from "./phonenumber.js";
 export * from "./pipeline.js";
 export * from "./profitandloss.js";
 export * from "./profitandlossfilter.js";
+export * from "./profitandlossindicator.js";
+export * from "./profitandlosstype.js";
 export * from "./purchaseorder.js";
 export * from "./purchaseordersfilter.js";
 export * from "./purchaseorderssort.js";

package/src/models/components/payment.ts

@@ -89,7 +89,7 @@ export type Payment = {
    */
   currencyRate?: number | null | undefined;
   /**
-   * The total amount of the transaction
+   * The total amount of the transaction or record
    */
   totalAmount: number | null;
   /**

package/src/models/components/paymentinput.ts

@@ -75,7 +75,7 @@ export type PaymentInput = {
    */
   currencyRate?: number | null | undefined;
   /**
-   * The total amount of the transaction
+   * The total amount of the transaction or record
    */
   totalAmount: number | null;
   /**