files.com 1.1.621 → 1.1.623

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb86e99a91ed94affab09f8054be848e7e490c25eebbf6467bb204a00586b1db
-  data.tar.gz: 1bfff0ba5b6afa49059bc33f9afa74b5e8eaf2fd2c8f32d679071f3893852894
+  metadata.gz: da9684b774fab5eedcdc1d418b70c1400f36d2d8b23c29f665103a62921dc37a
+  data.tar.gz: 6d44874b087627b5bd185fdc1bde86ba795d6fc85952c5b1cd2a27d5c3e61402
 SHA512:
-  metadata.gz: 03fe08b3bdb8f311961eb404adf0ac8b39ae6143d009a48c7dbbb1c2449a4d1fe15eed523e858c2c7de12318bc09a45cd832be3cf1ae43e94c2309392147e908
-  data.tar.gz: 1529d62c92c75b12f9008f394f46d0f105bb5927353920e2144f2afb7ef4108ffd5a48cc3d15942737c3d6a7678387772bd4972e25a3dd73cbe57a861b6637e0
+  metadata.gz: a8ad17c3f37e006bf7ab08722d22ceaf1220049f7999dd4e87b0dc7f755046601cd7cc1a981de15aba0232a0ad9a47af62103a24148da93eaf3f49ced140cf2a
+  data.tar.gz: e495a099ebc37896d07d85b0f074f07dd5edd69f40c1a097f8e879ab64a5d4b72817f5c234780c568a7151d140b83edc808b9788bc06c2549b1630e80b7edc80

data/_VERSION

@@ -1 +1 @@
-1.1.621
+1.1.623

data/docs/event_channel.md

@@ -0,0 +1,147 @@
+# EventChannel
+
+## Example EventChannel Object
+
+```
+{
+  "id": 1,
+  "name": "example",
+  "description": "example",
+  "enabled": true,
+  "default_channel": true,
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Event Channel ID
+* `name` (string): Event Channel name.
+* `description` (string): Event Channel description.
+* `enabled` (boolean): Whether this Event Channel can dispatch events.
+* `default_channel` (boolean): Whether this Event Channel is the default destination for newly published events.
+* `created_at` (date-time): Event Channel create date/time.
+* `updated_at` (date-time): Event Channel update date/time.
+
+
+---
+
+## List Event Channels
+
+```
+Files::EventChannel.list
+```
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `enabled` and `default_channel`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled` and `default_channel`.
+
+
+---
+
+## Show Event Channel
+
+```
+Files::EventChannel.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Channel ID.
+
+
+---
+
+## Create Event Channel
+
+```
+Files::EventChannel.create(
+  name: "example", 
+  description: "example", 
+  enabled: true, 
+  default_channel: true
+)
+```
+
+### Parameters
+
+* `name` (string): Required - Event Channel name.
+* `description` (string): Event Channel description.
+* `enabled` (boolean): Whether this Event Channel can dispatch events.
+* `default_channel` (boolean): Whether this Event Channel is the default destination for newly published events.
+
+
+---
+
+## Update Event Channel
+
+```
+Files::EventChannel.update(id, 
+  name: "example", 
+  description: "example", 
+  enabled: true, 
+  default_channel: true
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Channel ID.
+* `name` (string): Event Channel name.
+* `description` (string): Event Channel description.
+* `enabled` (boolean): Whether this Event Channel can dispatch events.
+* `default_channel` (boolean): Whether this Event Channel is the default destination for newly published events.
+
+
+---
+
+## Delete Event Channel
+
+```
+Files::EventChannel.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Channel ID.
+
+
+---
+
+## Update Event Channel
+
+```
+event_channel = Files::EventChannel.find(id)
+
+event_channel.update(
+  name: "example",
+  description: "example",
+  enabled: true,
+  default_channel: true
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Channel ID.
+* `name` (string): Event Channel name.
+* `description` (string): Event Channel description.
+* `enabled` (boolean): Whether this Event Channel can dispatch events.
+* `default_channel` (boolean): Whether this Event Channel is the default destination for newly published events.
+
+
+---
+
+## Delete Event Channel
+
+```
+event_channel = Files::EventChannel.find(id)
+
+event_channel.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Channel ID.

data/docs/event_delivery_attempt.md

@@ -0,0 +1,68 @@
+# EventDeliveryAttempt
+
+## Example EventDeliveryAttempt Object
+
+```
+{
+  "id": 1,
+  "event_record_id": 1,
+  "event_subscription_id": 1,
+  "event_target_id": 1,
+  "workspace_id": 1,
+  "status": "example",
+  "attempt_number": 1,
+  "response_code": 1,
+  "error_message": "example",
+  "response_body": "example",
+  "latency_ms": 1,
+  "delivered_at": "2000-01-01T01:00:00Z",
+  "last_attempted_at": "2000-01-01T01:00:00Z",
+  "next_attempt_at": "2000-01-01T01:00:00Z",
+  "created_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Event Delivery Attempt ID
+* `event_record_id` (int64): Event Record ID
+* `event_subscription_id` (int64): Event Subscription ID
+* `event_target_id` (int64): Event Target ID
+* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
+* `status` (string): Delivery status.
+* `attempt_number` (int64): Number of delivery attempts made.
+* `response_code` (int64): HTTP response code, if applicable.
+* `error_message` (string): Delivery error message, if applicable.
+* `response_body` (string): Delivery response body, if applicable.
+* `latency_ms` (int64): Delivery latency in milliseconds.
+* `delivered_at` (date-time): Successful delivery date/time.
+* `last_attempted_at` (date-time): Most recent attempt date/time.
+* `next_attempt_at` (date-time): Next scheduled attempt date/time.
+* `created_at` (date-time): Delivery Attempt create date/time.
+
+
+---
+
+## List Event Delivery Attempts
+
+```
+Files::EventDeliveryAttempt.list
+```
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `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`.
+* `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 ]`.
+
+
+---
+
+## Show Event Delivery Attempt
+
+```
+Files::EventDeliveryAttempt.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Delivery Attempt ID.

data/docs/event_record.md

@@ -0,0 +1,77 @@
+# EventRecord
+
+## Example EventRecord Object
+
+```
+{
+  "id": 1,
+  "workspace_id": 1,
+  "event_uuid": "example",
+  "event_type": "example",
+  "severity": "example",
+  "source_type": "example",
+  "source_id": 1,
+  "occurred_at": "2000-01-01T01:00:00Z",
+  "human_title": "example",
+  "human_summary": "example",
+  "human_fields": [
+    "example"
+  ],
+  "actor": "example",
+  "resources": [
+    "example"
+  ],
+  "payload": "example",
+  "created_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Event Record ID
+* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
+* `event_uuid` (string): Stable event UUID.
+* `event_type` (string): Versioned event type string.
+* `severity` (string): Event severity.
+* `source_type` (string): Source record type.
+* `source_id` (int64): Source record ID.
+* `occurred_at` (date-time): Event occurrence date/time.
+* `human_title` (string): Human-readable event title.
+* `human_summary` (string): Human-readable event summary.
+* `human_fields` (array(object)): Human-readable event detail fields.
+* `actor` (object): Actor associated with the event.
+* `resources` (array(object)): Resources associated with the event.
+* `payload` (object): Event payload.
+* `created_at` (date-time): Event Record create date/time.
+
+
+---
+
+## List Event Records
+
+```
+Files::EventRecord.list
+```
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `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`.
+* `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 ]`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
+* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `event_type`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
+
+
+---
+
+## Show Event Record
+
+```
+Files::EventRecord.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Record ID.

data/docs/event_subscription.md

@@ -0,0 +1,188 @@
+# EventSubscription
+
+## Example EventSubscription Object
+
+```
+{
+  "id": 1,
+  "event_channel_id": 1,
+  "workspace_id": 1,
+  "apply_to_all_workspaces": true,
+  "name": "example",
+  "enabled": true,
+  "event_types": [
+    "example"
+  ],
+  "filter": "example",
+  "delivery_policy": "example",
+  "event_target_ids": [
+    1
+  ],
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Event Subscription ID
+* `event_channel_id` (int64): Event Channel ID
+* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
+* `apply_to_all_workspaces` (boolean): If true, this default-workspace subscription applies to events from all workspaces.
+* `name` (string): Event Subscription name.
+* `enabled` (boolean): Whether this Event Subscription can dispatch events.
+* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types.
+* `filter` (object): Structured event payload filter.
+* `delivery_policy` (object): Event Subscription delivery policy.
+* `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
+* `created_at` (date-time): Event Subscription create date/time.
+* `updated_at` (date-time): Event Subscription update date/time.
+
+
+---
+
+## List Event Subscriptions
+
+```
+Files::EventSubscription.list
+```
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `enabled`, `event_channel_id` or `workspace_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled`, `event_channel_id` or `workspace_id`. Valid field combinations are `[ enabled, event_channel_id ]`, `[ workspace_id, enabled ]` or `[ workspace_id, enabled, event_channel_id ]`.
+
+
+---
+
+## Show Event Subscription
+
+```
+Files::EventSubscription.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Subscription ID.
+
+
+---
+
+## Create Event Subscription
+
+```
+Files::EventSubscription.create(
+  event_channel_id: 1, 
+  workspace_id: 1, 
+  apply_to_all_workspaces: true, 
+  name: "example", 
+  enabled: true, 
+  event_types: ["example"], 
+  delivery_policy: "example", 
+  event_target_ids: [1]
+)
+```
+
+### Parameters
+
+* `event_channel_id` (int64): Event Channel ID
+* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
+* `apply_to_all_workspaces` (boolean): If true, this default-workspace subscription applies to events from all workspaces.
+* `name` (string): Required - Event Subscription name.
+* `enabled` (boolean): Whether this Event Subscription can dispatch events.
+* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types.
+* `filter` (object): Structured event payload filter.
+* `delivery_policy` (object): Event Subscription delivery policy.
+* `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
+
+
+---
+
+## Update Event Subscription
+
+```
+Files::EventSubscription.update(id, 
+  event_channel_id: 1, 
+  workspace_id: 1, 
+  apply_to_all_workspaces: true, 
+  name: "example", 
+  enabled: true, 
+  event_types: ["example"], 
+  delivery_policy: "example", 
+  event_target_ids: [1]
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Subscription ID.
+* `event_channel_id` (int64): Event Channel ID
+* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
+* `apply_to_all_workspaces` (boolean): If true, this default-workspace subscription applies to events from all workspaces.
+* `name` (string): Event Subscription name.
+* `enabled` (boolean): Whether this Event Subscription can dispatch events.
+* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types.
+* `filter` (object): Structured event payload filter.
+* `delivery_policy` (object): Event Subscription delivery policy.
+* `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
+
+
+---
+
+## Delete Event Subscription
+
+```
+Files::EventSubscription.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Subscription ID.
+
+
+---
+
+## Update Event Subscription
+
+```
+event_subscription = Files::EventSubscription.find(id)
+
+event_subscription.update(
+  event_channel_id: 1,
+  workspace_id: 1,
+  apply_to_all_workspaces: true,
+  name: "example",
+  enabled: true,
+  event_types: ["example"],
+  delivery_policy: "example",
+  event_target_ids: [1]
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Subscription ID.
+* `event_channel_id` (int64): Event Channel ID
+* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
+* `apply_to_all_workspaces` (boolean): If true, this default-workspace subscription applies to events from all workspaces.
+* `name` (string): Event Subscription name.
+* `enabled` (boolean): Whether this Event Subscription can dispatch events.
+* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types.
+* `filter` (object): Structured event payload filter.
+* `delivery_policy` (object): Event Subscription delivery policy.
+* `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
+
+
+---
+
+## Delete Event Subscription
+
+```
+event_subscription = Files::EventSubscription.find(id)
+
+event_subscription.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Subscription ID.

data/docs/event_target.md

@@ -0,0 +1,171 @@
+# EventTarget
+
+## Example EventTarget Object
+
+```
+{
+  "id": 1,
+  "name": "example",
+  "target_type": "example",
+  "workspace_id": 1,
+  "apply_to_all_workspaces": true,
+  "enabled": true,
+  "config": "example",
+  "delivery_policy": "example",
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Event Target ID
+* `name` (string): Event Target name.
+* `target_type` (string): Event Target type.
+* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
+* `apply_to_all_workspaces` (boolean): If true, this default-workspace target can receive events from all workspaces.
+* `enabled` (boolean): Whether this Event Target can receive events.
+* `config` (object): Event Target configuration.
+* `delivery_policy` (object): Event Target delivery policy. Email targets support batch_interval in seconds, between 600 and 86400.
+* `created_at` (date-time): Event Target create date/time.
+* `updated_at` (date-time): Event Target update date/time.
+
+
+---
+
+## List Event Targets
+
+```
+Files::EventTarget.list
+```
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `enabled` and `workspace_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled`, `target_type` or `workspace_id`. Valid field combinations are `[ enabled, target_type ]`, `[ workspace_id, enabled ]` or `[ workspace_id, enabled, target_type ]`.
+
+
+---
+
+## Show Event Target
+
+```
+Files::EventTarget.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Target ID.
+
+
+---
+
+## Create Event Target
+
+```
+Files::EventTarget.create(
+  name: "example", 
+  workspace_id: 1, 
+  apply_to_all_workspaces: true, 
+  target_type: "example", 
+  enabled: true, 
+  config: "example", 
+  delivery_policy: "example"
+)
+```
+
+### Parameters
+
+* `name` (string): Required - Event Target name.
+* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
+* `apply_to_all_workspaces` (boolean): If true, this default-workspace target can receive events from all workspaces.
+* `target_type` (string): Required - Event Target type.
+* `enabled` (boolean): Whether this Event Target can receive events.
+* `config` (object): Required - Event Target configuration.
+* `delivery_policy` (object): Event Target delivery policy. Email targets support batch_interval in seconds, between 600 and 86400.
+
+
+---
+
+## Update Event Target
+
+```
+Files::EventTarget.update(id, 
+  name: "example", 
+  workspace_id: 1, 
+  apply_to_all_workspaces: true, 
+  target_type: "example", 
+  enabled: true, 
+  config: "example", 
+  delivery_policy: "example"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Target ID.
+* `name` (string): Event Target name.
+* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
+* `apply_to_all_workspaces` (boolean): If true, this default-workspace target can receive events from all workspaces.
+* `target_type` (string): Event Target type.
+* `enabled` (boolean): Whether this Event Target can receive events.
+* `config` (object): Event Target configuration.
+* `delivery_policy` (object): Event Target delivery policy. Email targets support batch_interval in seconds, between 600 and 86400.
+
+
+---
+
+## Delete Event Target
+
+```
+Files::EventTarget.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Target ID.
+
+
+---
+
+## Update Event Target
+
+```
+event_target = Files::EventTarget.find(id)
+
+event_target.update(
+  name: "example",
+  workspace_id: 1,
+  apply_to_all_workspaces: true,
+  target_type: "example",
+  enabled: true,
+  config: "example",
+  delivery_policy: "example"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Target ID.
+* `name` (string): Event Target name.
+* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
+* `apply_to_all_workspaces` (boolean): If true, this default-workspace target can receive events from all workspaces.
+* `target_type` (string): Event Target type.
+* `enabled` (boolean): Whether this Event Target can receive events.
+* `config` (object): Event Target configuration.
+* `delivery_policy` (object): Event Target delivery policy. Email targets support batch_interval in seconds, between 600 and 86400.
+
+
+---
+
+## Delete Event Target
+
+```
+event_target = Files::EventTarget.find(id)
+
+event_target.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Event Target ID.