mollie-api-typescript 1.12.12 → 1.12.14

package/src/models/transferresponse.ts

@@ -42,7 +42,7 @@ export type TransferResponseAccount = {
 /**
  * The debtor (sender) of the transfer, including their name and account details.
  */
-export type Debtor = {
+export type TransferResponseDebtor = {
   /**
    * The full name of the account holder.
    */
@@ -72,7 +72,7 @@ export type TransferResponse = {
   /**
    * The debtor (sender) of the transfer, including their name and account details.
    */
-  debtor: Debtor;
+  debtor: TransferResponseDebtor;
   /**
    * A party involved in the transfer, representing either the debtor (sender) or creditor (recipient).
    *
@@ -159,19 +159,22 @@ export function transferResponseAccountFromJSON(
 }
 
 /** @internal */
-export const Debtor$inboundSchema: z.ZodType<Debtor, z.ZodTypeDef, unknown> = z
-  .object({
-    fullName: z.string(),
-    account: z.lazy(() => TransferResponseAccount$inboundSchema),
-  });
+export const TransferResponseDebtor$inboundSchema: z.ZodType<
+  TransferResponseDebtor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fullName: z.string(),
+  account: z.lazy(() => TransferResponseAccount$inboundSchema),
+});
 
-export function debtorFromJSON(
+export function transferResponseDebtorFromJSON(
   jsonString: string,
-): SafeParseResult<Debtor, SDKValidationError> {
+): SafeParseResult<TransferResponseDebtor, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Debtor$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Debtor' from JSON`,
+    (x) => TransferResponseDebtor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferResponseDebtor' from JSON`,
   );
 }
 
@@ -184,7 +187,7 @@ export const TransferResponse$inboundSchema: z.ZodType<
   resource: z.string(),
   id: z.string(),
   mode: Mode$inboundSchema,
-  debtor: z.lazy(() => Debtor$inboundSchema),
+  debtor: z.lazy(() => TransferResponseDebtor$inboundSchema),
   creditor: TransferParty$inboundSchema,
   amount: Amount$inboundSchema,
   description: z.nullable(z.string()).optional(),

package/src/sdk/drafttransfers.ts

@@ -0,0 +1,134 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c11a92be104d
+ */
+
+import { draftTransfersCancel } from "../funcs/draftTransfersCancel.js";
+import { draftTransfersCreate } from "../funcs/draftTransfersCreate.js";
+import { draftTransfersGet } from "../funcs/draftTransfersGet.js";
+import { draftTransfersList } from "../funcs/draftTransfersList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class DraftTransfers extends ClientSDK {
+  /**
+   * Create draft transfer
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in beta testing, and the final specification may still change.
+   *
+   * Creates a draft transfer. The draft transfer immediately enters `awaiting-initiation` and appears in the
+   * initiator's queue in Mollie Apps. It carries no legal weight and moves no funds until a human initiator
+   * approves it there.
+   *
+   * ### Test mode
+   *
+   * | Action | Test-mode behavior |
+   * |---|---|
+   * | Create | Always returns a synthetic draft in `awaiting-initiation`, regardless of most input values |
+   * | Get / List | Always returns synthetic `awaiting-initiation` draft(s), not your real data |
+   * | Cancel | Always returns a synthetic `declined` draft |
+   *
+   * There is currently no way to synthesize an `initiated` draft via test mode alone. Initiation only happens when
+   * a real initiator approves in Mollie Apps, which test mode doesn't touch.
+   */
+  async create(
+    request?: operations.CreateDraftTransferRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.DraftTransferResponse> {
+    return unwrapAsync(draftTransfersCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List draft transfers
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in beta testing, and the final specification may still change.
+   *
+   * Retrieves a list of draft transfers for the organization including ones created in Mollie Apps, not just
+   * ones created via this API.
+   *
+   * The results are paginated.
+   *
+   * In test mode, this always returns a synthetic `awaiting-initiation` list. See [Create draft
+   * transfer](create-draft-transfer) for full test-mode behavior.
+   */
+  async list(
+    request?: operations.ListDraftTransfersRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListDraftTransfersResponse, { url: string }>
+  > {
+    return unwrapResultIterator(draftTransfersList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get draft transfer
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in beta testing, and the final specification may still change.
+   *
+   * Retrieves a single draft transfer by its identifier.
+   *
+   * Only draft transfers created via this API are visible via this endpoint. Draft transfers created in Mollie
+   * Apps return a `404`, even though they appear in the [list endpoint](list-draft-transfers).
+   *
+   * In test mode, this always returns a synthetic `awaiting-initiation` draft. See [Create draft
+   * transfer](create-draft-transfer) for full test-mode behavior.
+   */
+  async get(
+    request: operations.GetDraftTransferRequest,
+    options?: RequestOptions,
+  ): Promise<models.DraftTransferResponse> {
+    return unwrapAsync(draftTransfersGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Cancel draft transfer
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in beta testing, and the final specification may still change.
+   *
+   * Cancels a draft transfer created via this API. Transitions the draft transfer to `declined` with
+   * `statusReason` set to `"Declined by creator"`.
+   *
+   * Only draft transfers created via this API, and still in `awaiting-initiation`, can be cancelled this way. A
+   * `422` is returned if the initiator has already started approving it.
+   *
+   * In test mode, this always returns a synthetic `declined` draft. See [Create draft
+   * transfer](create-draft-transfer) for full test-mode behavior.
+   */
+  async cancel(
+    request: operations.CancelDraftTransferRequest,
+    options?: RequestOptions,
+  ): Promise<models.DraftTransferResponse> {
+    return unwrapAsync(draftTransfersCancel(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/salesinvoices.ts

@@ -19,10 +19,6 @@ export class SalesInvoices extends ClientSDK {
    * Create sales invoice
    *
    * @remarks
-   * > 🚧 Beta feature
-   * >
-   * > This feature is currently in beta testing, and the final specification may still change.
-   *
    * With the Sales Invoice API you can generate sales invoices to send to your customers.
    */
   async create(
@@ -40,10 +36,6 @@ export class SalesInvoices extends ClientSDK {
    * List sales invoices
    *
    * @remarks
-   * > 🚧 Beta feature
-   * >
-   * > This feature is currently in beta testing, and the final specification may still change.
-   *
    * Retrieve a list of all sales invoices created through the API.
    *
    * The results are paginated.
@@ -65,10 +57,6 @@ export class SalesInvoices extends ClientSDK {
    * Get sales invoice
    *
    * @remarks
-   * > 🚧 Beta feature
-   * >
-   * > This feature is currently in beta testing, and the final specification may still change.
-   *
    * Retrieve a single sales invoice by its ID.
    */
   async get(
@@ -86,10 +74,6 @@ export class SalesInvoices extends ClientSDK {
    * Update sales invoice
    *
    * @remarks
-   * > 🚧 Beta feature
-   * >
-   * > This feature is currently in beta testing, and the final specification may still change.
-   *
    * Certain details of an existing sales invoice can be updated. For `draft` it is all values listed below, but for
    * statuses `paid` and `issued` there are certain additional requirements (`paymentDetails` and `emailDetails`,
    * respectively).
@@ -109,10 +93,6 @@ export class SalesInvoices extends ClientSDK {
    * Delete sales invoice
    *
    * @remarks
-   * > 🚧 Beta feature
-   * >
-   * > This feature is currently in beta testing, and the final specification may still change.
-   *
    * Sales invoices which are in status `draft` can be deleted. For all other statuses, please use the
    * [Update sales invoice](update-sales-invoice) endpoint instead.
    */

package/src/sdk/sdk.ts

@@ -14,6 +14,7 @@ import { ClientLinks } from "./clientlinks.js";
 import { Clients } from "./clients.js";
 import { Customers } from "./customers.js";
 import { DelayedRouting } from "./delayedrouting.js";
+import { DraftTransfers } from "./drafttransfers.js";
 import { Invoices } from "./invoices.js";
 import { Mandates } from "./mandates.js";
 import { Methods } from "./methods.js";
@@ -196,6 +197,11 @@ export class Client extends ClientSDK {
     return (this._transfers ??= new Transfers(this._options));
   }
 
+  private _draftTransfers?: DraftTransfers;
+  get draftTransfers(): DraftTransfers {
+    return (this._draftTransfers ??= new DraftTransfers(this._options));
+  }
+
   private _verifyPayee?: VerifyPayee;
   get verifyPayee(): VerifyPayee {
     return (this._verifyPayee ??= new VerifyPayee(this._options));