files.com 1.0.218 → 1.0.220

package/docs/models/BundleRegistration.md

@@ -10,10 +10,12 @@
   "email": "john.doe@files.com",
   "ip": "10.1.1.1",
   "inbox_code": "abc123",
-  "clickwrap_body": "",
+  "clickwrap_body": "example",
   "form_field_set_id": 1,
-  "form_field_data": "",
-  "bundle_code": "",
+  "form_field_data": {
+    "key": "example value"
+  },
+  "bundle_code": "example",
   "bundle_id": 1,
   "bundle_recipient_id": 1
 }

package/docs/models/Clickwrap.md

@@ -7,9 +7,9 @@
   "id": 1,
   "name": "Example Site NDA for Files.com Use",
   "body": "[Legal body text]",
-  "use_with_users": "",
-  "use_with_bundles": "",
-  "use_with_inboxes": ""
+  "use_with_users": "example",
+  "use_with_bundles": "example",
+  "use_with_inboxes": "example"
 }
 ```
 
@@ -57,6 +57,9 @@ await Clickwrap.find(id)
 await Clickwrap.create({
   'name': "Example Site NDA for Files.com Use",
   'body': "[Legal body text]",
+  'use_with_bundles': "example",
+  'use_with_inboxes': "example",
+  'use_with_users': "example",
 })
 ```
 
@@ -79,6 +82,9 @@ const [clickwrap] = await Clickwrap.list()
 await clickwrap.update({
   'name': "Example Site NDA for Files.com Use",
   'body': "[Legal body text]",
+  'use_with_bundles': "example",
+  'use_with_inboxes': "example",
+  'use_with_users': "example",
 })
 ```
 
@@ -98,9 +104,9 @@ await clickwrap.update({
   "id": 1,
   "name": "Example Site NDA for Files.com Use",
   "body": "[Legal body text]",
-  "use_with_users": "",
-  "use_with_bundles": "",
-  "use_with_inboxes": ""
+  "use_with_users": "example",
+  "use_with_bundles": "example",
+  "use_with_inboxes": "example"
 }
 ```
 

package/docs/models/DnsRecord.md

@@ -4,7 +4,7 @@
 
 ```
 {
-  "id": "customdomain.com-CNAME-site.files.com",
+  "id": "example",
   "domain": "my-custom-domain.com",
   "rrtype": "CNAME",
   "value": "mysite.files.com"

package/docs/models/ExternalEvent.md

@@ -5,16 +5,16 @@
 ```
 {
   "id": 1,
-  "event_type": "",
-  "status": "",
-  "body": "",
+  "event_type": "example",
+  "status": "example",
+  "body": "example",
   "created_at": "2000-01-01T01:00:00Z",
-  "body_url": "",
+  "body_url": "example",
   "folder_behavior_id": 1,
   "successful_files": 1,
   "errored_files": 1,
   "bytes_synced": 1,
-  "remote_server_type": ""
+  "remote_server_type": "example"
 }
 ```
 
@@ -72,8 +72,8 @@ await ExternalEvent.find(id)
 
 ```
 await ExternalEvent.create({
-  'status': "status",
-  'body': "body",
+  'status': "example",
+  'body': "example",
 })
 ```
 

package/docs/models/File.md

@@ -20,13 +20,7 @@
   "download_uri": "https://mysite.files.com/...",
   "priority_color": "red",
   "preview_id": 1,
-  "preview": {
-    "id": 1,
-    "status": "complete",
-    "download_uri": "https://mysite.files.com/...",
-    "type": "image",
-    "size": "large"
-  }
+  "preview": ""
 }
 ```
 
@@ -153,13 +147,7 @@ await file.download({
   "download_uri": "https://mysite.files.com/...",
   "priority_color": "red",
   "preview_id": 1,
-  "preview": {
-    "id": 1,
-    "status": "complete",
-    "download_uri": "https://mysite.files.com/...",
-    "type": "image",
-    "size": "large"
-  }
+  "preview": ""
 }
 ```
 
@@ -203,13 +191,7 @@ await file.update({
   "download_uri": "https://mysite.files.com/...",
   "priority_color": "red",
   "preview_id": 1,
-  "preview": {
-    "id": 1,
-    "status": "complete",
-    "download_uri": "https://mysite.files.com/...",
-    "type": "image",
-    "size": "large"
-  }
+  "preview": ""
 }
 ```
 
@@ -257,7 +239,7 @@ await file.copy({
 ```json
 {
   "status": "pending",
-  "file_migration_id": "123"
+  "file_migration_id": 1
 }
 ```
 
@@ -284,7 +266,7 @@ await file.move({
 ```json
 {
   "status": "pending",
-  "file_migration_id": "123"
+  "file_migration_id": 1
 }
 ```
 
@@ -323,21 +305,27 @@ await file.begin_upload({
 ```json
 [
   {
-    "send": "",
+    "send": {
+      "key": "example value"
+    },
     "action": "multipart",
     "ask_about_overwrites": true,
     "available_parts": 1,
-    "expires": "",
-    "headers": "",
+    "expires": "example",
+    "headers": {
+      "key": "example value"
+    },
     "http_method": "PUT",
     "next_partsize": 1,
     "parallel_parts": true,
-    "parameters": "{}",
+    "parameters": {
+      "key": "example value"
+    },
     "part_number": 1,
     "partsize": 1,
     "path": "",
     "ref": "upload-1",
-    "upload_uri": ""
+    "upload_uri": "example"
   }
 ]
 ```

package/docs/models/FileAction.md

@@ -5,7 +5,7 @@
 ```
 {
   "status": "pending",
-  "file_migration_id": "123"
+  "file_migration_id": 1
 }
 ```
 

package/docs/models/FileComment.md

@@ -7,10 +7,7 @@
   "id": 1,
   "body": "What a great file!",
   "reactions": [
-    {
-      "id": 1,
-      "emoji": "👍"
-    }
+    null
   ]
 }
 ```
@@ -78,10 +75,7 @@ await file_comment.update({
   "id": 1,
   "body": "What a great file!",
   "reactions": [
-    {
-      "id": 1,
-      "emoji": "👍"
-    }
+    null
   ]
 }
 ```

package/docs/models/FileUploadPart.md

@@ -4,21 +4,27 @@
 
 ```
 {
-  "send": "",
+  "send": {
+    "key": "example value"
+  },
   "action": "multipart",
   "ask_about_overwrites": true,
   "available_parts": 1,
-  "expires": "",
-  "headers": "",
+  "expires": "example",
+  "headers": {
+    "key": "example value"
+  },
   "http_method": "PUT",
   "next_partsize": 1,
   "parallel_parts": true,
-  "parameters": "{}",
+  "parameters": {
+    "key": "example value"
+  },
   "part_number": 1,
   "partsize": 1,
   "path": "",
   "ref": "upload-1",
-  "upload_uri": ""
+  "upload_uri": "example"
 }
 ```
 

package/docs/models/Folder.md

@@ -20,13 +20,7 @@
   "download_uri": "https://mysite.files.com/...",
   "priority_color": "red",
   "preview_id": 1,
-  "preview": {
-    "id": 1,
-    "status": "complete",
-    "download_uri": "https://mysite.files.com/...",
-    "type": "image",
-    "size": "large"
-  }
+  "preview": ""
 }
 ```
 

package/docs/models/FormFieldSet.md

@@ -13,20 +13,7 @@
     4
   ],
   "form_fields": [
-    {
-      "id": 1,
-      "label": "Sample Label",
-      "required": true,
-      "help_text": "Help Text",
-      "field_type": "text",
-      "options_for_select": [
-        "red",
-        "green",
-        "blue"
-      ],
-      "default_option": "red",
-      "form_field_set_id": 1
-    }
+    null
   ],
   "skip_name": true,
   "skip_email": true,
@@ -85,7 +72,7 @@ await FormFieldSet.create({
   'skip_email': true,
   'skip_name': true,
   'skip_company': true,
-  'form_fields': [{"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}],
+  'form_fields': [null],
 })
 ```
 
@@ -111,7 +98,7 @@ await form_field_set.update({
   'skip_email': true,
   'skip_name': true,
   'skip_company': true,
-  'form_fields': [{"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}],
+  'form_fields': [null],
 })
 ```
 
@@ -137,20 +124,7 @@ await form_field_set.update({
     4
   ],
   "form_fields": [
-    {
-      "id": 1,
-      "label": "Sample Label",
-      "required": true,
-      "help_text": "Help Text",
-      "field_type": "text",
-      "options_for_select": [
-        "red",
-        "green",
-        "blue"
-      ],
-      "default_option": "red",
-      "form_field_set_id": 1
-    }
+    null
   ],
   "skip_name": true,
   "skip_email": true,

package/docs/models/Group.md

@@ -7,9 +7,9 @@
   "id": 1,
   "name": "owners",
   "admin_ids": "1",
-  "notes": "",
+  "notes": "example",
   "user_ids": "1",
-  "usernames": "user"
+  "usernames": "example"
 }
 ```
 
@@ -64,6 +64,7 @@ await Group.find(id)
 ```
 await Group.create({
   'name': "owners",
+  'notes': "example",
   'user_ids': "1",
   'admin_ids': "1",
 })
@@ -86,6 +87,7 @@ const [group] = await Group.list()
 
 await group.update({
   'name': "owners",
+  'notes': "example",
   'user_ids': "1",
   'admin_ids': "1",
 })
@@ -106,9 +108,9 @@ await group.update({
   "id": 1,
   "name": "owners",
   "admin_ids": "1",
-  "notes": "",
+  "notes": "example",
   "user_ids": "1",
-  "usernames": "user"
+  "usernames": "example"
 }
 ```
 

package/docs/models/GroupUser.md

@@ -4,7 +4,7 @@
 
 ```
 {
-  "group_name": "My Group",
+  "group_name": "example",
   "group_id": 1,
   "user_id": 1,
   "admin": true,
@@ -85,7 +85,7 @@ await group_user.update({
 
 ```json
 {
-  "group_name": "My Group",
+  "group_name": "example",
   "group_id": 1,
   "user_id": 1,
   "admin": true,

package/docs/models/HistoryExport.md

@@ -5,7 +5,7 @@
 ```
 {
   "id": 1,
-  "history_version": "20201213.2",
+  "history_version": "example",
   "start_at": "2000-01-01T01:00:00Z",
   "end_at": "2000-01-01T01:00:00Z",
   "status": "ready",

package/docs/models/InboxRegistration.md

@@ -8,12 +8,14 @@
   "name": "account",
   "company": "Action Verb",
   "email": "john.doe@files.com",
-  "clickwrap_body": "",
+  "clickwrap_body": "example",
   "form_field_set_id": 1,
-  "form_field_data": "",
+  "form_field_data": {
+    "key": "example value"
+  },
   "inbox_id": 1,
   "inbox_recipient_id": 1,
-  "inbox_title": ""
+  "inbox_title": "example"
 }
 ```
 

package/docs/models/InboxUpload.md

@@ -4,9 +4,9 @@
 
 ```
 {
-  "inbox_registration": "",
+  "inbox_registration": "example",
   "path": "a/b/test.txt",
-  "created_at": "2020-01-01 00:00:00"
+  "created_at": "2000-01-01T01:00:00Z"
 }
 ```
 

package/docs/models/Invoice.md

@@ -11,30 +11,14 @@
   "currency": "USD",
   "download_uri": "https://url...",
   "invoice_line_items": [
-    {
-      "amount": 1.0,
-      "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": "Premier",
-      "site": "My site"
-    }
+    null
   ],
   "method": "paypal",
   "payment_line_items": [
-    {
-      "amount": 1.0,
-      "created_at": "2000-01-01T01:00:00Z",
-      "invoice_id": 1,
-      "payment_id": 1,
-      "updated_at": "2000-01-01T01:00:00Z"
-    }
+    null
   ],
   "payment_reversed_at": "2000-01-01T01:00:00Z",
-  "payment_type": "",
+  "payment_type": "example",
   "site_name": "My Site",
   "type": "invoice",
   "updated_at": "2000-01-01T01:00:00Z"

package/docs/models/Lock.md

@@ -5,7 +5,7 @@
 ```
 {
   "path": "locked_file",
-  "timeout": 43200,
+  "timeout": 1,
   "depth": "infinity",
   "recursive": true,
   "owner": "user",

package/docs/models/Message.md

@@ -8,16 +8,7 @@
   "subject": "Files.com Account Upgrade",
   "body": "We should upgrade our Files.com account!",
   "comments": [
-    {
-      "id": 1,
-      "body": "What a great idea, thank you!",
-      "reactions": [
-        {
-          "id": 1,
-          "emoji": "👍"
-        }
-      ]
-    }
+    null
   ]
 }
 ```
@@ -112,16 +103,7 @@ await message.update({
   "subject": "Files.com Account Upgrade",
   "body": "We should upgrade our Files.com account!",
   "comments": [
-    {
-      "id": 1,
-      "body": "What a great idea, thank you!",
-      "reactions": [
-        {
-          "id": 1,
-          "emoji": "👍"
-        }
-      ]
-    }
+    null
   ]
 }
 ```

package/docs/models/MessageComment.md

@@ -7,10 +7,7 @@
   "id": 1,
   "body": "What a great idea, thank you!",
   "reactions": [
-    {
-      "id": 1,
-      "emoji": "👍"
-    }
+    null
   ]
 }
 ```
@@ -94,10 +91,7 @@ await message_comment.update({
   "id": 1,
   "body": "What a great idea, thank you!",
   "reactions": [
-    {
-      "id": 1,
-      "emoji": "👍"
-    }
+    null
   ]
 }
 ```

package/docs/models/Notification.md

@@ -7,7 +7,7 @@
   "id": 1,
   "path": "",
   "group_id": 1,
-  "group_name": "",
+  "group_name": "example",
   "triggering_group_ids": [
     1
   ],
@@ -29,7 +29,7 @@
     "notify_file.txt"
   ],
   "unsubscribed": true,
-  "unsubscribed_reason": "",
+  "unsubscribed_reason": "example",
   "user_id": 1,
   "username": "User",
   "suppressed_email": true
@@ -196,7 +196,7 @@ await notification.update({
   "id": 1,
   "path": "",
   "group_id": 1,
-  "group_name": "",
+  "group_name": "example",
   "triggering_group_ids": [
     1
   ],
@@ -218,7 +218,7 @@ await notification.update({
     "notify_file.txt"
   ],
   "unsubscribed": true,
-  "unsubscribed_reason": "",
+  "unsubscribed_reason": "example",
   "user_id": 1,
   "username": "User",
   "suppressed_email": true

package/docs/models/Payment.md

@@ -11,30 +11,14 @@
   "currency": "USD",
   "download_uri": "https://url...",
   "invoice_line_items": [
-    {
-      "amount": 1.0,
-      "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": "Premier",
-      "site": "My site"
-    }
+    null
   ],
   "method": "paypal",
   "payment_line_items": [
-    {
-      "amount": 1.0,
-      "created_at": "2000-01-01T01:00:00Z",
-      "invoice_id": 1,
-      "payment_id": 1,
-      "updated_at": "2000-01-01T01:00:00Z"
-    }
+    null
   ],
   "payment_reversed_at": "2000-01-01T01:00:00Z",
-  "payment_type": "",
+  "payment_type": "example",
   "site_name": "My Site",
   "type": "invoice",
   "updated_at": "2000-01-01T01:00:00Z"

package/docs/models/Permission.md

@@ -5,11 +5,11 @@
 ```
 {
   "id": 1,
-  "path": "",
+  "path": "example",
   "user_id": 1,
   "username": "Sser",
   "group_id": 1,
-  "group_name": "",
+  "group_name": "example",
   "permission": "full",
   "recursive": true
 }
@@ -31,6 +31,7 @@
 ```
 await Permission.list({
   'per_page': 1,
+  'path': "example",
   'group_id': 1,
   'user_id': 1,
   'include_groups': true,
@@ -61,6 +62,7 @@ await Permission.list({
 ```
 await Permission.create({
   'group_id': 1,
+  'path': "example",
   'permission': "full",
   'recursive': true,
   'user_id': 1,

package/docs/models/PublicIpAddress.md

@@ -6,8 +6,8 @@
 {
   "ip_address": "1.1.1.1",
   "server_name": "server-1",
-  "ftp_enabled": "",
-  "sftp_enabled": ""
+  "ftp_enabled": "example",
+  "sftp_enabled": "example"
 }
 ```