files.com 1.2.174 → 1.2.176

package/README.md

@@ -565,17 +565,7 @@ A README is available on the GitHub link.
 
 ## File/Folder Operations
 
-### File Operations
-
-#### List Root Folder
-
-```javascript
-import Folder from 'files.com/lib/models/Folder.js';
-
-const dirFiles = await Folder.listFor('/');
-```
-
-#### Uploading a File
+### Upload
 
 ```javascript
 import File from 'files.com/lib/models/File.js';
@@ -584,15 +574,18 @@ import { isBrowser } from 'files.com/lib/utils.js';
 // uploading raw file data
 await File.uploadData(destinationFileName, data);
 
+// upload readable stream
+await File.uploadStream(destinationFileName, readableStream)
+
 // uploading a file on disk (not available in browser)
 if (!isBrowser()) {
   await File.uploadFile(destinationFileName, sourceFilePath);
 }
 ```
 
-#### Downloading a File
+### Download
 
-##### Get a Downloadable File Object by Path
+#### Get a Downloadable File Object by Path
 
 ```javascript
 import File from 'files.com/lib/models/File.js';
@@ -601,7 +594,7 @@ const foundFile = await File.find(remoteFilePath);
 const downloadableFile = await foundFile.download();
 ```
 
-##### Download a File (not available in browser)
+#### Download a File (not available in browser)
 
 ```javascript
 import { isBrowser } from 'files.com/lib/utils.js';
@@ -618,7 +611,15 @@ if (!isBrowser()) {
 }
 ```
 
-#### Comparing Case-Insensitive Files and Paths
+### List
+
+```javascript
+import Folder from 'files.com/lib/models/Folder.js';
+
+const dirFiles = await Folder.listFor('/');
+```
+
+### Comparing Case-Insensitive Files and Paths
 
 For related documentation see [Case Sensitivity Documentation](https://www.files.com/docs/files-and-folders/file-system-semantics/case-sensitivity).
 

package/_VERSION

@@ -1 +1 @@
-1.2.174
+1.2.176

package/docs/models/Automation.md

@@ -200,7 +200,7 @@ await Automation.create({
 
 ---
 
-## Manually run automation
+## Manually Run Automation
 
 ```
 const automation = await Automation.find(id)

package/docs/models/Behavior.md

@@ -111,7 +111,7 @@ await Behavior.create({
 
 ---
 
-## Test webhook
+## Test Webhook
 
 ```
 await Behavior.webhookTest({

package/docs/models/DnsRecord.md

@@ -18,7 +18,7 @@
 
 ---
 
-## Show site DNS configuration
+## Show Site DNS Configuration
 
 ```
 await DnsRecord.list

package/docs/models/File.md

@@ -97,7 +97,7 @@
 
 ---
 
-## Upload file
+## Upload File
 
 ```
 await File.create(path, {
@@ -132,7 +132,7 @@ await File.create(path, {
 
 ---
 
-## Find file/folder by path
+## Find File/Folder by Path
 
 ```
 await File.find(path, {
@@ -151,7 +151,7 @@ await File.find(path, {
 
 ---
 
-## Download file
+## Download File
 
 ```
 const file = await File.find(path)
@@ -222,7 +222,7 @@ await file.download({
 
 ---
 
-## Update file/folder metadata
+## Update File/Folder Metadata
 
 ```
 const file = await File.find(path)
@@ -293,7 +293,7 @@ await file.update({
 
 ---
 
-## Delete file/folder
+## Delete File/Folder
 
 ```
 const file = await File.find(path)
@@ -311,7 +311,7 @@ await file.delete({
 
 ---
 
-## Copy file/folder
+## Copy File/Folder
 
 ```
 const file = await File.find(path)
@@ -341,7 +341,7 @@ await file.copy({
 
 ---
 
-## Move file/folder
+## Move File/Folder
 
 ```
 const file = await File.find(path)

package/docs/models/Folder.md

@@ -115,7 +115,7 @@ await Folder.listFor(path, {
 
 ---
 
-## Create folder
+## Create Folder
 
 ```
 await Folder.create(path, {

package/docs/models/Site.md

@@ -471,7 +471,7 @@
 
 ---
 
-## Show site settings
+## Show Site Settings
 
 ```
 await Site.get
@@ -489,7 +489,7 @@ await Site.getUsage
 
 ---
 
-## Update site settings
+## Update Site Settings
 
 ```
 await Site.update({

package/lib/Files.js

@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
 var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
-var version = '1.2.174';
+var version = '1.2.176';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/Automation.js

@@ -271,7 +271,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   (0, _defineProperty2.default)(this, "setWebhookUrl", function (value) {
     _this.attributes.webhook_url = value;
   });
-  // Manually run automation
+  // Manually Run Automation
   (0, _defineProperty2.default)(this, "manualRun", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
       _args = arguments;

package/lib/models/File.js

@@ -470,7 +470,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
   (0, _defineProperty2.default)(this, "setWithRename", function (value) {
     _this.attributes.with_rename = value;
   });
-  // Download file
+  // Download File
   //
   // Parameters:
   //   action - string - Can be blank, `redirect` or `stat`.  If set to `stat`, we will return file information but without a download URL, and without logging a download.  If set to `redirect` we will serve a 302 redirect directly to the file.  This is used for integrations with Zapier, and is not recommended for most integrations.
@@ -663,7 +663,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
     var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     return _this.delete(params);
   });
-  // Copy file/folder
+  // Copy File/Folder
   //
   // Parameters:
   //   destination (required) - string - Copy destination path.
@@ -743,7 +743,7 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
       }
     }, _callee9);
   })));
-  // Move file/folder
+  // Move File/Folder
   //
   // Parameters:
   //   destination (required) - string - Move destination path.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.2.174",
+  "version": "1.2.176",
   "description": "Files.com SDK for JavaScript",
   "keywords": [
     "files.com",

package/src/Files.js

@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
 let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
-const version = '1.2.174'
+const version = '1.2.176'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/Automation.js

@@ -266,7 +266,7 @@ class Automation {
     this.attributes.webhook_url = value
   }
 
-  // Manually run automation
+  // Manually Run Automation
   manualRun = async (params = {}) => {
     if (!this.attributes.id) {
       throw new errors.EmptyPropertyError('Current object has no id')

package/src/models/File.js

@@ -613,7 +613,7 @@ class File {
     this.attributes.with_rename = value
   }
 
-  // Download file
+  // Download File
   //
   // Parameters:
   //   action - string - Can be blank, `redirect` or `stat`.  If set to `stat`, we will return file information but without a download URL, and without logging a download.  If set to `redirect` we will serve a 302 redirect directly to the file.  This is used for integrations with Zapier, and is not recommended for most integrations.
@@ -724,7 +724,7 @@ class File {
   destroy = (params = {}) =>
     this.delete(params)
 
-  // Copy file/folder
+  // Copy File/Folder
   //
   // Parameters:
   //   destination (required) - string - Copy destination path.
@@ -770,7 +770,7 @@ class File {
     return new FileAction(response?.data, this.options)
   }
 
-  // Move file/folder
+  // Move File/Folder
   //
   // Parameters:
   //   destination (required) - string - Move destination path.