mollie-api-typescript 0.6.2 → 0.8.0

package/FUNCTIONS.md

@@ -25,6 +25,7 @@ import { balancesList } from "mollie-api-typescript/funcs/balancesList.js";
 // Use `ClientCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const client = new ClientCore({
+  testmode: false,
   security: {
     apiKey: process.env["CLIENT_API_KEY"] ?? "",
   },
@@ -35,7 +36,6 @@ async function run() {
     currency: "EUR",
     from: "bal_gVMhHKqSSRYJyPsuoPNFH",
     limit: 50,
-    testmode: false,
     idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
   if (res.ok) {

package/README.md

@@ -24,8 +24,11 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
   * [SDK Example Usage](#sdk-example-usage)
   * [Authentication](#authentication)
   * [Idempotency Key](#idempotency-key)
+  * [Add Custom User-Agent Header](#add-custom-user-agent-header)
+  * [Add Profile ID and Testmode to Client](#add-profile-id-and-testmode-to-client)
   * [Available Resources and Operations](#available-resources-and-operations)
   * [Standalone functions](#standalone-functions)
+  * [Global Parameters](#global-parameters)
   * [Retries](#retries)
   * [Error Handling](#error-handling)
   * [Server Selection](#server-selection)
@@ -92,7 +95,10 @@ Add the following server definition to your `claude_desktop_config.json` file:
         "--",
         "mcp", "start",
         "--api-key", "...",
-        "--o-auth", "..."
+        "--o-auth", "...",
+        "--profile-id", "...",
+        "--testmode", "...",
+        "--custom-user-agent", "..."
       ]
     }
   }
@@ -116,7 +122,10 @@ Create a `.cursor/mcp.json` file in your project root with the following content
         "--",
         "mcp", "start",
         "--api-key", "...",
-        "--o-auth", "..."
+        "--o-auth", "...",
+        "--profile-id", "...",
+        "--testmode", "...",
+        "--custom-user-agent", "..."
       ]
     }
   }
@@ -171,6 +180,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 import { Client } from "mollie-api-typescript";
 
 const client = new Client({
+  testmode: false,
   security: {
     apiKey: process.env["CLIENT_API_KEY"] ?? "",
   },
@@ -181,7 +191,6 @@ async function run() {
     currency: "EUR",
     from: "bal_gVMhHKqSSRYJyPsuoPNFH",
     limit: 50,
-    testmode: false,
     idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
 
@@ -213,6 +222,7 @@ const client = new Client({
   security: {
     apiKey: process.env["CLIENT_API_KEY"] ?? "",
   },
+  testmode: false,
 });
 
 async function run() {
@@ -220,7 +230,6 @@ async function run() {
     currency: "EUR",
     from: "bal_gVMhHKqSSRYJyPsuoPNFH",
     limit: 50,
-    testmode: false,
     idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
 
@@ -277,6 +286,43 @@ console.log(payment1.id === payment2.id ? "Payments are the same" : "Payments ar
 ```
 <!-- End Idempotency Key -->
 
+<!-- Start Add Custom User-Agent Header -->
+
+## Add Custom User-Agent Header
+The SDK allows you to append a custom suffix to the `User-Agent` header for all requests. This can be used to identify
+your application or integration when interacting with the API, making it easier to track usage or debug requests. The suffix is automatically added to the default User-Agent string generated by the SDK. You can add it when creating the
+client:
+
+```js
+let client = new Client({
+  security: {
+    apiKey: process.env["CLIENT_API_KEY"] ?? "",
+  },
+  customUserAgent: "insert something here"
+})
+```
+
+<!-- End Add Custom User-Agent Header -->
+
+<!-- Start Add Profile ID and Testmode to Client -->
+
+## Add Profile ID and Testmode to Client
+The SDK allows you to define the `profileId` and `testmode` in the client. This way, you don't need to add this
+information to the payload every time when using OAuth. This will not override the details provided in the individual
+requests.
+
+```ts
+let client = new Client({
+  security: {
+    oAuth: process.env["CLIENT_OAUTH_KEY"] ?? "",
+  },
+  testmode: false,
+  profileId: "pfl_..."
+})
+```
+
+<!-- End Add Profile ID and Testmode to Client -->
+
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
@@ -575,6 +621,55 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
 
+<!-- Start Global Parameters [global-parameters] -->
+## Global Parameters
+
+Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
+
+For example, you can set `profileId` to `` at SDK initialization and then you do not have to pass the same value on calls to operations like `list`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
+
+
+### Available Globals
+
+The following global parameters are available.
+Global parameters can also be set via environment variable.
+
+| Name            | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                            | Environment              |
+| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------ |
+| profileId       | string  | The identifier referring to the [profile](get-profile) you wish to<br/>retrieve the resources for.<br/><br/>Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted. For<br/>organization-level credentials such as OAuth access tokens however, the `profileId` parameter is required.                                                                     | CLIENT_PROFILE_ID        |
+| testmode        | boolean | Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query<br/>parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by<br/>setting the `testmode` query parameter to `true`.<br/><br/>Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa. | CLIENT_TESTMODE          |
+| customUserAgent | string  | Custom user agent string to be appended to the default Mollie SDK user agent.                                                                                                                                                                                                                                                                                                                          | CLIENT_CUSTOM_USER_AGENT |
+
+### Example
+
+```typescript
+import { Client } from "mollie-api-typescript";
+
+const client = new Client({
+  testmode: false,
+  profileId: "<id>",
+  customUserAgent: "<value>",
+  security: {
+    apiKey: process.env["CLIENT_API_KEY"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await client.balances.list({
+    currency: "EUR",
+    from: "bal_gVMhHKqSSRYJyPsuoPNFH",
+    limit: 50,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Global Parameters [global-parameters] -->
+
 <!-- Start Retries [retries] -->
 ## Retries
 
@@ -585,6 +680,7 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { Client } from "mollie-api-typescript";
 
 const client = new Client({
+  testmode: false,
   security: {
     apiKey: process.env["CLIENT_API_KEY"] ?? "",
   },
@@ -595,7 +691,6 @@ async function run() {
     currency: "EUR",
     from: "bal_gVMhHKqSSRYJyPsuoPNFH",
     limit: 50,
-    testmode: false,
     idempotencyKey: "123e4567-e89b-12d3-a456-426",
   }, {
     retries: {
@@ -632,6 +727,7 @@ const client = new Client({
     },
     retryConnectionErrors: false,
   },
+  testmode: false,
   security: {
     apiKey: process.env["CLIENT_API_KEY"] ?? "",
   },
@@ -642,7 +738,6 @@ async function run() {
     currency: "EUR",
     from: "bal_gVMhHKqSSRYJyPsuoPNFH",
     limit: 50,
-    testmode: false,
     idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
 
@@ -674,6 +769,7 @@ import { Client } from "mollie-api-typescript";
 import * as errors from "mollie-api-typescript/models/errors";
 
 const client = new Client({
+  testmode: false,
   security: {
     apiKey: process.env["CLIENT_API_KEY"] ?? "",
   },
@@ -685,7 +781,6 @@ async function run() {
       currency: "EUR",
       from: "bal_gVMhHKqSSRYJyPsuoPNFH",
       limit: 50,
-      testmode: false,
       idempotencyKey: "123e4567-e89b-12d3-a456-426",
     });
 
@@ -750,6 +845,7 @@ import { Client } from "mollie-api-typescript";
 
 const client = new Client({
   serverURL: "https://api.mollie.com/v2",
+  testmode: false,
   security: {
     apiKey: process.env["CLIENT_API_KEY"] ?? "",
   },
@@ -760,7 +856,6 @@ async function run() {
     currency: "EUR",
     from: "bal_gVMhHKqSSRYJyPsuoPNFH",
     limit: 50,
-    testmode: false,
     idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });