apify-client
Version:
Apify API client for JavaScript
53 lines • 2.06 kB
TypeScript
import type { ApiClientSubResourceOptions } from '../base/api_client';
import { ResourceCollectionClient } from '../base/resource_collection_client';
import type { PaginatedIterator, PaginationOptions } from '../utils';
import type { WebhookDispatch } from './webhook_dispatch';
/**
* Client for managing the collection of webhook dispatches.
*
* Webhook dispatches represent individual notifications sent by a webhook. This client provides
* methods to list all dispatches for a specific webhook.
*
* @example
* ```javascript
* const client = new ApifyClient({ token: 'my-token' });
* const webhookClient = client.webhook('my-webhook-id');
*
* // List all dispatches for this webhook
* const dispatchesClient = webhookClient.dispatches();
* const { items } = await dispatchesClient.list();
* ```
*
* @see https://docs.apify.com/platform/integrations/webhooks
*/
export declare class WebhookDispatchCollectionClient extends ResourceCollectionClient {
/**
* @hidden
*/
constructor(options: ApiClientSubResourceOptions);
/**
* Lists all webhook dispatches.
*
* Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
* items in a single API call is limited.
* ```javascript
* const paginatedList = await client.list(options);
* ```
*
* Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
* retrieved.
*
* ```javascript
* for await (const singleItem of client.list(options)) {...}
* ```
*
* @param options - Pagination and sorting options.
* @returns A paginated iterator of webhook dispatches.
* @see https://docs.apify.com/api/v2/webhook-dispatches-get
*/
list(options?: WebhookDispatchCollectionListOptions): PaginatedIterator<WebhookDispatch>;
}
export interface WebhookDispatchCollectionListOptions extends PaginationOptions {
desc?: boolean;
}
//# sourceMappingURL=webhook_dispatch_collection.d.ts.map