mollie-api-typescript 1.6.10 → 1.7.1

package/src/funcs/payoutsGet.ts

@@ -0,0 +1,201 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: dc969f7d14e9
+ */
+
+import { ClientCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 payout
+ *
+ * @remarks
+ * Retrieve a single payout by its ID.
+ */
+export function payoutsGet(
+  client: ClientCore,
+  request: operations.GetPayoutRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.EntityPayoutResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ClientCore,
+  request: operations.GetPayoutRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.EntityPayoutResponse,
+      | errors.ErrorResponse
+      | ClientError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetPayoutRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    payoutId: encodeSimple("payoutId", payload.payoutId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v2/payouts/{payoutId}")(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);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "get-payout",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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.EntityPayoutResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.EntityPayoutResponse$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/payoutsList.ts

@@ -0,0 +1,278 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9b9d3a48147e
+ */
+
+import { ClientCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+  URL_OVERRIDE,
+} from "../types/operations.js";
+
+/**
+ * List payouts
+ *
+ * @remarks
+ * Retrieve a list of all payouts for your organization, including payouts initiated automatically by the
+ * balance's payout schedule and payouts requested via the API or dashboard.
+ *
+ * Only payouts created on or after April 1st, 2026 are returned.
+ *
+ * The results are paginated. Use the `from` query parameter together with `_links.next` to iterate through
+ * the full result set.
+ */
+export function payoutsList(
+  client: ClientCore,
+  request?: operations.ListPayoutsRequest | undefined,
+  options?: RequestOptions & { [URL_OVERRIDE]?: URL },
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListPayoutsResponse,
+      | errors.ErrorResponse
+      | ClientError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { url: string }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ClientCore,
+  request?: operations.ListPayoutsRequest | undefined,
+  options?: RequestOptions & { [URL_OVERRIDE]?: URL },
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListPayoutsResponse,
+        | errors.ErrorResponse
+        | ClientError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { url: string }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListPayoutsRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = options?.[URL_OVERRIDE]
+    ? ""
+    : pathToFunc("/v2/payouts")();
+
+  const query = options?.[URL_OVERRIDE]
+    ? options[URL_OVERRIDE].search.substring(1)
+    : encodeFormQuery({
+      "balanceId": payload?.balanceId,
+      "from": payload?.from,
+      "limit": payload?.limit,
+      "sort": payload?.sort,
+      "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);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "list-payouts",
+    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?.[URL_OVERRIDE]?.href || 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 [haltIterator(requestRes), { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.ListPayoutsResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListPayoutsResponse$inboundSchema, {
+      ctype: "application/hal+json",
+      key: "Result",
+    }),
+    M.jsonErr(400, errors.ErrorResponse$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.ListPayoutsResponse,
+        | errors.ErrorResponse
+        | ClientError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { url: string };
+  } => {
+    let nextURL = dlv(responseData, "_links.next.href");
+    if (typeof nextURL !== "string") {
+      return { next: () => null };
+    }
+
+    try {
+      if (nextURL.startsWith("/")) {
+        nextURL = new URL(nextURL, client._baseURL ?? "").href;
+      }
+      new URL(nextURL);
+    } catch (_error) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      payoutsList(
+        client,
+        {
+          ...request!,
+        },
+        { ...options, [URL_OVERRIDE]: new URL(nextURL) },
+      );
+
+    return { next: nextVal, "~next": { url: nextURL } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}

package/src/hooks/mollie-auth-utils.ts

@@ -7,9 +7,9 @@ export function clientCanHaveGlobalFields(options: SDKOptions): boolean {
     const securityObj = typeof security === "function" ? security() : security;
     if (securityObj instanceof Promise) return false;
 
-    const token = (securityObj as { apiKey?: string; organizationAccessToken?: string; oAuth?: string }).apiKey
-        || (securityObj as { apiKey?: string; organizationAccessToken?: string; oAuth?: string }).organizationAccessToken
-        || (securityObj as { apiKey?: string; organizationAccessToken?: string; oAuth?: string }).oAuth;
+    const token = (securityObj as { apiKey?: string; advancedAccessToken?: string; oAuth?: string }).apiKey
+        || (securityObj as { apiKey?: string; advancedAccessToken?: string; oAuth?: string }).advancedAccessToken
+        || (securityObj as { apiKey?: string; advancedAccessToken?: string; oAuth?: string }).oAuth;
     return !!token && token.startsWith("access_");
 }
 

package/src/lib/config.ts

@@ -78,8 +78,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "1.6.10",
+  sdkVersion: "1.7.1",
   genVersion: "2.882.0",
   userAgent:
-    "speakeasy-sdk/typescript 1.6.10 2.882.0 1.0.0 mollie-api-typescript",
+    "speakeasy-sdk/typescript 1.7.1 2.882.0 1.0.0 mollie-api-typescript",
 } as const;

package/src/models/entitypayoutresponse.ts

@@ -0,0 +1,165 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 43f55d244bf6
+ */
+
+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,
+} from "./amountnullable.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { Mode, Mode$inboundSchema } from "./mode.js";
+import { PayoutStatus, PayoutStatus$inboundSchema } from "./payoutstatus.js";
+import {
+  PayoutStatusReason,
+  PayoutStatusReason$inboundSchema,
+} from "./payoutstatusreason.js";
+import { Url, Url$inboundSchema } from "./url.js";
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type EntityPayoutResponseLinks = {
+  /**
+   * 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.
+   */
+  documentation: Url;
+};
+
+export type EntityPayoutResponse = {
+  /**
+   * Indicates the response contains a payout object. Will always contain the string `payout` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this payout. Mollie assigns this identifier at payout creation time.
+   *
+   * @remarks
+   * Mollie will always refer to the payout by this ID. Example: `payout_j8NvRAM2WNZtsykpLEX8J`.
+   */
+  id: string;
+  /**
+   * The identifier of the balance that will be paid out. Example: `bal_gVMhHKqSSRYJyPsuoPNFH`.
+   */
+  balanceId: string;
+  /**
+   * The amount to pay out. When omitted from the request, the full available balance minus any configured
+   *
+   * @remarks
+   * balance reserve is paid out.
+   *
+   * Merchants registered in the United Kingdom cannot specify a custom amount — omit this field to pay out
+   * the full available balance.
+   *
+   * The value in the response reflects the amount paid out, excluding any applicable fees.
+   */
+  amount?: AmountNullable | null | undefined;
+  /**
+   * The description that will appear on the bank statement for this payout.
+   */
+  description?: string | undefined;
+  /**
+   * The status of the payout.
+   */
+  status: PayoutStatus;
+  /**
+   * The reason for the payout's current status.
+   */
+  statusReason: PayoutStatusReason;
+  /**
+   * 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 the payout was initiated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   *
+   * @remarks
+   * This is the moment Mollie attempted to reserve the funds on the balance.
+   */
+  initiatedAt?: string | null | undefined;
+  /**
+   * The date and time the payout was sent to the destination bank account, in
+   *
+   * @remarks
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. `null` if the payout has not completed yet.
+   */
+  completedAt?: string | null | undefined;
+  /**
+   * The date and time the payout was canceled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   *
+   * @remarks
+   * `null` if the payout was not canceled.
+   */
+  canceledAt?: string | null | undefined;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links?: EntityPayoutResponseLinks | undefined;
+};
+
+/** @internal */
+export const EntityPayoutResponseLinks$inboundSchema: z.ZodType<
+  EntityPayoutResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  documentation: Url$inboundSchema,
+});
+
+export function entityPayoutResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityPayoutResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityPayoutResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityPayoutResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityPayoutResponse$inboundSchema: z.ZodType<
+  EntityPayoutResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  balanceId: z.string(),
+  amount: z.nullable(AmountNullable$inboundSchema).optional(),
+  description: z.string().optional(),
+  status: PayoutStatus$inboundSchema,
+  statusReason: PayoutStatusReason$inboundSchema,
+  createdAt: z.string(),
+  initiatedAt: z.nullable(z.string()).optional(),
+  completedAt: z.nullable(z.string()).optional(),
+  canceledAt: z.nullable(z.string()).optional(),
+  mode: Mode$inboundSchema,
+  _links: z.lazy(() => EntityPayoutResponseLinks$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+
+export function entityPayoutResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityPayoutResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityPayoutResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityPayoutResponse' from JSON`,
+  );
+}