files.com 1.1.583 → 1.1.585

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315f62b11f8a9240a25e1c9fd14edab02f41af734f0218abbeb6853550768a15
-  data.tar.gz: 9d9e3d5020c9043c5c346a98bce3b306a23f6445160d1ffccb72a05514b3a727
+  metadata.gz: b4a4cc4151955a415daf9786a88904d61f7da7ea8c9e3ed003939c69507ba043
+  data.tar.gz: 7274f729bb0342b7b6061eef5e73bfd133df854c11ac48fc726147e2aaba92a8
 SHA512:
-  metadata.gz: b2cf49865ebdd57be968a2279b473789ede631e3bb68a13fd31f51153ba39e4b2036a94a92cd37f7eb37f5b54b244bba0cab14a03894a98725bd3db6f06ff6c8
-  data.tar.gz: 57cc111c49b1cac777631bbc9c455f8f3dbc1a0c4438511b41ce0269461524d7e682729749bd1cdc8d78e6850d4ce832bb174c57ea4462009edd6dd7c2a17577
+  metadata.gz: 6897940df2fe0490ca63febcc65c559e57cdd3688e47d926553649df7b0e7a842a267926eaae661f6c990bf685b5d13151a49e42186dfe4c4793c9c970a44a49
+  data.tar.gz: 20619d61edad5ac394afc578b64518e24a74e5032fc8e1ba53f6423c010bbabb40c5f40678e464bba35bed63f47099e117c32fa24186cec4cb36b3fa35d17e3e

data/README.md

@@ -159,7 +159,9 @@ The Ruby SDK is configured by setting attributes on the `Files` object.
 
 #### Base URL
 
-Setting the base URL for the API is required if your site is configured to disable global acceleration.
+Set this to the full https:// URL of your Files.com subdomain (e.g. `https://MY-SUBDOMAIN.files.com`).
+This is not required in most cases, but one benefit of setting it is that it ensures that authentication failures will be logged to your site's API logs.  Without setting this, we won't know which site to associate the authentication failure with, and it won't be logged to your site's API logs.
+This is always required if your site is configured to disable global acceleration.
 This can also be set to use a mock server in development or CI.
 
 ```ruby title="Example setting"
@@ -603,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.583
+1.1.585

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/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