files.com 1.0.121 → 1.0.126

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afbaa52d35acc90caddf03f3591030a31497eafabc834d7a7e80a118b75b275c
-  data.tar.gz: 0d09ba83f3191475ad3b6f4f3e4832a99cecf378e7a8290b9ae86462f858dde5
+  metadata.gz: 203e10058f232c82f9aab4122aa5d99e0d984cef6ddce45503703cf35dc3ad72
+  data.tar.gz: 8f84839cd7256c532669e0a2500fb5c7429b754822cab4675113919fdce1cabf
 SHA512:
-  metadata.gz: 2c8b2f614e56ec6d051a88ae44cf77fb7e62ccdee5f326364b9994ee2d8c3bb85d85a8ec0765cca2df3498eaea286874bfed4594289e628f1d891c09c7174e9a
-  data.tar.gz: c81352b474842a5b48e0e30ea708c67b506b42bfc4b9c26923728927459256fec710867588788f04431a1e60f6c5c5cec80f329fab1f78cec846876365800ba8
+  metadata.gz: 5a3a384c546820836c47b8a58955a08d6c8b7e55a24b39ab083d76deada2c36e4929809dc3783cdac88bec003c77ae757d2c852bc60c6d9f445a617b7459b49d
+  data.tar.gz: 51392695363317328c9416d161412e8dd92eafbd2e149bcdba5eb28ef679a63916bd9c24a520831c2485af7026259a8ddec1fc8ed34fe1375145408a71618976

data/_VERSION

@@ -1 +1 @@
-1.0.121
+1.0.126

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

@@ -6,14 +6,26 @@
 {
   "id": 1,
   "automation": "create_folder",
+  "trigger": "realtime",
+  "interval": "week",
+  "next_process_on": "2020-01-01",
+  "schedule": {
+    "days_of_week": [
+      0,
+      2,
+      4
+    ],
+    "times_of_day": [
+      "6:30",
+      "14:30"
+    ],
+    "time_zone": "Eastern Time (US & Canada)"
+  },
   "source": "",
   "destination": "",
   "destination_replace_from": "",
   "destination_replace_to": "",
-  "interval": "week",
-  "next_process_on": "2020-01-01",
   "path": "",
-  "realtime": true,
   "user_id": 1,
   "user_ids": [
 
@@ -26,14 +38,15 @@
 
 * `id` (int64): Automation ID
 * `automation` (string): Automation type
+* `trigger` (string): How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
+* `interval` (string): If trigger is `daily`, this specifies how often to run this automation.  One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
+* `next_process_on` (string): If trigger is `daily`, date this automation will next run.
+* `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
 * `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`.
 * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
-* `interval` (string): How often to run this automation?  One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
-* `next_process_on` (string): Date this automation will next run.
 * `path` (string): Path on which this Automation runs.  Supports globs. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
-* `realtime` (boolean): Does this automation run in real time?  This is a read-only property based on automation type.
 * `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)
@@ -45,7 +58,6 @@
 
 ```
 Files::Automation.list(
-  page: 1, 
   per_page: 1, 
   automation: "create_folder"
 )
@@ -53,10 +65,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 +99,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 +116,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 +129,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 +147,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 +175,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 +193,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.
 
 
 ---
@@ -150,6 +149,7 @@ Files::Bundle.share(id,
 
 ```
 Files::Bundle.update(id, 
+  paths: ["file.txt"], 
   password: "Password", 
   clickwrap_id: 1, 
   code: "abc123", 
@@ -166,6 +166,7 @@ Files::Bundle.update(id,
 ### Parameters
 
 * `id` (int64): Required - Bundle ID.
+* `paths` (array(string)): A list of paths to include in this bundle.
 * `password` (string): Password for this bundle.
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
@@ -200,7 +201,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 +211,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.
 
 
 ---
@@ -219,6 +222,7 @@ bundle.share(
 bundle = Files::Bundle.list_for(path).first
 
 bundle.update(
+  paths: ["file.txt"],
   password: "Password",
   clickwrap_id: 1,
   code: "abc123",
@@ -235,6 +239,7 @@ bundle.update(
 ### Parameters
 
 * `id` (int64): Required - Bundle ID.
+* `paths` (array(string)): A list of paths to include in this bundle.
 * `password` (string): Password for this bundle.
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.

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.