mollie-api-typescript 0.2.2 → 0.2.4

package/docs/sdks/paymentlinks/README.md

@@ -32,92 +32,95 @@ const client = new Client({
 
 async function run() {
   const result = await client.paymentLinks.create({
-    id: "pl_d9fQur83kFdhH8hIhaZfq",
-    description: "Chess Board",
-    amount: {
-      currency: "EUR",
-      value: "10.00",
-    },
-    minimumAmount: {
-      currency: "EUR",
-      value: "10.00",
-    },
-    redirectUrl: "https://webshop.example.org/payment-links/redirect/",
-    webhookUrl: "https://webshop.example.org/payment-links/webhook/",
-    lines: [
-      {
-        type: "physical",
-        description: "LEGO 4440 Forest Police Station",
-        quantity: 1,
-        quantityUnit: "pcs",
-        unitPrice: {
-          currency: "EUR",
-          value: "10.00",
-        },
-        discountAmount: {
-          currency: "EUR",
-          value: "10.00",
-        },
-        totalAmount: {
-          currency: "EUR",
-          value: "10.00",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
+    requestBody: {
+      id: "pl_d9fQur83kFdhH8hIhaZfq",
+      description: "Chess Board",
+      amount: {
+        currency: "EUR",
+        value: "10.00",
+      },
+      minimumAmount: {
+        currency: "EUR",
+        value: "10.00",
+      },
+      redirectUrl: "https://webshop.example.org/payment-links/redirect/",
+      webhookUrl: "https://webshop.example.org/payment-links/webhook/",
+      lines: [
+        {
+          type: "physical",
+          description: "LEGO 4440 Forest Police Station",
+          quantity: 1,
+          quantityUnit: "pcs",
+          unitPrice: {
+            currency: "EUR",
+            value: "10.00",
+          },
+          discountAmount: {
+            currency: "EUR",
+            value: "10.00",
+          },
+          totalAmount: {
+            currency: "EUR",
+            value: "10.00",
+          },
+          vatRate: "21.00",
+          vatAmount: {
+            currency: "EUR",
+            value: "10.00",
+          },
+          sku: "9780241661628",
+          categories: [
+            "meal",
+            "eco",
+          ],
+          imageUrl: "https://...",
+          productUrl: "https://...",
         },
-        vatRate: "21.00",
-        vatAmount: {
+      ],
+      billingAddress: {
+        title: "Mr.",
+        givenName: "Piet",
+        familyName: "Mondriaan",
+        organizationName: "Mollie B.V.",
+        streetAndNumber: "Keizersgracht 126",
+        streetAdditional: "Apt. 1",
+        postalCode: "1234AB",
+        email: "piet@example.org",
+        phone: "31208202070",
+        city: "Amsterdam",
+        region: "Noord-Holland",
+        country: "NL",
+      },
+      shippingAddress: {
+        title: "Mr.",
+        givenName: "Piet",
+        familyName: "Mondriaan",
+        organizationName: "Mollie B.V.",
+        streetAndNumber: "Keizersgracht 126",
+        streetAdditional: "Apt. 1",
+        postalCode: "1234AB",
+        email: "piet@example.org",
+        phone: "31208202070",
+        city: "Amsterdam",
+        region: "Noord-Holland",
+        country: "NL",
+      },
+      profileId: "pfl_QkEhN94Ba",
+      reusable: false,
+      expiresAt: "2025-12-24T11:00:16+00:00",
+      allowedMethods: null,
+      applicationFee: {
+        amount: {
           currency: "EUR",
           value: "10.00",
         },
-        sku: "9780241661628",
-        categories: [
-          "meal",
-          "eco",
-        ],
-        imageUrl: "https://...",
-        productUrl: "https://...",
-      },
-    ],
-    billingAddress: {
-      title: "Mr.",
-      givenName: "Piet",
-      familyName: "Mondriaan",
-      organizationName: "Mollie B.V.",
-      streetAndNumber: "Keizersgracht 126",
-      streetAdditional: "Apt. 1",
-      postalCode: "1234AB",
-      email: "piet@example.org",
-      phone: "31208202070",
-      city: "Amsterdam",
-      region: "Noord-Holland",
-      country: "NL",
-    },
-    shippingAddress: {
-      title: "Mr.",
-      givenName: "Piet",
-      familyName: "Mondriaan",
-      organizationName: "Mollie B.V.",
-      streetAndNumber: "Keizersgracht 126",
-      streetAdditional: "Apt. 1",
-      postalCode: "1234AB",
-      email: "piet@example.org",
-      phone: "31208202070",
-      city: "Amsterdam",
-      region: "Noord-Holland",
-      country: "NL",
-    },
-    profileId: "pfl_QkEhN94Ba",
-    reusable: false,
-    expiresAt: "2025-12-24T11:00:16+00:00",
-    allowedMethods: null,
-    applicationFee: {
-      amount: {
-        currency: "EUR",
-        value: "10.00",
+        description: "Platform fee",
       },
-      description: "Platform fee",
+      sequenceType: "oneoff",
+      customerId: "cst_XimFHuaEzd",
+      testmode: false,
     },
-    sequenceType: "oneoff",
-    customerId: "cst_XimFHuaEzd",
-    testmode: false,
   });
 
   console.log(result);
@@ -144,92 +147,95 @@ const client = new ClientCore({
 
 async function run() {
   const res = await paymentLinksCreate(client, {
-    id: "pl_d9fQur83kFdhH8hIhaZfq",
-    description: "Chess Board",
-    amount: {
-      currency: "EUR",
-      value: "10.00",
-    },
-    minimumAmount: {
-      currency: "EUR",
-      value: "10.00",
-    },
-    redirectUrl: "https://webshop.example.org/payment-links/redirect/",
-    webhookUrl: "https://webshop.example.org/payment-links/webhook/",
-    lines: [
-      {
-        type: "physical",
-        description: "LEGO 4440 Forest Police Station",
-        quantity: 1,
-        quantityUnit: "pcs",
-        unitPrice: {
-          currency: "EUR",
-          value: "10.00",
-        },
-        discountAmount: {
-          currency: "EUR",
-          value: "10.00",
-        },
-        totalAmount: {
-          currency: "EUR",
-          value: "10.00",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
+    requestBody: {
+      id: "pl_d9fQur83kFdhH8hIhaZfq",
+      description: "Chess Board",
+      amount: {
+        currency: "EUR",
+        value: "10.00",
+      },
+      minimumAmount: {
+        currency: "EUR",
+        value: "10.00",
+      },
+      redirectUrl: "https://webshop.example.org/payment-links/redirect/",
+      webhookUrl: "https://webshop.example.org/payment-links/webhook/",
+      lines: [
+        {
+          type: "physical",
+          description: "LEGO 4440 Forest Police Station",
+          quantity: 1,
+          quantityUnit: "pcs",
+          unitPrice: {
+            currency: "EUR",
+            value: "10.00",
+          },
+          discountAmount: {
+            currency: "EUR",
+            value: "10.00",
+          },
+          totalAmount: {
+            currency: "EUR",
+            value: "10.00",
+          },
+          vatRate: "21.00",
+          vatAmount: {
+            currency: "EUR",
+            value: "10.00",
+          },
+          sku: "9780241661628",
+          categories: [
+            "meal",
+            "eco",
+          ],
+          imageUrl: "https://...",
+          productUrl: "https://...",
         },
-        vatRate: "21.00",
-        vatAmount: {
+      ],
+      billingAddress: {
+        title: "Mr.",
+        givenName: "Piet",
+        familyName: "Mondriaan",
+        organizationName: "Mollie B.V.",
+        streetAndNumber: "Keizersgracht 126",
+        streetAdditional: "Apt. 1",
+        postalCode: "1234AB",
+        email: "piet@example.org",
+        phone: "31208202070",
+        city: "Amsterdam",
+        region: "Noord-Holland",
+        country: "NL",
+      },
+      shippingAddress: {
+        title: "Mr.",
+        givenName: "Piet",
+        familyName: "Mondriaan",
+        organizationName: "Mollie B.V.",
+        streetAndNumber: "Keizersgracht 126",
+        streetAdditional: "Apt. 1",
+        postalCode: "1234AB",
+        email: "piet@example.org",
+        phone: "31208202070",
+        city: "Amsterdam",
+        region: "Noord-Holland",
+        country: "NL",
+      },
+      profileId: "pfl_QkEhN94Ba",
+      reusable: false,
+      expiresAt: "2025-12-24T11:00:16+00:00",
+      allowedMethods: null,
+      applicationFee: {
+        amount: {
           currency: "EUR",
           value: "10.00",
         },
-        sku: "9780241661628",
-        categories: [
-          "meal",
-          "eco",
-        ],
-        imageUrl: "https://...",
-        productUrl: "https://...",
-      },
-    ],
-    billingAddress: {
-      title: "Mr.",
-      givenName: "Piet",
-      familyName: "Mondriaan",
-      organizationName: "Mollie B.V.",
-      streetAndNumber: "Keizersgracht 126",
-      streetAdditional: "Apt. 1",
-      postalCode: "1234AB",
-      email: "piet@example.org",
-      phone: "31208202070",
-      city: "Amsterdam",
-      region: "Noord-Holland",
-      country: "NL",
-    },
-    shippingAddress: {
-      title: "Mr.",
-      givenName: "Piet",
-      familyName: "Mondriaan",
-      organizationName: "Mollie B.V.",
-      streetAndNumber: "Keizersgracht 126",
-      streetAdditional: "Apt. 1",
-      postalCode: "1234AB",
-      email: "piet@example.org",
-      phone: "31208202070",
-      city: "Amsterdam",
-      region: "Noord-Holland",
-      country: "NL",
-    },
-    profileId: "pfl_QkEhN94Ba",
-    reusable: false,
-    expiresAt: "2025-12-24T11:00:16+00:00",
-    allowedMethods: null,
-    applicationFee: {
-      amount: {
-        currency: "EUR",
-        value: "10.00",
+        description: "Platform fee",
       },
-      description: "Platform fee",
+      sequenceType: "oneoff",
+      customerId: "cst_XimFHuaEzd",
+      testmode: false,
     },
-    sequenceType: "oneoff",
-    customerId: "cst_XimFHuaEzd",
-    testmode: false,
   });
   if (res.ok) {
     const { value: result } = res;
@@ -285,6 +291,7 @@ async function run() {
     from: "pl_d9fQur83kFdhH8hIhaZfq",
     limit: 50,
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
 
   console.log(result);
@@ -314,6 +321,7 @@ async function run() {
     from: "pl_d9fQur83kFdhH8hIhaZfq",
     limit: 50,
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -366,6 +374,7 @@ async function run() {
   const result = await client.paymentLinks.get({
     paymentLinkId: "pl_d9fQur83kFdhH8hIhaZfq",
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
 
   console.log(result);
@@ -394,6 +403,7 @@ async function run() {
   const res = await paymentLinksGet(client, {
     paymentLinkId: "pl_d9fQur83kFdhH8hIhaZfq",
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -445,6 +455,7 @@ const client = new Client({
 async function run() {
   const result = await client.paymentLinks.update({
     paymentLinkId: "pl_d9fQur83kFdhH8hIhaZfq",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     requestBody: {
       description: "Chess Board",
       minimumAmount: {
@@ -513,6 +524,7 @@ const client = new ClientCore({
 async function run() {
   const res = await paymentLinksUpdate(client, {
     paymentLinkId: "pl_d9fQur83kFdhH8hIhaZfq",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     requestBody: {
       description: "Chess Board",
       minimumAmount: {
@@ -611,6 +623,7 @@ const client = new Client({
 async function run() {
   const result = await client.paymentLinks.delete({
     paymentLinkId: "pl_d9fQur83kFdhH8hIhaZfq",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     requestBody: {
       testmode: false,
     },
@@ -641,6 +654,7 @@ const client = new ClientCore({
 async function run() {
   const res = await paymentLinksDelete(client, {
     paymentLinkId: "pl_d9fQur83kFdhH8hIhaZfq",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     requestBody: {
       testmode: false,
     },
@@ -701,6 +715,7 @@ async function run() {
     limit: 50,
     sort: "desc",
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
 
   console.log(result);
@@ -732,6 +747,7 @@ async function run() {
     limit: 50,
     sort: "desc",
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
   if (res.ok) {
     const { value: result } = res;

package/docs/sdks/payments/README.md

@@ -43,6 +43,7 @@ const client = new Client({
 async function run() {
   const result = await client.payments.create({
     include: "details.qrCode",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     paymentRequest: {
       id: "tr_5B8cwPMGnU",
       description: "Chess Board",
@@ -230,6 +231,7 @@ const client = new ClientCore({
 async function run() {
   const res = await paymentsCreate(client, {
     include: "details.qrCode",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     paymentRequest: {
       id: "tr_5B8cwPMGnU",
       description: "Chess Board",
@@ -447,6 +449,7 @@ async function run() {
     sort: "desc",
     profileId: "pfl_5B8cwPMGnU",
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
 
   console.log(result);
@@ -478,6 +481,7 @@ async function run() {
     sort: "desc",
     profileId: "pfl_5B8cwPMGnU",
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -532,6 +536,7 @@ async function run() {
     include: "details.qrCode",
     embed: "captures",
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
 
   console.log(result);
@@ -562,6 +567,7 @@ async function run() {
     include: "details.qrCode",
     embed: "captures",
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
   if (res.ok) {
     const { value: result } = res;
@@ -615,6 +621,7 @@ const client = new Client({
 async function run() {
   const result = await client.payments.update({
     paymentId: "tr_5B8cwPMGnU",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     requestBody: {
       description: "Chess Board",
       redirectUrl: "https://example.org/redirect",
@@ -683,6 +690,7 @@ const client = new ClientCore({
 async function run() {
   const res = await paymentsUpdate(client, {
     paymentId: "tr_5B8cwPMGnU",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     requestBody: {
       description: "Chess Board",
       redirectUrl: "https://example.org/redirect",
@@ -780,6 +788,7 @@ const client = new Client({
 async function run() {
   const result = await client.payments.cancel({
     paymentId: "tr_5B8cwPMGnU",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     requestBody: {
       testmode: false,
     },
@@ -810,6 +819,7 @@ const client = new ClientCore({
 async function run() {
   const res = await paymentsCancel(client, {
     paymentId: "tr_5B8cwPMGnU",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     requestBody: {
       testmode: false,
     },
@@ -871,6 +881,7 @@ const client = new Client({
 async function run() {
   const result = await client.payments.releaseAuthorization({
     paymentId: "tr_5B8cwPMGnU",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     requestBody: {
       profileId: "pfl_5B8cwPMGnU",
       testmode: false,
@@ -902,6 +913,7 @@ const client = new ClientCore({
 async function run() {
   const res = await paymentsReleaseAuthorization(client, {
     paymentId: "tr_5B8cwPMGnU",
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
     requestBody: {
       profileId: "pfl_5B8cwPMGnU",
       testmode: false,

package/docs/sdks/permissions/README.md

@@ -27,7 +27,9 @@ const client = new Client({
 });
 
 async function run() {
-  const result = await client.permissions.list();
+  const result = await client.permissions.list({
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
+  });
 
   console.log(result);
 }
@@ -52,7 +54,9 @@ const client = new ClientCore({
 });
 
 async function run() {
-  const res = await permissionsList(client);
+  const res = await permissionsList(client, {
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -68,6 +72,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.ListPermissionsRequest](../../models/operations/listpermissionsrequest.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
@@ -103,6 +108,7 @@ async function run() {
   const result = await client.permissions.get({
     permissionId: "payments.read",
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
 
   console.log(result);
@@ -131,6 +137,7 @@ async function run() {
   const res = await permissionsGet(client, {
     permissionId: "payments.read",
     testmode: false,
+    idempotencyKey: "123e4567-e89b-12d3-a456-426",
   });
   if (res.ok) {
     const { value: result } = res;