mollie-api-typescript 1.3.3 → 1.3.5

package/src/funcs/settlementsListRefunds.ts

@@ -41,6 +41,8 @@ import {
  * Retrieve all refunds 'deducted' from the given settlement.
  *
  * The response is in the same format as the response of the [List refunds endpoint](list-refunds).
+ *
+ * If set, this operation will use either {@link Security.organizationAccessToken} or {@link Security.oAuth} from the global security.
  */
 export function settlementsListRefunds(
   client: ClientCore,
@@ -122,7 +124,6 @@ async function $do(
       "embed": payload.embed,
       "from": payload.from,
       "limit": payload.limit,
-      "testmode": payload.testmode ?? client._options.testmode,
     });
 
   const headers = new Headers(compactMap({
@@ -135,7 +136,7 @@ async function $do(
   }));
 
   const securityInput = await extractSecurity(client._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1, 2]);
 
   const context = {
     options: client._options,

package/src/funcs/transfersCreate.ts

@@ -0,0 +1,234 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0bfa8fcb1442
+ */
+
+import { ClientCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { ClientError } from "../models/errors/clienterror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Create transfer
+ *
+ * @remarks
+ * > 🚧 Beta feature
+ * >
+ * > This feature is currently in beta testing, and the final specification may still change.
+ *
+ * Create a SEPA Credit Transfer from your Mollie Business Account.
+ *
+ * To initiate a transfer, you must provide the transfer scheme, the amount, the debtor IBAN (your Mollie Business
+ * Account IBAN), and the creditor (recipient) details.
+ *
+ * Each request must include an `Idempotency-Key` header to prevent duplicate transfers, and must be signed using the
+ * `X-Client-Signature` and `X-Client-Signed-At` headers.
+ *
+ * ### Simulating transfer scenarios in test mode
+ *
+ * In test mode, you can simulate various transfer scenarios by adjusting the transfer amount. This allows you to
+ * mimic the typical status progression of a real-world transfer. Note that a transfer's progression will stop once
+ * it reaches a final status: `blocked`, `failed`, or `processed`.
+ *
+ * | Amount  | Scenario                                           | Webhook sequence                                                                                                                                                   |
+ * |---------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+ * | `11.00` | Transfer initiated, pending review by Mollie       | `business-account-transfer.requested` → `business-account-transfer.initiated` → `business-account-transfer.pending-review`                                         |
+ * | `12.00` | Transfer initiated, blocked by Mollie              | `business-account-transfer.requested` → `business-account-transfer.initiated` → `business-account-transfer.pending-review` → `business-account-transfer.blocked`   |
+ * | `13.00` | Transfer initiated, failed on scheme submission    | `business-account-transfer.requested` → `business-account-transfer.initiated` → `business-account-transfer.failed`                                                 |
+ * | Other   | Default: transfer is processed                     | `business-account-transfer.requested` → `business-account-transfer.initiated` → `business-account-transfer.processed`                                              |
+ *
+ * If set, this operation will use {@link Security.organizationAccessToken} from the global security.
+ */
+export function transfersCreate(
+  client: ClientCore,
+  request: operations.CreateTransferRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.TransferResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ClientCore,
+  request: operations.CreateTransferRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.TransferResponse,
+      | errors.ErrorResponse
+      | ClientError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.CreateTransferRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload["transfer-request"], {
+    explode: true,
+  });
+
+  const path = pathToFunc("/business-accounts/transfers")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/hal+json",
+    "Idempotency-Key": encodeSimple(
+      "Idempotency-Key",
+      payload["Idempotency-Key"],
+      { explode: false, charEncoding: "none" },
+    ),
+    "X-Client-Signature": encodeSimple(
+      "X-Client-Signature",
+      payload["X-Client-Signature"],
+      { explode: false, charEncoding: "none" },
+    ),
+    "X-Client-Signed-At": encodeSimple(
+      "X-Client-Signed-At",
+      payload["X-Client-Signed-At"],
+      { explode: false, charEncoding: "none" },
+    ),
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key1"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "create-transfer",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 5000,
+          exponent: 2,
+          maxElapsedTime: 7500,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["5xx"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "4XX", "503", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.TransferResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(201, models.TransferResponse$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.jsonErr(422, errors.ErrorResponse$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.jsonErr(503, errors.ErrorResponse$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/transfersGet.ts

@@ -0,0 +1,209 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0080852ac3c7
+ */
+
+import { ClientCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { ClientError } from "../models/errors/clienterror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get transfer
+ *
+ * @remarks
+ * > 🚧 Beta feature
+ * >
+ * > This feature is currently in beta testing, and the final specification may still change.
+ *
+ * Retrieve a single transfer object by its transfer ID. This allows you to check the current status
+ * and details of a previously created transfer.
+ *
+ * If set, this operation will use {@link Security.organizationAccessToken} from the global security.
+ */
+export function transfersGet(
+  client: ClientCore,
+  request: operations.GetTransferRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.TransferResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ClientCore,
+  request: operations.GetTransferRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.TransferResponse,
+      | errors.ErrorResponse
+      | ClientError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetTransferRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    businessAccountsTransferId: encodeSimple(
+      "businessAccountsTransferId",
+      payload.businessAccountsTransferId,
+      { explode: false, charEncoding: "percent" },
+    ),
+  };
+  const path = pathToFunc(
+    "/business-accounts/transfers/{businessAccountsTransferId}",
+  )(pathParams);
+
+  const query = encodeFormQuery({
+    "testmode": payload.testmode ?? client._options.testmode,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/hal+json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "get-transfer",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 5000,
+          exponent: 2,
+          maxElapsedTime: 7500,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["5xx"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["404", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.TransferResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.TransferResponse$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.jsonErr(404, errors.ErrorResponse$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/verifyPayeesCreate.ts

@@ -0,0 +1,218 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 10f27368a6f1
+ */
+
+import { ClientCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { ClientError } from "../models/errors/clienterror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Verify Payee
+ *
+ * @remarks
+ * > 🚧 Beta feature
+ * >
+ * > This feature is currently in beta testing, and the final specification may still change.
+ *
+ * Perform a Verification of Payee (VoP) check. This allows you to verify the account holder name against the
+ * records held by the receiving bank before initiating a transfer.
+ *
+ * The verification result indicates whether the provided name matches, closely matches, or does not match the
+ * name on file at the receiving bank. This helps prevent misdirected payments.
+ *
+ * ### Simulating verification scenarios in test mode
+ *
+ * In test mode, you can simulate various verification outcomes by adjusting the creditor name in the
+ * `creditorBankAccount.accountHolderName` property. This allows you to test all possible Verification of Payee
+ * results without needing special properties. The names are case insensitive.
+ *
+ * | Account holder name                    | Scenario                                      | Verification result | Suggested name |
+ * |----------------------------------------|-----------------------------------------------|---------------------|----------------|
+ * | `John Close Match`                     | Name closely matches the bank records          | `close-match`       | `John Match`   |
+ * | `John No Match`                        | Name does not match the bank records           | `no-match`          | —              |
+ * | `John Unavailable`                     | Verification is not available                  | `not-available`     | —              |
+ * | Any other name                         | Default: name matches the bank records         | `match`             | —              |
+ *
+ * If set, this operation will use {@link Security.organizationAccessToken} from the global security.
+ */
+export function verifyPayeesCreate(
+  client: ClientCore,
+  request?: operations.VerifyPayeeRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.VerificationOfPayeeResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ClientCore,
+  request?: operations.VerifyPayeeRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.VerificationOfPayeeResponse,
+      | errors.ErrorResponse
+      | ClientError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.VerifyPayeeRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload?.["verification-of-payee-request"], {
+    explode: true,
+  });
+
+  const path = pathToFunc("/business-accounts/payee-verifications")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/hal+json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload?.["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "verify-payee",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 5000,
+          exponent: 2,
+          maxElapsedTime: 7500,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["5xx"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["422", "429", "4XX", "503", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.VerificationOfPayeeResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.VerificationOfPayeeResponse$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.jsonErr([422, 429], errors.ErrorResponse$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.jsonErr(503, errors.ErrorResponse$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/webhookEventsGet.ts

@@ -32,6 +32,8 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Retrieve a single webhook event object by its event ID.
+ *
+ * If set, this operation will use either {@link Security.organizationAccessToken} or {@link Security.oAuth} from the global security.
  */
 export function webhookEventsGet(
   client: ClientCore,
@@ -112,7 +114,7 @@ async function $do(
   }));
 
   const securityInput = await extractSecurity(client._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1, 2]);
 
   const context = {
     options: client._options,