files.com 1.0.92

data/docs/history.md

@@ -0,0 +1,171 @@
+# History
+
+## Example History Object
+
+```
+{
+  "id": 1,
+  "path": "path",
+  "when": "2000-01-01T01:00:00Z",
+  "destination": "/to_path",
+  "display": "Actual text of the action here.",
+  "ip": "192.283.128.182",
+  "source": "/from_path",
+  "targets": [
+
+  ],
+  "user_id": 1,
+  "username": "user",
+  "action": "create",
+  "failure_type": "none",
+  "interface": "web"
+}
+```
+
+* `id` (int64): Action ID
+* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `when` (date-time): Action occurrence date/time
+* `destination` (string): The destination path for this action, if applicable
+* `display` (string): Friendly displayed output
+* `ip` (string): IP Address that performed this action
+* `source` (string): The source path for this action, if applicable
+* `targets` (array): Targets
+* `user_id` (int64): User ID
+* `username` (string): Username
+* `action` (string): Type of action
+* `failure_type` (string): Failure type.  If action was a user login or session failure, why did it fail?
+* `interface` (string): Interface on which this action occurred.
+
+
+---
+
+## List history for specific file
+
+```
+Files::History.list_for_file(path, 
+  display: "Actual text of the action here.", 
+  page: 1, 
+  per_page: 1, 
+  action: "create"
+)
+```
+
+### Parameters
+
+* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
+* `end_at` (string): Leave blank or set to a date/time to filter later entries.
+* `display` (string): Display format. Leave blank or set to `full` or `parent`.
+* `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 `user_id` and `created_at`.
+* `path` (string): Required - Path to operate on.
+
+
+---
+
+## List history for specific folder
+
+```
+Files::History.list_for_folder(path, 
+  display: "Actual text of the action here.", 
+  page: 1, 
+  per_page: 1, 
+  action: "create"
+)
+```
+
+### Parameters
+
+* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
+* `end_at` (string): Leave blank or set to a date/time to filter later entries.
+* `display` (string): Display format. Leave blank or set to `full` or `parent`.
+* `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 `user_id` and `created_at`.
+* `path` (string): Required - Path to operate on.
+
+
+---
+
+## List history for specific user
+
+```
+Files::History.list_for_user(user_id, 
+  display: "Actual text of the action here.", 
+  page: 1, 
+  per_page: 1, 
+  action: "create"
+)
+```
+
+### Parameters
+
+* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
+* `end_at` (string): Leave blank or set to a date/time to filter later entries.
+* `display` (string): Display format. Leave blank or set to `full` or `parent`.
+* `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 `user_id` and `created_at`.
+* `user_id` (int64): Required - User ID.
+
+
+---
+
+## List site login history
+
+```
+Files::History.list_logins(
+  display: "Actual text of the action here.", 
+  page: 1, 
+  per_page: 1, 
+  action: "create"
+)
+```
+
+### Parameters
+
+* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
+* `end_at` (string): Leave blank or set to a date/time to filter later entries.
+* `display` (string): Display format. Leave blank or set to `full` or `parent`.
+* `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 `user_id` and `created_at`.
+
+
+---
+
+## List site full action history
+
+```
+Files::History.list(
+  display: "Actual text of the action here.", 
+  page: 1, 
+  per_page: 1, 
+  action: "create"
+)
+```
+
+### Parameters
+
+* `start_at` (string): Leave blank or set to a date/time to filter earlier entries.
+* `end_at` (string): Leave blank or set to a date/time to filter later entries.
+* `display` (string): Display format. Leave blank or set to `full` or `parent`.
+* `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`, `path`, `created_at`, `folder` or `user_id`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `user_id`, `folder` or `path`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.

data/docs/history_export.md

@@ -0,0 +1,174 @@
+# HistoryExport
+
+## Example HistoryExport Object
+
+```
+{
+  "id": 1,
+  "start_at": "2000-01-01T01:00:00Z",
+  "end_at": "2000-01-01T01:00:00Z",
+  "status": "ready",
+  "query_action": "read",
+  "query_interface": "ftp",
+  "query_user_id": 1,
+  "query_file_id": 1,
+  "query_parent_id": 1,
+  "query_path": "MyFile.txt",
+  "query_folder": "Folder",
+  "query_src": "SrcFolder",
+  "query_destination": "DestFolder",
+  "query_ip": "127.0.0.1",
+  "query_username": "jerry",
+  "query_failure_type": "bad_password",
+  "query_target_id": 1,
+  "query_target_name": "full",
+  "query_target_permission": "full",
+  "query_target_user_id": 1,
+  "query_target_username": "jerry",
+  "query_target_platform": "windows",
+  "query_target_permission_set": "desktop_app"
+}
+```
+
+* `id` (int64): History Export ID
+* `start_at` (date-time): Start date/time of export range.
+* `end_at` (date-time): End date/time of export range.
+* `status` (string): Status of export.  Will be: `building` or `ready`
+* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
+* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
+* `query_user_id` (int64): Return results that are actions performed by the user indiciated by this User ID
+* `query_file_id` (int64): Return results that are file actions related to the file indicated by this File ID
+* `query_parent_id` (int64): Return results that are file actions inside the parent folder specified by this folder ID
+* `query_path` (string): Return results that are file actions related to this path.
+* `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
+* `query_src` (string): Return results that are file moves originating from this path.
+* `query_destination` (string): Return results that are file moves with this path as destination.
+* `query_ip` (string): Filter results by this IP address.
+* `query_username` (string): Filter results by this username.
+* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`
+* `query_target_id` (int64): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
+* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
+* `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
+* `query_target_user_id` (int64): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
+* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
+* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
+* `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+
+
+---
+
+## List History Exports
+
+```
+Files::HistoryExport.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 History Export
+
+```
+Files::HistoryExport.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - History Export ID.
+
+
+---
+
+## Create History Export
+
+```
+Files::HistoryExport.create(
+  user_id: 1, 
+  start_at: "2000-01-01T01:00:00Z", 
+  end_at: "2000-01-01T01:00:00Z", 
+  query_action: "read", 
+  query_interface: "ftp", 
+  query_user_id: 1, 
+  query_file_id: 1, 
+  query_parent_id: 1, 
+  query_path: "MyFile.txt", 
+  query_folder: "Folder", 
+  query_src: "SrcFolder", 
+  query_destination: "DestFolder", 
+  query_ip: "127.0.0.1", 
+  query_username: "jerry", 
+  query_failure_type: "bad_password", 
+  query_target_id: 1, 
+  query_target_name: "full", 
+  query_target_permission: "full", 
+  query_target_user_id: 1, 
+  query_target_username: "jerry", 
+  query_target_platform: "windows", 
+  query_target_permission_set: "desktop_app"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `start_at` (string): Start date/time of export range.
+* `end_at` (string): End date/time of export range.
+* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
+* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
+* `query_user_id` (int64): Return results that are actions performed by the user indiciated by this User ID
+* `query_file_id` (int64): Return results that are file actions related to the file indicated by this File ID
+* `query_parent_id` (int64): Return results that are file actions inside the parent folder specified by this folder ID
+* `query_path` (string): Return results that are file actions related to this path.
+* `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
+* `query_src` (string): Return results that are file moves originating from this path.
+* `query_destination` (string): Return results that are file moves with this path as destination.
+* `query_ip` (string): Filter results by this IP address.
+* `query_username` (string): Filter results by this username.
+* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`
+* `query_target_id` (int64): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
+* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
+* `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
+* `query_target_user_id` (int64): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
+* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
+* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
+* `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
+
+
+---
+
+## Delete History Export
+
+```
+Files::HistoryExport.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - History Export ID.
+
+
+---
+
+## Delete History Export
+
+```
+history_export = Files::HistoryExport.list_for(path).first
+
+history_export.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - History Export ID.

data/docs/image.md

@@ -0,0 +1,13 @@
+# Image
+
+## Example Image Object
+
+```
+{
+  "name": "My logo",
+  "uri": "https://mysite.files.com/.../my_image.png"
+}
+```
+
+* `name` (string): Image name
+* `uri` (string): Image URI

data/docs/invoice.md

@@ -0,0 +1,72 @@
+# Invoice
+
+## Example Invoice Object
+
+```
+{
+  "id": 1,
+  "amount": "",
+  "balance": "",
+  "created_at": "2000-01-01T01:00:00Z",
+  "currency": "USD",
+  "download_uri": "https://url...",
+  "invoice_line_items": [
+
+  ],
+  "method": "paypal",
+  "payment_line_items": [
+
+  ],
+  "payment_reversed_at": "2000-01-01T01:00:00Z",
+  "payment_type": "",
+  "site_name": "My Site",
+  "type": "invoice",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Line item Id
+* `amount` (double): Line item amount
+* `balance` (double): Line item balance
+* `created_at` (date-time): Line item created at
+* `currency` (string): Line item currency
+* `download_uri` (string): Line item download uri
+* `invoice_line_items` (array): Associated invoice line items
+* `method` (string): Line item payment method
+* `payment_line_items` (array): Associated payment line items
+* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
+* `payment_type` (string): Type of payment if applicable
+* `site_name` (string): Site name this line item is for
+* `type` (string): Type of line item, either payment or invoice
+* `updated_at` (date-time): Line item updated at
+
+
+---
+
+## List Invoices
+
+```
+Files::Invoice.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.
+
+
+---
+
+## Show Invoice
+
+```
+Files::Invoice.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Invoice ID.

data/docs/invoice_line_item.md

@@ -0,0 +1,27 @@
+# InvoiceLineItem
+
+## Example InvoiceLineItem Object
+
+```
+{
+  "amount": "",
+  "created_at": "2000-01-01T01:00:00Z",
+  "description": "Service from 2019-01-01 through 2019-12-31",
+  "type": "invoice",
+  "service_end_at": "2000-01-01T01:00:00Z",
+  "service_start_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z",
+  "plan": "Enterprise",
+  "site": "My site"
+}
+```
+
+* `amount` (double): Invoice line item amount
+* `created_at` (date-time): Invoice line item created at date/time
+* `description` (string): Invoice line item description
+* `type` (string): Invoice line item type
+* `service_end_at` (date-time): Invoice line item service end date/time
+* `service_start_at` (date-time): Invoice line item service start date/time
+* `updated_at` (date-time): Invoice line item updated date/time
+* `plan` (string): Plan name
+* `site` (string): Site name