Skip to content

Commit b1e84f3

Browse files
files-opensource-botfiles-opensource-bot
committed
[Bot] push changes from Files.com
1 parent a897576 commit b1e84f3

38 files changed

Lines changed: 5037 additions & 148 deletions

‎_VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.2.628
1+
1.2.629

‎docs/models/EventChannel.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# EventChannel
2+
3+
## Example EventChannel Object
4+
5+
```
6+
{
7+
"id": 1,
8+
"name": "example",
9+
"description": "example",
10+
"enabled": true,
11+
"default_channel": true,
12+
"created_at": "2000-01-01T01:00:00Z",
13+
"updated_at": "2000-01-01T01:00:00Z"
14+
}
15+
```
16+
17+
* `id` (int64): Event Channel ID
18+
* `name` (string): Event Channel name.
19+
* `description` (string): Event Channel description.
20+
* `enabled` (boolean): Whether this Event Channel can dispatch events.
21+
* `default_channel` (boolean): Whether this Event Channel is the default destination for newly published events.
22+
* `created_at` (date-time): Event Channel create date/time.
23+
* `updated_at` (date-time): Event Channel update date/time.
24+
25+
---
26+
27+
## List Event Channels
28+
29+
```
30+
await EventChannel.list
31+
```
32+
33+
34+
### Parameters
35+
36+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
37+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `enabled` and `default_channel`.
39+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled` and `default_channel`.
40+
41+
---
42+
43+
## Show Event Channel
44+
45+
```
46+
await EventChannel.find(id)
47+
```
48+
49+
50+
### Parameters
51+
52+
* `id` (int64): Required - Event Channel ID.
53+
54+
---
55+
56+
## Create Event Channel
57+
58+
```
59+
await EventChannel.create({
60+
'name': "example",
61+
'description': "example",
62+
'enabled': true,
63+
'default_channel': true,
64+
})
65+
```
66+
67+
68+
### Parameters
69+
70+
* `name` (string): Required - Event Channel name.
71+
* `description` (string): Event Channel description.
72+
* `enabled` (boolean): Whether this Event Channel can dispatch events.
73+
* `default_channel` (boolean): Whether this Event Channel is the default destination for newly published events.
74+
75+
---
76+
77+
## Update Event Channel
78+
79+
```
80+
const event_channel = await EventChannel.find(id)
81+
82+
await event_channel.update({
83+
'name': "example",
84+
'description': "example",
85+
'enabled': true,
86+
'default_channel': true,
87+
})
88+
```
89+
90+
### Parameters
91+
92+
* `id` (int64): Required - Event Channel ID.
93+
* `name` (string): Event Channel name.
94+
* `description` (string): Event Channel description.
95+
* `enabled` (boolean): Whether this Event Channel can dispatch events.
96+
* `default_channel` (boolean): Whether this Event Channel is the default destination for newly published events.
97+
98+
### Example Response
99+
100+
```json
101+
{
102+
"id": 1,
103+
"name": "example",
104+
"description": "example",
105+
"enabled": true,
106+
"default_channel": true,
107+
"created_at": "2000-01-01T01:00:00Z",
108+
"updated_at": "2000-01-01T01:00:00Z"
109+
}
110+
```
111+
112+
---
113+
114+
## Delete Event Channel
115+
116+
```
117+
const event_channel = await EventChannel.find(id)
118+
119+
await event_channel.delete()
120+
```
121+
122+
### Parameters
123+
124+
* `id` (int64): Required - Event Channel ID.
125+

‎docs/models/EventDeliveryAttempt.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# EventDeliveryAttempt
2+
3+
## Example EventDeliveryAttempt Object
4+
5+
```
6+
{
7+
"id": 1,
8+
"event_record_id": 1,
9+
"event_subscription_id": 1,
10+
"event_target_id": 1,
11+
"workspace_id": 1,
12+
"status": "example",
13+
"attempt_number": 1,
14+
"response_code": 1,
15+
"error_message": "example",
16+
"response_body": "example",
17+
"latency_ms": 1,
18+
"delivered_at": "2000-01-01T01:00:00Z",
19+
"last_attempted_at": "2000-01-01T01:00:00Z",
20+
"next_attempt_at": "2000-01-01T01:00:00Z",
21+
"created_at": "2000-01-01T01:00:00Z"
22+
}
23+
```
24+
25+
* `id` (int64): Event Delivery Attempt ID
26+
* `event_record_id` (int64): Event Record ID
27+
* `event_subscription_id` (int64): Event Subscription ID
28+
* `event_target_id` (int64): Event Target ID
29+
* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
30+
* `status` (string): Delivery status.
31+
* `attempt_number` (int64): Number of delivery attempts made.
32+
* `response_code` (int64): HTTP response code, if applicable.
33+
* `error_message` (string): Delivery error message, if applicable.
34+
* `response_body` (string): Delivery response body, if applicable.
35+
* `latency_ms` (int64): Delivery latency in milliseconds.
36+
* `delivered_at` (date-time): Successful delivery date/time.
37+
* `last_attempted_at` (date-time): Most recent attempt date/time.
38+
* `next_attempt_at` (date-time): Next scheduled attempt date/time.
39+
* `created_at` (date-time): Delivery Attempt create date/time.
40+
41+
---
42+
43+
## List Event Delivery Attempts
44+
45+
```
46+
await EventDeliveryAttempt.list
47+
```
48+
49+
50+
### Parameters
51+
52+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
53+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
54+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `status`, `event_record_id`, `event_target_id` or `workspace_id`.
55+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id`, `event_record_id` or `event_target_id`. Valid field combinations are `[ workspace_id, status ]`, `[ workspace_id, event_record_id ]` or `[ workspace_id, event_target_id ]`.
56+
57+
---
58+
59+
## Show Event Delivery Attempt
60+
61+
```
62+
await EventDeliveryAttempt.find(id)
63+
```
64+
65+
66+
### Parameters
67+
68+
* `id` (int64): Required - Event Delivery Attempt ID.

‎docs/models/EventRecord.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# EventRecord
2+
3+
## Example EventRecord Object
4+
5+
```
6+
{
7+
"id": 1,
8+
"workspace_id": 1,
9+
"event_uuid": "example",
10+
"event_type": "example",
11+
"severity": "example",
12+
"source_type": "example",
13+
"source_id": 1,
14+
"occurred_at": "2000-01-01T01:00:00Z",
15+
"human_title": "example",
16+
"human_summary": "example",
17+
"human_fields": [
18+
"example"
19+
],
20+
"actor": "example",
21+
"resources": [
22+
"example"
23+
],
24+
"payload": "example",
25+
"created_at": "2000-01-01T01:00:00Z"
26+
}
27+
```
28+
29+
* `id` (int64): Event Record ID
30+
* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
31+
* `event_uuid` (string): Stable event UUID.
32+
* `event_type` (string): Versioned event type string.
33+
* `severity` (string): Event severity.
34+
* `source_type` (string): Source record type.
35+
* `source_id` (int64): Source record ID.
36+
* `occurred_at` (date-time): Event occurrence date/time.
37+
* `human_title` (string): Human-readable event title.
38+
* `human_summary` (string): Human-readable event summary.
39+
* `human_fields` (array(object)): Human-readable event detail fields.
40+
* `actor` (object): Actor associated with the event.
41+
* `resources` (array(object)): Resources associated with the event.
42+
* `payload` (object): Event payload.
43+
* `created_at` (date-time): Event Record create date/time.
44+
45+
---
46+
47+
## List Event Records
48+
49+
```
50+
await EventRecord.list
51+
```
52+
53+
54+
### Parameters
55+
56+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
57+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `event_type`, `created_at` or `workspace_id`.
59+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type` or `workspace_id`. Valid field combinations are `[ event_type, created_at ]`, `[ workspace_id, created_at ]`, `[ workspace_id, event_type ]` or `[ workspace_id, event_type, created_at ]`.
60+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
61+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
62+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `event_type`.
63+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
64+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
65+
66+
---
67+
68+
## Show Event Record
69+
70+
```
71+
await EventRecord.find(id)
72+
```
73+
74+
75+
### Parameters
76+
77+
* `id` (int64): Required - Event Record ID.

0 commit comments

Comments
 (0)