apify-client 0.4.1

An official, but experimental, AI-generated and AI-maintained Rust client for the Apify API (https://apify.com).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# Webhooks and dispatches

Obtained via `client.webhooks()` / `client.webhook(id)` and
`client.webhook_dispatches()` / `client.webhook_dispatch(id)`. Actor- and task-scoped
webhook collections are available via `actor.webhooks()` and `task.webhooks()`.

## `WebhookCollectionClient`

| Method | Arguments | Returns | Description |
|---|---|---|---|
| `list(options)` | `ListOptions` | `PaginationList<Webhook>` | Lists webhooks. |
| `create(webhook)` | `&impl Serialize` | `Webhook` | Creates a webhook. |

## `WebhookClient`

| Method | Arguments | Returns | Description |
|---|---|---|---|
| `get()` | — | `Option<Webhook>` | Fetches the webhook. |
| `update(fields)` | `&impl Serialize` | `Webhook` | Updates the webhook. |
| `delete()` | — | `()` | Deletes the webhook. |
| `test()` | — | `WebhookDispatch` | Triggers a test dispatch. |
| `dispatches()` | — | `WebhookDispatchCollectionClient` | This webhook's dispatches. |

## Webhook dispatches

`WebhookDispatchCollectionClient`: `list(options)`.
`WebhookDispatchClient`: `get()`.

## The `Webhook` model

Returned by `get`, `create`, `update`, `test` (via the resulting dispatch's `webhook_id`) and
(as `PaginationList<Webhook>`) by `list`. Unknown fields returned by the API are preserved in
`extra`.

| Field | Type | Description |
|---|---|---|
| `id` | `String` | Unique webhook ID (always present); used to build a `client.webhook(&webhook.id)` client. |
| `user_id` | `Option<String>` | ID of the user who owns the webhook. |
| `request_url` | `Option<String>` | The URL that receives the webhook POST request. |
| `event_types` | `Vec<String>` | Event types that trigger this webhook (e.g. `ACTOR.RUN.SUCCEEDED`). |
| `extra` | `Extra` | Any other fields returned by the API (e.g. `condition`, `isAdHoc`, `payloadTemplate`). |

## The `WebhookDispatch` model

Returned by `WebhookClient::test`, `WebhookDispatchClient::get`, and (as
`PaginationList<WebhookDispatch>`) by `WebhookDispatchCollectionClient::list`. Unknown fields
returned by the API are preserved in `extra`.

| Field | Type | Description |
|---|---|---|
| `id` | `String` | Unique dispatch ID (always present). |
| `webhook_id` | `Option<String>` | ID of the webhook that produced this dispatch. |
| `extra` | `Extra` | Any other fields returned by the API (e.g. `status`, `attempts`, `eventType`). |