mollie-api-typescript 1.3.3 → 1.3.5

package/src/models/index.ts

@@ -3,6 +3,8 @@
  * @generated-id: f93644b0f37e
  */
 
+export * from "./accountnumberformat.js";
+export * from "./accountnumberformatresponse.js";
 export * from "./address.js";
 export * from "./amount.js";
 export * from "./amountnullable.js";
@@ -31,6 +33,9 @@ export * from "./clientlinkrequest.js";
 export * from "./clientlinkresponse.js";
 export * from "./componentssubtotals.js";
 export * from "./createwebhook.js";
+export * from "./creditdebitindicator.js";
+export * from "./creditorbankaccount.js";
+export * from "./creditorbankaccountresponse.js";
 export * from "./currencies.js";
 export * from "./customerresponse.js";
 export * from "./deletevaluessalesinvoice.js";
@@ -80,6 +85,9 @@ export * from "./listpaymentresponse.js";
 export * from "./listprofileresponse.js";
 export * from "./listroutegetresponse.js";
 export * from "./listsalesinvoiceresponse.js";
+export * from "./listsettlementcaptureresponse.js";
+export * from "./listsettlementpaymentresponse.js";
+export * from "./listsettlementrefundresponse.js";
 export * from "./listsubscriptionresponse.js";
 export * from "./locale.js";
 export * from "./localeresponse.js";
@@ -168,8 +176,15 @@ export * from "./sessionrequest.js";
 export * from "./sessionresponse.js";
 export * from "./sessionsequencetype.js";
 export * from "./sessionsequencetyperesponse.js";
+export * from "./settlementcapturestatus.js";
+export * from "./settlementmode.js";
+export * from "./settlementpaymentstatus.js";
+export * from "./settlementrefundstatus.js";
 export * from "./sorting.js";
+export * from "./statushistoryentryresponse.js";
 export * from "./statusreason.js";
+export * from "./statusreason2.js";
+export * from "./statusreasoncoderesponse.js";
 export * from "./subgroup.js";
 export * from "./subscriptionmethod.js";
 export * from "./subscriptionmethodresponse.js";
@@ -178,7 +193,18 @@ export * from "./subscriptionresponse.js";
 export * from "./subtotals.js";
 export * from "./terminalbrand.js";
 export * from "./terminalmodel.js";
+export * from "./transferparty.js";
+export * from "./transferrequest.js";
+export * from "./transferresponse.js";
+export * from "./transferscheme.js";
+export * from "./transferschemeresponse.js";
+export * from "./transferschemetype.js";
+export * from "./transferschemetyperesponse.js";
+export * from "./transferstatus.js";
 export * from "./url.js";
 export * from "./urlnullable.js";
+export * from "./verificationofpayeerequest.js";
+export * from "./verificationofpayeeresponse.js";
+export * from "./verificationresultenum.js";
 export * from "./webhookeventtypes.js";
 export * from "./webhookstatus.js";

package/src/models/listsettlementcaptureresponse.ts

@@ -0,0 +1,360 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f7c911170b6e
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  AmountNullable,
+  AmountNullable$inboundSchema,
+  AmountNullable$Outbound,
+  AmountNullable$outboundSchema,
+} from "./amountnullable.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  Metadata,
+  Metadata$inboundSchema,
+  Metadata$Outbound,
+  Metadata$outboundSchema,
+} from "./metadata.js";
+import {
+  SettlementCaptureStatus,
+  SettlementCaptureStatus$inboundSchema,
+  SettlementCaptureStatus$outboundSchema,
+} from "./settlementcapturestatus.js";
+import {
+  SettlementMode,
+  SettlementMode$inboundSchema,
+  SettlementMode$outboundSchema,
+} from "./settlementmode.js";
+import {
+  Url,
+  Url$inboundSchema,
+  Url$Outbound,
+  Url$outboundSchema,
+} from "./url.js";
+import {
+  UrlNullable,
+  UrlNullable$inboundSchema,
+  UrlNullable$Outbound,
+  UrlNullable$outboundSchema,
+} from "./urlnullable.js";
+
+/**
+ * This optional field will contain the approximate amount that will be settled to your account, converted to the
+ *
+ * @remarks
+ * currency your account is settled in.
+ *
+ * Since the field contains an estimated amount during capture processing, it may change over time. To retrieve
+ * accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions)
+ * instead.
+ */
+export type ListSettlementCaptureResponseSettlementAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListSettlementCaptureResponseLinks = {
+  /**
+   * 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.
+   */
+  payment: Url;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  settlement?: UrlNullable | null | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  shipment?: UrlNullable | null | undefined;
+};
+
+export type ListSettlementCaptureResponse = {
+  /**
+   * Indicates the response contains a capture object. Will always contain the string `capture` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this capture. Example: `cpt_mNepDkEtco6ah3QNPUGYH`.
+   */
+  id: string;
+  /**
+   * Whether this entity was created in live mode or in test mode. Settlements are always in live mode.
+   */
+  mode: SettlementMode;
+  /**
+   * The description of the capture.
+   */
+  description?: string | undefined;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: AmountNullable | null;
+  /**
+   * This optional field will contain the approximate amount that will be settled to your account, converted to the
+   *
+   * @remarks
+   * currency your account is settled in.
+   *
+   * Since the field contains an estimated amount during capture processing, it may change over time. To retrieve
+   * accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions)
+   * instead.
+   */
+  settlementAmount?:
+    | ListSettlementCaptureResponseSettlementAmount
+    | null
+    | undefined;
+  /**
+   * The capture's status. Settlement captures always have a status of `succeeded`.
+   */
+  status: SettlementCaptureStatus;
+  /**
+   * Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
+   *
+   * @remarks
+   * you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
+   */
+  metadata?: Metadata | null | undefined;
+  /**
+   * The unique identifier of the payment this capture was created for. For example: `tr_5B8cwPMGnU6qLbRvo7qEZo`.
+   *
+   * @remarks
+   * The full payment object can be retrieved via the payment URL in the `_links` object.
+   */
+  paymentId: string;
+  /**
+   * The unique identifier of the shipment that triggered the creation of this capture, if applicable. For example:
+   *
+   * @remarks
+   * `shp_gNapNy9qQTUFZYnCrCF7J`.
+   */
+  shipmentId?: string | null | undefined;
+  /**
+   * The identifier referring to the settlement this capture was settled with. For example, `stl_BkEjN2eBb`. This field
+   *
+   * @remarks
+   * is omitted if the capture is not settled (yet).
+   */
+  settlementId?: string | null | undefined;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListSettlementCaptureResponseLinks;
+};
+
+/** @internal */
+export const ListSettlementCaptureResponseSettlementAmount$inboundSchema:
+  z.ZodType<
+    ListSettlementCaptureResponseSettlementAmount,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    currency: z.string(),
+    value: z.string(),
+  });
+/** @internal */
+export type ListSettlementCaptureResponseSettlementAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListSettlementCaptureResponseSettlementAmount$outboundSchema:
+  z.ZodType<
+    ListSettlementCaptureResponseSettlementAmount$Outbound,
+    z.ZodTypeDef,
+    ListSettlementCaptureResponseSettlementAmount
+  > = z.object({
+    currency: z.string(),
+    value: z.string(),
+  });
+
+export function listSettlementCaptureResponseSettlementAmountToJSON(
+  listSettlementCaptureResponseSettlementAmount:
+    ListSettlementCaptureResponseSettlementAmount,
+): string {
+  return JSON.stringify(
+    ListSettlementCaptureResponseSettlementAmount$outboundSchema.parse(
+      listSettlementCaptureResponseSettlementAmount,
+    ),
+  );
+}
+export function listSettlementCaptureResponseSettlementAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListSettlementCaptureResponseSettlementAmount,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListSettlementCaptureResponseSettlementAmount$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListSettlementCaptureResponseSettlementAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSettlementCaptureResponseLinks$inboundSchema: z.ZodType<
+  ListSettlementCaptureResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  payment: Url$inboundSchema,
+  settlement: z.nullable(UrlNullable$inboundSchema).optional(),
+  shipment: z.nullable(UrlNullable$inboundSchema).optional(),
+});
+/** @internal */
+export type ListSettlementCaptureResponseLinks$Outbound = {
+  self: Url$Outbound;
+  payment: Url$Outbound;
+  settlement?: UrlNullable$Outbound | null | undefined;
+  shipment?: UrlNullable$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ListSettlementCaptureResponseLinks$outboundSchema: z.ZodType<
+  ListSettlementCaptureResponseLinks$Outbound,
+  z.ZodTypeDef,
+  ListSettlementCaptureResponseLinks
+> = z.object({
+  self: Url$outboundSchema,
+  payment: Url$outboundSchema,
+  settlement: z.nullable(UrlNullable$outboundSchema).optional(),
+  shipment: z.nullable(UrlNullable$outboundSchema).optional(),
+});
+
+export function listSettlementCaptureResponseLinksToJSON(
+  listSettlementCaptureResponseLinks: ListSettlementCaptureResponseLinks,
+): string {
+  return JSON.stringify(
+    ListSettlementCaptureResponseLinks$outboundSchema.parse(
+      listSettlementCaptureResponseLinks,
+    ),
+  );
+}
+export function listSettlementCaptureResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSettlementCaptureResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListSettlementCaptureResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSettlementCaptureResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSettlementCaptureResponse$inboundSchema: z.ZodType<
+  ListSettlementCaptureResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: SettlementMode$inboundSchema,
+  description: z.string().optional(),
+  amount: z.nullable(AmountNullable$inboundSchema),
+  settlementAmount: z.nullable(
+    z.lazy(() => ListSettlementCaptureResponseSettlementAmount$inboundSchema),
+  ).optional(),
+  status: SettlementCaptureStatus$inboundSchema,
+  metadata: z.nullable(Metadata$inboundSchema).optional(),
+  paymentId: z.string(),
+  shipmentId: z.nullable(z.string()).optional(),
+  settlementId: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+  _links: z.lazy(() => ListSettlementCaptureResponseLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListSettlementCaptureResponse$Outbound = {
+  resource: string;
+  id: string;
+  mode: string;
+  description?: string | undefined;
+  amount: AmountNullable$Outbound | null;
+  settlementAmount?:
+    | ListSettlementCaptureResponseSettlementAmount$Outbound
+    | null
+    | undefined;
+  status: string;
+  metadata?: Metadata$Outbound | null | undefined;
+  paymentId: string;
+  shipmentId?: string | null | undefined;
+  settlementId?: string | null | undefined;
+  createdAt: string;
+  _links: ListSettlementCaptureResponseLinks$Outbound;
+};
+
+/** @internal */
+export const ListSettlementCaptureResponse$outboundSchema: z.ZodType<
+  ListSettlementCaptureResponse$Outbound,
+  z.ZodTypeDef,
+  ListSettlementCaptureResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: SettlementMode$outboundSchema,
+  description: z.string().optional(),
+  amount: z.nullable(AmountNullable$outboundSchema),
+  settlementAmount: z.nullable(
+    z.lazy(() => ListSettlementCaptureResponseSettlementAmount$outboundSchema),
+  ).optional(),
+  status: SettlementCaptureStatus$outboundSchema,
+  metadata: z.nullable(Metadata$outboundSchema).optional(),
+  paymentId: z.string(),
+  shipmentId: z.nullable(z.string()).optional(),
+  settlementId: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+  links: z.lazy(() => ListSettlementCaptureResponseLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listSettlementCaptureResponseToJSON(
+  listSettlementCaptureResponse: ListSettlementCaptureResponse,
+): string {
+  return JSON.stringify(
+    ListSettlementCaptureResponse$outboundSchema.parse(
+      listSettlementCaptureResponse,
+    ),
+  );
+}
+export function listSettlementCaptureResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSettlementCaptureResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSettlementCaptureResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSettlementCaptureResponse' from JSON`,
+  );
+}