@codat/lending 7.0.0 → 7.1.0

package/src/funcs/salesTransactionsList.ts

@@ -118,6 +118,7 @@ export async function salesTransactionsList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/transactionsAccountTransactionsGet.ts

@@ -118,6 +118,7 @@ export async function transactionsAccountTransactionsGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/transactionsAccountTransactionsList.ts

@@ -120,6 +120,7 @@ export async function transactionsAccountTransactionsList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/transactionsDirectCostsDownloadAttachment.ts

@@ -118,6 +118,7 @@ export async function transactionsDirectCostsDownloadAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/transactionsDirectCostsGet.ts

@@ -115,6 +115,7 @@ export async function transactionsDirectCostsGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/transactionsDirectCostsGetAttachment.ts

@@ -119,6 +119,7 @@ export async function transactionsDirectCostsGetAttachment(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/transactionsDirectCostsList.ts

@@ -118,6 +118,7 @@ export async function transactionsDirectCostsList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/transactionsDirectCostsListAttachments.ts

@@ -114,6 +114,7 @@ export async function transactionsDirectCostsListAttachments(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/transactionsJournalEntriesGet.ts

@@ -111,6 +111,7 @@ export async function transactionsJournalEntriesGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/transactionsJournalEntriesList.ts

@@ -116,6 +116,7 @@ export async function transactionsJournalEntriesList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/transactionsJournalsGet.ts

@@ -111,6 +111,7 @@ export async function transactionsJournalsGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/transactionsJournalsList.ts

@@ -112,6 +112,7 @@ export async function transactionsJournalsList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/transactionsTransfersGet.ts

@@ -115,6 +115,7 @@ export async function transactionsTransfersGet(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/transactionsTransfersList.ts

@@ -118,6 +118,7 @@ export async function transactionsTransfersList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/hooks/hooks.ts

@@ -12,6 +12,7 @@ import {
   BeforeCreateRequestHook,
   BeforeRequestContext,
   BeforeRequestHook,
+  Hook,
   Hooks,
   SDKInitHook,
   SDKInitOptions,
@@ -27,6 +28,25 @@ export class SDKHooks implements Hooks {
   afterErrorHooks: AfterErrorHook[] = [];
 
   constructor() {
+    const presetHooks: Array<Hook> = [];
+
+    for (const hook of presetHooks) {
+      if ("sdkInit" in hook) {
+        this.registerSDKInitHook(hook);
+      }
+      if ("beforeCreateRequest" in hook) {
+        this.registerBeforeCreateRequestHook(hook);
+      }
+      if ("beforeRequest" in hook) {
+        this.registerBeforeRequestHook(hook);
+      }
+      if ("afterSuccess" in hook) {
+        this.registerAfterSuccessHook(hook);
+      }
+      if ("afterError" in hook) {
+        this.registerAfterErrorHook(hook);
+      }
+    }
     initHooks(this);
   }
 

package/src/hooks/types.ts

@@ -5,10 +5,12 @@
 import { HTTPClient, RequestInput } from "../lib/http.js";
 import { RetryConfig } from "../lib/retries.js";
 import { SecurityState } from "../lib/security.js";
+import { WebhookRecipient } from "../sdk/types/webhooks.js";
 
 export type HookContext = {
   operationID: string;
   oAuth2Scopes?: string[];
+  webhookRecipient?: WebhookRecipient;
   securitySource?: any | (() => Promise<any>);
   retryConfig: RetryConfig;
   resolvedSecurity: SecurityState | null;
@@ -100,3 +102,10 @@ export interface Hooks {
   /** Registers a hook to be used by the SDK for the after error event. */
   registerAfterErrorHook(hook: AfterErrorHook): void;
 }
+
+export type Hook =
+  | SDKInitHook
+  | BeforeCreateRequestHook
+  | BeforeRequestHook
+  | AfterSuccessHook
+  | AfterErrorHook;

package/src/lib/config.ts

@@ -57,7 +57,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "3.0.0",
-  sdkVersion: "7.0.0",
-  genVersion: "2.463.0",
-  userAgent: "speakeasy-sdk/typescript 7.0.0 2.463.0 3.0.0 @codat/lending",
+  sdkVersion: "7.1.0",
+  genVersion: "2.486.1",
+  userAgent: "speakeasy-sdk/typescript 7.1.0 2.486.1 3.0.0 @codat/lending",
 } as const;

package/src/lib/sdks.ts

@@ -41,6 +41,10 @@ export type RequestOptions = {
    * Specifies the status codes which should be retried using the given retry policy.
    */
   retryCodes?: string[];
+  /**
+   * Overrides the base server URL that will be used by an operation.
+   */
+  serverURL?: string | URL;
   /**
    * Sets various request options on the `fetch` call made by an SDK method.
    *
@@ -52,7 +56,7 @@ export type RequestOptions = {
 type RequestConfig = {
   method: string;
   path: string;
-  baseURL?: string | URL;
+  baseURL?: string | URL | undefined;
   query?: string;
   body?: RequestInit["body"];
   headers?: HeadersInit;
@@ -119,6 +123,7 @@ export class ClientSDK {
     const inputURL = new URL(path, reqURL);
 
     if (path) {
+      reqURL.pathname += reqURL.pathname.endsWith("/") ? "" : "/";
       reqURL.pathname += inputURL.pathname.replace(/^\/+/, "");
     }
 

package/src/lib/security.ts

@@ -117,7 +117,7 @@ export function resolveSecurity(
   ...options: SecurityInput[][]
 ): SecurityState | null {
   const state: SecurityState = {
-    basic: { username: "", password: "" },
+    basic: {},
     headers: {},
     queryParams: {},
     cookies: {},

package/src/sdk/companies.ts

@@ -21,6 +21,19 @@ export class Companies extends ClientSDK {
    *
    * A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.
    * Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+   *
+   * ## Filter by tags
+   *
+   * The *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):
+   *
+   * - equals (`=`)
+   * - not equals (`!=`)
+   * - contains (`~`)
+   *
+   * For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team:
+   * - Foreign key: `uid = {yourCustomerId}`
+   * - Region: `region != uk`
+   * - Owning team and region: `region = uk && owningTeam = invoice-finance`
    */
   async list(
     request?: operations.ListCompaniesRequest | undefined,

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

@@ -10,8 +10,8 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as shared from "../shared/index.js";
 
 export type CreateSourceAccountRequestBody =
-  | shared.SourceAccount
-  | shared.SourceAccountV2;
+  | shared.SourceAccountPrototype
+  | shared.SourceAccountV2Prototype;
 
 export type CreateSourceAccountRequest = {
   /**
@@ -22,7 +22,10 @@ export type CreateSourceAccountRequest = {
    * Unique identifier for a connection.
    */
   connectionId: string;
-  requestBody?: shared.SourceAccount | shared.SourceAccountV2 | undefined;
+  requestBody?:
+    | shared.SourceAccountPrototype
+    | shared.SourceAccountV2Prototype
+    | undefined;
 };
 
 /**
@@ -38,14 +41,14 @@ export const CreateSourceAccountRequestBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
-  shared.SourceAccount$inboundSchema,
-  shared.SourceAccountV2$inboundSchema,
+  shared.SourceAccountPrototype$inboundSchema,
+  shared.SourceAccountV2Prototype$inboundSchema,
 ]);
 
 /** @internal */
 export type CreateSourceAccountRequestBody$Outbound =
-  | shared.SourceAccount$Outbound
-  | shared.SourceAccountV2$Outbound;
+  | shared.SourceAccountPrototype$Outbound
+  | shared.SourceAccountV2Prototype$Outbound;
 
 /** @internal */
 export const CreateSourceAccountRequestBody$outboundSchema: z.ZodType<
@@ -53,8 +56,8 @@ export const CreateSourceAccountRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateSourceAccountRequestBody
 > = z.union([
-  shared.SourceAccount$outboundSchema,
-  shared.SourceAccountV2$outboundSchema,
+  shared.SourceAccountPrototype$outboundSchema,
+  shared.SourceAccountV2Prototype$outboundSchema,
 ]);
 
 /**
@@ -99,8 +102,8 @@ export const CreateSourceAccountRequest$inboundSchema: z.ZodType<
   companyId: z.string(),
   connectionId: z.string(),
   RequestBody: z.union([
-    shared.SourceAccount$inboundSchema,
-    shared.SourceAccountV2$inboundSchema,
+    shared.SourceAccountPrototype$inboundSchema,
+    shared.SourceAccountV2Prototype$inboundSchema,
   ]).optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -113,8 +116,8 @@ export type CreateSourceAccountRequest$Outbound = {
   companyId: string;
   connectionId: string;
   RequestBody?:
-    | shared.SourceAccount$Outbound
-    | shared.SourceAccountV2$Outbound
+    | shared.SourceAccountPrototype$Outbound
+    | shared.SourceAccountV2Prototype$Outbound
     | undefined;
 };
 
@@ -127,8 +130,8 @@ export const CreateSourceAccountRequest$outboundSchema: z.ZodType<
   companyId: z.string(),
   connectionId: z.string(),
   requestBody: z.union([
-    shared.SourceAccount$outboundSchema,
-    shared.SourceAccountV2$outboundSchema,
+    shared.SourceAccountPrototype$outboundSchema,
+    shared.SourceAccountV2Prototype$outboundSchema,
   ]).optional(),
 }).transform((v) => {
   return remap$(v, {

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

@@ -0,0 +1,78 @@
+/*
+ * 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";
+
+export type GetBankAccountMappingRequest = {
+  /**
+   * Unique identifier for a company.
+   */
+  companyId: string;
+  /**
+   * Unique identifier for a connection.
+   */
+  connectionId: string;
+};
+
+/** @internal */
+export const GetBankAccountMappingRequest$inboundSchema: z.ZodType<
+  GetBankAccountMappingRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  companyId: z.string(),
+  connectionId: z.string(),
+});
+
+/** @internal */
+export type GetBankAccountMappingRequest$Outbound = {
+  companyId: string;
+  connectionId: string;
+};
+
+/** @internal */
+export const GetBankAccountMappingRequest$outboundSchema: z.ZodType<
+  GetBankAccountMappingRequest$Outbound,
+  z.ZodTypeDef,
+  GetBankAccountMappingRequest
+> = z.object({
+  companyId: z.string(),
+  connectionId: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetBankAccountMappingRequest$ {
+  /** @deprecated use `GetBankAccountMappingRequest$inboundSchema` instead. */
+  export const inboundSchema = GetBankAccountMappingRequest$inboundSchema;
+  /** @deprecated use `GetBankAccountMappingRequest$outboundSchema` instead. */
+  export const outboundSchema = GetBankAccountMappingRequest$outboundSchema;
+  /** @deprecated use `GetBankAccountMappingRequest$Outbound` instead. */
+  export type Outbound = GetBankAccountMappingRequest$Outbound;
+}
+
+export function getBankAccountMappingRequestToJSON(
+  getBankAccountMappingRequest: GetBankAccountMappingRequest,
+): string {
+  return JSON.stringify(
+    GetBankAccountMappingRequest$outboundSchema.parse(
+      getBankAccountMappingRequest,
+    ),
+  );
+}
+
+export function getBankAccountMappingRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetBankAccountMappingRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetBankAccountMappingRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetBankAccountMappingRequest' from JSON`,
+  );
+}

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

@@ -56,6 +56,7 @@ export * from "./getaccountingprofitandloss.js";
 export * from "./getaccountingsupplier.js";
 export * from "./getaccountingsupplierattachment.js";
 export * from "./getaccountingtransfer.js";
+export * from "./getbankaccountmapping.js";
 export * from "./getbankingaccount.js";
 export * from "./getbankingtransaction.js";
 export * from "./getbankingtransactioncategory.js";

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/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(