files.com 1.2.296 → 1.2.298
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 +6 -1
- package/_VERSION +1 -1
- package/docs/Errors.md +6 -1
- package/docs/models/AccountLineItem.md +1 -0
- package/docs/models/Invoice.md +1 -0
- package/docs/models/InvoiceLineItem.md +2 -0
- package/docs/models/Payment.md +1 -0
- package/docs/models/Sync.md +68 -2
- package/docs/models/SyncRun.md +8 -6
- package/lib/Errors.js +598 -538
- package/lib/Files.js +1 -1
- package/lib/models/InvoiceLineItem.js +4 -0
- package/lib/models/Sync.js +174 -118
- package/lib/models/SyncRun.js +23 -28
- package/package.json +1 -1
- package/src/Errors.js +6 -1
- package/src/Files.js +1 -1
- package/src/models/InvoiceLineItem.js +3 -0
- package/src/models/Sync.js +33 -0
- package/src/models/SyncRun.js +11 -14
package/lib/models/SyncRun.js
CHANGED
|
@@ -64,10 +64,6 @@ var SyncRun = /*#__PURE__*/(0, _createClass2.default)(function SyncRun() {
|
|
|
64
64
|
(0, _defineProperty2.default)(this, "getEventErrors", function () {
|
|
65
65
|
return _this.attributes.event_errors;
|
|
66
66
|
});
|
|
67
|
-
// int64 # Total bytes synced in this run
|
|
68
|
-
(0, _defineProperty2.default)(this, "getBytesSynced", function () {
|
|
69
|
-
return _this.attributes.bytes_synced;
|
|
70
|
-
});
|
|
71
67
|
// int64 # Number of files compared
|
|
72
68
|
(0, _defineProperty2.default)(this, "getComparedFiles", function () {
|
|
73
69
|
return _this.attributes.compared_files;
|
|
@@ -100,6 +96,18 @@ var SyncRun = /*#__PURE__*/(0, _createClass2.default)(function SyncRun() {
|
|
|
100
96
|
(0, _defineProperty2.default)(this, "getNotified", function () {
|
|
101
97
|
return _this.attributes.notified;
|
|
102
98
|
});
|
|
99
|
+
// boolean # Whether this run was a dry run (no actual changes made)
|
|
100
|
+
(0, _defineProperty2.default)(this, "getDryRun", function () {
|
|
101
|
+
return _this.attributes.dry_run;
|
|
102
|
+
});
|
|
103
|
+
// int64 # Total bytes synced in this run
|
|
104
|
+
(0, _defineProperty2.default)(this, "getBytesSynced", function () {
|
|
105
|
+
return _this.attributes.bytes_synced;
|
|
106
|
+
});
|
|
107
|
+
// int64 # Estimated bytes count for this run
|
|
108
|
+
(0, _defineProperty2.default)(this, "getEstimatedBytesCount", function () {
|
|
109
|
+
return _this.attributes.estimated_bytes_count;
|
|
110
|
+
});
|
|
103
111
|
// date-time # When this run was created
|
|
104
112
|
(0, _defineProperty2.default)(this, "getCreatedAt", function () {
|
|
105
113
|
return _this.attributes.created_at;
|
|
@@ -126,9 +134,8 @@ _SyncRun = SyncRun;
|
|
|
126
134
|
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
127
135
|
// 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.
|
|
128
136
|
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
129
|
-
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `
|
|
130
|
-
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`
|
|
131
|
-
// sync_id (required) - int64 - ID of the Sync this run belongs to
|
|
137
|
+
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `sync_id` or `created_at`.
|
|
138
|
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `dry_run` or `sync_id`. Valid field combinations are `[ sync_id, status ]`.
|
|
132
139
|
(0, _defineProperty2.default)(SyncRun, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
|
|
133
140
|
var _response$data;
|
|
134
141
|
var params,
|
|
@@ -140,44 +147,32 @@ _SyncRun = SyncRun;
|
|
|
140
147
|
case 0:
|
|
141
148
|
params = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
|
|
142
149
|
options = _args.length > 1 && _args[1] !== undefined ? _args[1] : {};
|
|
143
|
-
if (params.sync_id) {
|
|
144
|
-
_context.next = 1;
|
|
145
|
-
break;
|
|
146
|
-
}
|
|
147
|
-
throw new errors.MissingParameterError('Parameter missing: sync_id');
|
|
148
|
-
case 1:
|
|
149
150
|
if (!(params.user_id && !(0, _utils.isInt)(params.user_id))) {
|
|
150
|
-
_context.next =
|
|
151
|
+
_context.next = 1;
|
|
151
152
|
break;
|
|
152
153
|
}
|
|
153
154
|
throw new errors.InvalidParameterError("Bad parameter: user_id must be of type Int, received ".concat((0, _utils.getType)(params.user_id)));
|
|
154
|
-
case
|
|
155
|
+
case 1:
|
|
155
156
|
if (!(params.cursor && !(0, _utils.isString)(params.cursor))) {
|
|
156
|
-
_context.next =
|
|
157
|
+
_context.next = 2;
|
|
157
158
|
break;
|
|
158
159
|
}
|
|
159
160
|
throw new errors.InvalidParameterError("Bad parameter: cursor must be of type String, received ".concat((0, _utils.getType)(params.cursor)));
|
|
160
|
-
case
|
|
161
|
+
case 2:
|
|
161
162
|
if (!(params.per_page && !(0, _utils.isInt)(params.per_page))) {
|
|
162
|
-
_context.next =
|
|
163
|
+
_context.next = 3;
|
|
163
164
|
break;
|
|
164
165
|
}
|
|
165
166
|
throw new errors.InvalidParameterError("Bad parameter: per_page must be of type Int, received ".concat((0, _utils.getType)(params.per_page)));
|
|
166
|
-
case
|
|
167
|
-
|
|
168
|
-
_context.next = 5;
|
|
169
|
-
break;
|
|
170
|
-
}
|
|
171
|
-
throw new errors.InvalidParameterError("Bad parameter: sync_id must be of type Int, received ".concat((0, _utils.getType)(params.sync_id)));
|
|
172
|
-
case 5:
|
|
173
|
-
_context.next = 6;
|
|
167
|
+
case 3:
|
|
168
|
+
_context.next = 4;
|
|
174
169
|
return _Api.default.sendRequest('/sync_runs', 'GET', params, options);
|
|
175
|
-
case
|
|
170
|
+
case 4:
|
|
176
171
|
response = _context.sent;
|
|
177
172
|
return _context.abrupt("return", (response === null || response === void 0 || (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.map(function (obj) {
|
|
178
173
|
return new _SyncRun(obj, options);
|
|
179
174
|
})) || []);
|
|
180
|
-
case
|
|
175
|
+
case 5:
|
|
181
176
|
case "end":
|
|
182
177
|
return _context.stop();
|
|
183
178
|
}
|
package/package.json
CHANGED
package/src/Errors.js
CHANGED
|
@@ -178,12 +178,16 @@ export class NotAuthorized_FullPermissionRequiredError extends NotAuthorizedErro
|
|
|
178
178
|
export class NotAuthorized_HistoryPermissionRequiredError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_HistoryPermissionRequiredError' } } errorClasses.NotAuthorized_HistoryPermissionRequiredError = NotAuthorized_HistoryPermissionRequiredError
|
|
179
179
|
export class NotAuthorized_InsufficientPermissionForParamsError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_InsufficientPermissionForParamsError' } } errorClasses.NotAuthorized_InsufficientPermissionForParamsError = NotAuthorized_InsufficientPermissionForParamsError
|
|
180
180
|
export class NotAuthorized_InsufficientPermissionForSiteError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_InsufficientPermissionForSiteError' } } errorClasses.NotAuthorized_InsufficientPermissionForSiteError = NotAuthorized_InsufficientPermissionForSiteError
|
|
181
|
+
export class NotAuthorized_MoverAccessDeniedError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_MoverAccessDeniedError' } } errorClasses.NotAuthorized_MoverAccessDeniedError = NotAuthorized_MoverAccessDeniedError
|
|
182
|
+
export class NotAuthorized_MoverPackageRequiredError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_MoverPackageRequiredError' } } errorClasses.NotAuthorized_MoverPackageRequiredError = NotAuthorized_MoverPackageRequiredError
|
|
181
183
|
export class NotAuthorized_MustAuthenticateWithApiKeyError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_MustAuthenticateWithApiKeyError' } } errorClasses.NotAuthorized_MustAuthenticateWithApiKeyError = NotAuthorized_MustAuthenticateWithApiKeyError
|
|
182
184
|
export class NotAuthorized_NeedAdminPermissionForInboxError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_NeedAdminPermissionForInboxError' } } errorClasses.NotAuthorized_NeedAdminPermissionForInboxError = NotAuthorized_NeedAdminPermissionForInboxError
|
|
183
185
|
export class NotAuthorized_NonAdminsMustQueryByFolderOrPathError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_NonAdminsMustQueryByFolderOrPathError' } } errorClasses.NotAuthorized_NonAdminsMustQueryByFolderOrPathError = NotAuthorized_NonAdminsMustQueryByFolderOrPathError
|
|
184
186
|
export class NotAuthorized_NotAllowedToCreateBundleError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_NotAllowedToCreateBundleError' } } errorClasses.NotAuthorized_NotAllowedToCreateBundleError = NotAuthorized_NotAllowedToCreateBundleError
|
|
187
|
+
export class NotAuthorized_NotEnqueuableSyncError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_NotEnqueuableSyncError' } } errorClasses.NotAuthorized_NotEnqueuableSyncError = NotAuthorized_NotEnqueuableSyncError
|
|
185
188
|
export class NotAuthorized_PasswordChangeNotRequiredError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_PasswordChangeNotRequiredError' } } errorClasses.NotAuthorized_PasswordChangeNotRequiredError = NotAuthorized_PasswordChangeNotRequiredError
|
|
186
189
|
export class NotAuthorized_PasswordChangeRequiredError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_PasswordChangeRequiredError' } } errorClasses.NotAuthorized_PasswordChangeRequiredError = NotAuthorized_PasswordChangeRequiredError
|
|
190
|
+
export class NotAuthorized_PaymentMethodErrorError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_PaymentMethodErrorError' } } errorClasses.NotAuthorized_PaymentMethodErrorError = NotAuthorized_PaymentMethodErrorError
|
|
187
191
|
export class NotAuthorized_ReadOnlySessionError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_ReadOnlySessionError' } } errorClasses.NotAuthorized_ReadOnlySessionError = NotAuthorized_ReadOnlySessionError
|
|
188
192
|
export class NotAuthorized_ReadPermissionRequiredError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_ReadPermissionRequiredError' } } errorClasses.NotAuthorized_ReadPermissionRequiredError = NotAuthorized_ReadPermissionRequiredError
|
|
189
193
|
export class NotAuthorized_ReauthenticationFailedError extends NotAuthorizedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotAuthorized_ReauthenticationFailedError' } } errorClasses.NotAuthorized_ReauthenticationFailedError = NotAuthorized_ReauthenticationFailedError
|
|
@@ -209,6 +213,7 @@ export class NotFound_NestedNotFoundError extends NotFoundError { constructor(me
|
|
|
209
213
|
export class NotFound_PlanNotFoundError extends NotFoundError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotFound_PlanNotFoundError' } } errorClasses.NotFound_PlanNotFoundError = NotFound_PlanNotFoundError
|
|
210
214
|
export class NotFound_SiteNotFoundError extends NotFoundError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotFound_SiteNotFoundError' } } errorClasses.NotFound_SiteNotFoundError = NotFound_SiteNotFoundError
|
|
211
215
|
export class NotFound_UserNotFoundError extends NotFoundError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'NotFound_UserNotFoundError' } } errorClasses.NotFound_UserNotFoundError = NotFound_UserNotFoundError
|
|
216
|
+
export class ProcessingFailure_AgentUnavailableError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_AgentUnavailableError' } } errorClasses.ProcessingFailure_AgentUnavailableError = ProcessingFailure_AgentUnavailableError
|
|
212
217
|
export class ProcessingFailure_AlreadyCompletedError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_AlreadyCompletedError' } } errorClasses.ProcessingFailure_AlreadyCompletedError = ProcessingFailure_AlreadyCompletedError
|
|
213
218
|
export class ProcessingFailure_AutomationCannotBeRunManuallyError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_AutomationCannotBeRunManuallyError' } } errorClasses.ProcessingFailure_AutomationCannotBeRunManuallyError = ProcessingFailure_AutomationCannotBeRunManuallyError
|
|
214
219
|
export class ProcessingFailure_BehaviorNotAllowedOnRemoteServerError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_BehaviorNotAllowedOnRemoteServerError' } } errorClasses.ProcessingFailure_BehaviorNotAllowedOnRemoteServerError = ProcessingFailure_BehaviorNotAllowedOnRemoteServerError
|
|
@@ -250,6 +255,7 @@ export class ProcessingFailure_RemoteServerErrorError extends ProcessingFailureE
|
|
|
250
255
|
export class ProcessingFailure_ResourceBelongsToParentSiteError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_ResourceBelongsToParentSiteError' } } errorClasses.ProcessingFailure_ResourceBelongsToParentSiteError = ProcessingFailure_ResourceBelongsToParentSiteError
|
|
251
256
|
export class ProcessingFailure_ResourceLockedError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_ResourceLockedError' } } errorClasses.ProcessingFailure_ResourceLockedError = ProcessingFailure_ResourceLockedError
|
|
252
257
|
export class ProcessingFailure_SubfolderLockedError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_SubfolderLockedError' } } errorClasses.ProcessingFailure_SubfolderLockedError = ProcessingFailure_SubfolderLockedError
|
|
258
|
+
export class ProcessingFailure_SyncInProgressError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_SyncInProgressError' } } errorClasses.ProcessingFailure_SyncInProgressError = ProcessingFailure_SyncInProgressError
|
|
253
259
|
export class ProcessingFailure_TwoFactorAuthenticationCodeAlreadySentError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_TwoFactorAuthenticationCodeAlreadySentError' } } errorClasses.ProcessingFailure_TwoFactorAuthenticationCodeAlreadySentError = ProcessingFailure_TwoFactorAuthenticationCodeAlreadySentError
|
|
254
260
|
export class ProcessingFailure_TwoFactorAuthenticationCountryBlacklistedError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_TwoFactorAuthenticationCountryBlacklistedError' } } errorClasses.ProcessingFailure_TwoFactorAuthenticationCountryBlacklistedError = ProcessingFailure_TwoFactorAuthenticationCountryBlacklistedError
|
|
255
261
|
export class ProcessingFailure_TwoFactorAuthenticationGeneralErrorError extends ProcessingFailureError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ProcessingFailure_TwoFactorAuthenticationGeneralErrorError' } } errorClasses.ProcessingFailure_TwoFactorAuthenticationGeneralErrorError = ProcessingFailure_TwoFactorAuthenticationGeneralErrorError
|
|
@@ -263,7 +269,6 @@ export class RateLimited_TooManyConcurrentRequestsError extends RateLimitedError
|
|
|
263
269
|
export class RateLimited_TooManyLoginAttemptsError extends RateLimitedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'RateLimited_TooManyLoginAttemptsError' } } errorClasses.RateLimited_TooManyLoginAttemptsError = RateLimited_TooManyLoginAttemptsError
|
|
264
270
|
export class RateLimited_TooManyRequestsError extends RateLimitedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'RateLimited_TooManyRequestsError' } } errorClasses.RateLimited_TooManyRequestsError = RateLimited_TooManyRequestsError
|
|
265
271
|
export class RateLimited_TooManySharesError extends RateLimitedError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'RateLimited_TooManySharesError' } } errorClasses.RateLimited_TooManySharesError = RateLimited_TooManySharesError
|
|
266
|
-
export class ServiceUnavailable_AgentUnavailableError extends ServiceUnavailableError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ServiceUnavailable_AgentUnavailableError' } } errorClasses.ServiceUnavailable_AgentUnavailableError = ServiceUnavailable_AgentUnavailableError
|
|
267
272
|
export class ServiceUnavailable_AutomationsUnavailableError extends ServiceUnavailableError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ServiceUnavailable_AutomationsUnavailableError' } } errorClasses.ServiceUnavailable_AutomationsUnavailableError = ServiceUnavailable_AutomationsUnavailableError
|
|
268
273
|
export class ServiceUnavailable_MigrationInProgressError extends ServiceUnavailableError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ServiceUnavailable_MigrationInProgressError' } } errorClasses.ServiceUnavailable_MigrationInProgressError = ServiceUnavailable_MigrationInProgressError
|
|
269
274
|
export class ServiceUnavailable_SiteDisabledError extends ServiceUnavailableError { constructor(message, code, errorData) { super(message, code, errorData); this.name = 'ServiceUnavailable_SiteDisabledError' } } errorClasses.ServiceUnavailable_SiteDisabledError = ServiceUnavailable_SiteDisabledError
|
package/src/Files.js
CHANGED
package/src/models/Sync.js
CHANGED
|
@@ -202,6 +202,39 @@ class Sync {
|
|
|
202
202
|
this.attributes.holiday_region = value
|
|
203
203
|
}
|
|
204
204
|
|
|
205
|
+
// SyncRun # The latest run of this sync
|
|
206
|
+
getLatestSyncRun = () => this.attributes.latest_sync_run
|
|
207
|
+
|
|
208
|
+
setLatestSyncRun = value => {
|
|
209
|
+
this.attributes.latest_sync_run = value
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
// Dry Run Sync
|
|
213
|
+
dryRun = async (params = {}) => {
|
|
214
|
+
if (!this.attributes.id) {
|
|
215
|
+
throw new errors.EmptyPropertyError('Current object has no id')
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
if (!isObject(params)) {
|
|
219
|
+
throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
params.id = this.attributes.id
|
|
223
|
+
if (params.id && !isInt(params.id)) {
|
|
224
|
+
throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
if (!params.id) {
|
|
228
|
+
if (this.attributes.id) {
|
|
229
|
+
params.id = this.id
|
|
230
|
+
} else {
|
|
231
|
+
throw new errors.MissingParameterError('Parameter missing: id')
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
await Api.sendRequest(`/syncs/${encodeURIComponent(params.id)}/dry_run`, 'POST', params, this.options)
|
|
236
|
+
}
|
|
237
|
+
|
|
205
238
|
// Manually Run Sync
|
|
206
239
|
manualRun = async (params = {}) => {
|
|
207
240
|
if (!this.attributes.id) {
|
package/src/models/SyncRun.js
CHANGED
|
@@ -52,9 +52,6 @@ class SyncRun {
|
|
|
52
52
|
// array(string) # Array of errors encountered during the run
|
|
53
53
|
getEventErrors = () => this.attributes.event_errors
|
|
54
54
|
|
|
55
|
-
// int64 # Total bytes synced in this run
|
|
56
|
-
getBytesSynced = () => this.attributes.bytes_synced
|
|
57
|
-
|
|
58
55
|
// int64 # Number of files compared
|
|
59
56
|
getComparedFiles = () => this.attributes.compared_files
|
|
60
57
|
|
|
@@ -79,6 +76,15 @@ class SyncRun {
|
|
|
79
76
|
// boolean # Whether notifications were sent for this run
|
|
80
77
|
getNotified = () => this.attributes.notified
|
|
81
78
|
|
|
79
|
+
// boolean # Whether this run was a dry run (no actual changes made)
|
|
80
|
+
getDryRun = () => this.attributes.dry_run
|
|
81
|
+
|
|
82
|
+
// int64 # Total bytes synced in this run
|
|
83
|
+
getBytesSynced = () => this.attributes.bytes_synced
|
|
84
|
+
|
|
85
|
+
// int64 # Estimated bytes count for this run
|
|
86
|
+
getEstimatedBytesCount = () => this.attributes.estimated_bytes_count
|
|
87
|
+
|
|
82
88
|
// date-time # When this run was created
|
|
83
89
|
getCreatedAt = () => this.attributes.created_at
|
|
84
90
|
|
|
@@ -89,14 +95,9 @@ class SyncRun {
|
|
|
89
95
|
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
90
96
|
// 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.
|
|
91
97
|
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
92
|
-
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `
|
|
93
|
-
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`
|
|
94
|
-
// sync_id (required) - int64 - ID of the Sync this run belongs to
|
|
98
|
+
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `sync_id` or `created_at`.
|
|
99
|
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `dry_run` or `sync_id`. Valid field combinations are `[ sync_id, status ]`.
|
|
95
100
|
static list = async (params = {}, options = {}) => {
|
|
96
|
-
if (!params.sync_id) {
|
|
97
|
-
throw new errors.MissingParameterError('Parameter missing: sync_id')
|
|
98
|
-
}
|
|
99
|
-
|
|
100
101
|
if (params.user_id && !isInt(params.user_id)) {
|
|
101
102
|
throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params.user_id)}`)
|
|
102
103
|
}
|
|
@@ -109,10 +110,6 @@ class SyncRun {
|
|
|
109
110
|
throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params.per_page)}`)
|
|
110
111
|
}
|
|
111
112
|
|
|
112
|
-
if (params.sync_id && !isInt(params.sync_id)) {
|
|
113
|
-
throw new errors.InvalidParameterError(`Bad parameter: sync_id must be of type Int, received ${getType(params.sync_id)}`)
|
|
114
|
-
}
|
|
115
|
-
|
|
116
113
|
const response = await Api.sendRequest('/sync_runs', 'GET', params, options)
|
|
117
114
|
|
|
118
115
|
return response?.data?.map(obj => new SyncRun(obj, options)) || []
|