files.com 1.2.205 → 1.2.207
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/_VERSION +1 -1
- package/docs/Errors.md +4 -0
- package/docs/models/Permission.md +6 -2
- package/lib/Errors.js +776 -728
- package/lib/Files.js +1 -1
- package/lib/models/Permission.js +18 -4
- package/package.json +1 -1
- package/src/Errors.js +4 -0
- package/src/Files.js +1 -1
- package/src/models/Permission.js +13 -1
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.
|
|
14
|
+
var version = '1.2.207';
|
|
15
15
|
var userAgent = "Files.com JavaScript SDK v".concat(version);
|
|
16
16
|
var logLevel = _Logger.LogLevel.INFO;
|
|
17
17
|
var debugRequest = false;
|
package/lib/models/Permission.js
CHANGED
|
@@ -89,6 +89,13 @@ var Permission = /*#__PURE__*/(0, _createClass2.default)(function Permission() {
|
|
|
89
89
|
(0, _defineProperty2.default)(this, "setRecursive", function (value) {
|
|
90
90
|
_this.attributes.recursive = value;
|
|
91
91
|
});
|
|
92
|
+
// int64 # Site ID
|
|
93
|
+
(0, _defineProperty2.default)(this, "getSiteId", function () {
|
|
94
|
+
return _this.attributes.site_id;
|
|
95
|
+
});
|
|
96
|
+
(0, _defineProperty2.default)(this, "setSiteId", function (value) {
|
|
97
|
+
_this.attributes.site_id = value;
|
|
98
|
+
});
|
|
92
99
|
(0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
|
|
93
100
|
var params,
|
|
94
101
|
_args = arguments;
|
|
@@ -181,7 +188,7 @@ _Permission = Permission;
|
|
|
181
188
|
// Parameters:
|
|
182
189
|
// 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.
|
|
183
190
|
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
184
|
-
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `group_id`, `path` or `user_id`.
|
|
191
|
+
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path` or `user_id`.
|
|
185
192
|
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ user_id, path ]` or `[ user_id, group_id ]`.
|
|
186
193
|
// filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
|
187
194
|
// path - string - Permission path. If provided, will scope all permissions(including upward) to this path.
|
|
@@ -255,6 +262,7 @@ _Permission = Permission;
|
|
|
255
262
|
// user_id - int64 - User ID. Provide `username` or `user_id`
|
|
256
263
|
// username - string - User username. Provide `username` or `user_id`
|
|
257
264
|
// group_name - string - Group name. Provide `group_name` or `group_id`
|
|
265
|
+
// site_id - int64 - Site ID. If not provided, will default to current site. Used when creating a permission for a child site.
|
|
258
266
|
(0, _defineProperty2.default)(Permission, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
|
|
259
267
|
var params,
|
|
260
268
|
options,
|
|
@@ -307,12 +315,18 @@ _Permission = Permission;
|
|
|
307
315
|
}
|
|
308
316
|
throw new errors.InvalidParameterError("Bad parameter: group_name must be of type String, received ".concat((0, _utils.getType)(params.group_name)));
|
|
309
317
|
case 16:
|
|
310
|
-
|
|
311
|
-
|
|
318
|
+
if (!(params.site_id && !(0, _utils.isInt)(params.site_id))) {
|
|
319
|
+
_context4.next = 18;
|
|
320
|
+
break;
|
|
321
|
+
}
|
|
322
|
+
throw new errors.InvalidParameterError("Bad parameter: site_id must be of type Int, received ".concat((0, _utils.getType)(params.site_id)));
|
|
312
323
|
case 18:
|
|
324
|
+
_context4.next = 20;
|
|
325
|
+
return _Api.default.sendRequest('/permissions', 'POST', params, options);
|
|
326
|
+
case 20:
|
|
313
327
|
response = _context4.sent;
|
|
314
328
|
return _context4.abrupt("return", new _Permission(response === null || response === void 0 ? void 0 : response.data, options));
|
|
315
|
-
case
|
|
329
|
+
case 22:
|
|
316
330
|
case "end":
|
|
317
331
|
return _context4.stop();
|
|
318
332
|
}
|
package/package.json
CHANGED
package/src/Errors.js
CHANGED
|
@@ -104,6 +104,7 @@ export class BadRequest_CannotDownloadDirectoryError extends BadRequestError { c
|
|
|
104
104
|
export class BadRequest_CantMoveWithMultipleLocationsError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_CantMoveWithMultipleLocationsError' } } errorClasses.BadRequest_CantMoveWithMultipleLocationsError = BadRequest_CantMoveWithMultipleLocationsError
|
|
105
105
|
export class BadRequest_DatetimeParseError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_DatetimeParseError' } } errorClasses.BadRequest_DatetimeParseError = BadRequest_DatetimeParseError
|
|
106
106
|
export class BadRequest_DestinationSameError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_DestinationSameError' } } errorClasses.BadRequest_DestinationSameError = BadRequest_DestinationSameError
|
|
107
|
+
export class BadRequest_DoesNotSupportSortingError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_DoesNotSupportSortingError' } } errorClasses.BadRequest_DoesNotSupportSortingError = BadRequest_DoesNotSupportSortingError
|
|
107
108
|
export class BadRequest_FolderMustNotBeAFileError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_FolderMustNotBeAFileError' } } errorClasses.BadRequest_FolderMustNotBeAFileError = BadRequest_FolderMustNotBeAFileError
|
|
108
109
|
export class BadRequest_FoldersNotAllowedError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_FoldersNotAllowedError' } } errorClasses.BadRequest_FoldersNotAllowedError = BadRequest_FoldersNotAllowedError
|
|
109
110
|
export class BadRequest_InvalidBodyError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_InvalidBodyError' } } errorClasses.BadRequest_InvalidBodyError = BadRequest_InvalidBodyError
|
|
@@ -120,11 +121,13 @@ export class BadRequest_InvalidInterfaceError extends BadRequestError { construc
|
|
|
120
121
|
export class BadRequest_InvalidOauthProviderError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_InvalidOauthProviderError' } } errorClasses.BadRequest_InvalidOauthProviderError = BadRequest_InvalidOauthProviderError
|
|
121
122
|
export class BadRequest_InvalidPathError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_InvalidPathError' } } errorClasses.BadRequest_InvalidPathError = BadRequest_InvalidPathError
|
|
122
123
|
export class BadRequest_InvalidReturnToUrlError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_InvalidReturnToUrlError' } } errorClasses.BadRequest_InvalidReturnToUrlError = BadRequest_InvalidReturnToUrlError
|
|
124
|
+
export class BadRequest_InvalidSortFieldError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_InvalidSortFieldError' } } errorClasses.BadRequest_InvalidSortFieldError = BadRequest_InvalidSortFieldError
|
|
123
125
|
export class BadRequest_InvalidSortFilterCombinationError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_InvalidSortFilterCombinationError' } } errorClasses.BadRequest_InvalidSortFilterCombinationError = BadRequest_InvalidSortFilterCombinationError
|
|
124
126
|
export class BadRequest_InvalidUploadOffsetError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_InvalidUploadOffsetError' } } errorClasses.BadRequest_InvalidUploadOffsetError = BadRequest_InvalidUploadOffsetError
|
|
125
127
|
export class BadRequest_InvalidUploadPartGapError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_InvalidUploadPartGapError' } } errorClasses.BadRequest_InvalidUploadPartGapError = BadRequest_InvalidUploadPartGapError
|
|
126
128
|
export class BadRequest_InvalidUploadPartSizeError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_InvalidUploadPartSizeError' } } errorClasses.BadRequest_InvalidUploadPartSizeError = BadRequest_InvalidUploadPartSizeError
|
|
127
129
|
export class BadRequest_MethodNotAllowedError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_MethodNotAllowedError' } } errorClasses.BadRequest_MethodNotAllowedError = BadRequest_MethodNotAllowedError
|
|
130
|
+
export class BadRequest_MultipleSortParamsNotAllowedError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_MultipleSortParamsNotAllowedError' } } errorClasses.BadRequest_MultipleSortParamsNotAllowedError = BadRequest_MultipleSortParamsNotAllowedError
|
|
128
131
|
export class BadRequest_NoValidInputParamsError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_NoValidInputParamsError' } } errorClasses.BadRequest_NoValidInputParamsError = BadRequest_NoValidInputParamsError
|
|
129
132
|
export class BadRequest_PartNumberTooLargeError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_PartNumberTooLargeError' } } errorClasses.BadRequest_PartNumberTooLargeError = BadRequest_PartNumberTooLargeError
|
|
130
133
|
export class BadRequest_PathCannotHaveTrailingWhitespaceError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_PathCannotHaveTrailingWhitespaceError' } } errorClasses.BadRequest_PathCannotHaveTrailingWhitespaceError = BadRequest_PathCannotHaveTrailingWhitespaceError
|
|
@@ -133,6 +136,7 @@ export class BadRequest_RequestParamsContainInvalidCharacterError extends BadReq
|
|
|
133
136
|
export class BadRequest_RequestParamsInvalidError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_RequestParamsInvalidError' } } errorClasses.BadRequest_RequestParamsInvalidError = BadRequest_RequestParamsInvalidError
|
|
134
137
|
export class BadRequest_RequestParamsRequiredError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_RequestParamsRequiredError' } } errorClasses.BadRequest_RequestParamsRequiredError = BadRequest_RequestParamsRequiredError
|
|
135
138
|
export class BadRequest_SearchAllOnChildPathError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_SearchAllOnChildPathError' } } errorClasses.BadRequest_SearchAllOnChildPathError = BadRequest_SearchAllOnChildPathError
|
|
139
|
+
export class BadRequest_UnrecognizedSortIndexError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_UnrecognizedSortIndexError' } } errorClasses.BadRequest_UnrecognizedSortIndexError = BadRequest_UnrecognizedSortIndexError
|
|
136
140
|
export class BadRequest_UnsupportedCurrencyError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_UnsupportedCurrencyError' } } errorClasses.BadRequest_UnsupportedCurrencyError = BadRequest_UnsupportedCurrencyError
|
|
137
141
|
export class BadRequest_UnsupportedHttpResponseFormatError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_UnsupportedHttpResponseFormatError' } } errorClasses.BadRequest_UnsupportedHttpResponseFormatError = BadRequest_UnsupportedHttpResponseFormatError
|
|
138
142
|
export class BadRequest_UnsupportedMediaTypeError extends BadRequestError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'BadRequest_UnsupportedMediaTypeError' } } errorClasses.BadRequest_UnsupportedMediaTypeError = BadRequest_UnsupportedMediaTypeError
|
package/src/Files.js
CHANGED
package/src/models/Permission.js
CHANGED
|
@@ -84,6 +84,13 @@ class Permission {
|
|
|
84
84
|
this.attributes.recursive = value
|
|
85
85
|
}
|
|
86
86
|
|
|
87
|
+
// int64 # Site ID
|
|
88
|
+
getSiteId = () => this.attributes.site_id
|
|
89
|
+
|
|
90
|
+
setSiteId = value => {
|
|
91
|
+
this.attributes.site_id = value
|
|
92
|
+
}
|
|
93
|
+
|
|
87
94
|
delete = async (params = {}) => {
|
|
88
95
|
if (!this.attributes.id) {
|
|
89
96
|
throw new errors.EmptyPropertyError('Current object has no id')
|
|
@@ -125,7 +132,7 @@ class Permission {
|
|
|
125
132
|
// Parameters:
|
|
126
133
|
// 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.
|
|
127
134
|
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
128
|
-
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `group_id`, `path` or `user_id`.
|
|
135
|
+
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path` or `user_id`.
|
|
129
136
|
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ user_id, path ]` or `[ user_id, group_id ]`.
|
|
130
137
|
// filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
|
131
138
|
// path - string - Permission path. If provided, will scope all permissions(including upward) to this path.
|
|
@@ -169,6 +176,7 @@ class Permission {
|
|
|
169
176
|
// user_id - int64 - User ID. Provide `username` or `user_id`
|
|
170
177
|
// username - string - User username. Provide `username` or `user_id`
|
|
171
178
|
// group_name - string - Group name. Provide `group_name` or `group_id`
|
|
179
|
+
// site_id - int64 - Site ID. If not provided, will default to current site. Used when creating a permission for a child site.
|
|
172
180
|
static create = async (params = {}, options = {}) => {
|
|
173
181
|
if (!params.path) {
|
|
174
182
|
throw new errors.MissingParameterError('Parameter missing: path')
|
|
@@ -198,6 +206,10 @@ class Permission {
|
|
|
198
206
|
throw new errors.InvalidParameterError(`Bad parameter: group_name must be of type String, received ${getType(params.group_name)}`)
|
|
199
207
|
}
|
|
200
208
|
|
|
209
|
+
if (params.site_id && !isInt(params.site_id)) {
|
|
210
|
+
throw new errors.InvalidParameterError(`Bad parameter: site_id must be of type Int, received ${getType(params.site_id)}`)
|
|
211
|
+
}
|
|
212
|
+
|
|
201
213
|
const response = await Api.sendRequest('/permissions', 'POST', params, options)
|
|
202
214
|
|
|
203
215
|
return new Permission(response?.data, options)
|