mollie-api-typescript 1.8.1 → 1.8.2

package/src/funcs/terminalsTerminalsRequestPairingCode.ts

@@ -0,0 +1,209 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 351a2c36e865
+ */
+
+import { ClientCore } from "../core.js";
+import { encodeFormQuery, encodeJSON, 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";
+
+/**
+ * Request terminal pairing code
+ *
+ * @remarks
+ * > ℹ️ **Test mode**
+ * >
+ * > This endpoint currently does not support test mode yet.
+ *
+ * Request a pairing code to onboard a point-of-sale terminal.
+ *
+ * The response includes a human-readable `code` for manual entry on the terminal, and a QR Code as a
+ * base64 encoded SVG data URI for scanning if you specify the query parameter `include` with value `details.qrCode`.
+ *
+ * Pairing codes expire after 90 days (see `expiresAt`) and can be used multiple times.
+ *
+ * If set, this operation will use either {@link Security.apiKey} or {@link Security.oAuth} from the global security.
+ */
+export function terminalsTerminalsRequestPairingCode(
+  client: ClientCore,
+  request?: operations.TerminalsRequestPairingCodeRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.EntityPairingCode,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ClientCore,
+  request?: operations.TerminalsRequestPairingCodeRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.EntityPairingCode,
+      | errors.ErrorResponse
+      | ClientError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.TerminalsRequestPairingCodeRequest$outboundSchema.optional()
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload?.RequestBody, { explode: true });
+
+  const path = pathToFunc("/v2/terminals/pairing-codes")();
+
+  const query = encodeFormQuery({
+    "include": payload?.include,
+  });
+
+  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, [0, 2]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "terminals-request-pairing-code",
+    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: "POST",
+    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.EntityPairingCode,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(201, models.EntityPairingCode$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.jsonErr([422, 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/terminalsTerminalsRevokePairingCode.ts

@@ -0,0 +1,207 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 142d0a0681b4
+ */
+
+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";
+
+/**
+ * Revoke terminal pairing code
+ *
+ * @remarks
+ * > ℹ️ **Test mode**
+ * >
+ * > This endpoint currently does not support test mode yet.
+ *
+ * Revoke a pairing code, preventing the onboarding of new point-of-sale terminals.
+ *
+ * Terminals that have already paired with this code are not affected.
+ *
+ * If set, this operation will use either {@link Security.apiKey} or {@link Security.oAuth} from the global security.
+ */
+export function terminalsTerminalsRevokePairingCode(
+  client: ClientCore,
+  request: operations.TerminalsRevokePairingCodeRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.EntityPairingCode,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: ClientCore,
+  request: operations.TerminalsRevokePairingCodeRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.EntityPairingCode,
+      | errors.ErrorResponse
+      | ClientError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.TerminalsRevokePairingCodeRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    pairingCodeId: encodeSimple("pairingCodeId", payload.pairingCodeId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v2/terminals/pairing-codes/{pairingCodeId}")(
+    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, [0, 2]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "terminals-revoke-pairing-code",
+    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: "DELETE",
+    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.EntityPairingCode,
+    | errors.ErrorResponse
+    | ClientError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.EntityPairingCode$inboundSchema, {
+      ctype: "application/hal+json",
+    }),
+    M.jsonErr([404, 422, 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/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.8.1",
-  genVersion: "2.884.7",
+  sdkVersion: "1.8.2",
+  genVersion: "2.884.11",
   userAgent:
-    "speakeasy-sdk/typescript 1.8.1 2.884.7 1.0.0 mollie-api-typescript",
+    "speakeasy-sdk/typescript 1.8.2 2.884.11 1.0.0 mollie-api-typescript",
 } as const;

package/src/models/entitypairingcode.ts

@@ -0,0 +1,223 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 01b26dbb30ac
+ */
+
+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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { Mode, Mode$inboundSchema } from "./mode.js";
+import { Url, Url$inboundSchema } from "./url.js";
+
+/**
+ * The status of the pairing code.
+ */
+export const EntityPairingCodeStatus = {
+  Active: "active",
+  Expired: "expired",
+  Revoked: "revoked",
+} as const;
+/**
+ * The status of the pairing code.
+ */
+export type EntityPairingCodeStatus = OpenEnum<typeof EntityPairingCodeStatus>;
+
+/**
+ * The QR code representation of the pairing code.
+ */
+export type EntityPairingCodeQrCode = {
+  height?: number | undefined;
+  width?: number | undefined;
+  src?: string | undefined;
+};
+
+/**
+ * Additional pairing code data, present only when requested via the `include` parameter.
+ */
+export type EntityPairingCodeDetails = {
+  /**
+   * The QR code representation of the pairing code.
+   */
+  qrCode?: EntityPairingCodeQrCode | null | undefined;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type EntityPairingCodeLinks = {
+  /**
+   * 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.
+   */
+  profile: Url;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  documentation: Url;
+};
+
+export type EntityPairingCode = {
+  /**
+   * Indicates the response contains a terminal pairing code object. Will always contain the string
+   *
+   * @remarks
+   * `terminal-pairing-code` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The unique identifier of the pairing code. Example: `termpc_R7gX5Ea9bC4DkFj3G`.
+   */
+  id: string;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * The human-readable pairing code to be entered on the terminal. This code is multi-use and will expire after the
+   *
+   * @remarks
+   * time indicated in `expiresAt`.
+   */
+  code: string;
+  /**
+   * The ID of the profile the terminal is being paired with.
+   */
+  profileId: string;
+  status: EntityPairingCodeStatus;
+  /**
+   * Additional pairing code data, present only when requested via the `include` parameter.
+   */
+  details?: EntityPairingCodeDetails | null | undefined;
+  /**
+   * The date and time the pairing code expires, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Pairing
+   *
+   * @remarks
+   * codes expire 90 days after creation. After this time, the code can no longer be used to pair a terminal.
+   */
+  expiresAt: string;
+  /**
+   * The date and time the pairing code was revoked, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   *
+   * @remarks
+   * `null` if the code has not been revoked.
+   */
+  revokedAt?: string | null | undefined;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: EntityPairingCodeLinks;
+};
+
+/** @internal */
+export const EntityPairingCodeStatus$inboundSchema: z.ZodType<
+  EntityPairingCodeStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(EntityPairingCodeStatus);
+
+/** @internal */
+export const EntityPairingCodeQrCode$inboundSchema: z.ZodType<
+  EntityPairingCodeQrCode,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  height: z.number().optional(),
+  width: z.number().optional(),
+  src: z.string().optional(),
+});
+
+export function entityPairingCodeQrCodeFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityPairingCodeQrCode, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityPairingCodeQrCode$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityPairingCodeQrCode' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityPairingCodeDetails$inboundSchema: z.ZodType<
+  EntityPairingCodeDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  qrCode: z.nullable(z.lazy(() => EntityPairingCodeQrCode$inboundSchema))
+    .optional(),
+});
+
+export function entityPairingCodeDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityPairingCodeDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityPairingCodeDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityPairingCodeDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityPairingCodeLinks$inboundSchema: z.ZodType<
+  EntityPairingCodeLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  profile: Url$inboundSchema,
+  documentation: Url$inboundSchema,
+});
+
+export function entityPairingCodeLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityPairingCodeLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityPairingCodeLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityPairingCodeLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityPairingCode$inboundSchema: z.ZodType<
+  EntityPairingCode,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  code: z.string(),
+  profileId: z.string(),
+  status: EntityPairingCodeStatus$inboundSchema,
+  details: z.nullable(z.lazy(() => EntityPairingCodeDetails$inboundSchema))
+    .optional(),
+  expiresAt: z.string(),
+  revokedAt: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+  _links: z.lazy(() => EntityPairingCodeLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+
+export function entityPairingCodeFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityPairingCode, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityPairingCode$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityPairingCode' from JSON`,
+  );
+}

package/src/models/index.ts

@@ -61,6 +61,7 @@ export * from "./entityinvoice.js";
 export * from "./entitymethodget.js";
 export * from "./entityonboardingstatus.js";
 export * from "./entityorganization.js";
+export * from "./entitypairingcode.js";
 export * from "./entitypaymentroute.js";
 export * from "./entitypaymentrouteresponse.js";
 export * from "./entitypayoutresponse.js";

package/src/models/operations/index.ts

@@ -110,6 +110,10 @@ export * from "./requestapplepaypaymentsession.js";
 export * from "./returnunmatchedcredittransfer.js";
 export * from "./revokemandate.js";
 export * from "./submitonboardingdata.js";
+export * from "./terminalsgetpairingcode.js";
+export * from "./terminalslistpairingcodes.js";
+export * from "./terminalsrequestpairingcode.js";
+export * from "./terminalsrevokepairingcode.js";
 export * from "./testwebhook.js";
 export * from "./updatecustomer.js";
 export * from "./updatepayment.js";