files.com 1.0.119 → 1.0.124

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2294423fdd66aafad438d386bc6af4b46a335300a3210ef1a004c7301d957e
-  data.tar.gz: ee4436309d71628148785b905f57769c78adc477bca0368fc24d1a1e77ac65ce
+  metadata.gz: 92873bcd3bc5aba3dbdddbccbb0773e60e9a591517dcc0e2f7d306444e9ba3fa
+  data.tar.gz: 5d9714166c704bce65ba07c790fed61e0296bce705427ad73f6c4d3dee76cff3
 SHA512:
-  metadata.gz: 58985e92223a845d9a558a35f507ef871ee70305e25b589a72ce5dcc78bce6e1c6bb81c64aaa5a6a89b21fd59ecd9eb3e80fd0fd3ebc2f83d5047013df4e4eff
-  data.tar.gz: 115bff67bf99614deb62886c5c7264f1cff582e0db8ec1f4909b5abc5f9fb77138e3410ba3e2b7bab766f88d60808f9468d9588f53ff3ec03f543c5223157db8
+  metadata.gz: 2e61dae752728ff89f699fbad98f1aa9a8f70dd8bbe18492c5d60567979cc7ccf3476b27915ea0f6b96820d2b00d77f505186e0ed3ace4847f6d6d51e50faf66
+  data.tar.gz: f4b9cc0cc6b6cb5fd69a8096a65369b8472fce76f371ee7c5398db2ba8ef67bdfefe9183e0241ca9bd6f4c60d1cbcf842f1d7fe51dfbc0ce4f790323f686df23

data/_VERSION

@@ -1 +1 @@
-1.0.119
+1.0.124

data/docs/api_key.md

@@ -38,7 +38,6 @@
 ```
 Files::ApiKey.list(
   user_id: 1, 
-  page: 1, 
   per_page: 1
 )
 ```
@@ -46,10 +45,8 @@ Files::ApiKey.list(
 ### Parameters
 
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `deleted_at` and `expires_at`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.

data/docs/app.md

@@ -41,17 +41,14 @@
 
 ```
 Files::App.list(
-  page: 1, 
   per_page: 1
 )
 ```
 
 ### Parameters
 
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `name` and `app_type`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name` and `app_type`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name` and `app_type`.

data/docs/as2_key.md

@@ -26,7 +26,6 @@
 ```
 Files::As2Key.list(
   user_id: 1, 
-  page: 1, 
   per_page: 1
 )
 ```
@@ -34,10 +33,8 @@ Files::As2Key.list(
 ### Parameters
 
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 
 
 ---

data/docs/automation.md

@@ -20,7 +20,20 @@
   ],
   "group_ids": [
 
-  ]
+  ],
+  "trigger": "realtime",
+  "schedule": {
+    "days_of_week": [
+      0,
+      2,
+      4
+    ],
+    "times_of_day": [
+      "6:30",
+      "14:30"
+    ],
+    "time_zone": "Eastern Time (US & Canada)"
+  }
 }
 ```
 
@@ -37,6 +50,8 @@
 * `user_id` (int64): User ID of the Automation's creator.
 * `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
 * `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
+* `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
+* `schedule` (object): Custom schedule description for when the automation should be run.
 
 
 ---
@@ -45,7 +60,6 @@
 
 ```
 Files::Automation.list(
-  page: 1, 
   per_page: 1, 
   automation: "create_folder"
 )
@@ -53,10 +67,8 @@ Files::Automation.list(
 
 ### Parameters
 
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `automation`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
@@ -89,13 +101,15 @@ Files::Automation.create(
   automation: "create_folder", 
   source: "source", 
   destination: "destination", 
-  interval: "year"
+  interval: "year", 
+  schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"}, 
+  trigger: "realtime"
 )
 ```
 
 ### Parameters
 
-* `automation` (string): Required - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+* `automation` (string): Required - Automation type
 * `source` (string): Source Path
 * `destination` (string): Destination Path
 * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -104,6 +118,8 @@ Files::Automation.create(
 * `path` (string): Path on which this Automation runs.  Supports globs.
 * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+* `schedule` (object): Custom schedule for running this automation.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
 
 
 ---
@@ -115,14 +131,16 @@ Files::Automation.update(id,
   automation: "create_folder", 
   source: "source", 
   destination: "destination", 
-  interval: "year"
+  interval: "year", 
+  schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"}, 
+  trigger: "realtime"
 )
 ```
 
 ### Parameters
 
 * `id` (int64): Required - Automation ID.
-* `automation` (string): Required - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+* `automation` (string): Required - Automation type
 * `source` (string): Source Path
 * `destination` (string): Destination Path
 * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -131,6 +149,8 @@ Files::Automation.update(id,
 * `path` (string): Path on which this Automation runs.  Supports globs.
 * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+* `schedule` (object): Custom schedule for running this automation.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
 
 
 ---
@@ -157,14 +177,16 @@ automation.update(
   automation: "create_folder",
   source: "source",
   destination: "destination",
-  interval: "year"
+  interval: "year",
+  schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"},
+  trigger: "realtime"
 )
 ```
 
 ### Parameters
 
 * `id` (int64): Required - Automation ID.
-* `automation` (string): Required - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+* `automation` (string): Required - Automation type
 * `source` (string): Source Path
 * `destination` (string): Destination Path
 * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
@@ -173,6 +195,8 @@ automation.update(
 * `path` (string): Path on which this Automation runs.  Supports globs.
 * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
+* `schedule` (object): Custom schedule for running this automation.
+* `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
 
 
 ---

data/docs/bandwidth_snapshot.md

@@ -33,17 +33,14 @@
 
 ```
 Files::BandwidthSnapshot.list(
-  page: 1, 
   per_page: 1
 )
 ```
 
 ### Parameters
 
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `logged_at`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.

data/docs/behavior.md

@@ -28,7 +28,6 @@
 
 ```
 Files::Behavior.list(
-  page: 1, 
   per_page: 1, 
   behavior: "webhook"
 )
@@ -36,10 +35,8 @@ Files::Behavior.list(
 
 ### Parameters
 
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `behavior`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.
@@ -69,7 +66,6 @@ Files::Behavior.find(id)
 
 ```
 Files::Behavior.list_for(path, 
-  page: 1, 
   per_page: 1, 
   behavior: "webhook"
 )
@@ -77,10 +73,8 @@ Files::Behavior.list_for(path,
 
 ### Parameters
 
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `behavior`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `behavior`.

data/docs/bundle.md

@@ -55,7 +55,6 @@
 ```
 Files::Bundle.list(
   user_id: 1, 
-  page: 1, 
   per_page: 1
 )
 ```
@@ -63,10 +62,8 @@ Files::Bundle.list(
 ### Parameters
 
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `created_at` or `code`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
@@ -133,7 +130,8 @@ Files::Bundle.create(
 ```
 Files::Bundle.share(id, 
   to: ["johndoe@gmail.com"], 
-  note: "Just a note."
+  note: "Just a note.", 
+  recipients: [{"name":"John Doe","company":"Acme Ltd","recipient":"johndoe@gmail.com"}]
 )
 ```
 
@@ -142,6 +140,7 @@ Files::Bundle.share(id,
 * `id` (int64): Required - Bundle ID.
 * `to` (array(string)): Required - A list of email addresses to share this bundle with.
 * `note` (string): Note to include in email.
+* `recipients` (array(object)): A list of recipients to share this bundle with.
 
 
 ---
@@ -200,7 +199,8 @@ bundle = Files::Bundle.list_for(path).first
 
 bundle.share(
   to: ["johndoe@gmail.com"],
-  note: "Just a note."
+  note: "Just a note.",
+  recipients: [{"name":"John Doe","company":"Acme Ltd","recipient":"johndoe@gmail.com"}]
 )
 ```
 
@@ -209,6 +209,7 @@ bundle.share(
 * `id` (int64): Required - Bundle ID.
 * `to` (array(string)): Required - A list of email addresses to share this bundle with.
 * `note` (string): Note to include in email.
+* `recipients` (array(object)): A list of recipients to share this bundle with.
 
 
 ---

data/docs/bundle_download.md

@@ -21,7 +21,6 @@
 
 ```
 Files::BundleDownload.list(
-  page: 1, 
   per_page: 1, 
   bundle_registration_id: 1
 )
@@ -29,8 +28,6 @@ Files::BundleDownload.list(
 
 ### Parameters
 
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `bundle_registration_id` (int64): Required - BundleRegistration ID

data/docs/bundle_recipient.md

@@ -26,7 +26,6 @@
 ```
 Files::BundleRecipient.list(
   user_id: 1, 
-  page: 1, 
   per_page: 1, 
   bundle_id: 1
 )
@@ -35,8 +34,6 @@ Files::BundleRecipient.list(
 ### Parameters
 
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `bundle_id` (int64): Required - List recipients for the bundle with this ID.

data/docs/clickwrap.md

@@ -4,6 +4,7 @@
 
 ```
 {
+  "id": 1,
   "name": "Example Site NDA for Files.com Use",
   "body": "[Legal body text]",
   "use_with_users": "",
@@ -12,12 +13,12 @@
 }
 ```
 
+* `id` (int64): Clickwrap ID
 * `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
 * `body` (string): Body text of Clickwrap (supports Markdown formatting).
 * `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
 * `use_with_bundles` (string): Use this Clickwrap for Bundles?
 * `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
-* `id` (int64): Clickwrap ID.
 
 
 ---
@@ -26,17 +27,14 @@
 
 ```
 Files::Clickwrap.list(
-  page: 1, 
   per_page: 1
 )
 ```
 
 ### Parameters
 
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 
 
 ---

data/docs/dns_record.md

@@ -23,14 +23,11 @@
 
 ```
 Files::DnsRecord.list(
-  page: 1, 
   per_page: 1
 )
 ```
 
 ### Parameters
 
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.

data/docs/external_event.md

@@ -23,17 +23,14 @@
 
 ```
 Files::ExternalEvent.list(
-  page: 1, 
   per_page: 1
 )
 ```
 
 ### Parameters
 
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `site_id`, `event_type`, `created_at` or `status`.
 * `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
 * `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.

data/docs/file_comment.md

@@ -24,17 +24,14 @@
 
 ```
 Files::FileComment.list_for(path, 
-  page: 1, 
   per_page: 1
 )
 ```
 
 ### Parameters
 
-* `page` (int64): Current page number.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
-* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
 * `path` (string): Required - Path to operate on.