mollie-api-typescript 1.5.4 → 1.6.1

package/src/models/operations/oauthgeneratetokens.ts

@@ -0,0 +1,191 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d5e2632adf8f
+ */
+
+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";
+
+export const OauthGenerateTokensServerList = [
+  "https://api.mollie.com/oauth2",
+] as const;
+
+export type OauthGenerateTokensRequestBody = {
+  /**
+   * If you wish to exchange your authorization code for an app access token, use grant type
+   *
+   * @remarks
+   * `authorization_code`. If you wish to renew your app access token with your refresh token, use grant type
+   * `refresh_token`.
+   *
+   * Possible values: `authorization_code` `refresh_token`
+   */
+  grantType: string;
+  /**
+   * The authorization code you received when creating the authorization. Only use this field when using
+   *
+   * @remarks
+   * grant type `authorization_code`.
+   */
+  code?: string | null | undefined;
+  /**
+   * The refresh token you received when creating the authorization. Only use this field when using grant
+   *
+   * @remarks
+   * type `refresh_token`.
+   */
+  refreshToken?: string | null | undefined;
+  /**
+   * The URL the merchant is sent back to once the request has been authorized. It must match the URL you set
+   *
+   * @remarks
+   * when registering your app.
+   *
+   * For consecutive refresh token requests, this parameter is required only if the initial authorization
+   * code grant request also contained a `redirect_uri`.
+   */
+  redirectUri?: string | null | undefined;
+};
+
+export type OauthGenerateTokensRequest = {
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+  requestBody?: OauthGenerateTokensRequestBody | undefined;
+};
+
+/**
+ * The newly generated access token and refresh token.
+ */
+export type OauthGenerateTokensResponseBody = {
+  /**
+   * The app access token, with which you will be able to access the Mollie API on the merchant's behalf.
+   */
+  accessToken?: string | undefined;
+  /**
+   * The refresh token, with which you will be able to retrieve new app access tokens on this endpoint. The
+   *
+   * @remarks
+   * refresh token does not expire.
+   */
+  refreshToken?: string | undefined;
+  /**
+   * The number of seconds left before the app access token expires. Be sure to renew your app access token
+   *
+   * @remarks
+   * before this reaches zero.
+   */
+  expiresIn?: number | undefined;
+  /**
+   * As per OAuth standards, the provided app access token can only be used with `bearer` authentication.
+   *
+   * @remarks
+   *
+   * Possible values: `bearer`
+   */
+  tokenType?: string | undefined;
+  /**
+   * A space-separated list of [permissions](https://docs.mollie.com/docs/permissions).
+   */
+  scope?: string | undefined;
+};
+
+/** @internal */
+export type OauthGenerateTokensRequestBody$Outbound = {
+  grant_type: string;
+  code?: string | null | undefined;
+  refresh_token?: string | null | undefined;
+  redirect_uri?: string | null | undefined;
+};
+
+/** @internal */
+export const OauthGenerateTokensRequestBody$outboundSchema: z.ZodType<
+  OauthGenerateTokensRequestBody$Outbound,
+  z.ZodTypeDef,
+  OauthGenerateTokensRequestBody
+> = z.object({
+  grantType: z.string(),
+  code: z.nullable(z.string()).optional(),
+  refreshToken: z.nullable(z.string()).optional(),
+  redirectUri: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    grantType: "grant_type",
+    refreshToken: "refresh_token",
+    redirectUri: "redirect_uri",
+  });
+});
+
+export function oauthGenerateTokensRequestBodyToJSON(
+  oauthGenerateTokensRequestBody: OauthGenerateTokensRequestBody,
+): string {
+  return JSON.stringify(
+    OauthGenerateTokensRequestBody$outboundSchema.parse(
+      oauthGenerateTokensRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type OauthGenerateTokensRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  RequestBody?: OauthGenerateTokensRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const OauthGenerateTokensRequest$outboundSchema: z.ZodType<
+  OauthGenerateTokensRequest$Outbound,
+  z.ZodTypeDef,
+  OauthGenerateTokensRequest
+> = z.object({
+  idempotencyKey: z.string().optional(),
+  requestBody: z.lazy(() => OauthGenerateTokensRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    requestBody: "RequestBody",
+  });
+});
+
+export function oauthGenerateTokensRequestToJSON(
+  oauthGenerateTokensRequest: OauthGenerateTokensRequest,
+): string {
+  return JSON.stringify(
+    OauthGenerateTokensRequest$outboundSchema.parse(oauthGenerateTokensRequest),
+  );
+}
+
+/** @internal */
+export const OauthGenerateTokensResponseBody$inboundSchema: z.ZodType<
+  OauthGenerateTokensResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  access_token: z.string().optional(),
+  refresh_token: z.string().optional(),
+  expires_in: z.number().int().optional(),
+  token_type: z.string().optional(),
+  scope: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "access_token": "accessToken",
+    "refresh_token": "refreshToken",
+    "expires_in": "expiresIn",
+    "token_type": "tokenType",
+  });
+});
+
+export function oauthGenerateTokensResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<OauthGenerateTokensResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OauthGenerateTokensResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OauthGenerateTokensResponseBody' from JSON`,
+  );
+}

package/src/models/operations/oauthrevoketokens.ts

@@ -0,0 +1,94 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7c9c50253889
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export const OauthRevokeTokensServerList = [
+  "https://api.mollie.com/oauth2",
+] as const;
+
+export type OauthRevokeTokensRequestBody = {
+  /**
+   * The type of token you want to revoke.
+   *
+   * @remarks
+   *
+   * Possible values: `access_token` `refresh_token`
+   */
+  tokenTypeHint: string;
+  /**
+   * The token you want to revoke.
+   */
+  token: string;
+};
+
+export type OauthRevokeTokensRequest = {
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+  requestBody?: OauthRevokeTokensRequestBody | undefined;
+};
+
+/** @internal */
+export type OauthRevokeTokensRequestBody$Outbound = {
+  token_type_hint: string;
+  token: string;
+};
+
+/** @internal */
+export const OauthRevokeTokensRequestBody$outboundSchema: z.ZodType<
+  OauthRevokeTokensRequestBody$Outbound,
+  z.ZodTypeDef,
+  OauthRevokeTokensRequestBody
+> = z.object({
+  tokenTypeHint: z.string(),
+  token: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    tokenTypeHint: "token_type_hint",
+  });
+});
+
+export function oauthRevokeTokensRequestBodyToJSON(
+  oauthRevokeTokensRequestBody: OauthRevokeTokensRequestBody,
+): string {
+  return JSON.stringify(
+    OauthRevokeTokensRequestBody$outboundSchema.parse(
+      oauthRevokeTokensRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type OauthRevokeTokensRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  RequestBody?: OauthRevokeTokensRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const OauthRevokeTokensRequest$outboundSchema: z.ZodType<
+  OauthRevokeTokensRequest$Outbound,
+  z.ZodTypeDef,
+  OauthRevokeTokensRequest
+> = z.object({
+  idempotencyKey: z.string().optional(),
+  requestBody: z.lazy(() => OauthRevokeTokensRequestBody$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    requestBody: "RequestBody",
+  });
+});
+
+export function oauthRevokeTokensRequestToJSON(
+  oauthRevokeTokensRequest: OauthRevokeTokensRequest,
+): string {
+  return JSON.stringify(
+    OauthRevokeTokensRequest$outboundSchema.parse(oauthRevokeTokensRequest),
+  );
+}

package/src/models/operations/updatepayment.ts

@@ -9,7 +9,7 @@ import * as models from "../index.js";
 
 export type UpdatePaymentRequestBody = {
   /**
-   * The description of the payment. This will be shown to your customer on their card or bank statement when possible.
+   * The description of the payment will be shown to your customer on their card or bank statement when possible.
    *
    * @remarks
    * We truncate the description automatically according to the limits of the used payment method. The description is

package/src/models/paymentrequest.ts

@@ -259,7 +259,7 @@ export type Company = {
 
 export type PaymentRequest = {
   /**
-   * The description of the payment. This will be shown to your customer on their card or bank statement when possible.
+   * The description of the payment will be shown to your customer on their card or bank statement when possible.
    *
    * @remarks
    * We truncate the description automatically according to the limits of the used payment method. The description is

package/src/models/paymentresponse.ts

@@ -810,7 +810,7 @@ export type PaymentResponse = {
    */
   mode: Mode;
   /**
-   * The description of the payment. This will be shown to your customer on their card or bank statement when possible.
+   * The description of the payment will be shown to your customer on their card or bank statement when possible.
    *
    * @remarks
    * We truncate the description automatically according to the limits of the used payment method. The description is

package/src/sdk/oauth.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 37b7f9b2970b
+ */
+
+import { oauthGenerate } from "../funcs/oauthGenerate.js";
+import { oauthRevoke } from "../funcs/oauthRevoke.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Oauth extends ClientSDK {
+  /**
+   * Generate tokens
+   *
+   * @remarks
+   * Exchange the authorization code you received from the [Authorize endpoint](oauth-authorize) for an 'access token'
+   * API credential, with which you can communicate with the Mollie API on behalf of the consenting merchant.
+   *
+   * This endpoint can only be accessed using **OAuth client credentials**.
+   */
+  async generate(
+    request?: operations.OauthGenerateTokensRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<Uint8Array> {
+    return unwrapAsync(oauthGenerate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Revoke tokens
+   *
+   * @remarks
+   * Revoke an access token or refresh token. Once revoked, the token can no longer be used.
+   *
+   * Revoking a refresh token revokes all access tokens that were created using the same authorization.
+   *
+   * This endpoint can only be accessed using **OAuth client credentials**.
+   */
+  async revoke(
+    request?: operations.OauthRevokeTokensRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(oauthRevoke(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -17,6 +17,7 @@ import { DelayedRouting } from "./delayedrouting.js";
 import { Invoices } from "./invoices.js";
 import { Mandates } from "./mandates.js";
 import { Methods } from "./methods.js";
+import { Oauth } from "./oauth.js";
 import { Onboarding } from "./onboarding.js";
 import { Organizations } from "./organizations.js";
 import { PaymentLinks } from "./paymentlinks.js";
@@ -37,6 +38,11 @@ import { WebhookEvents } from "./webhookevents.js";
 import { Webhooks } from "./webhooks.js";
 
 export class Client extends ClientSDK {
+  private _oauth?: Oauth;
+  get oauth(): Oauth {
+    return (this._oauth ??= new Oauth(this._options));
+  }
+
   private _balances?: Balances;
   get balances(): Balances {
     return (this._balances ??= new Balances(this._options));