@codat/lending 7.0.0 → 7.2.0

package/src/funcs/accountsReceivableReportsIsAgedCreditorsAvailable.ts

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

package/src/funcs/accountsReceivableReportsIsAgedDebtorsAvailable.ts

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

package/src/funcs/bankStatementsEndUploadSession.ts

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

package/src/funcs/bankStatementsGetUploadConfiguration.ts

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

package/src/funcs/bankStatementsSetUploadConfiguration.ts

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

package/src/funcs/bankStatementsStartUploadSession.ts

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

package/src/funcs/bankStatementsUploadBankStatementData.ts

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

package/src/funcs/bankingAccountBalancesList.ts

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

package/src/funcs/bankingAccountsGet.ts

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

package/src/funcs/bankingAccountsList.ts

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

package/src/funcs/bankingCategorizedStatementGet.ts

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

package/src/funcs/bankingTransactionCategoriesGet.ts

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

package/src/funcs/bankingTransactionCategoriesList.ts

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

package/src/funcs/bankingTransactionsGet.ts

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

package/src/funcs/bankingTransactionsList.ts

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

package/src/funcs/companiesCreate.ts

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

package/src/funcs/companiesDelete.ts

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

package/src/funcs/companiesGet.ts

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

package/src/funcs/companiesList.ts

@@ -31,6 +31,19 @@ import { Result } from "../sdk/types/fp.js";
  *
  * 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`
  */
 export async function companiesList(
   client: CodatLendingCore,
@@ -68,6 +81,7 @@ export async function companiesList(
     "page": payload?.page,
     "pageSize": payload?.pageSize,
     "query": payload?.query,
+    "tags": payload?.tags,
   });
 
   const headers = new Headers({
@@ -104,6 +118,7 @@ export async function companiesList(
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
     method: "GET",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     query: query,

package/src/funcs/companiesReplace.ts

@@ -0,0 +1,158 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CodatLendingCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.js";
+import { SDKError } from "../sdk/models/errors/sdkerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as operations from "../sdk/models/operations/index.js";
+import * as shared from "../sdk/models/shared/index.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Replace company
+ *
+ * @remarks
+ * Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.
+ *
+ * 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.
+ */
+export async function companiesReplace(
+  client: CodatLendingCore,
+  request: operations.ReplaceCompanyRequest,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    shared.Company,
+    | errors.ErrorMessage
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ReplaceCompanyRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.CompanyRequestBody, {
+    explode: true,
+  });
+
+  const pathParams = {
+    companyId: encodeSimple("companyId", payload.companyId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/companies/{companyId}")(pathParams);
+
+  const headers = new Headers({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  });
+
+  const secConfig = await extractSecurity(client._options.authHeader);
+  const securityInput = secConfig == null ? {} : { authHeader: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    operationID: "replace-company",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.authHeader,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "429", "5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PUT",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return requestRes;
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "402", "403", "404", "429", "4XX", "500", "503", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return doResult;
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    shared.Company,
+    | errors.ErrorMessage
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, shared.Company$inboundSchema),
+    M.jsonErr(
+      [401, 402, 403, 404, 429, 500, 503],
+      errors.ErrorMessage$inboundSchema,
+    ),
+    M.fail(["4XX", "5XX"]),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

package/src/funcs/companiesUpdate.ts

@@ -27,10 +27,11 @@ import { Result } from "../sdk/types/fp.js";
  * Update company
  *
  * @remarks
- * Use the *Update company* endpoint to update both the name and description of the company.
+ * Use the *Update company* endpoint to update the name, description, or tags of the company.
+ *
+ * The *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update.
  *
  * 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.
  */
 export async function companiesUpdate(
   client: CodatLendingCore,
@@ -58,7 +59,7 @@ export async function companiesUpdate(
     return parsed;
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.CompanyRequestBody, {
+  const body = encodeJSON("body", payload.CompanyUpdateRequest, {
     explode: true,
   });
 
@@ -105,7 +106,8 @@ export async function companiesUpdate(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "PUT",
+    method: "PATCH",
+    baseURL: options?.serverURL,
     path: path,
     headers: headers,
     body: body,

package/src/funcs/companyInfoGetAccountingProfile.ts

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

package/src/funcs/companyInfoGetCommerceProfile.ts

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

package/src/funcs/connectionsCreate.ts

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

package/src/funcs/connectionsDelete.ts

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

package/src/funcs/connectionsGet.ts

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

package/src/funcs/connectionsList.ts

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

package/src/funcs/connectionsUnlink.ts

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

package/src/funcs/dataIntegrityDetails.ts

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

package/src/funcs/dataIntegrityStatus.ts

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

package/src/funcs/dataIntegritySummaries.ts

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

package/src/funcs/excelReportsDownload.ts

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

package/src/funcs/excelReportsGenerate.ts

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

package/src/funcs/excelReportsGetStatus.ts

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

package/src/funcs/fileUploadDownload.ts

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

package/src/funcs/fileUploadListUploaded.ts

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

package/src/funcs/fileUploadUpload.ts

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

package/src/funcs/financialStatementsAccountsGet.ts

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

package/src/funcs/financialStatementsAccountsList.ts

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

package/src/funcs/financialStatementsBalanceSheetGet.ts

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

package/src/funcs/financialStatementsBalanceSheetGetCategorizedAccounts.ts

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

package/src/funcs/financialStatementsCashFlowGet.ts

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

package/src/funcs/financialStatementsProfitAndLossGet.ts

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

package/src/funcs/financialStatementsProfitAndLossGetCategorizedAccounts.ts

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

package/src/funcs/liabilitiesGenerateLoanSummary.ts

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

package/src/funcs/liabilitiesGenerateLoanTransactions.ts

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

package/src/funcs/liabilitiesGetLoanSummary.ts

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

package/src/funcs/liabilitiesListLoanTransactions.ts

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

package/src/funcs/loanWritebackAccountsCreate.ts

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