mollie-api-typescript 0.8.3 → 0.8.5

package/src/models/balancefeetype.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+export const BalanceFeeType = {
+  PaymentFee: "payment-fee",
+  DirectDebitFailureFee: "direct-debit-failure-fee",
+  UnauthorizedDirectDebitFee: "unauthorized-direct-debit-fee",
+  BankChargedDirectDebitFailureFee: "bank-charged-direct-debit-failure-fee",
+  PartnerCommission: "partner-commission",
+  ApplicationFee: "application-fee",
+  CaptureFee: "capture-fee",
+  RefundFee: "refund-fee",
+  ChargebackFee: "chargeback-fee",
+  PaymentNotificationFee: "payment-notification-fee",
+  TransferNotificationFee: "transfer-notification-fee",
+  PayoutFee: "payout-fee",
+  FeeDiscount: "fee-discount",
+  FeeReimbursement: "fee-reimbursement",
+  PlatformVolumeFee: "platform-volume-fee",
+  PlatformConnectedOrganizationsFee: "platform-connected-organizations-fee",
+  BalanceChargeFee: "balance-charge-fee",
+  ThreedsAuthenticationAttemptFee: "3ds-authentication-attempt-fee",
+  TerminalMonthlyFee: "terminal-monthly-fee",
+  AcceptanceRiskFee: "acceptance-risk-fee",
+  TopUpFee: "top-up-fee",
+  PaymentGatewayFee: "payment-gateway-fee",
+  MastercardSpecialtyMerchantProgramProcessingFee:
+    "mastercard-specialty-merchant-program-processing-fee",
+  MastercardSpecialtyMerchantProgramRegistrationFee:
+    "mastercard-specialty-merchant-program-registration-fee",
+  VisaIntegrityRiskProgramProcessingFee:
+    "visa-integrity-risk-program-processing-fee",
+  VisaIntegrityRiskProgramRegistrationFee:
+    "visa-integrity-risk-program-registration-fee",
+  MinimumInvoiceAmountFee: "minimum-invoice-amount-fee",
+} as const;
+export type BalanceFeeType = OpenEnum<typeof BalanceFeeType>;
+
+/** @internal */
+export const BalanceFeeType$inboundSchema: z.ZodType<
+  BalanceFeeType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(BalanceFeeType);
+/** @internal */
+export const BalanceFeeType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  BalanceFeeType
+> = openEnums.outboundSchema(BalanceFeeType);

package/src/models/balanceprepaymentparttype.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+export const BalancePrepaymentPartType = {
+  Fee: "fee",
+  FeeReimbursement: "fee-reimbursement",
+  FeeDiscount: "fee-discount",
+  FeeVat: "fee-vat",
+  FeeRoundingCompensation: "fee-rounding-compensation",
+} as const;
+export type BalancePrepaymentPartType = OpenEnum<
+  typeof BalancePrepaymentPartType
+>;
+
+/** @internal */
+export const BalancePrepaymentPartType$inboundSchema: z.ZodType<
+  BalancePrepaymentPartType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(BalancePrepaymentPartType);
+/** @internal */
+export const BalancePrepaymentPartType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  BalancePrepaymentPartType
+> = openEnums.outboundSchema(BalancePrepaymentPartType);

package/src/models/balancetransactiontype.ts

@@ -7,52 +7,45 @@ import * as openEnums from "../types/enums.js";
 import { OpenEnum } from "../types/enums.js";
 
 export const BalanceTransactionType = {
-  ApplicationFee: "application-fee",
-  Capture: "capture",
-  Chargeback: "chargeback",
-  ChargebackReversal: "chargeback-reversal",
-  FailedPaymentFee: "failed-payment-fee",
-  FailedPayment: "failed-payment",
-  InvoiceCompensation: "invoice-compensation",
   Payment: "payment",
-  PaymentFee: "payment-fee",
-  PaymentCommission: "payment-commission",
-  Refund: "refund",
-  ReturnedRefund: "returned-refund",
-  ReturnedTransfer: "returned-transfer",
   SplitPayment: "split-payment",
-  OutgoingTransfer: "outgoing-transfer",
-  CaptureCommission: "capture-commission",
-  CanceledOutgoingTransfer: "canceled-outgoing-transfer",
-  IncomingTransfer: "incoming-transfer",
-  ApiPaymentRollingReserveRelease: "api-payment-rolling-reserve-release",
-  CaptureRollingReserveRelease: "capture-rolling-reserve-release",
-  ReimbursementFee: "reimbursement-fee",
-  BalanceCorrection: "balance-correction",
-  UnauthorizedDirectDebit: "unauthorized-direct-debit",
-  BankChargedFailureFee: "bank-charged-failure-fee",
+  FailedPayment: "failed-payment",
+  FailedPlatformSplitPayment: "failed-platform-split-payment",
+  FailedSplitPaymentCompensation: "failed-split-payment-compensation",
+  Capture: "capture",
+  SplitTransaction: "split-transaction",
+  Refund: "refund",
   PlatformPaymentRefund: "platform-payment-refund",
+  ReturnedPlatformPaymentRefund: "returned-platform-payment-refund",
   RefundCompensation: "refund-compensation",
   ReturnedRefundCompensation: "returned-refund-compensation",
-  ReturnedPlatformPaymentRefund: "returned-platform-payment-refund",
-  PlatformPaymentChargeback: "platform-payment-chargeback",
+  ReturnedRefund: "returned-refund",
+  Chargeback: "chargeback",
+  ChargebackReversal: "chargeback-reversal",
   ChargebackCompensation: "chargeback-compensation",
-  ReversedPlatformPaymentChargeback: "reversed-platform-payment-chargeback",
   ReversedChargebackCompensation: "reversed-chargeback-compensation",
-  FailedSplitPaymentPlatform: "failed-split-payment-platform",
-  FailedSplitPaymentCompensation: "failed-split-payment-compensation",
-  CashAdvanceLoan: "cash-advance-loan",
-  PlatformConnectedOrganizationsFee: "platform-connected-organizations-fee",
-  SplitTransaction: "split-transaction",
-  ManagedFee: "managed-fee",
-  ReturnedManagedFee: "returned-managed-fee",
-  Topup: "topup",
+  PlatformPaymentChargeback: "platform-payment-chargeback",
+  ReversedPlatformPaymentChargeback: "reversed-platform-payment-chargeback",
+  FeePrepayment: "fee-prepayment",
+  OutgoingTransfer: "outgoing-transfer",
+  IncomingTransfer: "incoming-transfer",
+  CanceledTransfer: "canceled-transfer",
+  ReturnedTransfer: "returned-transfer",
   BalanceReserve: "balance-reserve",
   BalanceReserveReturn: "balance-reserve-return",
-  Movement: "movement",
-  PostPaymentSplitPayment: "post-payment-split-payment",
-  CashCollateralIssuance: "cash-collateral-issuance",
+  InvoiceRoundingCompensation: "invoice-rounding-compensation",
+  RollingReserveHold: "rolling-reserve-hold",
+  RollingReserveRelease: "rolling-reserve-release",
+  BalanceCorrection: "balance-correction",
+  Repayment: "repayment",
+  Loan: "loan",
+  BalanceTopup: "balance-topup",
+  CashCollateralIssuance: "cash-collateral-issuance';",
   CashCollateralRelease: "cash-collateral-release",
+  PendingRollingReserve: "pending-rolling-reserve",
+  ToBeReleasedRollingReserve: "to-be-released-rolling-reserve",
+  HeldRollingReserve: "held-rolling-reserve",
+  ReleasedRollingReserve: "released-rolling-reserve",
 } as const;
 export type BalanceTransactionType = OpenEnum<typeof BalanceTransactionType>;
 

package/src/models/captureresponse.ts

@@ -5,6 +5,8 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import {
   AmountNullable,
@@ -12,11 +14,6 @@ import {
   AmountNullable$Outbound,
   AmountNullable$outboundSchema,
 } from "./amountnullable.js";
-import {
-  CaptureStatus,
-  CaptureStatus$inboundSchema,
-  CaptureStatus$outboundSchema,
-} from "./capturestatus.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import {
   Metadata,
@@ -38,6 +35,40 @@ import {
   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 CaptureResponseSettlementAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * The capture's status.
+ */
+export const CaptureResponseStatus = {
+  Pending: "pending",
+  Succeeded: "succeeded",
+  Failed: "failed",
+} as const;
+/**
+ * The capture's status.
+ */
+export type CaptureResponseStatus = OpenEnum<typeof CaptureResponseStatus>;
+
 /**
  * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
  */
@@ -69,6 +100,9 @@ export type CaptureResponse = {
    * 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.
@@ -83,13 +117,17 @@ export type CaptureResponse = {
    */
   amount: AmountNullable | null;
   /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
-   */
-  settlementAmount?: AmountNullable | null | undefined;
-  /**
-   * The capture's status.
+   * 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.
    */
-  status: CaptureStatus;
+  settlementAmount?: CaptureResponseSettlementAmount | null | undefined;
+  status: CaptureResponseStatus;
   /**
    * Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
    *
@@ -97,9 +135,27 @@ export type CaptureResponse = {
    * 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;
-  shipmentId?: string | undefined;
-  settlementId?: string | undefined;
+  /**
+   * 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.
    */
@@ -110,6 +166,63 @@ export type CaptureResponse = {
   links: CaptureResponseLinks;
 };
 
+/** @internal */
+export const CaptureResponseSettlementAmount$inboundSchema: z.ZodType<
+  CaptureResponseSettlementAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type CaptureResponseSettlementAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const CaptureResponseSettlementAmount$outboundSchema: z.ZodType<
+  CaptureResponseSettlementAmount$Outbound,
+  z.ZodTypeDef,
+  CaptureResponseSettlementAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function captureResponseSettlementAmountToJSON(
+  captureResponseSettlementAmount: CaptureResponseSettlementAmount,
+): string {
+  return JSON.stringify(
+    CaptureResponseSettlementAmount$outboundSchema.parse(
+      captureResponseSettlementAmount,
+    ),
+  );
+}
+export function captureResponseSettlementAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<CaptureResponseSettlementAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CaptureResponseSettlementAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CaptureResponseSettlementAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const CaptureResponseStatus$inboundSchema: z.ZodType<
+  CaptureResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(CaptureResponseStatus);
+/** @internal */
+export const CaptureResponseStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  CaptureResponseStatus
+> = openEnums.outboundSchema(CaptureResponseStatus);
+
 /** @internal */
 export const CaptureResponseLinks$inboundSchema: z.ZodType<
   CaptureResponseLinks,
@@ -172,12 +285,14 @@ export const CaptureResponse$inboundSchema: z.ZodType<
   mode: Mode$inboundSchema,
   description: z.string().optional(),
   amount: z.nullable(AmountNullable$inboundSchema),
-  settlementAmount: z.nullable(AmountNullable$inboundSchema).optional(),
-  status: CaptureStatus$inboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() => CaptureResponseSettlementAmount$inboundSchema),
+  ).optional(),
+  status: CaptureResponseStatus$inboundSchema,
   metadata: z.nullable(Metadata$inboundSchema).optional(),
   paymentId: z.string(),
-  shipmentId: z.string().optional(),
-  settlementId: z.string().optional(),
+  shipmentId: z.nullable(z.string()).optional(),
+  settlementId: z.nullable(z.string()).optional(),
   createdAt: z.string(),
   _links: z.lazy(() => CaptureResponseLinks$inboundSchema),
 }).transform((v) => {
@@ -192,12 +307,15 @@ export type CaptureResponse$Outbound = {
   mode: string;
   description?: string | undefined;
   amount: AmountNullable$Outbound | null;
-  settlementAmount?: AmountNullable$Outbound | null | undefined;
+  settlementAmount?:
+    | CaptureResponseSettlementAmount$Outbound
+    | null
+    | undefined;
   status: string;
   metadata?: Metadata$Outbound | null | undefined;
   paymentId: string;
-  shipmentId?: string | undefined;
-  settlementId?: string | undefined;
+  shipmentId?: string | null | undefined;
+  settlementId?: string | null | undefined;
   createdAt: string;
   _links: CaptureResponseLinks$Outbound;
 };
@@ -213,12 +331,14 @@ export const CaptureResponse$outboundSchema: z.ZodType<
   mode: Mode$outboundSchema,
   description: z.string().optional(),
   amount: z.nullable(AmountNullable$outboundSchema),
-  settlementAmount: z.nullable(AmountNullable$outboundSchema).optional(),
-  status: CaptureStatus$outboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() => CaptureResponseSettlementAmount$outboundSchema),
+  ).optional(),
+  status: CaptureResponseStatus$outboundSchema,
   metadata: z.nullable(Metadata$outboundSchema).optional(),
   paymentId: z.string(),
-  shipmentId: z.string().optional(),
-  settlementId: z.string().optional(),
+  shipmentId: z.nullable(z.string()).optional(),
+  settlementId: z.nullable(z.string()).optional(),
   createdAt: z.string(),
   links: z.lazy(() => CaptureResponseLinks$outboundSchema),
 }).transform((v) => {