@codat/lending 5.0.0 → 6.0.0

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

@@ -3,22 +3,29 @@
  */
 
 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 {
-  AccountRef,
-  AccountRef$inboundSchema,
-  AccountRef$Outbound,
-  AccountRef$outboundSchema,
-} from "./accountref.js";
+  AccountingRecordRef,
+  AccountingRecordRef$inboundSchema,
+  AccountingRecordRef$Outbound,
+  AccountingRecordRef$outboundSchema,
+} from "./accountingrecordref.js";
 
 /**
  * Account details of the account sending or receiving the transfer.
  */
 export type TransferAccount = {
   /**
-   * Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.
+   * Links the current record to the underlying record or data type that created it.
+   *
+   * @remarks
+   *
+   * For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model.
    */
-  accountRef?: AccountRef | undefined;
+  accountRef?: AccountingRecordRef | undefined;
   /**
    * The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
    *
@@ -43,14 +50,14 @@ export const TransferAccount$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  accountRef: AccountRef$inboundSchema.optional(),
+  accountRef: AccountingRecordRef$inboundSchema.optional(),
   currency: z.string().optional(),
   amount: z.number().transform(v => new Decimal$(v)).optional(),
 });
 
 /** @internal */
 export type TransferAccount$Outbound = {
-  accountRef?: AccountRef$Outbound | undefined;
+  accountRef?: AccountingRecordRef$Outbound | undefined;
   currency?: string | undefined;
   amount?: number | undefined;
 };
@@ -61,7 +68,7 @@ export const TransferAccount$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TransferAccount
 > = z.object({
-  accountRef: AccountRef$outboundSchema.optional(),
+  accountRef: AccountingRecordRef$outboundSchema.optional(),
   currency: z.string().optional(),
   amount: z.union([z.instanceof(Decimal$), z.number()]).transform(v =>
     typeof v === "number" ? v : v.toNumber()
@@ -80,3 +87,19 @@ export namespace TransferAccount$ {
   /** @deprecated use `TransferAccount$Outbound` instead. */
   export type Outbound = TransferAccount$Outbound;
 }
+
+export function transferAccountToJSON(
+  transferAccount: TransferAccount,
+): string {
+  return JSON.stringify(TransferAccount$outboundSchema.parse(transferAccount));
+}
+
+export function transferAccountFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferAccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferAccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferAccount' from JSON`,
+  );
+}

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

@@ -3,6 +3,9 @@
  */
 
 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 {
   ValidationItem,
   ValidationItem$inboundSchema,
@@ -56,3 +59,17 @@ export namespace Validation$ {
   /** @deprecated use `Validation$Outbound` instead. */
   export type Outbound = Validation$Outbound;
 }
+
+export function validationToJSON(validation: Validation): string {
+  return JSON.stringify(Validation$outboundSchema.parse(validation));
+}
+
+export function validationFromJSON(
+  jsonString: string,
+): SafeParseResult<Validation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Validation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Validation' from JSON`,
+  );
+}

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

@@ -3,6 +3,9 @@
  */
 
 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 ValidationItem = {
   /**
@@ -60,3 +63,17 @@ export namespace ValidationItem$ {
   /** @deprecated use `ValidationItem$Outbound` instead. */
   export type Outbound = ValidationItem$Outbound;
 }
+
+export function validationItemToJSON(validationItem: ValidationItem): string {
+  return JSON.stringify(ValidationItem$outboundSchema.parse(validationItem));
+}
+
+export function validationItemFromJSON(
+  jsonString: string,
+): SafeParseResult<ValidationItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ValidationItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ValidationItem' from JSON`,
+  );
+}

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

@@ -3,7 +3,10 @@
  */
 
 import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
  * The type of the weblink.
@@ -87,3 +90,17 @@ export namespace WebLink$ {
   /** @deprecated use `WebLink$Outbound` instead. */
   export type Outbound = WebLink$Outbound;
 }
+
+export function webLinkToJSON(webLink: WebLink): string {
+  return JSON.stringify(WebLink$outboundSchema.parse(webLink));
+}
+
+export function webLinkFromJSON(
+  jsonString: string,
+): SafeParseResult<WebLink, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebLink$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebLink' from JSON`,
+  );
+}

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

@@ -3,7 +3,10 @@
  */
 
 import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
  * Allowed name of the 'dataType'.
@@ -93,3 +96,17 @@ export namespace Zero$ {
   /** @deprecated use `Zero$Outbound` instead. */
   export type Outbound = Zero$Outbound;
 }
+
+export function zeroToJSON(zero: Zero): string {
+  return JSON.stringify(Zero$outboundSchema.parse(zero));
+}
+
+export function zeroFromJSON(
+  jsonString: string,
+): SafeParseResult<Zero, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Zero$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Zero' from JSON`,
+  );
+}

package/src/sdk/models/webhooks/reportcategorizedbankstatementgeneratesuccessful.ts

@@ -3,6 +3,9 @@
  */
 
 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 * as shared from "../shared/index.js";
 
 export type ReportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhook =
@@ -90,3 +93,30 @@ export namespace ReportCategorizedBankStatementGenerateSuccessfulReportGeneratio
   export type Outbound =
     ReportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhook$Outbound;
 }
+
+export function reportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhookToJSON(
+  reportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhook:
+    ReportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhook,
+): string {
+  return JSON.stringify(
+    ReportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhook$outboundSchema
+      .parse(
+        reportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhook,
+      ),
+  );
+}
+
+export function reportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhookFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ReportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhook,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ReportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhook$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'ReportCategorizedBankStatementGenerateSuccessfulReportGenerationWebhook' from JSON`,
+  );
+}

package/sdk/models/shared/recordref.d.ts

@@ -1,40 +0,0 @@
-import * as z from "zod";
-/**
- * Links the current record to the underlying record or data type that created it.
- *
- * @remarks
- *
- * For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model.
- */
-export type RecordRef = {
-    /**
-     * 'id' of the underlying record or data type.
-     */
-    id?: string | undefined;
-    /**
-     * Allowed name of the 'dataType'.
-     */
-    dataType?: string | undefined;
-};
-/** @internal */
-export declare const RecordRef$inboundSchema: z.ZodType<RecordRef, z.ZodTypeDef, unknown>;
-/** @internal */
-export type RecordRef$Outbound = {
-    id?: string | undefined;
-    dataType?: string | undefined;
-};
-/** @internal */
-export declare const RecordRef$outboundSchema: z.ZodType<RecordRef$Outbound, z.ZodTypeDef, RecordRef>;
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export declare namespace RecordRef$ {
-    /** @deprecated use `RecordRef$inboundSchema` instead. */
-    const inboundSchema: z.ZodType<RecordRef, z.ZodTypeDef, unknown>;
-    /** @deprecated use `RecordRef$outboundSchema` instead. */
-    const outboundSchema: z.ZodType<RecordRef$Outbound, z.ZodTypeDef, RecordRef>;
-    /** @deprecated use `RecordRef$Outbound` instead. */
-    type Outbound = RecordRef$Outbound;
-}
-//# sourceMappingURL=recordref.d.ts.map

package/sdk/models/shared/recordref.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"recordref.d.ts","sourceRoot":"","sources":["../../../src/sdk/models/shared/recordref.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,SAAS,CAIT,CAAC;AAEH;;;GAGG;AACH,yBAAiB,UAAU,CAAC;IAC1B,yDAAyD;IAClD,MAAM,aAAa,6CAA0B,CAAC;IACrD,0DAA0D;IACnD,MAAM,cAAc,wDAA2B,CAAC;IACvD,oDAAoD;IACpD,KAAY,QAAQ,GAAG,kBAAkB,CAAC;CAC3C"}

package/sdk/models/shared/recordref.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"recordref.js","sourceRoot":"","sources":["../../../src/sdk/models/shared/recordref.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uCAAyB;AAoBzB,gBAAgB;AACH,QAAA,uBAAuB,GAIhC,CAAC,CAAC,MAAM,CAAC;IACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAQH,gBAAgB;AACH,QAAA,wBAAwB,GAIjC,CAAC,CAAC,MAAM,CAAC;IACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,UAAU,CAO1B;AAPD,WAAiB,UAAU;IACzB,yDAAyD;IAC5C,wBAAa,GAAG,+BAAuB,CAAC;IACrD,0DAA0D;IAC7C,yBAAc,GAAG,gCAAwB,CAAC;AAGzD,CAAC,EAPgB,UAAU,0BAAV,UAAU,QAO1B"}

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

@@ -1,62 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-
-/**
- * Links the current record to the underlying record or data type that created it.
- *
- * @remarks
- *
- * For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model.
- */
-export type RecordRef = {
-  /**
-   * 'id' of the underlying record or data type.
-   */
-  id?: string | undefined;
-  /**
-   * Allowed name of the 'dataType'.
-   */
-  dataType?: string | undefined;
-};
-
-/** @internal */
-export const RecordRef$inboundSchema: z.ZodType<
-  RecordRef,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  id: z.string().optional(),
-  dataType: z.string().optional(),
-});
-
-/** @internal */
-export type RecordRef$Outbound = {
-  id?: string | undefined;
-  dataType?: string | undefined;
-};
-
-/** @internal */
-export const RecordRef$outboundSchema: z.ZodType<
-  RecordRef$Outbound,
-  z.ZodTypeDef,
-  RecordRef
-> = z.object({
-  id: z.string().optional(),
-  dataType: 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 RecordRef$ {
-  /** @deprecated use `RecordRef$inboundSchema` instead. */
-  export const inboundSchema = RecordRef$inboundSchema;
-  /** @deprecated use `RecordRef$outboundSchema` instead. */
-  export const outboundSchema = RecordRef$outboundSchema;
-  /** @deprecated use `RecordRef$Outbound` instead. */
-  export type Outbound = RecordRef$Outbound;
-}