@apideck/unify 0.38.2 → 0.39.0

package/src/models/components/refundinput.ts

@@ -0,0 +1,281 @@
+/*
+ * 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 {
+  Address,
+  Address$Outbound,
+  Address$outboundSchema,
+} from "./address.js";
+import {
+  AllocationInput,
+  AllocationInput$Outbound,
+  AllocationInput$outboundSchema,
+} from "./allocation.js";
+import { Currency, Currency$outboundSchema } from "./currency.js";
+import {
+  CustomField,
+  CustomField$Outbound,
+  CustomField$outboundSchema,
+} from "./customfield.js";
+import {
+  InvoiceLineItemInput,
+  InvoiceLineItemInput$Outbound,
+  InvoiceLineItemInput$outboundSchema,
+} from "./invoicelineitem.js";
+import {
+  LinkedCustomerInput,
+  LinkedCustomerInput$Outbound,
+  LinkedCustomerInput$outboundSchema,
+} from "./linkedcustomerinput.js";
+import {
+  LinkedDepartmentInput,
+  LinkedDepartmentInput$Outbound,
+  LinkedDepartmentInput$outboundSchema,
+} from "./linkeddepartmentinput.js";
+import {
+  LinkedLedgerAccount,
+  LinkedLedgerAccount$Outbound,
+  LinkedLedgerAccount$outboundSchema,
+} from "./linkedledgeraccount.js";
+import {
+  LinkedLocationInput,
+  LinkedLocationInput$Outbound,
+  LinkedLocationInput$outboundSchema,
+} from "./linkedlocationinput.js";
+import {
+  LinkedTrackingCategory,
+  LinkedTrackingCategory$Outbound,
+  LinkedTrackingCategory$outboundSchema,
+} from "./linkedtrackingcategory.js";
+import {
+  PassThroughBody,
+  PassThroughBody$Outbound,
+  PassThroughBody$outboundSchema,
+} from "./passthroughbody.js";
+import { RefundStatus, RefundStatus$outboundSchema } from "./refundstatus.js";
+import { RefundType, RefundType$outboundSchema } from "./refundtype.js";
+
+export type RefundInput = {
+  /**
+   * Reference number for the refund.
+   */
+  number?: string | null | undefined;
+  /**
+   * The customer this entity is linked to.
+   */
+  customer?: LinkedCustomerInput | 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<InvoiceLineItemInput> | 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<AllocationInput> | 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?: LinkedDepartmentInput | null | undefined;
+  location?: LinkedLocationInput | null | undefined;
+  /**
+   * A list of linked tracking categories.
+   */
+  trackingCategories?: Array<LinkedTrackingCategory | null> | 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 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 type RefundInput$Outbound = {
+  number?: string | null | undefined;
+  customer?: LinkedCustomerInput$Outbound | null | undefined;
+  company_id?: string | null | undefined;
+  currency?: string | null | undefined;
+  currency_rate?: number | null | undefined;
+  tax_inclusive?: boolean | null | undefined;
+  sub_total?: number | null | undefined;
+  total_amount: number | null;
+  total_tax?: number | null | undefined;
+  refund_date?: string | null | undefined;
+  status?: string | undefined;
+  type?: string | undefined;
+  payment_method?: string | null | undefined;
+  payment_method_reference?: string | null | undefined;
+  payment_method_id?: string | null | undefined;
+  account?: LinkedLedgerAccount$Outbound | null | undefined;
+  line_items?: Array<InvoiceLineItemInput$Outbound> | undefined;
+  allocations?: Array<AllocationInput$Outbound> | undefined;
+  tax_code?: string | null | undefined;
+  discount_percentage?: number | null | undefined;
+  discount_amount?: number | null | undefined;
+  note?: string | null | undefined;
+  customer_memo?: string | null | undefined;
+  reference?: string | null | undefined;
+  billing_address?: Address$Outbound | undefined;
+  shipping_address?: Address$Outbound | undefined;
+  department?: LinkedDepartmentInput$Outbound | null | undefined;
+  location?: LinkedLocationInput$Outbound | null | undefined;
+  tracking_categories?:
+    | Array<LinkedTrackingCategory$Outbound | null>
+    | null
+    | undefined;
+  custom_fields?: Array<CustomField$Outbound> | undefined;
+  row_version?: string | null | undefined;
+  pass_through?: Array<PassThroughBody$Outbound> | undefined;
+};
+
+/** @internal */
+export const RefundInput$outboundSchema: z.ZodType<
+  RefundInput$Outbound,
+  z.ZodTypeDef,
+  RefundInput
+> = z.object({
+  number: z.nullable(z.string()).optional(),
+  customer: z.nullable(LinkedCustomerInput$outboundSchema).optional(),
+  companyId: z.nullable(z.string()).optional(),
+  currency: z.nullable(Currency$outboundSchema).optional(),
+  currencyRate: z.nullable(z.number()).optional(),
+  taxInclusive: z.nullable(z.boolean()).optional(),
+  subTotal: z.nullable(z.number()).optional(),
+  totalAmount: z.nullable(z.number()),
+  totalTax: z.nullable(z.number()).optional(),
+  refundDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  status: RefundStatus$outboundSchema.optional(),
+  type: RefundType$outboundSchema.optional(),
+  paymentMethod: z.nullable(z.string()).optional(),
+  paymentMethodReference: z.nullable(z.string()).optional(),
+  paymentMethodId: z.nullable(z.string()).optional(),
+  account: z.nullable(LinkedLedgerAccount$outboundSchema).optional(),
+  lineItems: z.array(InvoiceLineItemInput$outboundSchema).optional(),
+  allocations: z.array(AllocationInput$outboundSchema).optional(),
+  taxCode: z.nullable(z.string()).optional(),
+  discountPercentage: z.nullable(z.number()).optional(),
+  discountAmount: z.nullable(z.number()).optional(),
+  note: z.nullable(z.string()).optional(),
+  customerMemo: z.nullable(z.string()).optional(),
+  reference: z.nullable(z.string()).optional(),
+  billingAddress: Address$outboundSchema.optional(),
+  shippingAddress: Address$outboundSchema.optional(),
+  department: z.nullable(LinkedDepartmentInput$outboundSchema).optional(),
+  location: z.nullable(LinkedLocationInput$outboundSchema).optional(),
+  trackingCategories: z.nullable(
+    z.array(z.nullable(LinkedTrackingCategory$outboundSchema)),
+  ).optional(),
+  customFields: z.array(CustomField$outboundSchema).optional(),
+  rowVersion: z.nullable(z.string()).optional(),
+  passThrough: z.array(PassThroughBody$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    currencyRate: "currency_rate",
+    taxInclusive: "tax_inclusive",
+    subTotal: "sub_total",
+    totalAmount: "total_amount",
+    totalTax: "total_tax",
+    refundDate: "refund_date",
+    paymentMethod: "payment_method",
+    paymentMethodReference: "payment_method_reference",
+    paymentMethodId: "payment_method_id",
+    lineItems: "line_items",
+    taxCode: "tax_code",
+    discountPercentage: "discount_percentage",
+    discountAmount: "discount_amount",
+    customerMemo: "customer_memo",
+    billingAddress: "billing_address",
+    shippingAddress: "shipping_address",
+    trackingCategories: "tracking_categories",
+    customFields: "custom_fields",
+    rowVersion: "row_version",
+    passThrough: "pass_through",
+  });
+});
+
+export function refundInputToJSON(refundInput: RefundInput): string {
+  return JSON.stringify(RefundInput$outboundSchema.parse(refundInput));
+}

package/src/models/components/refundsfilter.ts

@@ -0,0 +1,39 @@
+/*
+ * 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 RefundsFilter = {
+  updatedSince?: Date | undefined;
+  /**
+   * Filter by customer id
+   */
+  customerId?: string | undefined;
+};
+
+/** @internal */
+export type RefundsFilter$Outbound = {
+  updated_since?: string | undefined;
+  customer_id?: string | undefined;
+};
+
+/** @internal */
+export const RefundsFilter$outboundSchema: z.ZodType<
+  RefundsFilter$Outbound,
+  z.ZodTypeDef,
+  RefundsFilter
+> = z.object({
+  updatedSince: z.date().transform(v => v.toISOString()).optional(),
+  customerId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    updatedSince: "updated_since",
+    customerId: "customer_id",
+  });
+});
+
+export function refundsFilterToJSON(refundsFilter: RefundsFilter): string {
+  return JSON.stringify(RefundsFilter$outboundSchema.parse(refundsFilter));
+}

package/src/models/components/refundssort.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import {
+  SortDirection,
+  SortDirection$outboundSchema,
+} from "./sortdirection.js";
+
+/**
+ * The field on which to sort the Refunds
+ */
+export const RefundsSortBy = {
+  UpdatedAt: "updated_at",
+  CreatedAt: "created_at",
+} as const;
+/**
+ * The field on which to sort the Refunds
+ */
+export type RefundsSortBy = OpenEnum<typeof RefundsSortBy>;
+
+export type RefundsSort = {
+  /**
+   * The field on which to sort the Refunds
+   */
+  by?: RefundsSortBy | undefined;
+  /**
+   * The direction in which to sort the results
+   */
+  direction?: SortDirection | undefined;
+};
+
+/** @internal */
+export const RefundsSortBy$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  RefundsSortBy
+> = openEnums.outboundSchema(RefundsSortBy);
+
+/** @internal */
+export type RefundsSort$Outbound = {
+  by?: string | undefined;
+  direction: string;
+};
+
+/** @internal */
+export const RefundsSort$outboundSchema: z.ZodType<
+  RefundsSort$Outbound,
+  z.ZodTypeDef,
+  RefundsSort
+> = z.object({
+  by: RefundsSortBy$outboundSchema.optional(),
+  direction: SortDirection$outboundSchema.default("asc"),
+});
+
+export function refundsSortToJSON(refundsSort: RefundsSort): string {
+  return JSON.stringify(RefundsSort$outboundSchema.parse(refundsSort));
+}

package/src/models/components/refundstatus.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Status of refund. Maps to: QBO (limited status), NetSuite CashRefund status, Sage Intacct state (draft/posted/voided), Zoho Books vis_state.
+ */
+export const RefundStatus = {
+  Draft: "draft",
+  Authorised: "authorised",
+  Posted: "posted",
+  Paid: "paid",
+  Voided: "voided",
+  Deleted: "deleted",
+} as const;
+/**
+ * Status of refund. Maps to: QBO (limited status), NetSuite CashRefund status, Sage Intacct state (draft/posted/voided), Zoho Books vis_state.
+ */
+export type RefundStatus = OpenEnum<typeof RefundStatus>;
+
+/** @internal */
+export const RefundStatus$inboundSchema: z.ZodType<
+  RefundStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(RefundStatus);
+/** @internal */
+export const RefundStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  RefundStatus
+> = openEnums.outboundSchema(RefundStatus);

package/src/models/components/refundtype.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * 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).
+ */
+export const RefundType = {
+  RefundReceipt: "refund_receipt",
+  CashRefund: "cash_refund",
+  CreditNoteRefund: "credit_note_refund",
+} as const;
+/**
+ * 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).
+ */
+export type RefundType = OpenEnum<typeof RefundType>;
+
+/** @internal */
+export const RefundType$inboundSchema: z.ZodType<
+  RefundType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(RefundType);
+/** @internal */
+export const RefundType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  RefundType
+> = openEnums.outboundSchema(RefundType);

package/src/models/components/supplier.ts

@@ -179,6 +179,10 @@ export type Supplier = {
    * Terms of payment.
    */
   terms?: string | null | undefined;
+  /**
+   * The ID of the payment terms
+   */
+  termsId?: string | null | undefined;
   /**
    * The channel through which the transaction is processed.
    */
@@ -306,6 +310,10 @@ export type SupplierInput = {
    * Terms of payment.
    */
   terms?: string | null | undefined;
+  /**
+   * The ID of the payment terms
+   */
+  termsId?: string | null | undefined;
   /**
    * The channel through which the transaction is processed.
    */
@@ -385,6 +393,7 @@ export const Supplier$inboundSchema: z.ZodType<
   status: z.nullable(SupplierStatus$inboundSchema).optional(),
   payment_method: z.nullable(types.string()).optional(),
   terms: z.nullable(types.string()).optional(),
+  terms_id: z.nullable(types.string()).optional(),
   channel: z.nullable(types.string()).optional(),
   issued_method: z.nullable(types.string()).optional(),
   issued_email: z.nullable(types.string()).optional(),
@@ -420,6 +429,7 @@ export const Supplier$inboundSchema: z.ZodType<
     "tax_rate": "taxRate",
     "tax_number": "taxNumber",
     "payment_method": "paymentMethod",
+    "terms_id": "termsId",
     "issued_method": "issuedMethod",
     "issued_email": "issuedEmail",
     "custom_mappings": "customMappings",
@@ -474,6 +484,7 @@ export type SupplierInput$Outbound = {
   status?: string | null | undefined;
   payment_method?: string | null | undefined;
   terms?: string | null | undefined;
+  terms_id?: string | null | undefined;
   channel?: string | null | undefined;
   issued_method?: string | null | undefined;
   issued_email?: string | null | undefined;
@@ -517,6 +528,7 @@ export const SupplierInput$outboundSchema: z.ZodType<
   status: z.nullable(SupplierStatus$outboundSchema).optional(),
   paymentMethod: z.nullable(z.string()).optional(),
   terms: z.nullable(z.string()).optional(),
+  termsId: z.nullable(z.string()).optional(),
   channel: z.nullable(z.string()).optional(),
   issuedMethod: z.nullable(z.string()).optional(),
   issuedEmail: z.nullable(z.string()).optional(),
@@ -543,6 +555,7 @@ export const SupplierInput$outboundSchema: z.ZodType<
     taxRate: "tax_rate",
     taxNumber: "tax_number",
     paymentMethod: "payment_method",
+    termsId: "terms_id",
     issuedMethod: "issued_method",
     issuedEmail: "issued_email",
     customFields: "custom_fields",

package/src/models/components/updateaccountingemployeeresponse.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 { UnifiedId, UnifiedId$inboundSchema } from "./unifiedid.js";
+
+/**
+ * Employees
+ */
+export type UpdateAccountingEmployeeResponse = {
+  /**
+   * HTTP Response Status Code
+   */
+  statusCode: number;
+  /**
+   * HTTP Response Status
+   */
+  status: string;
+  /**
+   * Apideck ID of service provider
+   */
+  service: string;
+  /**
+   * Unified API resource name
+   */
+  resource: string;
+  /**
+   * Operation performed
+   */
+  operation: string;
+  /**
+   * A object containing a unique identifier for the resource that was created, updated, or deleted.
+   */
+  data: UnifiedId;
+  /**
+   * Raw response from the integration when raw=true query param is provided
+   */
+  raw?: { [k: string]: any } | null | undefined;
+};
+
+/** @internal */
+export const UpdateAccountingEmployeeResponse$inboundSchema: z.ZodType<
+  UpdateAccountingEmployeeResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status_code: types.number(),
+  status: types.string(),
+  service: types.string(),
+  resource: types.string(),
+  operation: types.string(),
+  data: UnifiedId$inboundSchema,
+  _raw: z.nullable(z.record(z.any())).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "status_code": "statusCode",
+    "_raw": "raw",
+  });
+});
+
+export function updateAccountingEmployeeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateAccountingEmployeeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateAccountingEmployeeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateAccountingEmployeeResponse' from JSON`,
+  );
+}

package/src/models/components/updateexpensecategoryresponse.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 { UnifiedId, UnifiedId$inboundSchema } from "./unifiedid.js";
+
+/**
+ * Expense Categories
+ */
+export type UpdateExpenseCategoryResponse = {
+  /**
+   * HTTP Response Status Code
+   */
+  statusCode: number;
+  /**
+   * HTTP Response Status
+   */
+  status: string;
+  /**
+   * Apideck ID of service provider
+   */
+  service: string;
+  /**
+   * Unified API resource name
+   */
+  resource: string;
+  /**
+   * Operation performed
+   */
+  operation: string;
+  /**
+   * A object containing a unique identifier for the resource that was created, updated, or deleted.
+   */
+  data: UnifiedId;
+  /**
+   * Raw response from the integration when raw=true query param is provided
+   */
+  raw?: { [k: string]: any } | null | undefined;
+};
+
+/** @internal */
+export const UpdateExpenseCategoryResponse$inboundSchema: z.ZodType<
+  UpdateExpenseCategoryResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status_code: types.number(),
+  status: types.string(),
+  service: types.string(),
+  resource: types.string(),
+  operation: types.string(),
+  data: UnifiedId$inboundSchema,
+  _raw: z.nullable(z.record(z.any())).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "status_code": "statusCode",
+    "_raw": "raw",
+  });
+});
+
+export function updateExpenseCategoryResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateExpenseCategoryResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateExpenseCategoryResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateExpenseCategoryResponse' from JSON`,
+  );
+}