Add throttling to the iteration API.

The iterate methods ‒ by default ‒ produce 500 values per minute. This hopefully discourages developers from using this API to request an unreasonable amount of values (payments/customers/…). See: #271

src/binders/chargebacks/ChargebacksBinder.ts

@@ -4,7 +4,7 @@ import List from '../../data/list/List';
 import renege from '../../plumbing/renege';
 import Callback from '../../types/Callback';
 import InnerBinder from '../InnerBinder';
-import { ListParameters } from './parameters';
+import { IterateParameters, ListParameters } from './parameters';
 
 const pathSegment = 'chargebacks';
 
@@ -57,7 +57,8 @@ export default class ChargebacksBinder extends InnerBinder<ChargebackData, Charg
    * @since 3.6.0
    * @see https://docs.mollie.com/reference/v2/chargebacks-api/list-chargebacks
    */
-  public iterate(parameters?: Omit<ListParameters, 'limit'>) {
-    return this.networkClient.iterate<ChargebackData, Chargeback>(pathSegment, 'chargebacks', parameters);
+  public iterate(parameters?: IterateParameters) {
+    const { valuesPerMinute, ...query } = parameters ?? {};
+    return this.networkClient.iterate<ChargebackData, Chargeback>(pathSegment, 'chargebacks', query, valuesPerMinute);
   }
 }

src/binders/chargebacks/parameters.ts

@@ -1,6 +1,8 @@
 import { ChargebackEmbed } from '../../data/chargebacks/Chargeback';
-import { PaginationParameters } from '../../types/parameters';
+import { PaginationParameters, ThrottlingParameters } from '../../types/parameters';
 
 export type ListParameters = PaginationParameters & {
   embed?: ChargebackEmbed[];
 };
+
+export type IterateParameters = Omit<ListParameters, 'limit'> & ThrottlingParameters;

src/binders/customers/CustomersBinder.ts

@@ -6,7 +6,7 @@ import checkId from '../../plumbing/checkId';
 import renege from '../../plumbing/renege';
 import Callback from '../../types/Callback';
 import Binder from '../Binder';
-import { CreateParameters, DeleteParameters, GetParameters, ListParameters, UpdateParameters } from './parameters';
+import { CreateParameters, DeleteParameters, GetParameters, IterateParameters, ListParameters, UpdateParameters } from './parameters';
 
 const pathSegment = 'customers';
 
@@ -97,8 +97,9 @@ export default class CustomersBinder extends Binder<CustomerData, Customer> {
    * @since 3.6.0
    * @see https://docs.mollie.com/reference/v2/customers-api/list-customers
    */
-  public iterate(parameters?: Omit<ListParameters, 'limit'>) {
-    return this.networkClient.iterate<CustomerData, Customer>(pathSegment, 'customers', parameters);
+  public iterate(parameters?: IterateParameters) {
+    const { valuesPerMinute, ...query } = parameters ?? {};
+    return this.networkClient.iterate<CustomerData, Customer>(pathSegment, 'customers', query, valuesPerMinute);
   }
 
   /**

src/binders/customers/mandates/CustomerMandatesBinder.ts

@@ -7,7 +7,7 @@ import checkId from '../../../plumbing/checkId';
 import renege from '../../../plumbing/renege';
 import Callback from '../../../types/Callback';
 import InnerBinder from '../../InnerBinder';
-import { CreateParameters, GetParameters, ListParameters, RevokeParameters } from './parameters';
+import { CreateParameters, GetParameters, IterateParameters, ListParameters, RevokeParameters } from './parameters';
 
 function getPathSegments(customerId: string) {
   return `customers/${customerId}/mandates`;
@@ -127,14 +127,14 @@ export default class CustomerMandatesBinder extends InnerBinder<MandateData, Man
    * @since 3.6.0
    * @see https://docs.mollie.com/reference/v2/mandates-api/list-mandates
    */
-  public iterate(parameters: Omit<ListParameters, 'limit'>) {
+  public iterate(parameters: IterateParameters) {
     // parameters ?? {} is used here, because in case withParent is used, parameters could be omitted.
     const customerId = this.getParentId((parameters ?? {}).customerId);
     if (!checkId(customerId, 'customer')) {
       throw new ApiError('The customer id is invalid');
     }
-    const { customerId: _, ...query } = parameters ?? {};
-    return this.networkClient.iterate<MandateData, Mandate>(getPathSegments(customerId), 'mandates', query);
+    const { valuesPerMinute, customerId: _, ...query } = parameters ?? {};
+    return this.networkClient.iterate<MandateData, Mandate>(getPathSegments(customerId), 'mandates', query, valuesPerMinute);
   }
 
   /**

src/binders/customers/mandates/parameters.ts

@@ -1,5 +1,5 @@
 import { MandateData } from '../../../data/customers/mandates/data';
-import { PaginationParameters } from '../../../types/parameters';
+import { PaginationParameters, ThrottlingParameters } from '../../../types/parameters';
 
 interface ContextParameters {
   customerId: string;
@@ -56,4 +56,6 @@ export type GetParameters = ContextParameters;
 
 export type ListParameters = ContextParameters & PaginationParameters;
 
+export type IterateParameters = Omit<ListParameters, 'limit'> & ThrottlingParameters;
+
 export type RevokeParameters = ContextParameters;

src/binders/customers/parameters.ts

@@ -1,5 +1,5 @@
 import { CustomerData } from '../../data/customers/Customer';
-import { PaginationParameters } from '../../types/parameters';
+import { PaginationParameters, ThrottlingParameters } from '../../types/parameters';
 import PickOptional from '../../types/PickOptional';
 
 interface ContextParameters {
@@ -12,6 +12,8 @@ export type GetParameters = ContextParameters;
 
 export type ListParameters = ContextParameters & PaginationParameters;
 
+export type IterateParameters = Omit<ListParameters, 'limit'> & ThrottlingParameters;
+
 export type UpdateParameters = ContextParameters & PickOptional<CustomerData, 'name' | 'email' | 'locale' | 'metadata'>;
 
 export type DeleteParameters = ContextParameters;

src/binders/customers/payments/CustomerPaymentsBinder.ts

@@ -7,7 +7,7 @@ import checkId from '../../../plumbing/checkId';
 import renege from '../../../plumbing/renege';
 import Callback from '../../../types/Callback';
 import InnerBinder from '../../InnerBinder';
-import { CreateParameters, ListParameters } from './parameters';
+import { CreateParameters, IterateParameters, ListParameters } from './parameters';
 
 function getPathSegments(customerId: string) {
   return `customers/${customerId}/payments`;
@@ -85,13 +85,13 @@ export default class CustomerPaymentsBinder extends InnerBinder<PaymentData, Pay
    * @since 3.6.0
    * @see https://docs.mollie.com/reference/v2/customers-api/list-customer-payments
    */
-  public iterate(parameters: Omit<ListParameters, 'limit'>) {
+  public iterate(parameters: IterateParameters) {
     // parameters ?? {} is used here, because in case withParent is used, parameters could be omitted.
     const customerId = this.getParentId((parameters ?? {}).customerId);
     if (!checkId(customerId, 'customer')) {
       throw new ApiError('The customer id is invalid');
     }
-    const { customerId: _, ...query } = parameters ?? {};
-    return this.networkClient.iterate<PaymentData, Payment>(getPathSegments(customerId), 'payments', query);
+    const { valuesPerMinute, customerId: _, ...query } = parameters ?? {};
+    return this.networkClient.iterate<PaymentData, Payment>(getPathSegments(customerId), 'payments', query, valuesPerMinute);
   }
 }

src/binders/customers/payments/parameters.ts

@@ -1,6 +1,6 @@
 import { PaymentMethod } from '../../../data/global';
 import { PaymentData } from '../../../data/payments/data';
-import { PaginationParameters } from '../../../types/parameters';
+import { PaginationParameters, ThrottlingParameters } from '../../../types/parameters';
 import PickOptional from '../../../types/PickOptional';
 
 interface ContextParameters {
@@ -25,3 +25,5 @@ export type CreateParameters = ContextParameters &
   };
 
 export type ListParameters = ContextParameters & PaginationParameters;
+
+export type IterateParameters = Omit<ListParameters, 'limit'> & ThrottlingParameters;

src/binders/customers/subscriptions/CustomerSubscriptionsBinder.ts

@@ -7,7 +7,7 @@ import checkId from '../../../plumbing/checkId';
 import renege from '../../../plumbing/renege';
 import Callback from '../../../types/Callback';
 import InnerBinder from '../../InnerBinder';
-import { CancelParameters, CreateParameters, GetParameters, ListParameters, UpdateParameters } from './parameters';
+import { CancelParameters, CreateParameters, GetParameters, IterateParameters, ListParameters, UpdateParameters } from './parameters';
 
 function getPathSegments(customerId: string) {
   return `customers/${customerId}/subscriptions`;
@@ -120,14 +120,14 @@ export default class CustomerSubscriptionsBinder extends InnerBinder<Subscriptio
    * @since 3.6.0
    * @see https://docs.mollie.com/reference/v2/subscriptions-api/list-subscriptions
    */
-  public iterate(parameters: ListParameters) {
+  public iterate(parameters: IterateParameters) {
     // parameters ?? {} is used here, because in case withParent is used, parameters could be omitted.
     const customerId = this.getParentId((parameters ?? {}).customerId);
     if (!checkId(customerId, 'customer')) {
       throw new ApiError('The customer id is invalid');
     }
-    const { customerId: _, ...query } = parameters ?? {};
-    return this.networkClient.iterate<SubscriptionData, Subscription>(getPathSegments(customerId), 'subscriptions', query);
+    const { valuesPerMinute, customerId: _, ...query } = parameters ?? {};
+    return this.networkClient.iterate<SubscriptionData, Subscription>(getPathSegments(customerId), 'subscriptions', query, valuesPerMinute);
   }
 
   /**

src/binders/customers/subscriptions/parameters.ts

@@ -1,5 +1,5 @@
 import { SubscriptionData } from '../../../data/subscription/data';
-import { PaginationParameters } from '../../../types/parameters';
+import { PaginationParameters, ThrottlingParameters } from '../../../types/parameters';
 import PickOptional from '../../../types/PickOptional';
 
 interface ContextParameters {
@@ -15,6 +15,8 @@ export type GetParameters = ContextParameters;
 
 export type ListParameters = ContextParameters & PaginationParameters;
 
+export type IterateParameters = Omit<ListParameters, 'limit'> & ThrottlingParameters;
+
 export type UpdateParameters = ContextParameters &
   Pick<SubscriptionData, 'mandateId'> &
   PickOptional<SubscriptionData, 'amount' | 'description' | 'interval' | 'metadata' | 'startDate' | 'times' | 'webhookUrl'>;

src/binders/orders/OrdersBinder.ts

@@ -7,7 +7,7 @@ import checkId from '../../plumbing/checkId';
 import renege from '../../plumbing/renege';
 import Callback from '../../types/Callback';
 import Binder from '../Binder';
-import { CancelParameters, CreateParameters, GetParameters, ListParameters, UpdateParameters } from './parameters';
+import { CancelParameters, CreateParameters, GetParameters, IterateParameters, ListParameters, UpdateParameters } from './parameters';
 
 export const pathSegment = 'orders';
 
@@ -141,8 +141,9 @@ export default class OrdersBinder extends Binder<OrderData, Order> {
    * @since 3.6.0
    * @see https://docs.mollie.com/reference/v2/orders-api/list-orders
    */
-  public iterate(parameters?: Omit<ListParameters, 'limit'>) {
-    return this.networkClient.iterate<OrderData, Order>(pathSegment, 'orders', parameters);
+  public iterate(parameters?: IterateParameters) {
+    const { valuesPerMinute, ...query } = parameters ?? {};
+    return this.networkClient.iterate<OrderData, Order>(pathSegment, 'orders', query, valuesPerMinute);
   }
 
   /**

src/binders/orders/parameters.ts

@@ -1,7 +1,7 @@
 import { PaymentMethod } from '../../data/global';
 import { OrderAddress, OrderData, OrderEmbed } from '../../data/orders/data';
 import { OrderLineData } from '../../data/orders/orderlines/OrderLine';
-import { PaginationParameters } from '../../types/parameters';
+import { PaginationParameters, ThrottlingParameters } from '../../types/parameters';
 import { CreateParameters as PaymentCreateParameters } from '../payments/parameters';
 import PickOptional from '../../types/PickOptional';
 
@@ -113,6 +113,8 @@ export type ListParameters = PaginationParameters & {
   testmode?: boolean;
 };
 
+export type IterateParameters = Omit<ListParameters, 'limit'> & ThrottlingParameters;
+
 export interface CancelParameters {
   testmode?: boolean;
 }

src/binders/paymentLinks/PaymentLinksBinder.ts

@@ -7,7 +7,7 @@ import checkId from '../../plumbing/checkId';
 import renege from '../../plumbing/renege';
 import Callback from '../../types/Callback';
 import Binder from '../Binder';
-import { CreateParameters, GetParameters, ListParameters } from './parameters';
+import { CreateParameters, GetParameters, IterateParameters, ListParameters } from './parameters';
 
 const pathSegment = 'payment-links';
 
@@ -67,7 +67,8 @@ export default class PaymentsLinksBinder extends Binder<PaymentLinkData, Payment
    * @since 3.6.0
    * @see https://docs.mollie.com/reference/v2/payment-links-api/get-payment-link
    */
-  public iterate(parameters?: Omit<ListParameters, 'limit'>) {
-    return this.networkClient.iterate<PaymentLinkData, PaymentLink>(pathSegment, 'payment_links', parameters);
+  public iterate(parameters?: IterateParameters) {
+    const { valuesPerMinute, ...query } = parameters ?? {};
+    return this.networkClient.iterate<PaymentLinkData, PaymentLink>(pathSegment, 'payment_links', query, valuesPerMinute);
   }
 }

src/binders/paymentLinks/parameters.ts

@@ -1,5 +1,5 @@
 import { PaymentLinkData } from '../../data/paymentLink/data';
-import { PaginationParameters } from '../../types/parameters';
+import { PaginationParameters, ThrottlingParameters } from '../../types/parameters';
 
 export type CreateParameters = Pick<PaymentLinkData, 'description' | 'amount' | 'redirectUrl' | 'webhookUrl' | 'expiresAt'> & {
   profileId?: string;
@@ -14,3 +14,5 @@ export type ListParameters = PaginationParameters & {
   profileId?: string;
   testmode?: boolean;
 };
+
+export type IterateParameters = Omit<ListParameters, 'limit'> & ThrottlingParameters;

src/binders/payments/PaymentsBinder.ts

@@ -7,7 +7,7 @@ import checkId from '../../plumbing/checkId';
 import renege from '../../plumbing/renege';
 import Callback from '../../types/Callback';
 import Binder from '../Binder';
-import { CancelParameters, CreateParameters, GetParameters, ListParameters, UpdateParameters } from './parameters';
+import { CancelParameters, CreateParameters, GetParameters, IterateParameters, ListParameters, UpdateParameters } from './parameters';
 
 const pathSegment = 'payments';
 
@@ -106,8 +106,9 @@ export default class PaymentsBinder extends Binder<PaymentData, Payment> {
    * @since 3.6.0
    * @see https://docs.mollie.com/reference/v2/payments-api/list-payments
    */
-  public iterate(parameters?: Omit<ListParameters, 'limit'>) {
-    return this.networkClient.iterate<PaymentData, Payment>(pathSegment, 'payments', parameters);
+  public iterate(parameters?: IterateParameters) {
+    const { valuesPerMinute, ...query } = parameters ?? {};
+    return this.networkClient.iterate<PaymentData, Payment>(pathSegment, 'payments', query, valuesPerMinute);
   }
 
   /**

src/binders/payments/captures/PaymentCapturesBinder.ts

@@ -7,7 +7,7 @@ import checkId from '../../../plumbing/checkId';
 import renege from '../../../plumbing/renege';
 import Callback from '../../../types/Callback';
 import InnerBinder from '../../InnerBinder';
-import { GetParameters, ListParameters } from './parameters';
+import { GetParameters, IterateParameters, ListParameters } from './parameters';
 
 function getPathSegments(paymentId: string) {
   return `payments/${paymentId}/captures`;
@@ -97,13 +97,13 @@ export default class PaymentCapturesBinder extends InnerBinder<CaptureData, Capt
    * @since 3.6.0
    * @see https://docs.mollie.com/reference/v2/captures-api/list-captures
    */
-  public iterate(parameters: Omit<ListParameters, 'limit'>) {
+  public iterate(parameters: IterateParameters) {
     // parameters ?? {} is used here, because in case withParent is used, parameters could be omitted.
     const paymentId = this.getParentId((parameters ?? {}).paymentId);
     if (!checkId(paymentId, 'payment')) {
       throw new ApiError('The payment id is invalid');
     }
-    const { paymentId: _, ...query } = parameters;
-    return this.networkClient.iterate<CaptureData, Capture>(getPathSegments(paymentId), 'captures', query);
+    const { valuesPerMinute, paymentId: _, ...query } = parameters ?? {};
+    return this.networkClient.iterate<CaptureData, Capture>(getPathSegments(paymentId), 'captures', query, valuesPerMinute);
   }
 }

src/binders/payments/captures/parameters.ts

@@ -1,5 +1,5 @@
 import { CaptureEmbed } from '../../../data/payments/captures/data';
-import { PaginationParameters } from '../../../types/parameters';
+import { PaginationParameters, ThrottlingParameters } from '../../../types/parameters';
 
 interface ContextParameters {
   paymentId: string;
@@ -14,3 +14,5 @@ export type ListParameters = ContextParameters &
   PaginationParameters & {
     embed?: CaptureEmbed[];
   };
+
+export type IterateParameters = Omit<ListParameters, 'limit'> & ThrottlingParameters;

src/binders/payments/chargebacks/PaymentChargebacksBinder.ts

@@ -6,7 +6,7 @@ import checkId from '../../../plumbing/checkId';
 import renege from '../../../plumbing/renege';
 import Callback from '../../../types/Callback';
 import InnerBinder from '../../InnerBinder';
-import { GetParameters, ListParameters } from './parameters';
+import { GetParameters, IterateParameters, ListParameters } from './parameters';
 
 function getPathSegments(paymentId: string) {
   return `payments/${paymentId}/chargebacks`;
@@ -91,13 +91,13 @@ export default class PaymentChargebacksBinder extends InnerBinder<ChargebackData
    * @since 3.6.0
    * @see https://docs.mollie.com/reference/v2/chargebacks-api/list-chargebacks
    */
-  public iterate(parameters: Omit<ListParameters, 'limit'>) {
+  public iterate(parameters: IterateParameters) {
     // parameters ?? {} is used here, because in case withParent is used, parameters could be omitted.
     const paymentId = this.getParentId((parameters ?? {}).paymentId);
     if (!checkId(paymentId, 'payment')) {
       throw new ApiError('The payment id is invalid');
     }
-    const { paymentId: _, ...query } = parameters;
-    return this.networkClient.iterate<ChargebackData, Chargeback>(getPathSegments(paymentId), 'chargebacks', query);
+    const { valuesPerMinute, paymentId: _, ...query } = parameters ?? {};
+    return this.networkClient.iterate<ChargebackData, Chargeback>(getPathSegments(paymentId), 'chargebacks', query, valuesPerMinute);
   }
 }

src/binders/payments/chargebacks/parameters.ts

@@ -1,5 +1,5 @@
 import { ChargebackEmbed } from '../../../data/chargebacks/Chargeback';
-import { PaginationParameters } from '../../../types/parameters';
+import { PaginationParameters, ThrottlingParameters } from '../../../types/parameters';
 
 interface ContextParameters {
   paymentId: string;
@@ -13,3 +13,5 @@ export type ListParameters = ContextParameters &
   PaginationParameters & {
     embed?: ChargebackEmbed[];
   };
+
+export type IterateParameters = Omit<ListParameters, 'limit'> & ThrottlingParameters;

src/binders/payments/parameters.ts

@@ -1,7 +1,7 @@
 import { Address, Amount, PaymentMethod } from '../../data/global';
 import { Issuer } from '../../data/Issuer';
 import { PaymentData, PaymentEmbed, PaymentInclude } from '../../data/payments/data';
-import { PaginationParameters } from '../../types/parameters';
+import { PaginationParameters, ThrottlingParameters } from '../../types/parameters';
 import PickOptional from '../../types/PickOptional';
 
 export type CreateParameters = Pick<PaymentData, 'amount' | 'description' | 'redirectUrl' | 'webhookUrl' | 'customerId' | 'mandateId'> &
@@ -170,6 +170,8 @@ export type ListParameters = PaginationParameters & {
   testmode?: boolean;
 };
 
+export type IterateParameters = Omit<ListParameters, 'limit'> & ThrottlingParameters;
+
 export type UpdateParameters = Pick<PaymentData, 'redirectUrl' | 'webhookUrl'> &
   PickOptional<PaymentData, 'description' | 'metadata'> & {
     /**