@apideck/unify 0.11.5 → 0.12.0

package/src/lib/config.ts

@@ -63,8 +63,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "10.8.3",
-  sdkVersion: "0.11.5",
-  genVersion: "2.472.1",
-  userAgent: "speakeasy-sdk/typescript 0.11.5 2.472.1 10.8.3 @apideck/unify",
+  openapiDocVersion: "10.9.0",
+  sdkVersion: "0.12.0",
+  genVersion: "2.477.4",
+  userAgent: "speakeasy-sdk/typescript 0.12.0 2.477.4 10.9.0 @apideck/unify",
 } as const;

package/src/models/components/agedcreditors.ts

@@ -0,0 +1,116 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { RFCDate } from "../../types/rfcdate.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  OutstandingBalance,
+  OutstandingBalance$inboundSchema,
+  OutstandingBalance$Outbound,
+  OutstandingBalance$outboundSchema,
+} from "./outstandingbalance.js";
+
+export type AgedCreditors = {
+  /**
+   * The exact date and time the report was generated.
+   */
+  reportGeneratedAt?: Date | undefined;
+  /**
+   * The cutoff date for transactions included in the report.
+   */
+  reportAsOfDate?: RFCDate | undefined;
+  /**
+   * Number of aging periods shown in the report.
+   */
+  periodCount?: number | undefined;
+  /**
+   * Length of each aging period in days.
+   */
+  periodLength?: number | undefined;
+  outstandingBalances?: Array<OutstandingBalance> | undefined;
+};
+
+/** @internal */
+export const AgedCreditors$inboundSchema: z.ZodType<
+  AgedCreditors,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  report_generated_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  report_as_of_date: z.string().transform(v => new RFCDate(v)).optional(),
+  period_count: z.number().int().default(4),
+  period_length: z.number().int().default(30),
+  outstanding_balances: z.array(OutstandingBalance$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "report_generated_at": "reportGeneratedAt",
+    "report_as_of_date": "reportAsOfDate",
+    "period_count": "periodCount",
+    "period_length": "periodLength",
+    "outstanding_balances": "outstandingBalances",
+  });
+});
+
+/** @internal */
+export type AgedCreditors$Outbound = {
+  report_generated_at?: string | undefined;
+  report_as_of_date?: string | undefined;
+  period_count: number;
+  period_length: number;
+  outstanding_balances?: Array<OutstandingBalance$Outbound> | undefined;
+};
+
+/** @internal */
+export const AgedCreditors$outboundSchema: z.ZodType<
+  AgedCreditors$Outbound,
+  z.ZodTypeDef,
+  AgedCreditors
+> = z.object({
+  reportGeneratedAt: z.date().transform(v => v.toISOString()).optional(),
+  reportAsOfDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+  periodCount: z.number().int().default(4),
+  periodLength: z.number().int().default(30),
+  outstandingBalances: z.array(OutstandingBalance$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    reportGeneratedAt: "report_generated_at",
+    reportAsOfDate: "report_as_of_date",
+    periodCount: "period_count",
+    periodLength: "period_length",
+    outstandingBalances: "outstanding_balances",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgedCreditors$ {
+  /** @deprecated use `AgedCreditors$inboundSchema` instead. */
+  export const inboundSchema = AgedCreditors$inboundSchema;
+  /** @deprecated use `AgedCreditors$outboundSchema` instead. */
+  export const outboundSchema = AgedCreditors$outboundSchema;
+  /** @deprecated use `AgedCreditors$Outbound` instead. */
+  export type Outbound = AgedCreditors$Outbound;
+}
+
+export function agedCreditorsToJSON(agedCreditors: AgedCreditors): string {
+  return JSON.stringify(AgedCreditors$outboundSchema.parse(agedCreditors));
+}
+
+export function agedCreditorsFromJSON(
+  jsonString: string,
+): SafeParseResult<AgedCreditors, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgedCreditors$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgedCreditors' from JSON`,
+  );
+}

package/src/models/components/ageddebtors.ts

@@ -0,0 +1,116 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { RFCDate } from "../../types/rfcdate.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  OutstandingBalance,
+  OutstandingBalance$inboundSchema,
+  OutstandingBalance$Outbound,
+  OutstandingBalance$outboundSchema,
+} from "./outstandingbalance.js";
+
+export type AgedDebtors = {
+  /**
+   * The exact date and time the report was generated.
+   */
+  reportGeneratedAt?: Date | undefined;
+  /**
+   * The cutoff date for transactions included in the report.
+   */
+  reportAsOfDate?: RFCDate | undefined;
+  /**
+   * Number of aging periods shown in the report.
+   */
+  periodCount?: number | undefined;
+  /**
+   * Length of each aging period in days.
+   */
+  periodLength?: number | undefined;
+  outstandingBalances?: Array<OutstandingBalance> | undefined;
+};
+
+/** @internal */
+export const AgedDebtors$inboundSchema: z.ZodType<
+  AgedDebtors,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  report_generated_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  report_as_of_date: z.string().transform(v => new RFCDate(v)).optional(),
+  period_count: z.number().int().default(4),
+  period_length: z.number().int().default(30),
+  outstanding_balances: z.array(OutstandingBalance$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "report_generated_at": "reportGeneratedAt",
+    "report_as_of_date": "reportAsOfDate",
+    "period_count": "periodCount",
+    "period_length": "periodLength",
+    "outstanding_balances": "outstandingBalances",
+  });
+});
+
+/** @internal */
+export type AgedDebtors$Outbound = {
+  report_generated_at?: string | undefined;
+  report_as_of_date?: string | undefined;
+  period_count: number;
+  period_length: number;
+  outstanding_balances?: Array<OutstandingBalance$Outbound> | undefined;
+};
+
+/** @internal */
+export const AgedDebtors$outboundSchema: z.ZodType<
+  AgedDebtors$Outbound,
+  z.ZodTypeDef,
+  AgedDebtors
+> = z.object({
+  reportGeneratedAt: z.date().transform(v => v.toISOString()).optional(),
+  reportAsOfDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+  periodCount: z.number().int().default(4),
+  periodLength: z.number().int().default(30),
+  outstandingBalances: z.array(OutstandingBalance$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    reportGeneratedAt: "report_generated_at",
+    reportAsOfDate: "report_as_of_date",
+    periodCount: "period_count",
+    periodLength: "period_length",
+    outstandingBalances: "outstanding_balances",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgedDebtors$ {
+  /** @deprecated use `AgedDebtors$inboundSchema` instead. */
+  export const inboundSchema = AgedDebtors$inboundSchema;
+  /** @deprecated use `AgedDebtors$outboundSchema` instead. */
+  export const outboundSchema = AgedDebtors$outboundSchema;
+  /** @deprecated use `AgedDebtors$Outbound` instead. */
+  export type Outbound = AgedDebtors$Outbound;
+}
+
+export function agedDebtorsToJSON(agedDebtors: AgedDebtors): string {
+  return JSON.stringify(AgedDebtors$outboundSchema.parse(agedDebtors));
+}
+
+export function agedDebtorsFromJSON(
+  jsonString: string,
+): SafeParseResult<AgedDebtors, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgedDebtors$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgedDebtors' from JSON`,
+  );
+}

package/src/models/components/agedreportfilter.ts

@@ -0,0 +1,105 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AgedReportFilter = {
+  /**
+   * Filter by customer id
+   */
+  customerId?: string | undefined;
+  /**
+   * The cutoff date for considering transactions
+   */
+  reportAsOfDate?: string | undefined;
+  /**
+   * Number of periods to split the aged creditors report into
+   */
+  periodCount?: number | undefined;
+  /**
+   * Length of each period in days
+   */
+  periodLength?: number | undefined;
+};
+
+/** @internal */
+export const AgedReportFilter$inboundSchema: z.ZodType<
+  AgedReportFilter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  customer_id: z.string().optional(),
+  report_as_of_date: z.string().optional(),
+  period_count: z.number().int().optional(),
+  period_length: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "customer_id": "customerId",
+    "report_as_of_date": "reportAsOfDate",
+    "period_count": "periodCount",
+    "period_length": "periodLength",
+  });
+});
+
+/** @internal */
+export type AgedReportFilter$Outbound = {
+  customer_id?: string | undefined;
+  report_as_of_date?: string | undefined;
+  period_count?: number | undefined;
+  period_length?: number | undefined;
+};
+
+/** @internal */
+export const AgedReportFilter$outboundSchema: z.ZodType<
+  AgedReportFilter$Outbound,
+  z.ZodTypeDef,
+  AgedReportFilter
+> = z.object({
+  customerId: z.string().optional(),
+  reportAsOfDate: z.string().optional(),
+  periodCount: z.number().int().optional(),
+  periodLength: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    customerId: "customer_id",
+    reportAsOfDate: "report_as_of_date",
+    periodCount: "period_count",
+    periodLength: "period_length",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AgedReportFilter$ {
+  /** @deprecated use `AgedReportFilter$inboundSchema` instead. */
+  export const inboundSchema = AgedReportFilter$inboundSchema;
+  /** @deprecated use `AgedReportFilter$outboundSchema` instead. */
+  export const outboundSchema = AgedReportFilter$outboundSchema;
+  /** @deprecated use `AgedReportFilter$Outbound` instead. */
+  export type Outbound = AgedReportFilter$Outbound;
+}
+
+export function agedReportFilterToJSON(
+  agedReportFilter: AgedReportFilter,
+): string {
+  return JSON.stringify(
+    AgedReportFilter$outboundSchema.parse(agedReportFilter),
+  );
+}
+
+export function agedReportFilterFromJSON(
+  jsonString: string,
+): SafeParseResult<AgedReportFilter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AgedReportFilter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AgedReportFilter' from JSON`,
+  );
+}

package/src/models/components/balancebyperiod.ts

@@ -0,0 +1,109 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { RFCDate } from "../../types/rfcdate.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  BalanceByTransaction,
+  BalanceByTransaction$inboundSchema,
+  BalanceByTransaction$Outbound,
+  BalanceByTransaction$outboundSchema,
+} from "./balancebytransaction.js";
+
+export type BalanceByPeriod = {
+  /**
+   * Start date of the period.
+   */
+  startDate?: RFCDate | undefined;
+  /**
+   * End date of the period.
+   */
+  endDate?: RFCDate | undefined;
+  /**
+   * Total amount of the period.
+   */
+  totalAmount?: number | undefined;
+  balancesByTransaction?: Array<BalanceByTransaction> | undefined;
+};
+
+/** @internal */
+export const BalanceByPeriod$inboundSchema: z.ZodType<
+  BalanceByPeriod,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  start_date: z.string().transform(v => new RFCDate(v)).optional(),
+  end_date: z.string().transform(v => new RFCDate(v)).optional(),
+  total_amount: z.number().optional(),
+  balances_by_transaction: z.array(BalanceByTransaction$inboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "start_date": "startDate",
+    "end_date": "endDate",
+    "total_amount": "totalAmount",
+    "balances_by_transaction": "balancesByTransaction",
+  });
+});
+
+/** @internal */
+export type BalanceByPeriod$Outbound = {
+  start_date?: string | undefined;
+  end_date?: string | undefined;
+  total_amount?: number | undefined;
+  balances_by_transaction?: Array<BalanceByTransaction$Outbound> | undefined;
+};
+
+/** @internal */
+export const BalanceByPeriod$outboundSchema: z.ZodType<
+  BalanceByPeriod$Outbound,
+  z.ZodTypeDef,
+  BalanceByPeriod
+> = z.object({
+  startDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+  endDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+  totalAmount: z.number().optional(),
+  balancesByTransaction: z.array(BalanceByTransaction$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    startDate: "start_date",
+    endDate: "end_date",
+    totalAmount: "total_amount",
+    balancesByTransaction: "balances_by_transaction",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BalanceByPeriod$ {
+  /** @deprecated use `BalanceByPeriod$inboundSchema` instead. */
+  export const inboundSchema = BalanceByPeriod$inboundSchema;
+  /** @deprecated use `BalanceByPeriod$outboundSchema` instead. */
+  export const outboundSchema = BalanceByPeriod$outboundSchema;
+  /** @deprecated use `BalanceByPeriod$Outbound` instead. */
+  export type Outbound = BalanceByPeriod$Outbound;
+}
+
+export function balanceByPeriodToJSON(
+  balanceByPeriod: BalanceByPeriod,
+): string {
+  return JSON.stringify(BalanceByPeriod$outboundSchema.parse(balanceByPeriod));
+}
+
+export function balanceByPeriodFromJSON(
+  jsonString: string,
+): SafeParseResult<BalanceByPeriod, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BalanceByPeriod$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BalanceByPeriod' from JSON`,
+  );
+}

package/src/models/components/balancebytransaction.ts

@@ -0,0 +1,162 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 { RFCDate } from "../../types/rfcdate.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Type of the transaction.
+ */
+export const TransactionType = {
+  Invoice: "invoice",
+  CreditNote: "credit_note",
+  Bill: "bill",
+  Payment: "payment",
+  BillPayment: "bill-payment",
+} as const;
+/**
+ * Type of the transaction.
+ */
+export type TransactionType = ClosedEnum<typeof TransactionType>;
+
+export type BalanceByTransaction = {
+  /**
+   * Unique identifier for the transaction.
+   */
+  transactionId?: string | undefined;
+  /**
+   * Date of the transaction.
+   */
+  transactionDate?: RFCDate | undefined;
+  /**
+   * Type of the transaction.
+   */
+  transactionType?: TransactionType | undefined;
+  /**
+   * Due date of the transaction.
+   */
+  dueDate?: RFCDate | undefined;
+  /**
+   * Original amount of the transaction.
+   */
+  originalAmount?: number | undefined;
+  /**
+   * Outstanding balance of the transaction.
+   */
+  outstandingBalance?: number | undefined;
+};
+
+/** @internal */
+export const TransactionType$inboundSchema: z.ZodNativeEnum<
+  typeof TransactionType
+> = z.nativeEnum(TransactionType);
+
+/** @internal */
+export const TransactionType$outboundSchema: z.ZodNativeEnum<
+  typeof TransactionType
+> = TransactionType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TransactionType$ {
+  /** @deprecated use `TransactionType$inboundSchema` instead. */
+  export const inboundSchema = TransactionType$inboundSchema;
+  /** @deprecated use `TransactionType$outboundSchema` instead. */
+  export const outboundSchema = TransactionType$outboundSchema;
+}
+
+/** @internal */
+export const BalanceByTransaction$inboundSchema: z.ZodType<
+  BalanceByTransaction,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  transaction_id: z.string().optional(),
+  transaction_date: z.string().transform(v => new RFCDate(v)).optional(),
+  transaction_type: TransactionType$inboundSchema.optional(),
+  due_date: z.string().transform(v => new RFCDate(v)).optional(),
+  original_amount: z.number().optional(),
+  outstanding_balance: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "transaction_id": "transactionId",
+    "transaction_date": "transactionDate",
+    "transaction_type": "transactionType",
+    "due_date": "dueDate",
+    "original_amount": "originalAmount",
+    "outstanding_balance": "outstandingBalance",
+  });
+});
+
+/** @internal */
+export type BalanceByTransaction$Outbound = {
+  transaction_id?: string | undefined;
+  transaction_date?: string | undefined;
+  transaction_type?: string | undefined;
+  due_date?: string | undefined;
+  original_amount?: number | undefined;
+  outstanding_balance?: number | undefined;
+};
+
+/** @internal */
+export const BalanceByTransaction$outboundSchema: z.ZodType<
+  BalanceByTransaction$Outbound,
+  z.ZodTypeDef,
+  BalanceByTransaction
+> = z.object({
+  transactionId: z.string().optional(),
+  transactionDate: z.instanceof(RFCDate).transform(v => v.toString())
+    .optional(),
+  transactionType: TransactionType$outboundSchema.optional(),
+  dueDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
+  originalAmount: z.number().optional(),
+  outstandingBalance: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    transactionId: "transaction_id",
+    transactionDate: "transaction_date",
+    transactionType: "transaction_type",
+    dueDate: "due_date",
+    originalAmount: "original_amount",
+    outstandingBalance: "outstanding_balance",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BalanceByTransaction$ {
+  /** @deprecated use `BalanceByTransaction$inboundSchema` instead. */
+  export const inboundSchema = BalanceByTransaction$inboundSchema;
+  /** @deprecated use `BalanceByTransaction$outboundSchema` instead. */
+  export const outboundSchema = BalanceByTransaction$outboundSchema;
+  /** @deprecated use `BalanceByTransaction$Outbound` instead. */
+  export type Outbound = BalanceByTransaction$Outbound;
+}
+
+export function balanceByTransactionToJSON(
+  balanceByTransaction: BalanceByTransaction,
+): string {
+  return JSON.stringify(
+    BalanceByTransaction$outboundSchema.parse(balanceByTransaction),
+  );
+}
+
+export function balanceByTransactionFromJSON(
+  jsonString: string,
+): SafeParseResult<BalanceByTransaction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BalanceByTransaction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BalanceByTransaction' from JSON`,
+  );
+}