files.com 1.0.90

data/docs/app.md

@@ -0,0 +1,57 @@
+# App
+
+## Example App Object
+
+```
+{
+  "name": "",
+  "extended_description": "",
+  "documentation_links": "Important Info => http://files.test/learn-more",
+  "logo_url": "",
+  "logo_thumbnail_url": "",
+  "sso_strategy_type": "",
+  "remote_server_type": "",
+  "folder_behavior_type": "",
+  "external_homepage_url": "",
+  "app_type": "",
+  "featured": true
+}
+```
+
+* `name` (string): Name of the App
+* `extended_description` (string): Long form description of the App
+* `documentation_links` (string): Collection of named links to documentation
+* `logo_url` (string): Full size logo for the App
+* `logo_thumbnail_url` (string): Logo thumbnail for the App
+* `sso_strategy_type` (string): Associated SSO Strategy type, if any
+* `remote_server_type` (string): Associated Remote Server type, if any
+* `folder_behavior_type` (string): Associated Folder Behavior type, if any
+* `external_homepage_url` (string): Link to external homepage
+* `app_type` (string): The type of the App
+* `featured` (boolean): Is featured on the App listing?
+
+
+---
+
+## List Apps
+
+```
+Files::App.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `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`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name` and `app_type`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `name` and `app_type`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `name` and `app_type`.

data/docs/as2_key.md

@@ -0,0 +1,133 @@
+# As2Key
+
+## Example As2Key Object
+
+```
+{
+  "id": 1,
+  "as2_partnership_name": "Test",
+  "created_at": "2000-01-01T01:00:00Z",
+  "fingerprint": "cf:cb:d3:26:52:6c:55:88:83:17:13:cf:e7:70:eb:1b:32:37:38:c0"
+}
+```
+
+* `id` (int64): AS2 Key ID
+* `as2_partnership_name` (string): AS2 Partnership Name
+* `created_at` (date-time): AS2 Key created at date/time
+* `fingerprint` (string): Public key fingerprint
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `public_key` (string): Actual contents of Public key.
+
+
+---
+
+## List As2 Keys
+
+```
+Files::As2Key.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `page` (int64): Current page number.
+* `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.
+
+
+---
+
+## Show As2 Key
+
+```
+Files::As2Key.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Key ID.
+
+
+---
+
+## Create As2 Key
+
+```
+Files::As2Key.create(
+  user_id: 1, 
+  as2_partnership_name: "Test", 
+  public_key: "public_key"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `as2_partnership_name` (string): Required - AS2 Partnership Name
+* `public_key` (string): Required - Actual contents of Public key.
+
+
+---
+
+## Update As2 Key
+
+```
+Files::As2Key.update(id, 
+  as2_partnership_name: "Test"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Key ID.
+* `as2_partnership_name` (string): Required - AS2 Partnership Name
+
+
+---
+
+## Delete As2 Key
+
+```
+Files::As2Key.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Key ID.
+
+
+---
+
+## Update As2 Key
+
+```
+as2_key = Files::As2Key.list_for(path).first
+
+as2_key.update(
+  as2_partnership_name: "Test"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Key ID.
+* `as2_partnership_name` (string): Required - AS2 Partnership Name
+
+
+---
+
+## Delete As2 Key
+
+```
+as2_key = Files::As2Key.list_for(path).first
+
+as2_key.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - As2 Key ID.

data/docs/auto.md

@@ -0,0 +1,11 @@
+# Auto
+
+## Example Auto Object
+
+```
+{
+  "dynamic": ""
+}
+```
+
+* `dynamic` (object): 

data/docs/automation.md

@@ -0,0 +1,190 @@
+# Automation
+
+## Example Automation Object
+
+```
+{
+  "id": 1,
+  "automation": "create_folder",
+  "source": "",
+  "destination": "",
+  "destination_replace_from": "",
+  "destination_replace_to": "",
+  "interval": "week",
+  "next_process_on": "2020-01-01",
+  "path": "",
+  "realtime": true,
+  "user_id": 1,
+  "user_ids": [
+
+  ],
+  "group_ids": [
+
+  ]
+}
+```
+
+* `id` (int64): Automation ID
+* `automation` (string): 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`.
+* `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)
+
+
+---
+
+## List Automations
+
+```
+Files::Automation.list(
+  page: 1, 
+  per_page: 1, 
+  automation: "create_folder"
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `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`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `automation`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `automation`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `automation`.
+* `automation` (string): DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
+
+
+---
+
+## Show Automation
+
+```
+Files::Automation.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation ID.
+
+
+---
+
+## Create Automation
+
+```
+Files::Automation.create(
+  automation: "create_folder", 
+  source: "source", 
+  destination: "destination", 
+  interval: "year"
+)
+```
+
+### Parameters
+
+* `automation` (string): Required - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+* `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`
+* `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.
+
+
+---
+
+## Update Automation
+
+```
+Files::Automation.update(id, 
+  automation: "create_folder", 
+  source: "source", 
+  destination: "destination", 
+  interval: "year"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation ID.
+* `automation` (string): Required - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+* `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`
+* `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.
+
+
+---
+
+## Delete Automation
+
+```
+Files::Automation.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation ID.
+
+
+---
+
+## Update Automation
+
+```
+automation = Files::Automation.list_for(path).first
+
+automation.update(
+  automation: "create_folder",
+  source: "source",
+  destination: "destination",
+  interval: "year"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation ID.
+* `automation` (string): Required - Type of automation.  One of: `create_folder`, `request_file`, `request_move`
+* `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`
+* `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.
+
+
+---
+
+## Delete Automation
+
+```
+automation = Files::Automation.list_for(path).first
+
+automation.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation ID.

data/docs/behavior.md

@@ -0,0 +1,208 @@
+# Behavior
+
+## Example Behavior Object
+
+```
+{
+  "id": 1,
+  "path": "",
+  "attachment_url": "",
+  "behavior": "webhook",
+  "value": {
+    "method": "GET"
+  }
+}
+```
+
+* `id` (int64): Folder behavior ID
+* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `attachment_url` (string): URL for attached file
+* `behavior` (string): Behavior type.
+* `value` (object): Settings for this behavior.  See the section above for an example value to provide here.  Formatting is different for each Behavior type.  May be sent as nested JSON or a single JSON-encoded string.  If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
+* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
+
+
+---
+
+## List Behaviors
+
+```
+Files::Behavior.list(
+  page: 1, 
+  per_page: 1, 
+  behavior: "webhook"
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `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`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `behavior`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `behavior`.
+* `behavior` (string): If set, only shows folder behaviors matching this behavior type.
+
+
+---
+
+## Show Behavior
+
+```
+Files::Behavior.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Behavior ID.
+
+
+---
+
+## List Behaviors by path
+
+```
+Files::Behavior.list_for(path, 
+  page: 1, 
+  per_page: 1, 
+  behavior: "webhook"
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `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`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `behavior`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `behavior`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `behavior`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `behavior`.
+* `path` (string): Required - Path to operate on.
+* `recursive` (string): Show behaviors above this path?
+* `behavior` (string): DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
+
+
+---
+
+## Create Behavior
+
+```
+Files::Behavior.create(
+  value: "{\"method\": \"GET\"}", 
+  path: "path", 
+  behavior: "webhook"
+)
+```
+
+### Parameters
+
+* `value` (string): The value of the folder behavior.  Can be a integer, array, or hash depending on the type of folder behavior.
+* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
+* `path` (string): Required - Folder behaviors path.
+* `behavior` (string): Required - Behavior type.
+
+
+---
+
+## Test webhook
+
+```
+Files::Behavior.webhook_test(
+  url: "https://www.site.com/...", 
+  method: "GET", 
+  encoding: "RAW", 
+  headers: "x-test-header => testvalue", 
+  body: "test-param => testvalue", 
+  action: "test"
+)
+```
+
+### Parameters
+
+* `url` (string): Required - URL for testing the webhook.
+* `method` (string): HTTP method(GET or POST).
+* `encoding` (string): HTTP encoding method.  Can be JSON, XML, or RAW (form data).
+* `headers` (object): Additional request headers.
+* `body` (object): Additional body parameters.
+* `action` (string): action for test body
+
+
+---
+
+## Update Behavior
+
+```
+Files::Behavior.update(id, 
+  value: "{\"method\": \"GET\"}", 
+  behavior: "webhook"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Behavior ID.
+* `value` (string): The value of the folder behavior.  Can be a integer, array, or hash depending on the type of folder behavior.
+* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
+* `behavior` (string): Behavior type.
+* `path` (string): Folder behaviors path.
+
+
+---
+
+## Delete Behavior
+
+```
+Files::Behavior.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Behavior ID.
+
+
+---
+
+## Update Behavior
+
+```
+behavior = Files::Behavior.list_for(path).first
+
+behavior.update(
+  value: "{\"method\": \"GET\"}",
+  behavior: "webhook"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Behavior ID.
+* `value` (string): The value of the folder behavior.  Can be a integer, array, or hash depending on the type of folder behavior.
+* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
+* `behavior` (string): Behavior type.
+* `path` (string): Folder behaviors path.
+
+
+---
+
+## Delete Behavior
+
+```
+behavior = Files::Behavior.list_for(path).first
+
+behavior.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Behavior ID.