mollie-api-typescript 1.8.0 → 1.8.2

package/src/models/operations/terminalslistpairingcodes.ts

@@ -0,0 +1,195 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: bc1b621a466f
+ */
+
+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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as models from "../index.js";
+
+export type TerminalsListPairingCodesGlobals = {
+  /**
+   * The identifier referring to the [profile](get-profile) you wish to
+   *
+   * @remarks
+   * retrieve the resources for.
+   *
+   * Most API credentials are linked to a single profile. In these cases the `profileId` must not be sent. For
+   * organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.
+   */
+  profileId?: string | undefined;
+};
+
+export type TerminalsListPairingCodesRequest = {
+  /**
+   * Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+   *
+   * @remarks
+   * result set.
+   */
+  from?: string | null | undefined;
+  /**
+   * The maximum number of items to return. Defaults to 50 items.
+   */
+  limit?: number | null | undefined;
+  /**
+   * Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from
+   *
+   * @remarks
+   * newest to oldest.
+   */
+  sort?: models.Sorting | undefined;
+  /**
+   * The identifier referring to the [profile](get-profile) you wish to retrieve pairing codes for.
+   */
+  profileId?: string | undefined;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type TerminalPairingCode = {};
+
+export type TerminalsListPairingCodesEmbedded = {
+  /**
+   * An array of terminal pairing code objects. For a complete reference of the terminal pairing code
+   *
+   * @remarks
+   * object, refer to the [Get terminal pairing code endpoint](terminals-get-pairing-code)
+   * documentation.
+   */
+  terminalPairingCodes?: Array<TerminalPairingCode> | undefined;
+};
+
+/**
+ * A list of terminal pairing code objects. For a complete reference of the terminal pairing code object, refer to
+ *
+ * @remarks
+ * the [Get terminal pairing code endpoint](terminals-get-pairing-code) documentation.
+ */
+export type TerminalsListPairingCodesResponse = {
+  /**
+   * The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
+   *
+   * @remarks
+   * as well.
+   *
+   * The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
+   * limit is 50 items.
+   */
+  count?: number | undefined;
+  embedded?: TerminalsListPairingCodesEmbedded | undefined;
+  /**
+   * Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field.
+   */
+  links?: models.ListLinks | undefined;
+};
+
+/** @internal */
+export type TerminalsListPairingCodesRequest$Outbound = {
+  from?: string | null | undefined;
+  limit?: number | null | undefined;
+  sort?: string | undefined;
+  profileId?: string | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const TerminalsListPairingCodesRequest$outboundSchema: z.ZodType<
+  TerminalsListPairingCodesRequest$Outbound,
+  z.ZodTypeDef,
+  TerminalsListPairingCodesRequest
+> = z.object({
+  from: z.nullable(z.string()).optional(),
+  limit: z.nullable(z.number().int()).optional(),
+  sort: models.Sorting$outboundSchema.optional(),
+  profileId: z.string().optional(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function terminalsListPairingCodesRequestToJSON(
+  terminalsListPairingCodesRequest: TerminalsListPairingCodesRequest,
+): string {
+  return JSON.stringify(
+    TerminalsListPairingCodesRequest$outboundSchema.parse(
+      terminalsListPairingCodesRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const TerminalPairingCode$inboundSchema: z.ZodType<
+  TerminalPairingCode,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function terminalPairingCodeFromJSON(
+  jsonString: string,
+): SafeParseResult<TerminalPairingCode, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TerminalPairingCode$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TerminalPairingCode' from JSON`,
+  );
+}
+
+/** @internal */
+export const TerminalsListPairingCodesEmbedded$inboundSchema: z.ZodType<
+  TerminalsListPairingCodesEmbedded,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "terminal-pairing-codes": z.array(
+    z.lazy(() => TerminalPairingCode$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "terminal-pairing-codes": "terminalPairingCodes",
+  });
+});
+
+export function terminalsListPairingCodesEmbeddedFromJSON(
+  jsonString: string,
+): SafeParseResult<TerminalsListPairingCodesEmbedded, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TerminalsListPairingCodesEmbedded$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TerminalsListPairingCodesEmbedded' from JSON`,
+  );
+}
+
+/** @internal */
+export const TerminalsListPairingCodesResponse$inboundSchema: z.ZodType<
+  TerminalsListPairingCodesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int().optional(),
+  _embedded: z.lazy(() => TerminalsListPairingCodesEmbedded$inboundSchema)
+    .optional(),
+  _links: models.ListLinks$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_embedded": "embedded",
+    "_links": "links",
+  });
+});
+
+export function terminalsListPairingCodesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TerminalsListPairingCodesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TerminalsListPairingCodesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TerminalsListPairingCodesResponse' from JSON`,
+  );
+}

package/src/models/operations/terminalsrequestpairingcode.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 017d1fbcc397
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type TerminalsRequestPairingCodeRequestBody = {
+  /**
+   * The ID of the profile to pair the terminal with.
+   */
+  profileId: string;
+};
+
+export type TerminalsRequestPairingCodeRequest = {
+  /**
+   * Include additional information in the response.
+   */
+  include?: string | null | undefined;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+  requestBody?: TerminalsRequestPairingCodeRequestBody | undefined;
+};
+
+/** @internal */
+export type TerminalsRequestPairingCodeRequestBody$Outbound = {
+  profileId: string;
+};
+
+/** @internal */
+export const TerminalsRequestPairingCodeRequestBody$outboundSchema: z.ZodType<
+  TerminalsRequestPairingCodeRequestBody$Outbound,
+  z.ZodTypeDef,
+  TerminalsRequestPairingCodeRequestBody
+> = z.object({
+  profileId: z.string(),
+});
+
+export function terminalsRequestPairingCodeRequestBodyToJSON(
+  terminalsRequestPairingCodeRequestBody:
+    TerminalsRequestPairingCodeRequestBody,
+): string {
+  return JSON.stringify(
+    TerminalsRequestPairingCodeRequestBody$outboundSchema.parse(
+      terminalsRequestPairingCodeRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type TerminalsRequestPairingCodeRequest$Outbound = {
+  include?: string | null | undefined;
+  "idempotency-key"?: string | undefined;
+  RequestBody?: TerminalsRequestPairingCodeRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const TerminalsRequestPairingCodeRequest$outboundSchema: z.ZodType<
+  TerminalsRequestPairingCodeRequest$Outbound,
+  z.ZodTypeDef,
+  TerminalsRequestPairingCodeRequest
+> = z.object({
+  include: z.nullable(z.string()).optional(),
+  idempotencyKey: z.string().optional(),
+  requestBody: z.lazy(() =>
+    TerminalsRequestPairingCodeRequestBody$outboundSchema
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    requestBody: "RequestBody",
+  });
+});
+
+export function terminalsRequestPairingCodeRequestToJSON(
+  terminalsRequestPairingCodeRequest: TerminalsRequestPairingCodeRequest,
+): string {
+  return JSON.stringify(
+    TerminalsRequestPairingCodeRequest$outboundSchema.parse(
+      terminalsRequestPairingCodeRequest,
+    ),
+  );
+}

package/src/models/operations/terminalsrevokepairingcode.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9742dfb51ef0
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type TerminalsRevokePairingCodeRequest = {
+  /**
+   * Provide the ID of the terminal pairing code.
+   */
+  pairingCodeId: string;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export type TerminalsRevokePairingCodeRequest$Outbound = {
+  pairingCodeId: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const TerminalsRevokePairingCodeRequest$outboundSchema: z.ZodType<
+  TerminalsRevokePairingCodeRequest$Outbound,
+  z.ZodTypeDef,
+  TerminalsRevokePairingCodeRequest
+> = z.object({
+  pairingCodeId: z.string(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function terminalsRevokePairingCodeRequestToJSON(
+  terminalsRevokePairingCodeRequest: TerminalsRevokePairingCodeRequest,
+): string {
+  return JSON.stringify(
+    TerminalsRevokePairingCodeRequest$outboundSchema.parse(
+      terminalsRevokePairingCodeRequest,
+    ),
+  );
+}

package/src/sdk/terminals.ts

@@ -5,6 +5,10 @@
 
 import { terminalsGet } from "../funcs/terminalsGet.js";
 import { terminalsList } from "../funcs/terminalsList.js";
+import { terminalsTerminalsGetPairingCode } from "../funcs/terminalsTerminalsGetPairingCode.js";
+import { terminalsTerminalsListPairingCodes } from "../funcs/terminalsTerminalsListPairingCodes.js";
+import { terminalsTerminalsRequestPairingCode } from "../funcs/terminalsTerminalsRequestPairingCode.js";
+import { terminalsTerminalsRevokePairingCode } from "../funcs/terminalsTerminalsRevokePairingCode.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
@@ -47,4 +51,98 @@ export class Terminals extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * 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.
+   */
+  async terminalsRequestPairingCode(
+    request?: operations.TerminalsRequestPairingCodeRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.EntityPairingCode> {
+    return unwrapAsync(terminalsTerminalsRequestPairingCode(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List terminal pairing codes
+   *
+   * @remarks
+   * > ℹ️ **Test mode**
+   * >
+   * > This endpoint currently does not support test mode yet.
+   *
+   * Returns all pairing codes: `active`, `expired`, and `revoked`. Results are paginated.
+   */
+  async terminalsListPairingCodes(
+    request?: operations.TerminalsListPairingCodesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.TerminalsListPairingCodesResponse> {
+    return unwrapAsync(terminalsTerminalsListPairingCodes(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get terminal pairing code
+   *
+   * @remarks
+   * > ℹ️ **Test mode**
+   * >
+   * > This endpoint currently does not support test mode yet.
+   *
+   * Get a pairing code to onboard a point-of-sale terminal.
+   *
+   * The response includes a human-readable `code` for manual entry on the terminal and, optionally, a QR Code as a
+   * base64 encoded SVG data URI when you use the `include` query parameter with value `details.qrCode`.
+   */
+  async terminalsGetPairingCode(
+    request: operations.TerminalsGetPairingCodeRequest,
+    options?: RequestOptions,
+  ): Promise<models.EntityPairingCode> {
+    return unwrapAsync(terminalsTerminalsGetPairingCode(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async terminalsRevokePairingCode(
+    request: operations.TerminalsRevokePairingCodeRequest,
+    options?: RequestOptions,
+  ): Promise<models.EntityPairingCode> {
+    return unwrapAsync(terminalsTerminalsRevokePairingCode(
+      this,
+      request,
+      options,
+    ));
+  }
 }