@codat/lending 7.1.0 → 7.2.0

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,7 @@ export async function companiesUpdate(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "PUT",
+    method: "PATCH",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,

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.1.0",
-  genVersion: "2.486.1",
-  userAgent: "speakeasy-sdk/typescript 7.1.0 2.486.1 3.0.0 @codat/lending",
+  sdkVersion: "7.2.0",
+  genVersion: "2.492.3",
+  userAgent: "speakeasy-sdk/typescript 7.2.0 2.492.3 3.0.0 @codat/lending",
 } as const;

package/src/sdk/companies.ts

@@ -6,6 +6,7 @@ import { companiesCreate } from "../funcs/companiesCreate.js";
 import { companiesDelete } from "../funcs/companiesDelete.js";
 import { companiesGet } from "../funcs/companiesGet.js";
 import { companiesList } from "../funcs/companiesList.js";
+import { companiesReplace } from "../funcs/companiesReplace.js";
 import { companiesUpdate } from "../funcs/companiesUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
@@ -69,14 +70,35 @@ export class Companies extends ClientSDK {
   }
 
   /**
-   * Update company
+   * Replace company
    *
    * @remarks
-   * Use the *Update company* endpoint to update both the name and description of the company.
+   * 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.
    */
+  async replace(
+    request: operations.ReplaceCompanyRequest,
+    options?: RequestOptions,
+  ): Promise<shared.Company> {
+    return unwrapAsync(companiesReplace(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update company
+   *
+   * @remarks
+   * 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.
+   */
   async update(
     request: operations.UpdateCompanyRequest,
     options?: RequestOptions,

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

@@ -144,6 +144,7 @@ export * from "./listreconciledinvoices.js";
 export * from "./listreports.js";
 export * from "./refreshalldatatypes.js";
 export * from "./refreshdatatype.js";
+export * from "./replacecompany.js";
 export * from "./setbankstatementuploadconfiguration.js";
 export * from "./startbankstatementuploadsession.js";
 export * from "./unlinkconnection.js";

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

@@ -0,0 +1,83 @@
+/*
+ * 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";
+import * as shared from "../shared/index.js";
+
+export type ReplaceCompanyRequest = {
+  /**
+   * Unique identifier for a company.
+   */
+  companyId: string;
+  companyRequestBody?: shared.CompanyRequestBody | undefined;
+};
+
+/** @internal */
+export const ReplaceCompanyRequest$inboundSchema: z.ZodType<
+  ReplaceCompanyRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  companyId: z.string(),
+  CompanyRequestBody: shared.CompanyRequestBody$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "CompanyRequestBody": "companyRequestBody",
+  });
+});
+
+/** @internal */
+export type ReplaceCompanyRequest$Outbound = {
+  companyId: string;
+  CompanyRequestBody?: shared.CompanyRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const ReplaceCompanyRequest$outboundSchema: z.ZodType<
+  ReplaceCompanyRequest$Outbound,
+  z.ZodTypeDef,
+  ReplaceCompanyRequest
+> = z.object({
+  companyId: z.string(),
+  companyRequestBody: shared.CompanyRequestBody$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    companyRequestBody: "CompanyRequestBody",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReplaceCompanyRequest$ {
+  /** @deprecated use `ReplaceCompanyRequest$inboundSchema` instead. */
+  export const inboundSchema = ReplaceCompanyRequest$inboundSchema;
+  /** @deprecated use `ReplaceCompanyRequest$outboundSchema` instead. */
+  export const outboundSchema = ReplaceCompanyRequest$outboundSchema;
+  /** @deprecated use `ReplaceCompanyRequest$Outbound` instead. */
+  export type Outbound = ReplaceCompanyRequest$Outbound;
+}
+
+export function replaceCompanyRequestToJSON(
+  replaceCompanyRequest: ReplaceCompanyRequest,
+): string {
+  return JSON.stringify(
+    ReplaceCompanyRequest$outboundSchema.parse(replaceCompanyRequest),
+  );
+}
+
+export function replaceCompanyRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ReplaceCompanyRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReplaceCompanyRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReplaceCompanyRequest' from JSON`,
+  );
+}

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

@@ -14,7 +14,7 @@ export type UpdateCompanyRequest = {
    * Unique identifier for a company.
    */
   companyId: string;
-  companyRequestBody?: shared.CompanyRequestBody | undefined;
+  companyUpdateRequest?: shared.CompanyUpdateRequest | undefined;
 };
 
 /** @internal */
@@ -24,17 +24,17 @@ export const UpdateCompanyRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   companyId: z.string(),
-  CompanyRequestBody: shared.CompanyRequestBody$inboundSchema.optional(),
+  CompanyUpdateRequest: shared.CompanyUpdateRequest$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
-    "CompanyRequestBody": "companyRequestBody",
+    "CompanyUpdateRequest": "companyUpdateRequest",
   });
 });
 
 /** @internal */
 export type UpdateCompanyRequest$Outbound = {
   companyId: string;
-  CompanyRequestBody?: shared.CompanyRequestBody$Outbound | undefined;
+  CompanyUpdateRequest?: shared.CompanyUpdateRequest$Outbound | undefined;
 };
 
 /** @internal */
@@ -44,10 +44,10 @@ export const UpdateCompanyRequest$outboundSchema: z.ZodType<
   UpdateCompanyRequest
 > = z.object({
   companyId: z.string(),
-  companyRequestBody: shared.CompanyRequestBody$outboundSchema.optional(),
+  companyUpdateRequest: shared.CompanyUpdateRequest$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
-    companyRequestBody: "CompanyRequestBody",
+    companyUpdateRequest: "CompanyUpdateRequest",
   });
 });
 

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

@@ -45,7 +45,7 @@ export type AccountingBalanceSheet = {
    *
    * There are only a very small number of edge cases where this currency code is returned by the Codat system.
    */
-  currency: string;
+  currency?: string | undefined;
   /**
    * An array of balance sheet reports.
    */
@@ -102,7 +102,7 @@ export const AccountingBalanceSheet$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  currency: z.string(),
+  currency: z.string().optional(),
   reports: z.array(BalanceSheet$inboundSchema),
   mostRecentAvailableMonth: z.string().optional(),
   earliestAvailableMonth: z.string().optional(),
@@ -110,7 +110,7 @@ export const AccountingBalanceSheet$inboundSchema: z.ZodType<
 
 /** @internal */
 export type AccountingBalanceSheet$Outbound = {
-  currency: string;
+  currency?: string | undefined;
   reports: Array<BalanceSheet$Outbound>;
   mostRecentAvailableMonth?: string | undefined;
   earliestAvailableMonth?: string | undefined;
@@ -122,7 +122,7 @@ export const AccountingBalanceSheet$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AccountingBalanceSheet
 > = z.object({
-  currency: z.string(),
+  currency: z.string().optional(),
   reports: z.array(BalanceSheet$outboundSchema),
   mostRecentAvailableMonth: z.string().optional(),
   earliestAvailableMonth: z.string().optional(),

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

@@ -62,7 +62,7 @@ export type AccountingCashFlowStatement = {
    *
    * There are only a very small number of edge cases where this currency code is returned by the Codat system.
    */
-  currency: string;
+  currency?: 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:
    *
@@ -118,7 +118,7 @@ export const AccountingCashFlowStatement$inboundSchema: z.ZodType<
   reports: z.array(CashFlowStatement$inboundSchema),
   reportBasis: ReportBasis$inboundSchema,
   reportInput: ReportInput$inboundSchema,
-  currency: z.string(),
+  currency: z.string().optional(),
   mostRecentAvailableMonth: z.string().optional(),
   earliestAvailableMonth: z.string().optional(),
 });
@@ -128,7 +128,7 @@ export type AccountingCashFlowStatement$Outbound = {
   reports: Array<CashFlowStatement$Outbound>;
   reportBasis: string;
   reportInput: string;
-  currency: string;
+  currency?: string | undefined;
   mostRecentAvailableMonth?: string | undefined;
   earliestAvailableMonth?: string | undefined;
 };
@@ -142,7 +142,7 @@ export const AccountingCashFlowStatement$outboundSchema: z.ZodType<
   reports: z.array(CashFlowStatement$outboundSchema),
   reportBasis: ReportBasis$outboundSchema,
   reportInput: ReportInput$outboundSchema,
-  currency: z.string(),
+  currency: z.string().optional(),
   mostRecentAvailableMonth: z.string().optional(),
   earliestAvailableMonth: z.string().optional(),
 });

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

@@ -53,7 +53,7 @@ export type AccountingProfitAndLossReport = {
   /**
    * Base currency of the company in which the profit and loss report is presented.
    */
-  currency: string;
+  currency?: 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:
    *
@@ -108,7 +108,7 @@ export const AccountingProfitAndLossReport$inboundSchema: z.ZodType<
 > = z.object({
   reports: z.array(ProfitAndLossReport$inboundSchema),
   reportBasis: ReportBasis$inboundSchema,
-  currency: z.string(),
+  currency: z.string().optional(),
   mostRecentAvailableMonth: z.string().optional(),
   earliestAvailableMonth: z.string().optional(),
 });
@@ -117,7 +117,7 @@ export const AccountingProfitAndLossReport$inboundSchema: z.ZodType<
 export type AccountingProfitAndLossReport$Outbound = {
   reports: Array<ProfitAndLossReport$Outbound>;
   reportBasis: string;
-  currency: string;
+  currency?: string | undefined;
   mostRecentAvailableMonth?: string | undefined;
   earliestAvailableMonth?: string | undefined;
 };
@@ -130,7 +130,7 @@ export const AccountingProfitAndLossReport$outboundSchema: z.ZodType<
 > = z.object({
   reports: z.array(ProfitAndLossReport$outboundSchema),
   reportBasis: ReportBasis$outboundSchema,
-  currency: z.string(),
+  currency: z.string().optional(),
   mostRecentAvailableMonth: z.string().optional(),
   earliestAvailableMonth: z.string().optional(),
 });

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

@@ -0,0 +1,83 @@
+/*
+ * 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 CompanyUpdateRequest = {
+  /**
+   * Name of company being connected.
+   */
+  name?: string | undefined;
+  /**
+   * Additional information about the company. This can be used to store foreign IDs, references, etc.
+   */
+  description?: string | undefined;
+  /**
+   * A collection of user-defined key-value pairs that store custom metadata against the company.
+   */
+  tags?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const CompanyUpdateRequest$inboundSchema: z.ZodType<
+  CompanyUpdateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  description: z.string().optional(),
+  tags: z.record(z.string()).optional(),
+});
+
+/** @internal */
+export type CompanyUpdateRequest$Outbound = {
+  name?: string | undefined;
+  description?: string | undefined;
+  tags?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const CompanyUpdateRequest$outboundSchema: z.ZodType<
+  CompanyUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  CompanyUpdateRequest
+> = z.object({
+  name: z.string().optional(),
+  description: z.string().optional(),
+  tags: z.record(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 CompanyUpdateRequest$ {
+  /** @deprecated use `CompanyUpdateRequest$inboundSchema` instead. */
+  export const inboundSchema = CompanyUpdateRequest$inboundSchema;
+  /** @deprecated use `CompanyUpdateRequest$outboundSchema` instead. */
+  export const outboundSchema = CompanyUpdateRequest$outboundSchema;
+  /** @deprecated use `CompanyUpdateRequest$Outbound` instead. */
+  export type Outbound = CompanyUpdateRequest$Outbound;
+}
+
+export function companyUpdateRequestToJSON(
+  companyUpdateRequest: CompanyUpdateRequest,
+): string {
+  return JSON.stringify(
+    CompanyUpdateRequest$outboundSchema.parse(companyUpdateRequest),
+  );
+}
+
+export function companyUpdateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyUpdateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyUpdateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyUpdateRequest' from JSON`,
+  );
+}

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

@@ -147,6 +147,7 @@ export * from "./companies.js";
 export * from "./company.js";
 export * from "./companyreference.js";
 export * from "./companyrequestbody.js";
+export * from "./companyupdaterequest.js";
 export * from "./connection.js";
 export * from "./connections.js";
 export * from "./contact.js";