@codat/lending 6.0.0 → 7.1.0

package/src/sdk/models/operations/listcompanies.ts

@@ -24,6 +24,10 @@ export type ListCompaniesRequest = {
    * Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).
    */
   orderBy?: string | undefined;
+  /**
+   * Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying).
+   */
+  tags?: string | undefined;
 };
 
 /** @internal */
@@ -36,6 +40,7 @@ export const ListCompaniesRequest$inboundSchema: z.ZodType<
   pageSize: z.number().int().default(100),
   query: z.string().optional(),
   orderBy: z.string().optional(),
+  tags: z.string().optional(),
 });
 
 /** @internal */
@@ -44,6 +49,7 @@ export type ListCompaniesRequest$Outbound = {
   pageSize: number;
   query?: string | undefined;
   orderBy?: string | undefined;
+  tags?: string | undefined;
 };
 
 /** @internal */
@@ -56,6 +62,7 @@ export const ListCompaniesRequest$outboundSchema: z.ZodType<
   pageSize: z.number().int().default(100),
   query: z.string().optional(),
   orderBy: z.string().optional(),
+  tags: z.string().optional(),
 });
 
 /**

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

@@ -38,7 +38,7 @@ import {
  *
  * > **Company information or companies?**
  * >
- * > Company profile is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.
+ * > Company information is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.
  */
 export type AccountingCompanyInfo = {
   /**

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

@@ -0,0 +1,170 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Decimal as Decimal$ } from "../../types/decimal.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  TargetAccountOption,
+  TargetAccountOption$inboundSchema,
+  TargetAccountOption$Outbound,
+  TargetAccountOption$outboundSchema,
+} from "./targetaccountoption.js";
+
+/**
+ * A bank feed connection between a source account and a target account, including potential target accounts.
+ */
+export type BankFeedMapping = {
+  /**
+   * Unique ID for the source account.
+   */
+  sourceAccountId?: string | undefined;
+  /**
+   * Name for the source account.
+   */
+  sourceAccountName?: string | undefined;
+  /**
+   * Account number for the source account.
+   */
+  sourceAccountNumber?: string | undefined;
+  /**
+   * Balance for the source account.
+   */
+  sourceBalance?: Decimal$ | number | undefined;
+  /**
+   * The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
+   *
+   * @remarks
+   *
+   * ## Unknown currencies
+   *
+   * In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.
+   *
+   * There are only a very small number of edge cases where this currency code is returned by the Codat system.
+   */
+  sourceCurrency?: string | undefined;
+  /**
+   * Unique ID for the target account in the accounting software.
+   */
+  targetAccountId?: string | null | undefined;
+  /**
+   * Name for the target account in the accounting software.
+   */
+  targetAccountName?: string | undefined;
+  /**
+   * The status.
+   */
+  status?: string | undefined;
+  /**
+   * An array of potential target accounts.
+   */
+  targetAccountOptions?: Array<TargetAccountOption> | null | undefined;
+  /**
+   * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
+   *
+   * @remarks
+   *
+   * ```
+   * 2020-10-08T22:40:50Z
+   * 2021-01-01T00:00:00
+   * ```
+   *
+   * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+   *
+   * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+   * - Unqualified local time: `2021-11-15T01:00:00`
+   * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+   *
+   * > Time zones
+   * >
+   * > Not all dates from Codat will contain information about time zones.
+   * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+   */
+  feedStartDate?: string | undefined;
+};
+
+/** @internal */
+export const BankFeedMapping$inboundSchema: z.ZodType<
+  BankFeedMapping,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sourceAccountId: z.string().optional(),
+  sourceAccountName: z.string().optional(),
+  sourceAccountNumber: z.string().optional(),
+  sourceBalance: z.number().transform(v => new Decimal$(v)).optional(),
+  sourceCurrency: z.string().optional(),
+  targetAccountId: z.nullable(z.string()).optional(),
+  targetAccountName: z.string().optional(),
+  status: z.string().optional(),
+  targetAccountOptions: z.nullable(z.array(TargetAccountOption$inboundSchema))
+    .optional(),
+  feedStartDate: z.string().optional(),
+});
+
+/** @internal */
+export type BankFeedMapping$Outbound = {
+  sourceAccountId?: string | undefined;
+  sourceAccountName?: string | undefined;
+  sourceAccountNumber?: string | undefined;
+  sourceBalance?: number | undefined;
+  sourceCurrency?: string | undefined;
+  targetAccountId?: string | null | undefined;
+  targetAccountName?: string | undefined;
+  status?: string | undefined;
+  targetAccountOptions?: Array<TargetAccountOption$Outbound> | null | undefined;
+  feedStartDate?: string | undefined;
+};
+
+/** @internal */
+export const BankFeedMapping$outboundSchema: z.ZodType<
+  BankFeedMapping$Outbound,
+  z.ZodTypeDef,
+  BankFeedMapping
+> = z.object({
+  sourceAccountId: z.string().optional(),
+  sourceAccountName: z.string().optional(),
+  sourceAccountNumber: z.string().optional(),
+  sourceBalance: z.union([z.instanceof(Decimal$), z.number()]).transform(v =>
+    typeof v === "number" ? v : v.toNumber()
+  ).optional(),
+  sourceCurrency: z.string().optional(),
+  targetAccountId: z.nullable(z.string()).optional(),
+  targetAccountName: z.string().optional(),
+  status: z.string().optional(),
+  targetAccountOptions: z.nullable(z.array(TargetAccountOption$outboundSchema))
+    .optional(),
+  feedStartDate: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BankFeedMapping$ {
+  /** @deprecated use `BankFeedMapping$inboundSchema` instead. */
+  export const inboundSchema = BankFeedMapping$inboundSchema;
+  /** @deprecated use `BankFeedMapping$outboundSchema` instead. */
+  export const outboundSchema = BankFeedMapping$outboundSchema;
+  /** @deprecated use `BankFeedMapping$Outbound` instead. */
+  export type Outbound = BankFeedMapping$Outbound;
+}
+
+export function bankFeedMappingToJSON(
+  bankFeedMapping: BankFeedMapping,
+): string {
+  return JSON.stringify(BankFeedMapping$outboundSchema.parse(bankFeedMapping));
+}
+
+export function bankFeedMappingFromJSON(
+  jsonString: string,
+): SafeParseResult<BankFeedMapping, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BankFeedMapping$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BankFeedMapping' from JSON`,
+  );
+}

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

@@ -86,11 +86,11 @@ export namespace FileT$ {
   export type Outbound = FileT$Outbound;
 }
 
-export function fileTToJSON(fileT: FileT): string {
+export function fileToJSON(fileT: FileT): string {
   return JSON.stringify(FileT$outboundSchema.parse(fileT));
 }
 
-export function fileTFromJSON(
+export function fileFromJSON(
   jsonString: string,
 ): SafeParseResult<FileT, SDKValidationError> {
   return safeParse(

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

@@ -86,6 +86,7 @@ export * from "./bankaccountref.js";
 export * from "./bankaccountstatus.js";
 export * from "./bankfeedbankaccountmapping.js";
 export * from "./bankfeedbankaccountmappingresponse.js";
+export * from "./bankfeedmapping.js";
 export * from "./bankingaccount.js";
 export * from "./bankingaccountbalance.js";
 export * from "./bankingaccountbalances.js";
@@ -238,6 +239,7 @@ export * from "./productvariantref.js";
 export * from "./productvariantstatus.js";
 export * from "./profitandlossreport.js";
 export * from "./projectref.js";
+export * from "./propertieaccounttype.js";
 export * from "./propertiedatatype.js";
 export * from "./propertieitemref.js";
 export * from "./pulloperation.js";
@@ -265,17 +267,21 @@ export * from "./reportoperation.js";
 export * from "./reports.js";
 export * from "./reporttype.js";
 export * from "./routinginfo.js";
+export * from "./schema.js";
 export * from "./security.js";
 export * from "./servicecharge.js";
 export * from "./servicechargetype.js";
 export * from "./sourceaccount.js";
+export * from "./sourceaccountprototype.js";
 export * from "./sourceaccountv2.js";
+export * from "./sourceaccountv2prototype.js";
 export * from "./sourceref.js";
 export * from "./startuploadsessionrequest.js";
 export * from "./status.js";
 export * from "./supplementaldata.js";
 export * from "./supplierref.js";
 export * from "./supplierstatus.js";
+export * from "./targetaccountoption.js";
 export * from "./taxcomponentallocation.js";
 export * from "./taxcomponentref.js";
 export * from "./taxrateref.js";

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

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard.
+ */
+export const PropertieAccountType = {
+  Checking: "checking",
+  Savings: "savings",
+  Loan: "loan",
+  CreditCard: "creditCard",
+  PrepaidCard: "prepaidCard",
+} as const;
+/**
+ * The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard.
+ */
+export type PropertieAccountType = ClosedEnum<typeof PropertieAccountType>;
+
+/** @internal */
+export const PropertieAccountType$inboundSchema: z.ZodNativeEnum<
+  typeof PropertieAccountType
+> = z.nativeEnum(PropertieAccountType);
+
+/** @internal */
+export const PropertieAccountType$outboundSchema: z.ZodNativeEnum<
+  typeof PropertieAccountType
+> = PropertieAccountType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertieAccountType$ {
+  /** @deprecated use `PropertieAccountType$inboundSchema` instead. */
+  export const inboundSchema = PropertieAccountType$inboundSchema;
+  /** @deprecated use `PropertieAccountType$outboundSchema` instead. */
+  export const outboundSchema = PropertieAccountType$outboundSchema;
+}

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

@@ -26,6 +26,7 @@ export type ReportOperationStatus = ClosedEnum<typeof ReportOperationStatus>;
  */
 export const ReportOperationType = {
   CategorizedBankStatement: "categorizedBankStatement",
+  CreditModel: "creditModel",
 } as const;
 /**
  * The name of the report generated.

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

@@ -7,6 +7,7 @@ import { ClosedEnum } from "../../types/enums.js";
 
 export const ReportType = {
   CategorizedBankStatement: "categorizedBankStatement",
+  CreditModel: "creditModel",
 } as const;
 export type ReportType = ClosedEnum<typeof ReportType>;
 

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

@@ -0,0 +1,104 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ReportGenerationPayload,
+  ReportGenerationPayload$inboundSchema,
+  ReportGenerationPayload$Outbound,
+  ReportGenerationPayload$outboundSchema,
+} from "./reportgenerationpayload.js";
+
+export type Schema = {
+  /**
+   * Unique identifier of the event.
+   */
+  id?: string | undefined;
+  /**
+   * The type of event.
+   */
+  eventType?: string | undefined;
+  /**
+   * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
+   *
+   * @remarks
+   *
+   * ```
+   * 2020-10-08T22:40:50Z
+   * 2021-01-01T00:00:00
+   * ```
+   *
+   * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+   *
+   * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+   * - Unqualified local time: `2021-11-15T01:00:00`
+   * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+   *
+   * > Time zones
+   * >
+   * > Not all dates from Codat will contain information about time zones.
+   * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+   */
+  generatedDate?: string | undefined;
+  payload?: ReportGenerationPayload | undefined;
+};
+
+/** @internal */
+export const Schema$inboundSchema: z.ZodType<Schema, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string().optional(),
+    eventType: z.string().optional(),
+    generatedDate: z.string().optional(),
+    payload: ReportGenerationPayload$inboundSchema.optional(),
+  });
+
+/** @internal */
+export type Schema$Outbound = {
+  id?: string | undefined;
+  eventType?: string | undefined;
+  generatedDate?: string | undefined;
+  payload?: ReportGenerationPayload$Outbound | undefined;
+};
+
+/** @internal */
+export const Schema$outboundSchema: z.ZodType<
+  Schema$Outbound,
+  z.ZodTypeDef,
+  Schema
+> = z.object({
+  id: z.string().optional(),
+  eventType: z.string().optional(),
+  generatedDate: z.string().optional(),
+  payload: ReportGenerationPayload$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Schema$ {
+  /** @deprecated use `Schema$inboundSchema` instead. */
+  export const inboundSchema = Schema$inboundSchema;
+  /** @deprecated use `Schema$outboundSchema` instead. */
+  export const outboundSchema = Schema$outboundSchema;
+  /** @deprecated use `Schema$Outbound` instead. */
+  export type Outbound = Schema$Outbound;
+}
+
+export function schemaToJSON(schema: Schema): string {
+  return JSON.stringify(Schema$outboundSchema.parse(schema));
+}
+
+export function schemaFromJSON(
+  jsonString: string,
+): SafeParseResult<Schema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Schema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Schema' from JSON`,
+  );
+}

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

@@ -0,0 +1,149 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Decimal as Decimal$ } from "../../types/decimal.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SourceAccountPrototype = {
+  /**
+   * Unique ID for the bank account.
+   */
+  id?: string | undefined;
+  /**
+   * The bank account name.
+   */
+  accountName?: string | null | undefined;
+  /**
+   * The type of bank account e.g. Credit.
+   */
+  accountType?: string | null | undefined;
+  /**
+   * The account number.
+   */
+  accountNumber?: string | null | undefined;
+  /**
+   * The sort code.
+   */
+  sortCode?: string | null | undefined;
+  /**
+   * The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
+   *
+   * @remarks
+   *
+   * ## Unknown currencies
+   *
+   * In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.
+   *
+   * There are only a very small number of edge cases where this currency code is returned by the Codat system.
+   */
+  currency?: string | undefined;
+  /**
+   * The latest balance for the bank account.
+   */
+  balance?: Decimal$ | number | null | undefined;
+  /**
+   * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
+   *
+   * @remarks
+   *
+   * ```
+   * 2020-10-08T22:40:50Z
+   * 2021-01-01T00:00:00
+   * ```
+   *
+   * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+   *
+   * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+   * - Unqualified local time: `2021-11-15T01:00:00`
+   * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+   *
+   * > Time zones
+   * >
+   * > Not all dates from Codat will contain information about time zones.
+   * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+   */
+  modifiedDate?: string | undefined;
+};
+
+/** @internal */
+export const SourceAccountPrototype$inboundSchema: z.ZodType<
+  SourceAccountPrototype,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  accountName: z.nullable(z.string()).optional(),
+  accountType: z.nullable(z.string()).optional(),
+  accountNumber: z.nullable(z.string()).optional(),
+  sortCode: z.nullable(z.string()).optional(),
+  currency: z.string().optional(),
+  balance: z.nullable(z.number().transform(v => new Decimal$(v))).optional(),
+  modifiedDate: z.string().optional(),
+});
+
+/** @internal */
+export type SourceAccountPrototype$Outbound = {
+  id?: string | undefined;
+  accountName?: string | null | undefined;
+  accountType?: string | null | undefined;
+  accountNumber?: string | null | undefined;
+  sortCode?: string | null | undefined;
+  currency?: string | undefined;
+  balance?: number | null | undefined;
+  modifiedDate?: string | undefined;
+};
+
+/** @internal */
+export const SourceAccountPrototype$outboundSchema: z.ZodType<
+  SourceAccountPrototype$Outbound,
+  z.ZodTypeDef,
+  SourceAccountPrototype
+> = z.object({
+  id: z.string().optional(),
+  accountName: z.nullable(z.string()).optional(),
+  accountType: z.nullable(z.string()).optional(),
+  accountNumber: z.nullable(z.string()).optional(),
+  sortCode: z.nullable(z.string()).optional(),
+  currency: z.string().optional(),
+  balance: z.nullable(
+    z.union([z.instanceof(Decimal$), z.number()]).transform(v =>
+      typeof v === "number" ? v : v.toNumber()
+    ),
+  ).optional(),
+  modifiedDate: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SourceAccountPrototype$ {
+  /** @deprecated use `SourceAccountPrototype$inboundSchema` instead. */
+  export const inboundSchema = SourceAccountPrototype$inboundSchema;
+  /** @deprecated use `SourceAccountPrototype$outboundSchema` instead. */
+  export const outboundSchema = SourceAccountPrototype$outboundSchema;
+  /** @deprecated use `SourceAccountPrototype$Outbound` instead. */
+  export type Outbound = SourceAccountPrototype$Outbound;
+}
+
+export function sourceAccountPrototypeToJSON(
+  sourceAccountPrototype: SourceAccountPrototype,
+): string {
+  return JSON.stringify(
+    SourceAccountPrototype$outboundSchema.parse(sourceAccountPrototype),
+  );
+}
+
+export function sourceAccountPrototypeFromJSON(
+  jsonString: string,
+): SafeParseResult<SourceAccountPrototype, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SourceAccountPrototype$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SourceAccountPrototype' from JSON`,
+  );
+}

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

@@ -73,6 +73,10 @@ export type SourceAccountV2 = {
    * The account number.
    */
   accountNumber: string;
+  /**
+   * The sort code.
+   */
+  sortCode?: string | null | undefined;
   /**
    * Routing information for the bank. This does not include account number.
    */
@@ -183,6 +187,7 @@ export const SourceAccountV2$inboundSchema: z.ZodType<
   accountName: z.string(),
   accountType: SourceAccountV2AccountType$inboundSchema,
   accountNumber: z.string(),
+  sortCode: z.nullable(z.string()).optional(),
   routingInfo: RoutingInfo$inboundSchema.optional(),
   currency: z.string(),
   balance: z.number().transform(v => new Decimal$(v)),
@@ -198,6 +203,7 @@ export type SourceAccountV2$Outbound = {
   accountName: string;
   accountType: string;
   accountNumber: string;
+  sortCode?: string | null | undefined;
   routingInfo?: RoutingInfo$Outbound | undefined;
   currency: string;
   balance: number;
@@ -217,6 +223,7 @@ export const SourceAccountV2$outboundSchema: z.ZodType<
   accountName: z.string(),
   accountType: SourceAccountV2AccountType$outboundSchema,
   accountNumber: z.string(),
+  sortCode: z.nullable(z.string()).optional(),
   routingInfo: RoutingInfo$outboundSchema.optional(),
   currency: z.string(),
   balance: z.union([z.instanceof(Decimal$), z.number()]).transform(v =>