files.com 1.2.120 → 1.2.122

Sign up to get free protection for your applications and to get access to all the features.
package/README.md CHANGED
@@ -9,9 +9,11 @@ The Files.com JavaScript SDK provides convenient access to all aspects of Files.
9
9
 
10
10
  This includes directly working with files and folders as well as performing management tasks such as adding/removing users, onboarding counterparties, retrieving information about automations and more.
11
11
 
12
+ The JavaScript SDK uses the Files.com RESTful APIs via the HTTPS protocol (port 443) to securely communicate and transfer files so no firewall changes should be required in order to allow connectivity to Files.com.
13
+
12
14
  ### JavaScript is a Core Focus at Files.com
13
15
 
14
- This SDK is used internally by serveral Files.com integrations that we maintain, and we work hard to ensure that it is always up to date and performant.
16
+ This SDK is used internally by several Files.com integrations that we maintain, and we work hard to ensure that it is always up to date and performant.
15
17
 
16
18
  It is also a very popular choice for Files.com customers looking to integrate with Files.com.
17
19
 
@@ -31,7 +33,7 @@ npm install files.com
31
33
 
32
34
  ### Usage
33
35
 
34
- #### Import and initialize
36
+ #### Import and Initialize
35
37
 
36
38
  ```js
37
39
  import Files from "files.com/lib/Files.js";
@@ -98,7 +100,7 @@ session times out, simply create a new session and resume where you left off. Th
98
100
  automatically handled by SDKs because we do not want to store password information in memory without
99
101
  your explicit consent.
100
102
 
101
- #### Logging in
103
+ #### Logging In
102
104
 
103
105
  To create a session, the `create` method is called on the `Session` object with the user's username and
104
106
  password.
@@ -109,7 +111,7 @@ This returns a session object that can be used to authenticate SDK method calls.
109
111
  const session = await Session.create({ username: 'motor', password: 'vroom' })
110
112
  ```
111
113
 
112
- #### Using a session
114
+ #### Using a Session
113
115
 
114
116
  Once a session has been created, you can store the session globally, use the session per object, or use the session per request to authenticate SDK operations.
115
117
 
@@ -124,7 +126,7 @@ const user = new User(params, { session_id: session.id })
124
126
  await User.find(id, params, { session_id: session.id })
125
127
  ```
126
128
 
127
- #### Logging out
129
+ #### Logging Out
128
130
 
129
131
  User sessions can be ended calling the `destroy` method on the `session` object.
130
132
 
@@ -134,7 +136,7 @@ await Session.destroy()
134
136
 
135
137
  ## Configuration
136
138
 
137
- ### Configuration options
139
+ ### Configuration Options
138
140
 
139
141
  #### Base URL
140
142
 
@@ -145,7 +147,7 @@ This can also be set to use a mock server in development or CI.
145
147
  Files.setBaseUrl("https://MY-SUBDOMAIN.files.com");
146
148
  ```
147
149
 
148
- #### Log level
150
+ #### Log Level
149
151
 
150
152
  Supported values:
151
153
 
@@ -171,7 +173,7 @@ Files.configureDebugging({
171
173
  })
172
174
  ```
173
175
 
174
- #### Network settings
176
+ #### Network Settings
175
177
 
176
178
  ```javascript title="Example setting"
177
179
  Files.configureNetwork({
@@ -441,14 +443,14 @@ Error
441
443
 
442
444
  ### File Operations
443
445
 
444
- #### List root folder
446
+ #### List Root Folder
445
447
 
446
448
  ```javascript
447
449
  import Folder from 'files.com/lib/models/Folder.js'
448
450
  const dirFiles = await Folder.listFor('/')
449
451
  ```
450
452
 
451
- #### Uploading a file
453
+ #### Uploading a File
452
454
 
453
455
  ```javascript
454
456
  import File from 'files.com/lib/models/File.js'
@@ -463,9 +465,9 @@ if (!isBrowser()) {
463
465
  }
464
466
  ```
465
467
 
466
- #### Downloading a file
468
+ #### Downloading a File
467
469
 
468
- ##### Get a downloadable file object by path
470
+ ##### Get a Downloadable File Object by Path
469
471
 
470
472
  ```javascript
471
473
  import File from 'files.com/lib/models/File.js'
@@ -474,7 +476,7 @@ const foundFile = await File.find(remoteFilePath)
474
476
  const downloadableFile = await foundFile.download()
475
477
  ```
476
478
 
477
- ##### Download a file (not available in browser)
479
+ ##### Download a File (not available in browser)
478
480
 
479
481
  ```javascript
480
482
  import { isBrowser } from 'files.com/lib/utils.js'
@@ -491,7 +493,7 @@ if (!isBrowser()) {
491
493
  }
492
494
  ```
493
495
 
494
- #### Comparing Case insensitive files and paths
496
+ #### Comparing Case-Insensitive Files and Paths
495
497
 
496
498
  For related documentation see [Case Sensitivity Documentation](https://www.files.com/docs/files-and-folders/file-system-semantics/case-sensitivity).
497
499
 
package/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.2.120
1
+ 1.2.122
package/lib/Files.js CHANGED
@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
11
11
  var apiKey;
12
12
  var baseUrl = 'https://app.files.com';
13
13
  var sessionId = null;
14
- var version = '1.2.120';
14
+ var version = '1.2.122';
15
15
  var userAgent = "Files.com JavaScript SDK v".concat(version);
16
16
  var logLevel = _Logger.LogLevel.INFO;
17
17
  var debugRequest = false;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "files.com",
3
- "version": "1.2.120",
3
+ "version": "1.2.122",
4
4
  "description": "Files.com SDK for JavaScript",
5
5
  "keywords": [
6
6
  "files.com",
package/src/Files.js CHANGED
@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
5
5
  let apiKey
6
6
  let baseUrl = 'https://app.files.com'
7
7
  let sessionId = null
8
- const version = '1.2.120'
8
+ const version = '1.2.122'
9
9
  let userAgent = `Files.com JavaScript SDK v${version}`
10
10
 
11
11
  let logLevel = LogLevel.INFO