files.com 1.1.584 → 1.1.586

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 399d304d2c98204d465ad03d72e5df9f3ebdbea359f3e55bde756c686e98c166
-  data.tar.gz: 28069a5212effbe750041db772a33aa781c4562b1f2d93a75a8cbdf1e94df5f5
+  metadata.gz: 7381871a12348fc7bc7c94188042ec8de9229d5738feabd920e45609b09f9177
+  data.tar.gz: 054a63d35f2e9ef3e577b7d0ee34b1d1cdf897a124c5dbe9cce484381f3ba57a
 SHA512:
-  metadata.gz: 0ec58f19be8e362d73afd6f28f26cfba5f85b8e20fcdff683716dc7570aff0fc819b99e545978b6d89f90bbd65aabaa4856536f6f299f364d69109be96a44c85
-  data.tar.gz: 1fbd7ea5d2608d4695f82f25222ecc9db74153927ef700cdad51b0fa906ef79f7e1d3c4064ea9b20e9d8b565894cbd46c2b334f3879f70c07592c33ff9d0acd8
+  metadata.gz: 9f6fc64d2b72989574c192e74976bd3432ffc3d21b911d73d4061a0926a7ba2c16fc7ec35adbb8acae831d0d578b2eae134156f1788e11d18459d9f4ef05b216
+  data.tar.gz: f5eabdd14a03394c0ea5955e14a7d85a0fb5fd1b63e4ba4ac173ade4e56cbb7e3225e08936f81a734220a54343657b8c292448730809d2425d4e7295e346fff2

data/README.md

@@ -605,6 +605,8 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`DestinationParentConflictError`|  `ProcessingFailureError` |
 |`DestinationParentDoesNotExistError`|  `ProcessingFailureError` |
 |`ExceededRuntimeLimitError`|  `ProcessingFailureError` |
+|`ExpectationAlreadyHasOpenWindowError`|  `ProcessingFailureError` |
+|`ExpectationNotManualTriggerError`|  `ProcessingFailureError` |
 |`ExpiredPrivateKeyError`|  `ProcessingFailureError` |
 |`ExpiredPublicKeyError`|  `ProcessingFailureError` |
 |`ExportFailureError`|  `ProcessingFailureError` |

data/_VERSION

@@ -1 +1 @@
-1.1.584
+1.1.586

data/docs/expectation.md

@@ -0,0 +1,318 @@
+# Expectation
+
+## Example Expectation Object
+
+```
+{
+  "id": 1,
+  "workspace_id": 1,
+  "name": "Daily Vendor Feed",
+  "description": "Wait for the vendor CSV every morning.",
+  "path": "incoming/vendor_a",
+  "source": "*.csv",
+  "exclude_pattern": "*.tmp",
+  "disabled": true,
+  "expectations_version": 1,
+  "trigger": "manual",
+  "interval": "day",
+  "recurring_day": 3,
+  "schedule_days_of_week": [
+    1,
+    3,
+    5
+  ],
+  "schedule_times_of_day": [
+    "06:00"
+  ],
+  "schedule_time_zone": "UTC",
+  "holiday_region": "us",
+  "lookback_interval": 3600,
+  "late_acceptance_interval": 900,
+  "inactivity_interval": 300,
+  "max_open_interval": 43200,
+  "criteria": {
+    "count": {
+      "exact": 1
+    },
+    "extensions": [
+      "csv"
+    ]
+  },
+  "last_evaluated_at": "2000-01-01T01:00:00Z",
+  "last_success_at": "2000-01-01T01:00:00Z",
+  "last_failure_at": "2000-01-01T01:00:00Z",
+  "last_result": "success",
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Expectation ID
+* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
+* `name` (string): Expectation name.
+* `description` (string): Expectation description.
+* `path` (string): Path scope for the expectation. Supports workspace-relative presentation. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `source` (string): Source glob used to select candidate files.
+* `exclude_pattern` (string): Optional source exclusion glob.
+* `disabled` (boolean): If true, the expectation is disabled.
+* `expectations_version` (int64): Criteria schema version for this expectation.
+* `trigger` (string): How this expectation opens windows.
+* `interval` (string): If trigger is `daily`, this specifies how often to run the expectation.
+* `recurring_day` (int64): If trigger is `daily`, this selects the day number inside the chosen interval.
+* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for schedule-driven expectations.
+* `schedule_time_zone` (string): Time zone used by the expectation schedule.
+* `holiday_region` (string): Optional holiday region used by schedule-driven expectations.
+* `lookback_interval` (int64): How many seconds before the due boundary the window starts.
+* `late_acceptance_interval` (int64): How many seconds a schedule-driven window may remain eligible to close as late.
+* `inactivity_interval` (int64): How many quiet seconds are required before final closure.
+* `max_open_interval` (int64): Hard-stop duration in seconds for unscheduled expectations.
+* `criteria` (object): Structured criteria v1 definition for the expectation.
+* `last_evaluated_at` (date-time): Last time this expectation was evaluated.
+* `last_success_at` (date-time): Last time this expectation closed successfully.
+* `last_failure_at` (date-time): Last time this expectation closed with a failure result.
+* `last_result` (string): Most recent terminal result for this expectation.
+* `created_at` (date-time): Creation time.
+* `updated_at` (date-time): Last update time.
+
+
+---
+
+## List Expectations
+
+```
+Files::Expectation.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 `workspace_id`, `name` or `disabled`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled` and `workspace_id`. Valid field combinations are `[ workspace_id, disabled ]`.
+
+
+---
+
+## Show Expectation
+
+```
+Files::Expectation.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation ID.
+
+
+---
+
+## Create Expectation
+
+```
+Files::Expectation.create(
+  name: "Daily Vendor Feed", 
+  description: "Wait for the vendor CSV every morning.", 
+  path: "incoming/vendor_a", 
+  source: "*.csv", 
+  exclude_pattern: "*.tmp", 
+  disabled: true, 
+  trigger: "manual", 
+  interval: "day", 
+  recurring_day: 3, 
+  schedule_days_of_week: [1,3,5], 
+  schedule_times_of_day: ["06:00"], 
+  schedule_time_zone: "UTC", 
+  holiday_region: "us", 
+  lookback_interval: 3600, 
+  late_acceptance_interval: 900, 
+  inactivity_interval: 300, 
+  max_open_interval: 43200, 
+  criteria: {"count":{"exact":1},"extensions":["csv"]}, 
+  workspace_id: 0
+)
+```
+
+### Parameters
+
+* `name` (string): Expectation name.
+* `description` (string): Expectation description.
+* `path` (string): Path scope for the expectation. Supports workspace-relative presentation.
+* `source` (string): Source glob used to select candidate files.
+* `exclude_pattern` (string): Optional source exclusion glob.
+* `disabled` (boolean): If true, the expectation is disabled.
+* `trigger` (string): How this expectation opens windows.
+* `interval` (string): If trigger is `daily`, this specifies how often to run the expectation.
+* `recurring_day` (int64): If trigger is `daily`, this selects the day number inside the chosen interval.
+* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for schedule-driven expectations.
+* `schedule_time_zone` (string): Time zone used by the expectation schedule.
+* `holiday_region` (string): Optional holiday region used by schedule-driven expectations.
+* `lookback_interval` (int64): How many seconds before the due boundary the window starts.
+* `late_acceptance_interval` (int64): How many seconds a schedule-driven window may remain eligible to close as late.
+* `inactivity_interval` (int64): How many quiet seconds are required before final closure.
+* `max_open_interval` (int64): Hard-stop duration in seconds for unscheduled expectations.
+* `criteria` (object): Structured criteria v1 definition for the expectation.
+* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
+
+
+---
+
+## Manually open an Expectation window
+
+```
+Files::Expectation.trigger_evaluation(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation ID.
+
+
+---
+
+## Update Expectation
+
+```
+Files::Expectation.update(id, 
+  name: "Daily Vendor Feed", 
+  description: "Wait for the vendor CSV every morning.", 
+  path: "incoming/vendor_a", 
+  source: "*.csv", 
+  exclude_pattern: "*.tmp", 
+  disabled: true, 
+  trigger: "manual", 
+  interval: "day", 
+  recurring_day: 3, 
+  schedule_days_of_week: [1,3,5], 
+  schedule_times_of_day: ["06:00"], 
+  schedule_time_zone: "UTC", 
+  holiday_region: "us", 
+  lookback_interval: 3600, 
+  late_acceptance_interval: 900, 
+  inactivity_interval: 300, 
+  max_open_interval: 43200, 
+  criteria: {"count":{"exact":1},"extensions":["csv"]}, 
+  workspace_id: 0
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation ID.
+* `name` (string): Expectation name.
+* `description` (string): Expectation description.
+* `path` (string): Path scope for the expectation. Supports workspace-relative presentation.
+* `source` (string): Source glob used to select candidate files.
+* `exclude_pattern` (string): Optional source exclusion glob.
+* `disabled` (boolean): If true, the expectation is disabled.
+* `trigger` (string): How this expectation opens windows.
+* `interval` (string): If trigger is `daily`, this specifies how often to run the expectation.
+* `recurring_day` (int64): If trigger is `daily`, this selects the day number inside the chosen interval.
+* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for schedule-driven expectations.
+* `schedule_time_zone` (string): Time zone used by the expectation schedule.
+* `holiday_region` (string): Optional holiday region used by schedule-driven expectations.
+* `lookback_interval` (int64): How many seconds before the due boundary the window starts.
+* `late_acceptance_interval` (int64): How many seconds a schedule-driven window may remain eligible to close as late.
+* `inactivity_interval` (int64): How many quiet seconds are required before final closure.
+* `max_open_interval` (int64): Hard-stop duration in seconds for unscheduled expectations.
+* `criteria` (object): Structured criteria v1 definition for the expectation.
+* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
+
+
+---
+
+## Delete Expectation
+
+```
+Files::Expectation.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation ID.
+
+
+---
+
+## Manually open an Expectation window
+
+```
+expectation = Files::Expectation.find(id)
+
+expectation.trigger_evaluation
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation ID.
+
+
+---
+
+## Update Expectation
+
+```
+expectation = Files::Expectation.find(id)
+
+expectation.update(
+  name: "Daily Vendor Feed",
+  description: "Wait for the vendor CSV every morning.",
+  path: "incoming/vendor_a",
+  source: "*.csv",
+  exclude_pattern: "*.tmp",
+  disabled: true,
+  trigger: "manual",
+  interval: "day",
+  recurring_day: 3,
+  schedule_days_of_week: [1,3,5],
+  schedule_times_of_day: ["06:00"],
+  schedule_time_zone: "UTC",
+  holiday_region: "us",
+  lookback_interval: 3600,
+  late_acceptance_interval: 900,
+  inactivity_interval: 300,
+  max_open_interval: 43200,
+  criteria: {"count":{"exact":1},"extensions":["csv"]},
+  workspace_id: 0
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation ID.
+* `name` (string): Expectation name.
+* `description` (string): Expectation description.
+* `path` (string): Path scope for the expectation. Supports workspace-relative presentation.
+* `source` (string): Source glob used to select candidate files.
+* `exclude_pattern` (string): Optional source exclusion glob.
+* `disabled` (boolean): If true, the expectation is disabled.
+* `trigger` (string): How this expectation opens windows.
+* `interval` (string): If trigger is `daily`, this specifies how often to run the expectation.
+* `recurring_day` (int64): If trigger is `daily`, this selects the day number inside the chosen interval.
+* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for schedule-driven expectations.
+* `schedule_time_zone` (string): Time zone used by the expectation schedule.
+* `holiday_region` (string): Optional holiday region used by schedule-driven expectations.
+* `lookback_interval` (int64): How many seconds before the due boundary the window starts.
+* `late_acceptance_interval` (int64): How many seconds a schedule-driven window may remain eligible to close as late.
+* `inactivity_interval` (int64): How many quiet seconds are required before final closure.
+* `max_open_interval` (int64): Hard-stop duration in seconds for unscheduled expectations.
+* `criteria` (object): Structured criteria v1 definition for the expectation.
+* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
+
+
+---
+
+## Delete Expectation
+
+```
+expectation = Files::Expectation.find(id)
+
+expectation.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation ID.

data/docs/expectation_evaluation.md

@@ -0,0 +1,80 @@
+# ExpectationEvaluation
+
+## Example ExpectationEvaluation Object
+
+```
+{
+  "id": 1,
+  "workspace_id": 1,
+  "expectation_id": 1,
+  "status": "open",
+  "opened_via": "manual",
+  "opened_at": "2000-01-01T01:00:00Z",
+  "window_start_at": "2000-01-01T01:00:00Z",
+  "window_end_at": "2000-01-01T01:00:00Z",
+  "deadline_at": "2000-01-01T01:00:00Z",
+  "late_acceptance_cutoff_at": "2000-01-01T01:00:00Z",
+  "hard_close_at": "2000-01-01T01:00:00Z",
+  "closed_at": "2000-01-01T01:00:00Z",
+  "matched_files": [
+
+  ],
+  "missing_files": [
+
+  ],
+  "criteria_errors": [
+
+  ],
+  "summary": null,
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): ExpectationEvaluation ID
+* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
+* `expectation_id` (int64): Expectation ID.
+* `status` (string): Evaluation status.
+* `opened_via` (string): How the evaluation window was opened.
+* `opened_at` (date-time): When the evaluation row was opened.
+* `window_start_at` (date-time): Logical start of the candidate window.
+* `window_end_at` (date-time): Actual candidate cutoff boundary for the window.
+* `deadline_at` (date-time): Logical due boundary for schedule-driven windows.
+* `late_acceptance_cutoff_at` (date-time): Logical cutoff for late acceptance, when present.
+* `hard_close_at` (date-time): Hard stop after which the window may not remain open.
+* `closed_at` (date-time): When the evaluation row was finalized.
+* `matched_files` (array(object)): Captured evidence for files that matched the window.
+* `missing_files` (array(object)): Captured evidence for required files that were missing.
+* `criteria_errors` (array(object)): Captured criteria failures for the window.
+* `summary` (object): Compact evaluator summary payload.
+* `created_at` (date-time): Creation time.
+* `updated_at` (date-time): Last update time.
+
+
+---
+
+## List Expectation Evaluations
+
+```
+Files::ExpectationEvaluation.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 `workspace_id`, `created_at` or `expectation_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expectation_id` and `workspace_id`. Valid field combinations are `[ workspace_id, expectation_id ]`.
+
+
+---
+
+## Show Expectation Evaluation
+
+```
+Files::ExpectationEvaluation.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation Evaluation ID.

data/docs/expectation_incident.md

@@ -0,0 +1,158 @@
+# ExpectationIncident
+
+## Example ExpectationIncident Object
+
+```
+{
+  "id": 1,
+  "workspace_id": 1,
+  "expectation_id": 1,
+  "status": "open",
+  "opened_at": "2000-01-01T01:00:00Z",
+  "last_failed_at": "2000-01-01T01:00:00Z",
+  "acknowledged_at": "2000-01-01T01:00:00Z",
+  "snoozed_until": "2000-01-01T01:00:00Z",
+  "resolved_at": "2000-01-01T01:00:00Z",
+  "opened_by_evaluation_id": 1,
+  "last_evaluation_id": 2,
+  "resolved_by_evaluation_id": 3,
+  "summary": null,
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Expectation Incident ID
+* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
+* `expectation_id` (int64): Expectation ID.
+* `status` (string): Incident status.
+* `opened_at` (date-time): When the incident was opened.
+* `last_failed_at` (date-time): When the most recent failing evaluation contributing to the incident occurred.
+* `acknowledged_at` (date-time): When the incident was acknowledged.
+* `snoozed_until` (date-time): When the current snooze expires.
+* `resolved_at` (date-time): When the incident was resolved.
+* `opened_by_evaluation_id` (int64): Evaluation that first opened the incident.
+* `last_evaluation_id` (int64): Most recent evaluation linked to the incident.
+* `resolved_by_evaluation_id` (int64): Evaluation that resolved the incident.
+* `summary` (object): Compact incident summary payload.
+* `created_at` (date-time): Creation time.
+* `updated_at` (date-time): Last update time.
+
+
+---
+
+## List Expectation Incidents
+
+```
+Files::ExpectationIncident.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 `workspace_id`, `created_at` or `expectation_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expectation_id` and `workspace_id`. Valid field combinations are `[ workspace_id, expectation_id ]`.
+
+
+---
+
+## Show Expectation Incident
+
+```
+Files::ExpectationIncident.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation Incident ID.
+
+
+---
+
+## Resolve an expectation incident
+
+```
+Files::ExpectationIncident.resolve(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation Incident ID.
+
+
+---
+
+## Snooze an expectation incident until a specified time
+
+```
+Files::ExpectationIncident.snooze(id, 
+  snoozed_until: "snoozed_until"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation Incident ID.
+* `snoozed_until` (string): Required - Time until which the incident should remain snoozed.
+
+
+---
+
+## Acknowledge an expectation incident
+
+```
+Files::ExpectationIncident.acknowledge(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation Incident ID.
+
+
+---
+
+## Resolve an expectation incident
+
+```
+expectation_incident = Files::ExpectationIncident.find(id)
+
+expectation_incident.resolve
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation Incident ID.
+
+
+---
+
+## Snooze an expectation incident until a specified time
+
+```
+expectation_incident = Files::ExpectationIncident.find(id)
+
+expectation_incident.snooze(
+  snoozed_until: "snoozed_until"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation Incident ID.
+* `snoozed_until` (string): Required - Time until which the incident should remain snoozed.
+
+
+---
+
+## Acknowledge an expectation incident
+
+```
+expectation_incident = Files::ExpectationIncident.find(id)
+
+expectation_incident.acknowledge
+```
+
+### Parameters
+
+* `id` (int64): Required - Expectation Incident ID.

data/docs/key_lifecycle_rule.md

@@ -34,7 +34,7 @@ Files::KeyLifecycleRule.list
 * `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 `workspace_id` and `key_type`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `key_type` and `workspace_id`. Valid field combinations are `[ workspace_id, key_type ]`.
 
 
 ---

data/lib/files.com/errors.rb

@@ -187,6 +187,8 @@ module Files
   class DestinationParentConflictError < ProcessingFailureError; end
   class DestinationParentDoesNotExistError < ProcessingFailureError; end
   class ExceededRuntimeLimitError < ProcessingFailureError; end
+  class ExpectationAlreadyHasOpenWindowError < ProcessingFailureError; end
+  class ExpectationNotManualTriggerError < ProcessingFailureError; end
   class ExpiredPrivateKeyError < ProcessingFailureError; end
   class ExpiredPublicKeyError < ProcessingFailureError; end
   class ExportFailureError < ProcessingFailureError; end