mollie-api-typescript 0.2.9 → 0.3.1

package/src/models/entitybalancetransfer.ts

@@ -0,0 +1,131 @@
+/*
+ * 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 {
+  Amount,
+  Amount$inboundSchema,
+  Amount$Outbound,
+  Amount$outboundSchema,
+} from "./amount.js";
+import {
+  BalanceTransferCategory,
+  BalanceTransferCategory$inboundSchema,
+  BalanceTransferCategory$outboundSchema,
+} from "./balancetransfercategory.js";
+import {
+  EntityBalanceTransferParty,
+  EntityBalanceTransferParty$inboundSchema,
+  EntityBalanceTransferParty$Outbound,
+  EntityBalanceTransferParty$outboundSchema,
+} from "./entitybalancetransferparty.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type EntityBalanceTransfer = {
+  id: string;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * A party involved in the balance transfer, either the sender or the receiver.
+   */
+  source: EntityBalanceTransferParty;
+  /**
+   * A party involved in the balance transfer, either the sender or the receiver.
+   */
+  destination: EntityBalanceTransferParty;
+  /**
+   * The transfer description for initiating party.
+   */
+  description: string;
+  /**
+   * The type of the transfer. Different fees may apply to different types of transfers.
+   */
+  category?: BalanceTransferCategory | undefined;
+  /**
+   * Whether to create the entity in test mode or live mode.
+   *
+   * @remarks
+   *
+   * Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
+   * omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
+   * `testmode` to `true`.
+   */
+  testmode?: boolean | null | undefined;
+};
+
+/** @internal */
+export const EntityBalanceTransfer$inboundSchema: z.ZodType<
+  EntityBalanceTransfer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  amount: Amount$inboundSchema,
+  source: EntityBalanceTransferParty$inboundSchema,
+  destination: EntityBalanceTransferParty$inboundSchema,
+  description: z.string(),
+  category: BalanceTransferCategory$inboundSchema.optional(),
+  testmode: z.nullable(z.boolean()).optional(),
+});
+
+/** @internal */
+export type EntityBalanceTransfer$Outbound = {
+  id: string;
+  amount: Amount$Outbound;
+  source: EntityBalanceTransferParty$Outbound;
+  destination: EntityBalanceTransferParty$Outbound;
+  description: string;
+  category?: string | undefined;
+  testmode?: boolean | null | undefined;
+};
+
+/** @internal */
+export const EntityBalanceTransfer$outboundSchema: z.ZodType<
+  EntityBalanceTransfer$Outbound,
+  z.ZodTypeDef,
+  EntityBalanceTransfer
+> = z.object({
+  id: z.string(),
+  amount: Amount$outboundSchema,
+  source: EntityBalanceTransferParty$outboundSchema,
+  destination: EntityBalanceTransferParty$outboundSchema,
+  description: z.string(),
+  category: BalanceTransferCategory$outboundSchema.optional(),
+  testmode: z.nullable(z.boolean()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EntityBalanceTransfer$ {
+  /** @deprecated use `EntityBalanceTransfer$inboundSchema` instead. */
+  export const inboundSchema = EntityBalanceTransfer$inboundSchema;
+  /** @deprecated use `EntityBalanceTransfer$outboundSchema` instead. */
+  export const outboundSchema = EntityBalanceTransfer$outboundSchema;
+  /** @deprecated use `EntityBalanceTransfer$Outbound` instead. */
+  export type Outbound = EntityBalanceTransfer$Outbound;
+}
+
+export function entityBalanceTransferToJSON(
+  entityBalanceTransfer: EntityBalanceTransfer,
+): string {
+  return JSON.stringify(
+    EntityBalanceTransfer$outboundSchema.parse(entityBalanceTransfer),
+  );
+}
+
+export function entityBalanceTransferFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityBalanceTransfer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityBalanceTransfer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityBalanceTransfer' from JSON`,
+  );
+}

package/src/models/entitybalancetransferparty.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  BalanceTransferPartyType,
+  BalanceTransferPartyType$inboundSchema,
+  BalanceTransferPartyType$outboundSchema,
+} from "./balancetransferpartytype.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * A party involved in the balance transfer, either the sender or the receiver.
+ */
+export type EntityBalanceTransferParty = {
+  /**
+   * Defines the type of the party. At the moment, only `organization` is supported.
+   */
+  type: BalanceTransferPartyType;
+  id: string;
+  /**
+   * The transfer description for the transfer party. This is the description that will appear in the financial reports of the party.
+   */
+  description: string;
+};
+
+/** @internal */
+export const EntityBalanceTransferParty$inboundSchema: z.ZodType<
+  EntityBalanceTransferParty,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: BalanceTransferPartyType$inboundSchema,
+  id: z.string(),
+  description: z.string(),
+});
+
+/** @internal */
+export type EntityBalanceTransferParty$Outbound = {
+  type: string;
+  id: string;
+  description: string;
+};
+
+/** @internal */
+export const EntityBalanceTransferParty$outboundSchema: z.ZodType<
+  EntityBalanceTransferParty$Outbound,
+  z.ZodTypeDef,
+  EntityBalanceTransferParty
+> = z.object({
+  type: BalanceTransferPartyType$outboundSchema,
+  id: z.string(),
+  description: 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 EntityBalanceTransferParty$ {
+  /** @deprecated use `EntityBalanceTransferParty$inboundSchema` instead. */
+  export const inboundSchema = EntityBalanceTransferParty$inboundSchema;
+  /** @deprecated use `EntityBalanceTransferParty$outboundSchema` instead. */
+  export const outboundSchema = EntityBalanceTransferParty$outboundSchema;
+  /** @deprecated use `EntityBalanceTransferParty$Outbound` instead. */
+  export type Outbound = EntityBalanceTransferParty$Outbound;
+}
+
+export function entityBalanceTransferPartyToJSON(
+  entityBalanceTransferParty: EntityBalanceTransferParty,
+): string {
+  return JSON.stringify(
+    EntityBalanceTransferParty$outboundSchema.parse(entityBalanceTransferParty),
+  );
+}
+
+export function entityBalanceTransferPartyFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityBalanceTransferParty, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityBalanceTransferParty$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityBalanceTransferParty' from JSON`,
+  );
+}

package/src/models/entitybalancetransferpartyresponse.ts

@@ -0,0 +1,92 @@
+/*
+ * 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 {
+  BalanceTransferPartyTypeResponse,
+  BalanceTransferPartyTypeResponse$inboundSchema,
+  BalanceTransferPartyTypeResponse$outboundSchema,
+} from "./balancetransferpartytyperesponse.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * A party involved in the balance transfer, either the sender or the receiver.
+ */
+export type EntityBalanceTransferPartyResponse = {
+  /**
+   * Defines the type of the party. At the moment, only `organization` is supported.
+   */
+  type: BalanceTransferPartyTypeResponse;
+  id: string;
+  /**
+   * The transfer description for the transfer party. This is the description that will appear in the financial reports of the party.
+   */
+  description: string;
+};
+
+/** @internal */
+export const EntityBalanceTransferPartyResponse$inboundSchema: z.ZodType<
+  EntityBalanceTransferPartyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: BalanceTransferPartyTypeResponse$inboundSchema,
+  id: z.string(),
+  description: z.string(),
+});
+
+/** @internal */
+export type EntityBalanceTransferPartyResponse$Outbound = {
+  type: string;
+  id: string;
+  description: string;
+};
+
+/** @internal */
+export const EntityBalanceTransferPartyResponse$outboundSchema: z.ZodType<
+  EntityBalanceTransferPartyResponse$Outbound,
+  z.ZodTypeDef,
+  EntityBalanceTransferPartyResponse
+> = z.object({
+  type: BalanceTransferPartyTypeResponse$outboundSchema,
+  id: z.string(),
+  description: 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 EntityBalanceTransferPartyResponse$ {
+  /** @deprecated use `EntityBalanceTransferPartyResponse$inboundSchema` instead. */
+  export const inboundSchema = EntityBalanceTransferPartyResponse$inboundSchema;
+  /** @deprecated use `EntityBalanceTransferPartyResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    EntityBalanceTransferPartyResponse$outboundSchema;
+  /** @deprecated use `EntityBalanceTransferPartyResponse$Outbound` instead. */
+  export type Outbound = EntityBalanceTransferPartyResponse$Outbound;
+}
+
+export function entityBalanceTransferPartyResponseToJSON(
+  entityBalanceTransferPartyResponse: EntityBalanceTransferPartyResponse,
+): string {
+  return JSON.stringify(
+    EntityBalanceTransferPartyResponse$outboundSchema.parse(
+      entityBalanceTransferPartyResponse,
+    ),
+  );
+}
+
+export function entityBalanceTransferPartyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityBalanceTransferPartyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EntityBalanceTransferPartyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityBalanceTransferPartyResponse' from JSON`,
+  );
+}

package/src/models/entitybalancetransferresponse.ts

@@ -0,0 +1,263 @@
+/*
+ * 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 {
+  Amount,
+  Amount$inboundSchema,
+  Amount$Outbound,
+  Amount$outboundSchema,
+} from "./amount.js";
+import {
+  BalanceTransferCategoryResponse,
+  BalanceTransferCategoryResponse$inboundSchema,
+  BalanceTransferCategoryResponse$outboundSchema,
+} from "./balancetransfercategoryresponse.js";
+import {
+  BalanceTransferStatus,
+  BalanceTransferStatus$inboundSchema,
+  BalanceTransferStatus$outboundSchema,
+} from "./balancetransferstatus.js";
+import {
+  BalanceTransferStatusReasonResponse,
+  BalanceTransferStatusReasonResponse$inboundSchema,
+  BalanceTransferStatusReasonResponse$outboundSchema,
+} from "./balancetransferstatusreasonresponse.js";
+import {
+  EntityBalanceTransferPartyResponse,
+  EntityBalanceTransferPartyResponse$inboundSchema,
+  EntityBalanceTransferPartyResponse$Outbound,
+  EntityBalanceTransferPartyResponse$outboundSchema,
+} from "./entitybalancetransferpartyresponse.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
+
+/**
+ * The reason for the current status of the transfer, if applicable.
+ */
+export type EntityBalanceTransferResponseStatusReason = {
+  /**
+   * A machine-readable code that indicates the reason for the transfer's status.
+   */
+  code: BalanceTransferStatusReasonResponse;
+  /**
+   * A description of the status reason, localized according to the transfer.
+   */
+  message: string;
+};
+
+export type EntityBalanceTransferResponse = {
+  /**
+   * Indicates the response contains a balance transfer object. Will always contain the string `connect-balance-transfer` for this endpoint.
+   */
+  resource: string;
+  id: string;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * A party involved in the balance transfer, either the sender or the receiver.
+   */
+  source: EntityBalanceTransferPartyResponse;
+  /**
+   * A party involved in the balance transfer, either the sender or the receiver.
+   */
+  destination: EntityBalanceTransferPartyResponse;
+  /**
+   * The transfer description for initiating party.
+   */
+  description: string;
+  /**
+   * The status of the transfer.
+   */
+  status: BalanceTransferStatus;
+  /**
+   * The reason for the current status of the transfer, if applicable.
+   */
+  statusReason: EntityBalanceTransferResponseStatusReason;
+  /**
+   * The type of the transfer. Different fees may apply to different types of transfers.
+   */
+  category?: BalanceTransferCategoryResponse | undefined;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * The date and time when the transfer was completed, in ISO 8601 format. This parameter is omitted if the transfer is
+   *
+   * @remarks
+   * not executed (yet).
+   */
+  executedAt?: string | null | undefined;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+};
+
+/** @internal */
+export const EntityBalanceTransferResponseStatusReason$inboundSchema: z.ZodType<
+  EntityBalanceTransferResponseStatusReason,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: BalanceTransferStatusReasonResponse$inboundSchema,
+  message: z.string(),
+});
+
+/** @internal */
+export type EntityBalanceTransferResponseStatusReason$Outbound = {
+  code: string;
+  message: string;
+};
+
+/** @internal */
+export const EntityBalanceTransferResponseStatusReason$outboundSchema:
+  z.ZodType<
+    EntityBalanceTransferResponseStatusReason$Outbound,
+    z.ZodTypeDef,
+    EntityBalanceTransferResponseStatusReason
+  > = z.object({
+    code: BalanceTransferStatusReasonResponse$outboundSchema,
+    message: 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 EntityBalanceTransferResponseStatusReason$ {
+  /** @deprecated use `EntityBalanceTransferResponseStatusReason$inboundSchema` instead. */
+  export const inboundSchema =
+    EntityBalanceTransferResponseStatusReason$inboundSchema;
+  /** @deprecated use `EntityBalanceTransferResponseStatusReason$outboundSchema` instead. */
+  export const outboundSchema =
+    EntityBalanceTransferResponseStatusReason$outboundSchema;
+  /** @deprecated use `EntityBalanceTransferResponseStatusReason$Outbound` instead. */
+  export type Outbound = EntityBalanceTransferResponseStatusReason$Outbound;
+}
+
+export function entityBalanceTransferResponseStatusReasonToJSON(
+  entityBalanceTransferResponseStatusReason:
+    EntityBalanceTransferResponseStatusReason,
+): string {
+  return JSON.stringify(
+    EntityBalanceTransferResponseStatusReason$outboundSchema.parse(
+      entityBalanceTransferResponseStatusReason,
+    ),
+  );
+}
+
+export function entityBalanceTransferResponseStatusReasonFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EntityBalanceTransferResponseStatusReason,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EntityBalanceTransferResponseStatusReason$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EntityBalanceTransferResponseStatusReason' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityBalanceTransferResponse$inboundSchema: z.ZodType<
+  EntityBalanceTransferResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  amount: Amount$inboundSchema,
+  source: EntityBalanceTransferPartyResponse$inboundSchema,
+  destination: EntityBalanceTransferPartyResponse$inboundSchema,
+  description: z.string(),
+  status: BalanceTransferStatus$inboundSchema,
+  statusReason: z.lazy(() =>
+    EntityBalanceTransferResponseStatusReason$inboundSchema
+  ),
+  category: BalanceTransferCategoryResponse$inboundSchema.optional(),
+  createdAt: z.string(),
+  executedAt: z.nullable(z.string()).optional(),
+  mode: Mode$inboundSchema,
+});
+
+/** @internal */
+export type EntityBalanceTransferResponse$Outbound = {
+  resource: string;
+  id: string;
+  amount: Amount$Outbound;
+  source: EntityBalanceTransferPartyResponse$Outbound;
+  destination: EntityBalanceTransferPartyResponse$Outbound;
+  description: string;
+  status: string;
+  statusReason: EntityBalanceTransferResponseStatusReason$Outbound;
+  category?: string | undefined;
+  createdAt: string;
+  executedAt?: string | null | undefined;
+  mode: string;
+};
+
+/** @internal */
+export const EntityBalanceTransferResponse$outboundSchema: z.ZodType<
+  EntityBalanceTransferResponse$Outbound,
+  z.ZodTypeDef,
+  EntityBalanceTransferResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  amount: Amount$outboundSchema,
+  source: EntityBalanceTransferPartyResponse$outboundSchema,
+  destination: EntityBalanceTransferPartyResponse$outboundSchema,
+  description: z.string(),
+  status: BalanceTransferStatus$outboundSchema,
+  statusReason: z.lazy(() =>
+    EntityBalanceTransferResponseStatusReason$outboundSchema
+  ),
+  category: BalanceTransferCategoryResponse$outboundSchema.optional(),
+  createdAt: z.string(),
+  executedAt: z.nullable(z.string()).optional(),
+  mode: Mode$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EntityBalanceTransferResponse$ {
+  /** @deprecated use `EntityBalanceTransferResponse$inboundSchema` instead. */
+  export const inboundSchema = EntityBalanceTransferResponse$inboundSchema;
+  /** @deprecated use `EntityBalanceTransferResponse$outboundSchema` instead. */
+  export const outboundSchema = EntityBalanceTransferResponse$outboundSchema;
+  /** @deprecated use `EntityBalanceTransferResponse$Outbound` instead. */
+  export type Outbound = EntityBalanceTransferResponse$Outbound;
+}
+
+export function entityBalanceTransferResponseToJSON(
+  entityBalanceTransferResponse: EntityBalanceTransferResponse,
+): string {
+  return JSON.stringify(
+    EntityBalanceTransferResponse$outboundSchema.parse(
+      entityBalanceTransferResponse,
+    ),
+  );
+}
+
+export function entityBalanceTransferResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityBalanceTransferResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityBalanceTransferResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityBalanceTransferResponse' from JSON`,
+  );
+}

package/src/models/entitywebhook.ts

@@ -29,6 +29,10 @@ import {
  * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
  */
 export type EntityWebhookLinks = {
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  self: Url;
   /**
    * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
    */
@@ -87,11 +91,13 @@ export const EntityWebhookLinks$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  self: Url$inboundSchema,
   documentation: Url$inboundSchema,
 });
 
 /** @internal */
 export type EntityWebhookLinks$Outbound = {
+  self: Url$Outbound;
   documentation: Url$Outbound;
 };
 
@@ -101,6 +107,7 @@ export const EntityWebhookLinks$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityWebhookLinks
 > = z.object({
+  self: Url$outboundSchema,
   documentation: Url$outboundSchema,
 });
 

package/src/models/index.ts

@@ -8,8 +8,14 @@ export * from "./amountnullable.js";
 export * from "./balancereportgrouping.js";
 export * from "./balancestatus.js";
 export * from "./balancetransactiontype.js";
+export * from "./balancetransfercategory.js";
+export * from "./balancetransfercategoryresponse.js";
 export * from "./balancetransferdestinationtype.js";
 export * from "./balancetransferfrequency.js";
+export * from "./balancetransferpartytype.js";
+export * from "./balancetransferpartytyperesponse.js";
+export * from "./balancetransferstatus.js";
+export * from "./balancetransferstatusreasonresponse.js";
 export * from "./capabilityrequirementstatus.js";
 export * from "./capabilitystatus.js";
 export * from "./capabilitystatusreason.js";
@@ -25,6 +31,10 @@ export * from "./deletevaluessalesinvoice.js";
 export * from "./entitybalance.js";
 export * from "./entitybalancereport.js";
 export * from "./entitybalancetransaction.js";
+export * from "./entitybalancetransfer.js";
+export * from "./entitybalancetransferparty.js";
+export * from "./entitybalancetransferpartyresponse.js";
+export * from "./entitybalancetransferresponse.js";
 export * from "./entitycapability.js";
 export * from "./entitycapabilityrequirement.js";
 export * from "./entitycapture.js";