mollie-api-typescript 1.12.12 → 1.12.14

package/src/funcs/draftTransfersGet.ts

@@ -0,0 +1,210 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4e0bae8e6811
+ */
+
+import { ClientCore } from "../core.js";
+import { 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 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.
+ *
+ * If set, this operation will use either {@link Security.advancedAccessToken} or {@link Security.oAuth} from the global security.
+ */
+export function draftTransfersGet(
+  client: ClientCore,
+  request: operations.GetDraftTransferRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.DraftTransferResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ClientCore,
+  request: operations.GetDraftTransferRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.DraftTransferResponse,
+      | errors.ErrorResponse
+      | ClientError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetDraftTransferRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    draftTransferId: encodeSimple("draftTransferId", payload.draftTransferId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/v2/business-accounts/draft-transfers/{draftTransferId}",
+  )(pathParams);
+
+  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, 2]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "get-draft-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 || ["429", "5xx"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    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,
+    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.DraftTransferResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.DraftTransferResponse$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.jsonErr([404, 429], 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/draftTransfersList.ts

@@ -0,0 +1,287 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5d5f58e8eddd
+ */
+
+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 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 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.
+ *
+ * If set, this operation will use either {@link Security.advancedAccessToken} or {@link Security.oAuth} from the global security.
+ */
+export function draftTransfersList(
+  client: ClientCore,
+  request?: operations.ListDraftTransfersRequest | undefined,
+  options?: RequestOptions & { [URL_OVERRIDE]?: URL },
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListDraftTransfersResponse,
+      | 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.ListDraftTransfersRequest | undefined,
+  options?: RequestOptions & { [URL_OVERRIDE]?: URL },
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListDraftTransfersResponse,
+        | errors.ErrorResponse
+        | ClientError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { url: string }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListDraftTransfersRequest$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/business-accounts/draft-transfers")();
+
+  const query = options?.[URL_OVERRIDE]
+    ? options[URL_OVERRIDE].search.substring(1)
+    : encodeFormQuery({
+      "from": payload?.from,
+      "limit": payload?.limit,
+      "source": payload?.source,
+      "status": payload?.status,
+    });
+
+  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, 2]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "list-draft-transfers",
+    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 || ["429", "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.ListDraftTransfersResponse,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListDraftTransfersResponse$inboundSchema, {
+      ctype: "application/hal+json",
+      key: "Result",
+    }),
+    M.jsonErr([400, 429], 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.ListDraftTransfersResponse,
+        | errors.ErrorResponse
+        | ClientError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { url: string };
+  } => {
+    const nextURLValue =
+      (responseData as { _links: { next: { href?: unknown } | null } })._links
+        .next?.href;
+    if (typeof nextURLValue !== "string") {
+      return { next: () => null };
+    }
+    let nextURL = nextURLValue;
+
+    try {
+      if (nextURL.startsWith("/")) {
+        nextURL = new URL(nextURL, client._baseURL ?? "").href;
+      }
+      new URL(nextURL);
+    } catch (_error) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      draftTransfersList(
+        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/funcs/salesInvoicesCreate.ts

@@ -32,10 +32,6 @@ import { Result } from "../types/fp.js";
  * 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.
  *
  * If set, this operation will use one of {@link Security.apiKey}, {@link Security.advancedAccessToken}, or {@link Security.oAuth} from the global security.

package/src/funcs/salesInvoicesDelete.ts

@@ -32,10 +32,6 @@ import { Result } from "../types/fp.js";
  * 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/funcs/salesInvoicesGet.ts

@@ -32,10 +32,6 @@ import { Result } from "../types/fp.js";
  * 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.
  *
  * If set, this operation will use one of {@link Security.apiKey}, {@link Security.advancedAccessToken}, or {@link Security.oAuth} from the global security.

package/src/funcs/salesInvoicesList.ts

@@ -38,10 +38,6 @@ import {
  * 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.

package/src/funcs/salesInvoicesUpdate.ts

@@ -32,10 +32,6 @@ import { Result } from "../types/fp.js";
  * 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).

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.12.12",
-  genVersion: "2.916.2",
+  sdkVersion: "1.12.14",
+  genVersion: "2.918.3",
   userAgent:
-    "speakeasy-sdk/typescript 1.12.12 2.916.2 1.0.0 mollie-api-typescript",
+    "speakeasy-sdk/typescript 1.12.14 2.918.3 1.0.0 mollie-api-typescript",
 } as const;

package/src/lib/http.ts

@@ -46,8 +46,10 @@ export class HTTPClient {
   private requestHooks: BeforeRequestHook[] = [];
   private requestErrorHooks: RequestErrorHook[] = [];
   private responseHooks: ResponseHook[] = [];
+  private options: HTTPClientOptions;
 
-  constructor(private options: HTTPClientOptions = {}) {
+  constructor(options: HTTPClientOptions = {}) {
+    this.options = options;
     this.fetcher = options.fetcher || DEFAULT_FETCHER;
   }
 

package/src/lib/security.ts

@@ -14,17 +14,22 @@ type OAuth2PasswordFlow = {
   tokenURL: string;
 };
 
-export enum SecurityErrorCode {
-  Incomplete = "incomplete",
-  UnrecognisedSecurityType = "unrecognized_security_type",
-}
+export const SecurityErrorCode = {
+  Incomplete: "incomplete",
+  UnrecognisedSecurityType: "unrecognized_security_type",
+} as const;
+export type SecurityErrorCode =
+  (typeof SecurityErrorCode)[keyof typeof SecurityErrorCode];
 
 export class SecurityError extends Error {
+  public code: SecurityErrorCode;
+
   constructor(
-    public code: SecurityErrorCode,
+    code: SecurityErrorCode,
     message: string,
   ) {
     super(message);
+    this.code = code;
     this.name = "SecurityError";
   }
 

package/src/models/createdrafttransferrequest.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 816bdee77acb
+ */
+
+import * as z from "zod/v3";
+import { RFCDate } from "../types/rfcdate.js";
+import { Amount, Amount$Outbound, Amount$outboundSchema } from "./amount.js";
+import {
+  DraftTransferParty,
+  DraftTransferParty$Outbound,
+  DraftTransferParty$outboundSchema,
+} from "./drafttransferparty.js";
+
+export type CreateDraftTransferRequest = {
+  /**
+   * The IBAN of the debtor's (sender) Mollie Business Account. Defaults to your organization's primary account
+   *
+   * @remarks
+   * if omitted.
+   */
+  debtorIban?: string | undefined;
+  /**
+   * A party involved in the draft transfer, representing either the debtor (sender) or creditor
+   *
+   * @remarks
+   * (recipient). Contains the party's name and account details.
+   */
+  creditor: DraftTransferParty;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * A short description of the draft transfer. Once approved, this will appear on the bank statement of both
+   *
+   * @remarks
+   * the debtor and creditor.
+   */
+  description: string | null;
+  /**
+   * The date on which the resulting transfer will be executed, once approved. Defaults to same-day if omitted,
+   *
+   * @remarks
+   * in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date format.
+   */
+  scheduledFor?: RFCDate | null | undefined;
+};
+
+/** @internal */
+export type CreateDraftTransferRequest$Outbound = {
+  debtorIban?: string | undefined;
+  creditor: DraftTransferParty$Outbound;
+  amount: Amount$Outbound;
+  description: string | null;
+  scheduledFor?: string | null | undefined;
+};
+
+/** @internal */
+export const CreateDraftTransferRequest$outboundSchema: z.ZodType<
+  CreateDraftTransferRequest$Outbound,
+  z.ZodTypeDef,
+  CreateDraftTransferRequest
+> = z.object({
+  debtorIban: z.string().optional(),
+  creditor: DraftTransferParty$outboundSchema,
+  amount: Amount$outboundSchema,
+  description: z.nullable(z.string()),
+  scheduledFor: z.nullable(z.instanceof(RFCDate).transform(v => v.toString()))
+    .optional(),
+});
+
+export function createDraftTransferRequestToJSON(
+  createDraftTransferRequest: CreateDraftTransferRequest,
+): string {
+  return JSON.stringify(
+    CreateDraftTransferRequest$outboundSchema.parse(createDraftTransferRequest),
+  );
+}