files.com 1.1.671 → 1.1.673

data/docs/support_request.md

@@ -1,126 +0,0 @@
-# SupportRequest
-
-## Example SupportRequest Object
-
-```
-{
-  "id": 1,
-  "subject": "example",
-  "comment": "example",
-  "created_at": "2000-01-01T01:00:00Z",
-  "access_until": "2000-01-01T01:00:00Z",
-  "customer_success_access": "`no`",
-  "priority": "`low`",
-  "name": "John Doe",
-  "phone_number": "555-555-5555"
-}
-```
-
-* `id` (int64): ID
-* `subject` (string): Subject of the support request.
-* `comment` (string): Main body of the support request.
-* `created_at` (date): When this support request was made.
-* `access_until` (date): Customer Support can access your user account up through this date/time.
-* `customer_success_access` (string): Enable Customer Support access to your user account?
-* `priority` (string): Priority. Can be `low` (e.g. general or billing/account questions), `normal` (e.g. the system is impaired), `high` (e.g. a production workflow or business process is impaired), `urgent` (e.g. a production workflow or business process is down), `critical` (e.g. a business-critical workflow or business process is down)
-* `name` (string): Support Request name
-* `phone_number` (string): Support Request phone number
-* `access_reset` (boolean): If set to `true`, will reset the customer success access window.
-* `email` (string): Email address of the user requesting support.
-* `attachments_files` (array(file)): 
-
-
----
-
-## List Support Requests
-
-```
-Files::SupportRequest.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: 10000, 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 .
-
-
----
-
-## Create Support Request
-
-```
-Files::SupportRequest.create(
-  customer_success_access: "`no`", 
-  access_reset: false, 
-  email: "email", 
-  subject: "example", 
-  comment: "example", 
-  priority: "`low`", 
-  phone_number: "555-555-5555", 
-  name: "John Doe"
-)
-```
-
-### Parameters
-
-* `customer_success_access` (string): Enable Customer Support access to your user account?
-* `access_reset` (boolean): If set to `true`, will reset the customer success access window.
-* `email` (string): Required - Email address of the user requesting support.
-* `subject` (string): Required - Subject of the support request.
-* `comment` (string): Required - Main body of the support request.
-* `priority` (string): Priority. Can be `low` (e.g. general or billing/account questions), `normal` (e.g. the system is impaired), `high` (e.g. a production workflow or business process is impaired), `urgent` (e.g. a production workflow or business process is down), `critical` (e.g. a business-critical workflow or business process is down)
-* `phone_number` (string): Support Request phone number
-* `name` (string): Support Request name
-* `attachments_files` (array(file)): 
-
-
----
-
-## Create an export CSV of Support Request resources
-
-```
-Files::SupportRequest.create_export
-```
-
-### Parameters
-
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
-
-
----
-
-## Update Support Request
-
-```
-Files::SupportRequest.update(id, 
-  customer_success_access: "`no`", 
-  access_reset: false
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Support Request ID.
-* `customer_success_access` (string): Enable Customer Support access to your user account?
-* `access_reset` (boolean): If set to `true`, will reset the customer success access window.
-
-
----
-
-## Update Support Request
-
-```
-support_request = Files::SupportRequest.list.first
-
-support_request.update(
-  customer_success_access: "`no`",
-  access_reset: false
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Support Request ID.
-* `customer_success_access` (string): Enable Customer Support access to your user account?
-* `access_reset` (boolean): If set to `true`, will reset the customer success access window.

data/docs/sync_api_usage_snapshot.md

@@ -1,23 +0,0 @@
-# SyncApiUsageSnapshot
-
-## Example SyncApiUsageSnapshot Object
-
-```
-{
-  "ifname": "example",
-  "api_reads": 1,
-  "api_writes": 1,
-  "list_cache_hits": 1,
-  "list_cache_misses": 1,
-  "stat_cache_hits": 1,
-  "stat_cache_misses": 1
-}
-```
-
-* `ifname` (string): Interface Name
-* `api_reads` (int64): API Reads
-* `api_writes` (int64): API Writes
-* `list_cache_hits` (int64): List Cache Hits
-* `list_cache_misses` (int64): List Cache Misses
-* `stat_cache_hits` (int64): Stat Cache Hits
-* `stat_cache_misses` (int64): Stat Cache Misses

data/docs/sync_api_usage_snapshot_report.md

@@ -1,71 +0,0 @@
-# SyncApiUsageSnapshotReport
-
-## Example SyncApiUsageSnapshotReport Object
-
-```
-{
-  "start_time": "2000-01-01T01:00:00Z",
-  "end_time": "2000-01-01T01:00:00Z",
-  "uuid": "example",
-  "auth_cache_hits": 1,
-  "auth_cache_misses": 1,
-  "auth_api_requests_for_sftp": 1,
-  "auth_api_requests_for_ftp": 1,
-  "auth_api_requests_for_dav": 1,
-  "auth_api_requests_for_desktop": 1,
-  "auth_api_requests_for_restapi": 1,
-  "number_of_sync_api_usage_snapshots": 1,
-  "sync_api_usage_snapshots": [
-
-  ]
-}
-```
-
-* `start_time` (date-time): start time of statistics collection
-* `end_time` (date-time): end time of statistics collection
-* `uuid` (string): Unique ID for this entry
-* `auth_cache_hits` (int64): Numbers of hits of the authentication cache
-* `auth_cache_misses` (int64): Numbers of misses of the authentication cache
-* `auth_api_requests_for_sftp` (int64): A count of api authentications requests for SFTP
-* `auth_api_requests_for_ftp` (int64): A count of api authentications requests for FTP
-* `auth_api_requests_for_dav` (int64): A count of api authentications requests for DAV
-* `auth_api_requests_for_desktop` (int64): A count of api authentications requests for Desktop
-* `auth_api_requests_for_restapi` (int64): A count of api authentications requests for Restapi
-* `number_of_sync_api_usage_snapshots` (int64): A count of the number of api usage logs
-* `sync_api_usage_snapshots` (array(object)): A list of all the api usage logs
-
-
----
-
-## Create Sync API Usage Snapshot Report
-
-```
-Files::SyncApiUsageSnapshotReport.create(
-  start_time: "2000-01-01T01:00:00Z", 
-  end_time: "2000-01-01T01:00:00Z", 
-  uuid: "example", 
-  auth_cache_hits: 1, 
-  auth_cache_misses: 1, 
-  auth_api_requests_for_sftp: 1, 
-  auth_api_requests_for_ftp: 1, 
-  auth_api_requests_for_dav: 1, 
-  auth_api_requests_for_desktop: 1, 
-  auth_api_requests_for_restapi: 1, 
-  number_of_sync_api_usage_snapshots: 1
-)
-```
-
-### Parameters
-
-* `start_time` (string): start time of statistics collection
-* `end_time` (string): end time of statistics collection
-* `uuid` (string): Unique ID for this entry
-* `auth_cache_hits` (int64): Numbers of hits of the authentication cache
-* `auth_cache_misses` (int64): Numbers of misses of the authentication cache
-* `auth_api_requests_for_sftp` (int64): A count of api authentications requests for SFTP
-* `auth_api_requests_for_ftp` (int64): A count of api authentications requests for FTP
-* `auth_api_requests_for_dav` (int64): A count of api authentications requests for DAV
-* `auth_api_requests_for_desktop` (int64): A count of api authentications requests for Desktop
-* `auth_api_requests_for_restapi` (int64): A count of api authentications requests for Restapi
-* `number_of_sync_api_usage_snapshots` (int64): A count of the number of api usage logs
-* `sync_api_usage_snapshots` (array(object)): 

data/docs/sync_bandwidth_snapshot.md

@@ -1,48 +0,0 @@
-# SyncBandwidthSnapshot
-
-## Example SyncBandwidthSnapshot Object
-
-```
-{
-  "id": 1,
-  "site_id": 123,
-  "sync_bytes_received": "1.0",
-  "sync_bytes_sent": "1.0",
-  "created_at": "2000-01-01T01:00:00Z"
-}
-```
-
-* `id` (int64): sync bandwidth snapshot ID
-* `site_id` (int64): Site ID
-* `sync_bytes_received` (decimal): bytes received
-* `sync_bytes_sent` (decimal): bytes sent
-* `created_at` (date-time): sync bandwidth snapshot created at date/time
-* `remote_server_id` (int64): ID for the remote server consuming sync bandwidth
-
-
----
-
-## Create Sync Bandwidth Snapshot
-
-```
-Files::SyncBandwidthSnapshot.create(
-  remote_server_id: 1, 
-  sync_bytes_sent: 1, 
-  sync_bytes_received: 1
-)
-```
-
-### Parameters
-
-* `remote_server_id` (int64): Required - ID for the remote server consuming sync bandwidth
-* `sync_bytes_sent` (int64): Required - Sync bytes sent
-* `sync_bytes_received` (int64): Required - Sync bytes received
-
-
----
-
-## Create Sync Bandwidth Snapshots
-
-```
-Files::SyncBandwidthSnapshot.create_batch
-```

data/docs/two_factor_authentication_method.md

@@ -1,169 +0,0 @@
-# TwoFactorAuthenticationMethod
-
-## Example TwoFactorAuthenticationMethod Object
-
-```
-{
-  "id": 1,
-  "name": "My Verizon Phone",
-  "method_type": "sms",
-  "phone_number": "+15555555555",
-  "phone_number_country": "US",
-  "phone_number_national_format": "+15555555555",
-  "secret_tokens": [
-    "example"
-  ],
-  "setup_expired": true,
-  "setup_complete": true,
-  "setup_expires_at": "2000-01-01T01:00:00Z",
-  "totp_provisioning_uri": "https://...",
-  "webauthn_registration_options": {
-    "key": "example value"
-  },
-  "bypass_for_ftp_sftp_dav": true
-}
-```
-
-* `id` (int64): 2fa ID
-* `name` (string): 2fa method name
-* `method_type` (string): Type of 2fa
-* `phone_number` (string): 2fa phone number (if SMS)
-* `phone_number_country` (string): 2fa phone number country (if SMS)
-* `phone_number_national_format` (string): 2fa phone number national format (if SMS)
-* `secret_tokens` (array(string)): For the Static method type, this is the list of tokens which can be used
-* `setup_expired` (boolean): 2fa setup expired?
-* `setup_complete` (boolean): 2fa setup complete?
-* `setup_expires_at` (date-time): 2fa setup expires at this date/time (typically 10 minutes after a new method is created)
-* `totp_provisioning_uri` (string): TOTP provisioning URI (if TOTP)
-* `webauthn_registration_options` (object): WebAuthn / FIDO 2 registration options (if WebAuthn)
-* `bypass_for_ftp_sftp_dav` (boolean): Set true to skip checking this 2FA method when using FTP, SFTP, and DAV
-* `otp` (string): Current value of OTP, Yubikey string, or Webauthn response value.
-
-
----
-
-## List current user's 2FA methods
-
-```
-Files::TwoFactorAuthenticationMethod.get
-```
-
-### 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: 10000, 1,000 or less is recommended).
-
-
----
-
-## Create 2FA method on current user
-
-```
-Files::TwoFactorAuthenticationMethod.create(
-  method_type: "sms", 
-  name: "My Verizon Phone", 
-  phone_number: "+15555555555", 
-  bypass_for_ftp_sftp_dav: false
-)
-```
-
-### Parameters
-
-* `method_type` (string): Required - Type of 2fa
-* `name` (string): 2fa method name
-* `phone_number` (string): 2fa phone number (if SMS)
-* `bypass_for_ftp_sftp_dav` (boolean): Set true to skip checking this 2FA method when using FTP, SFTP, and DAV
-
-
----
-
-## Generate (and send if applicable) a one time password for current user's primary 2FA method
-
-```
-Files::TwoFactorAuthenticationMethod.send_code(
-  webauthn_only: false
-)
-```
-
-### Parameters
-
-* `webauthn_only` (boolean): Set to `true` to only generate an OTP for Webauthn keys and skip things like SMS.
-
-
----
-
-## List current user's 2FA methods
-
-```
-Files::TwoFactorAuthenticationMethod.create_export
-```
-
-
----
-
-## Update 2fa
-
-```
-Files::TwoFactorAuthenticationMethod.update(id, 
-  otp: "123456", 
-  name: "My Verizon Phone", 
-  bypass_for_ftp_sftp_dav: false
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - 2fa ID.
-* `otp` (string): Current value of OTP, Yubikey string, or Webauthn response value.
-* `name` (string): 2fa method name
-* `bypass_for_ftp_sftp_dav` (boolean): Set true to skip checking this 2FA method when using FTP, SFTP, and DAV
-
-
----
-
-## Delete 2fa
-
-```
-Files::TwoFactorAuthenticationMethod.delete(id)
-```
-
-### Parameters
-
-* `id` (int64): Required - 2fa ID.
-
-
----
-
-## Update 2fa
-
-```
-two_factor_authentication_method = Files::TwoFactorAuthenticationMethod.find(id)
-
-two_factor_authentication_method.update(
-  otp: "123456",
-  name: "My Verizon Phone",
-  bypass_for_ftp_sftp_dav: false
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - 2fa ID.
-* `otp` (string): Current value of OTP, Yubikey string, or Webauthn response value.
-* `name` (string): 2fa method name
-* `bypass_for_ftp_sftp_dav` (boolean): Set true to skip checking this 2FA method when using FTP, SFTP, and DAV
-
-
----
-
-## Delete 2fa
-
-```
-two_factor_authentication_method = Files::TwoFactorAuthenticationMethod.find(id)
-
-two_factor_authentication_method.delete
-```
-
-### Parameters
-
-* `id` (int64): Required - 2fa ID.

data/docs/warning.md

@@ -1,36 +0,0 @@
-# Warning
-
-## Example Warning Object
-
-```
-{
-  "warnings": [
-    "Warning"
-  ]
-}
-```
-
-* `warnings` (array(object)): A list of warnings
-
-
----
-
-## List warnings that apply to the current site
-
-```
-Files::Warning.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: 10000, 1,000 or less is recommended).
-
-
----
-
-## List warnings that apply to the current site
-
-```
-Files::Warning.create_export
-```

data/docs/webauthn_sign_request.md

@@ -1,13 +0,0 @@
-# WebauthnSignRequest
-
-## Example WebauthnSignRequest Object
-
-```
-{
-  "webauthn_authentication_options": [
-    "example"
-  ]
-}
-```
-
-* `webauthn_authentication_options` (array(object)): WebAuthn / FIDO 2 authentication options

data/docs/zip_download.md

@@ -1,32 +0,0 @@
-# ZipDownload
-
-## Example ZipDownload Object
-
-```
-{
-  "download_uri": "/zip/download?z=CODE"
-}
-```
-
-* `download_uri` (string): URL for downloading the ZIP
-* `paths` (array(string)): 
-* `bundle_registration_code` (string): 
-* `encoded_paths` (array(string)): 
-
-
----
-
-## Create a URL that can be used to download a ZIP of several files at once
-
-```
-Files::ZipDownload.create(
-  paths: ["file.txt"], 
-  encoded_paths: ["file.txt"]
-)
-```
-
-### Parameters
-
-* `paths` (array(string)): Required - 
-* `bundle_registration_code` (string): 
-* `encoded_paths` (array(string)): 

data/docs/zip_download_file.md

@@ -1,45 +0,0 @@
-# ZipDownloadFile
-
-## Example ZipDownloadFile Object
-
-```
-{
-  "site_id": 1,
-  "user_id": 1,
-  "bundle_id": 1,
-  "bundle_registration_id": 1,
-  "files": [
-    "example"
-  ],
-  "cursor": "example"
-}
-```
-
-* `site_id` (int64): Site Id
-* `user_id` (int64): User Id
-* `bundle_id` (int64): Bundle Id
-* `bundle_registration_id` (int64): Bundle Registration Id
-* `files` (array(object)): A list of file names, sizes, and signed download URLs.
-* `cursor` (string): Cursor for fetching more files in subsequent requests.
-* `code` (string): Secure code that was generated when creating the zip download.
-* `limit` (int64): Limit the number of files returned.
-
-
----
-
-## Fetch a set of file resources for a ZIP: POST /zip_download_files
-
-```
-Files::ZipDownloadFile.create(
-  code: "code", 
-  limit: 1, 
-  site_id: 1
-)
-```
-
-### Parameters
-
-* `code` (string): Required - Secure code that was generated when creating the zip download.
-* `limit` (int64): Limit the number of files returned.
-* `cursor` (string): Cursor used for paging through files.
-* `site_id` (int64): Only check the given site for the zip download.

data/docs/zip_download_files.md

@@ -1,23 +0,0 @@
-# ZipDownloadFiles
-
-## Example ZipDownloadFiles Object
-
-```
-{
-  "site_id": 1,
-  "user_id": 1,
-  "bundle_id": 1,
-  "bundle_registration_id": 1,
-  "files": [
-    "example"
-  ],
-  "cursor": "example"
-}
-```
-
-* `site_id` (int64): Site Id
-* `user_id` (int64): User Id
-* `bundle_id` (int64): Bundle Id
-* `bundle_registration_id` (int64): Bundle Registration Id
-* `files` (array(object)): A list of file names, sizes, and signed download URLs.
-* `cursor` (string): Cursor for fetching more files in subsequent requests.