@apideck/unify 0.38.2 → 0.39.0

package/src/models/components/linkedexpensecategory.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The expense category this entity is linked to.
+ */
+export type LinkedExpenseCategory = {
+  /**
+   * The ID of the expense category.
+   */
+  id?: string | undefined;
+  /**
+   * The third-party API ID of the expense category.
+   */
+  downstreamId?: string | null | undefined;
+  /**
+   * The display ID of the expense category.
+   */
+  displayId?: string | null | undefined;
+  /**
+   * The name of the expense category.
+   */
+  name?: string | null | undefined;
+};
+
+/** @internal */
+export const LinkedExpenseCategory$inboundSchema: z.ZodType<
+  LinkedExpenseCategory,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.string()),
+  downstream_id: z.nullable(types.string()).optional(),
+  display_id: z.nullable(types.string()).optional(),
+  name: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "downstream_id": "downstreamId",
+    "display_id": "displayId",
+  });
+});
+/** @internal */
+export type LinkedExpenseCategory$Outbound = {
+  id?: string | undefined;
+  downstream_id?: string | null | undefined;
+  display_id?: string | null | undefined;
+  name?: string | null | undefined;
+};
+
+/** @internal */
+export const LinkedExpenseCategory$outboundSchema: z.ZodType<
+  LinkedExpenseCategory$Outbound,
+  z.ZodTypeDef,
+  LinkedExpenseCategory
+> = z.object({
+  id: z.string().optional(),
+  downstreamId: z.nullable(z.string()).optional(),
+  displayId: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    downstreamId: "downstream_id",
+    displayId: "display_id",
+  });
+});
+
+export function linkedExpenseCategoryToJSON(
+  linkedExpenseCategory: LinkedExpenseCategory,
+): string {
+  return JSON.stringify(
+    LinkedExpenseCategory$outboundSchema.parse(linkedExpenseCategory),
+  );
+}
+export function linkedExpenseCategoryFromJSON(
+  jsonString: string,
+): SafeParseResult<LinkedExpenseCategory, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LinkedExpenseCategory$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LinkedExpenseCategory' from JSON`,
+  );
+}

package/src/models/components/linkedsubsidiary.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type LinkedSubsidiary = {
+  /**
+   * A unique identifier for an object.
+   */
+  id?: string | undefined;
+  /**
+   * Id to be displayed.
+   */
+  displayId?: string | null | undefined;
+  /**
+   * The name of the resource.
+   */
+  name?: string | null | undefined;
+};
+
+/** @internal */
+export const LinkedSubsidiary$inboundSchema: z.ZodType<
+  LinkedSubsidiary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.string()),
+  display_id: z.nullable(types.string()).optional(),
+  name: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "display_id": "displayId",
+  });
+});
+
+export function linkedSubsidiaryFromJSON(
+  jsonString: string,
+): SafeParseResult<LinkedSubsidiary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LinkedSubsidiary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LinkedSubsidiary' from JSON`,
+  );
+}

package/src/models/components/linkedsubsidiaryinput.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type LinkedSubsidiaryInput = {
+  /**
+   * Id to be displayed.
+   */
+  displayId?: string | null | undefined;
+  /**
+   * The name of the resource.
+   */
+  name?: string | null | undefined;
+};
+
+/** @internal */
+export type LinkedSubsidiaryInput$Outbound = {
+  display_id?: string | null | undefined;
+  name?: string | null | undefined;
+};
+
+/** @internal */
+export const LinkedSubsidiaryInput$outboundSchema: z.ZodType<
+  LinkedSubsidiaryInput$Outbound,
+  z.ZodTypeDef,
+  LinkedSubsidiaryInput
+> = z.object({
+  displayId: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    displayId: "display_id",
+  });
+});
+
+export function linkedSubsidiaryInputToJSON(
+  linkedSubsidiaryInput: LinkedSubsidiaryInput,
+): string {
+  return JSON.stringify(
+    LinkedSubsidiaryInput$outboundSchema.parse(linkedSubsidiaryInput),
+  );
+}

package/src/models/components/purchaseorder.ts

@@ -201,6 +201,10 @@ export type PurchaseOrder = {
    * Terms of payment.
    */
   terms?: string | null | undefined;
+  /**
+   * The ID of the payment terms
+   */
+  termsId?: string | null | undefined;
   /**
    * Type of amortization
    */
@@ -367,6 +371,10 @@ export type PurchaseOrderInput = {
    * Terms of payment.
    */
   terms?: string | null | undefined;
+  /**
+   * The ID of the payment terms
+   */
+  termsId?: string | null | undefined;
   /**
    * Type of amortization
    */
@@ -477,6 +485,7 @@ export const PurchaseOrder$inboundSchema: z.ZodType<
   due_date: z.nullable(types.date()).optional(),
   payment_method: z.nullable(types.string()).optional(),
   terms: z.nullable(types.string()).optional(),
+  terms_id: z.nullable(types.string()).optional(),
   amortization_type: z.nullable(PurchaseOrderAmortizationType$inboundSchema)
     .optional(),
   tax_code: z.nullable(types.string()).optional(),
@@ -523,6 +532,7 @@ export const PurchaseOrder$inboundSchema: z.ZodType<
     "accounting_by_row": "accountingByRow",
     "due_date": "dueDate",
     "payment_method": "paymentMethod",
+    "terms_id": "termsId",
     "amortization_type": "amortizationType",
     "tax_code": "taxCode",
     "tax_method": "taxMethod",
@@ -581,6 +591,7 @@ export type PurchaseOrderInput$Outbound = {
   due_date?: string | null | undefined;
   payment_method?: string | null | undefined;
   terms?: string | null | undefined;
+  terms_id?: string | null | undefined;
   amortization_type?: string | null | undefined;
   tax_code?: string | null | undefined;
   tax_method?: string | null | undefined;
@@ -641,6 +652,7 @@ export const PurchaseOrderInput$outboundSchema: z.ZodType<
   ).optional(),
   paymentMethod: z.nullable(z.string()).optional(),
   terms: z.nullable(z.string()).optional(),
+  termsId: z.nullable(z.string()).optional(),
   amortizationType: z.nullable(PurchaseOrderAmortizationType$outboundSchema)
     .optional(),
   taxCode: z.nullable(z.string()).optional(),
@@ -681,6 +693,7 @@ export const PurchaseOrderInput$outboundSchema: z.ZodType<
     accountingByRow: "accounting_by_row",
     dueDate: "due_date",
     paymentMethod: "payment_method",
+    termsId: "terms_id",
     amortizationType: "amortization_type",
     taxCode: "tax_code",
     taxMethod: "tax_method",

package/src/models/components/quote.ts

@@ -123,6 +123,10 @@ export type Quote = {
    * Terms of the quote.
    */
   terms?: string | null | undefined;
+  /**
+   * The ID of the payment terms
+   */
+  termsId?: string | null | undefined;
   /**
    * Optional reference identifier for the transaction.
    */
@@ -250,6 +254,10 @@ export type QuoteInput = {
    * Terms of the quote.
    */
   terms?: string | null | undefined;
+  /**
+   * The ID of the payment terms
+   */
+  termsId?: string | null | undefined;
   /**
    * Optional reference identifier for the transaction.
    */
@@ -352,6 +360,7 @@ export const Quote$inboundSchema: z.ZodType<Quote, z.ZodTypeDef, unknown> = z
     quote_date: z.nullable(types.date()).optional(),
     expiry_date: z.nullable(types.date()).optional(),
     terms: z.nullable(types.string()).optional(),
+    terms_id: z.nullable(types.string()).optional(),
     reference: z.nullable(types.string()).optional(),
     status: z.nullable(QuoteStatus$inboundSchema).optional(),
     currency: z.nullable(Currency$inboundSchema).optional(),
@@ -389,6 +398,7 @@ export const Quote$inboundSchema: z.ZodType<Quote, z.ZodTypeDef, unknown> = z
       "project_id": "projectId",
       "quote_date": "quoteDate",
       "expiry_date": "expiryDate",
+      "terms_id": "termsId",
       "currency_rate": "currencyRate",
       "tax_inclusive": "taxInclusive",
       "sub_total": "subTotal",
@@ -434,6 +444,7 @@ export type QuoteInput$Outbound = {
   quote_date?: string | null | undefined;
   expiry_date?: string | null | undefined;
   terms?: string | null | undefined;
+  terms_id?: string | null | undefined;
   reference?: string | null | undefined;
   status?: string | null | undefined;
   currency?: string | null | undefined;
@@ -479,6 +490,7 @@ export const QuoteInput$outboundSchema: z.ZodType<
     z.date().transform(v => v.toISOString().slice(0, "YYYY-MM-DD".length)),
   ).optional(),
   terms: z.nullable(z.string()).optional(),
+  termsId: z.nullable(z.string()).optional(),
   reference: z.nullable(z.string()).optional(),
   status: z.nullable(QuoteStatus$outboundSchema).optional(),
   currency: z.nullable(Currency$outboundSchema).optional(),
@@ -510,6 +522,7 @@ export const QuoteInput$outboundSchema: z.ZodType<
     projectId: "project_id",
     quoteDate: "quote_date",
     expiryDate: "expiry_date",
+    termsId: "terms_id",
     currencyRate: "currency_rate",
     taxInclusive: "tax_inclusive",
     subTotal: "sub_total",

package/src/models/components/refund.ts

@@ -0,0 +1,265 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Address, Address$inboundSchema } from "./address.js";
+import { Allocation, Allocation$inboundSchema } from "./allocation.js";
+import { Currency, Currency$inboundSchema } from "./currency.js";
+import { CustomField, CustomField$inboundSchema } from "./customfield.js";
+import {
+  InvoiceLineItem,
+  InvoiceLineItem$inboundSchema,
+} from "./invoicelineitem.js";
+import {
+  LinkedCustomer,
+  LinkedCustomer$inboundSchema,
+} from "./linkedcustomer.js";
+import {
+  LinkedDepartment,
+  LinkedDepartment$inboundSchema,
+} from "./linkeddepartment.js";
+import {
+  LinkedLedgerAccount,
+  LinkedLedgerAccount$inboundSchema,
+} from "./linkedledgeraccount.js";
+import {
+  LinkedLocation,
+  LinkedLocation$inboundSchema,
+} from "./linkedlocation.js";
+import {
+  LinkedTrackingCategory,
+  LinkedTrackingCategory$inboundSchema,
+} from "./linkedtrackingcategory.js";
+import {
+  PassThroughBody,
+  PassThroughBody$inboundSchema,
+} from "./passthroughbody.js";
+import { RefundStatus, RefundStatus$inboundSchema } from "./refundstatus.js";
+import { RefundType, RefundType$inboundSchema } from "./refundtype.js";
+
+export type Refund = {
+  /**
+   * Unique identifier representing the refund
+   */
+  id: string;
+  /**
+   * Reference number for the refund.
+   */
+  number?: string | null | undefined;
+  /**
+   * The customer this entity is linked to.
+   */
+  customer?: LinkedCustomer | null | undefined;
+  /**
+   * The company ID the transaction belongs to
+   */
+  companyId?: string | null | undefined;
+  /**
+   * Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
+   */
+  currency?: Currency | null | undefined;
+  /**
+   * Currency Exchange Rate at the time entity was recorded/generated.
+   */
+  currencyRate?: number | null | undefined;
+  /**
+   * Amounts are including tax
+   */
+  taxInclusive?: boolean | null | undefined;
+  /**
+   * Subtotal amount, normally before tax.
+   */
+  subTotal?: number | null | undefined;
+  /**
+   * The total amount of the transaction or record
+   */
+  totalAmount: number | null;
+  /**
+   * Total tax amount applied to this transaction.
+   */
+  totalTax?: number | null | undefined;
+  /**
+   * The date of the refund - YYYY-MM-DDThh:mm:ss.sTZD
+   */
+  refundDate?: Date | null | undefined;
+  /**
+   * Status of refund. Maps to: QBO (limited status), NetSuite CashRefund status, Sage Intacct state (draft/posted/voided), Zoho Books vis_state.
+   */
+  status?: RefundStatus | undefined;
+  /**
+   * Type of refund. `refund_receipt` for itemized refunds with product/service lines and payment (QBO RefundReceipt, NetSuite CashRefund). `cash_refund` for cash-out refunds with GL distribution or allocations (Sage Intacct). `credit_note_refund` for refunds applied against a credit note (Zoho Books).
+   */
+  type?: RefundType | undefined;
+  /**
+   * Payment method used for the transaction, such as cash, credit card, bank transfer, or check
+   */
+  paymentMethod?: string | null | undefined;
+  /**
+   * Optional reference message returned by payment method on processing
+   */
+  paymentMethodReference?: string | null | undefined;
+  /**
+   * A unique identifier for an object.
+   */
+  paymentMethodId?: string | null | undefined;
+  account?: LinkedLedgerAccount | null | undefined;
+  /**
+   * Line items for itemized refunds (type: refund_receipt). Used when the refund includes product/service details with quantities and pricing. Supported by QBO RefundReceipt and NetSuite CashRefund.
+   */
+  lineItems?: Array<InvoiceLineItem> | undefined;
+  /**
+   * Allocations linking refund to existing documents (invoices, credit notes, overpayments). Used for credit_note_refund and cash_refund types where the refund is applied against prior transactions. Supported by Sage Intacct and Zoho Books.
+   */
+  allocations?: Array<Allocation> | undefined;
+  /**
+   * Applicable tax id/code override if tax is not supplied on a line item basis.
+   */
+  taxCode?: string | null | undefined;
+  /**
+   * Discount percentage applied to this refund.
+   */
+  discountPercentage?: number | null | undefined;
+  /**
+   * Discount amount applied to this refund.
+   */
+  discountAmount?: number | null | undefined;
+  /**
+   * Optional note to be associated with the refund.
+   */
+  note?: string | null | undefined;
+  /**
+   * Customer memo
+   */
+  customerMemo?: string | null | undefined;
+  /**
+   * Optional reference message for the refund.
+   */
+  reference?: string | null | undefined;
+  billingAddress?: Address | undefined;
+  shippingAddress?: Address | undefined;
+  department?: LinkedDepartment | null | undefined;
+  location?: LinkedLocation | null | undefined;
+  /**
+   * A list of linked tracking categories.
+   */
+  trackingCategories?: Array<LinkedTrackingCategory | null> | null | undefined;
+  /**
+   * When custom mappings are configured on the resource, the result is included here.
+   */
+  customMappings?: { [k: string]: any } | null | undefined;
+  customFields?: Array<CustomField> | undefined;
+  /**
+   * A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
+   */
+  rowVersion?: string | null | undefined;
+  /**
+   * The user who last updated the object.
+   */
+  updatedBy?: string | null | undefined;
+  /**
+   * The user who created the object.
+   */
+  createdBy?: string | null | undefined;
+  /**
+   * The date and time when the object was last updated.
+   */
+  updatedAt?: Date | null | undefined;
+  /**
+   * The date and time when the object was created.
+   */
+  createdAt?: Date | null | undefined;
+  /**
+   * The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
+   */
+  passThrough?: Array<PassThroughBody> | undefined;
+};
+
+/** @internal */
+export const Refund$inboundSchema: z.ZodType<Refund, z.ZodTypeDef, unknown> = z
+  .object({
+    id: types.string(),
+    number: z.nullable(types.string()).optional(),
+    customer: z.nullable(LinkedCustomer$inboundSchema).optional(),
+    company_id: z.nullable(types.string()).optional(),
+    currency: z.nullable(Currency$inboundSchema).optional(),
+    currency_rate: z.nullable(types.number()).optional(),
+    tax_inclusive: z.nullable(types.boolean()).optional(),
+    sub_total: z.nullable(types.number()).optional(),
+    total_amount: types.nullable(types.number()),
+    total_tax: z.nullable(types.number()).optional(),
+    refund_date: z.nullable(types.date()).optional(),
+    status: types.optional(RefundStatus$inboundSchema),
+    type: types.optional(RefundType$inboundSchema),
+    payment_method: z.nullable(types.string()).optional(),
+    payment_method_reference: z.nullable(types.string()).optional(),
+    payment_method_id: z.nullable(types.string()).optional(),
+    account: z.nullable(LinkedLedgerAccount$inboundSchema).optional(),
+    line_items: types.optional(z.array(InvoiceLineItem$inboundSchema)),
+    allocations: types.optional(z.array(Allocation$inboundSchema)),
+    tax_code: z.nullable(types.string()).optional(),
+    discount_percentage: z.nullable(types.number()).optional(),
+    discount_amount: z.nullable(types.number()).optional(),
+    note: z.nullable(types.string()).optional(),
+    customer_memo: z.nullable(types.string()).optional(),
+    reference: z.nullable(types.string()).optional(),
+    billing_address: types.optional(Address$inboundSchema),
+    shipping_address: types.optional(Address$inboundSchema),
+    department: z.nullable(LinkedDepartment$inboundSchema).optional(),
+    location: z.nullable(LinkedLocation$inboundSchema).optional(),
+    tracking_categories: z.nullable(
+      z.array(types.nullable(LinkedTrackingCategory$inboundSchema)),
+    ).optional(),
+    custom_mappings: z.nullable(z.record(z.any())).optional(),
+    custom_fields: types.optional(z.array(CustomField$inboundSchema)),
+    row_version: z.nullable(types.string()).optional(),
+    updated_by: z.nullable(types.string()).optional(),
+    created_by: z.nullable(types.string()).optional(),
+    updated_at: z.nullable(types.date()).optional(),
+    created_at: z.nullable(types.date()).optional(),
+    pass_through: types.optional(z.array(PassThroughBody$inboundSchema)),
+  }).transform((v) => {
+    return remap$(v, {
+      "company_id": "companyId",
+      "currency_rate": "currencyRate",
+      "tax_inclusive": "taxInclusive",
+      "sub_total": "subTotal",
+      "total_amount": "totalAmount",
+      "total_tax": "totalTax",
+      "refund_date": "refundDate",
+      "payment_method": "paymentMethod",
+      "payment_method_reference": "paymentMethodReference",
+      "payment_method_id": "paymentMethodId",
+      "line_items": "lineItems",
+      "tax_code": "taxCode",
+      "discount_percentage": "discountPercentage",
+      "discount_amount": "discountAmount",
+      "customer_memo": "customerMemo",
+      "billing_address": "billingAddress",
+      "shipping_address": "shippingAddress",
+      "tracking_categories": "trackingCategories",
+      "custom_mappings": "customMappings",
+      "custom_fields": "customFields",
+      "row_version": "rowVersion",
+      "updated_by": "updatedBy",
+      "created_by": "createdBy",
+      "updated_at": "updatedAt",
+      "created_at": "createdAt",
+      "pass_through": "passThrough",
+    });
+  });
+
+export function refundFromJSON(
+  jsonString: string,
+): SafeParseResult<Refund, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Refund$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Refund' from JSON`,
+  );
+}