files.com 1.0.247 → 1.0.249
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/models/RemoteServer.md +16 -2
- package/lib/models/AccountLineItem.js +14 -0
- package/lib/models/Action.js +13 -0
- package/lib/models/ActionNotificationExport.js +27 -0
- package/lib/models/ActionNotificationExportResult.js +15 -0
- package/lib/models/ActionWebhookFailure.js +1 -0
- package/lib/models/ApiKey.js +42 -0
- package/lib/models/App.js +26 -0
- package/lib/models/As2IncomingMessage.js +46 -0
- package/lib/models/As2OutgoingMessage.js +42 -0
- package/lib/models/As2Partner.js +29 -0
- package/lib/models/As2Station.js +31 -0
- package/lib/models/Auto.js +1 -0
- package/lib/models/Automation.js +72 -0
- package/lib/models/AutomationRun.js +20 -0
- package/lib/models/BandwidthSnapshot.js +19 -0
- package/lib/models/Behavior.js +57 -0
- package/lib/models/Bundle.js +98 -0
- package/lib/models/BundleDownload.js +16 -0
- package/lib/models/BundleNotification.js +20 -0
- package/lib/models/BundleRecipient.js +28 -0
- package/lib/models/BundleRegistration.js +18 -0
- package/lib/models/Clickwrap.js +23 -0
- package/lib/models/DnsRecord.js +7 -0
- package/lib/models/Errors.js +2 -0
- package/lib/models/ExternalEvent.js +26 -0
- package/lib/models/File.js +88 -0
- package/lib/models/FileAction.js +2 -0
- package/lib/models/FileComment.js +13 -0
- package/lib/models/FileCommentReaction.js +8 -0
- package/lib/models/FileMigration.js +11 -0
- package/lib/models/FileUploadPart.js +15 -0
- package/lib/models/Folder.js +33 -0
- package/lib/models/FormField.js +8 -0
- package/lib/models/FormFieldSet.js +27 -0
- package/lib/models/Group.js +29 -0
- package/lib/models/GroupUser.js +22 -0
- package/lib/models/History.js +57 -0
- package/lib/models/HistoryExport.js +51 -0
- package/lib/models/HistoryExportResult.js +29 -0
- package/lib/models/Image.js +2 -0
- package/lib/models/InboxRecipient.js +28 -0
- package/lib/models/InboxRegistration.js +15 -0
- package/lib/models/InboxUpload.js +15 -0
- package/lib/models/Invoice.js +19 -0
- package/lib/models/InvoiceLineItem.js +9 -0
- package/lib/models/IpAddress.js +13 -0
- package/lib/models/Lock.js +25 -0
- package/lib/models/Message.js +22 -0
- package/lib/models/MessageComment.js +16 -0
- package/lib/models/MessageCommentReaction.js +13 -0
- package/lib/models/MessageReaction.js +13 -0
- package/lib/models/Notification.js +70 -0
- package/lib/models/Payment.js +19 -0
- package/lib/models/PaymentLineItem.js +4 -0
- package/lib/models/Permission.js +29 -0
- package/lib/models/Preview.js +5 -0
- package/lib/models/Priority.js +6 -0
- package/lib/models/Project.js +11 -0
- package/lib/models/PublicIpAddress.js +4 -0
- package/lib/models/PublicKey.js +18 -0
- package/lib/models/RemoteBandwidthSnapshot.js +15 -0
- package/lib/models/RemoteServer.js +253 -11
- package/lib/models/RemoteServerConfigurationFile.js +12 -0
- package/lib/models/Request.js +25 -0
- package/lib/models/Session.js +13 -0
- package/lib/models/SettingsChange.js +15 -0
- package/lib/models/SftpHostKey.js +16 -0
- package/lib/models/Site.js +276 -0
- package/lib/models/SsoStrategy.js +49 -0
- package/lib/models/Status.js +7 -0
- package/lib/models/Style.js +9 -0
- package/lib/models/UsageDailySnapshot.js +21 -0
- package/lib/models/UsageSnapshot.js +18 -0
- package/lib/models/User.js +183 -0
- package/lib/models/UserCipherUse.js +10 -0
- package/lib/models/UserRequest.js +13 -0
- package/lib/models/WebhookTest.js +24 -0
- package/package.json +1 -1
- package/src/models/RemoteServer.js +41 -0
@@ -31,24 +31,28 @@ var FileCommentReaction = /*#__PURE__*/(0, _createClass2.default)(function FileC
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// int64 # Reaction ID
|
34
35
|
(0, _defineProperty2.default)(this, "getId", function () {
|
35
36
|
return _this.attributes.id;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setId", function (value) {
|
38
39
|
_this.attributes.id = value;
|
39
40
|
});
|
41
|
+
// string # Emoji used in the reaction.
|
40
42
|
(0, _defineProperty2.default)(this, "getEmoji", function () {
|
41
43
|
return _this.attributes.emoji;
|
42
44
|
});
|
43
45
|
(0, _defineProperty2.default)(this, "setEmoji", function (value) {
|
44
46
|
_this.attributes.emoji = value;
|
45
47
|
});
|
48
|
+
// int64 # User ID. Provide a value of `0` to operate the current session's user.
|
46
49
|
(0, _defineProperty2.default)(this, "getUserId", function () {
|
47
50
|
return _this.attributes.user_id;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setUserId", function (value) {
|
50
53
|
_this.attributes.user_id = value;
|
51
54
|
});
|
55
|
+
// int64 # ID of file comment to attach reaction to.
|
52
56
|
(0, _defineProperty2.default)(this, "getFileCommentId", function () {
|
53
57
|
return _this.attributes.file_comment_id;
|
54
58
|
});
|
@@ -133,6 +137,10 @@ var FileCommentReaction = /*#__PURE__*/(0, _createClass2.default)(function FileC
|
|
133
137
|
});
|
134
138
|
this.options = _objectSpread({}, options);
|
135
139
|
});
|
140
|
+
// Parameters:
|
141
|
+
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
142
|
+
// file_comment_id (required) - int64 - ID of file comment to attach reaction to.
|
143
|
+
// emoji (required) - string - Emoji to react with.
|
136
144
|
(0, _defineProperty2.default)(FileCommentReaction, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
|
137
145
|
var params,
|
138
146
|
options,
|
@@ -31,30 +31,39 @@ var FileMigration = /*#__PURE__*/(0, _createClass2.default)(function FileMigrati
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// int64 # File migration ID
|
34
35
|
(0, _defineProperty2.default)(this, "getId", function () {
|
35
36
|
return _this.attributes.id;
|
36
37
|
});
|
38
|
+
// string # Source path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
37
39
|
(0, _defineProperty2.default)(this, "getPath", function () {
|
38
40
|
return _this.attributes.path;
|
39
41
|
});
|
42
|
+
// string # Destination path
|
40
43
|
(0, _defineProperty2.default)(this, "getDestPath", function () {
|
41
44
|
return _this.attributes.dest_path;
|
42
45
|
});
|
46
|
+
// int64 # Number of files processed
|
43
47
|
(0, _defineProperty2.default)(this, "getFilesMoved", function () {
|
44
48
|
return _this.attributes.files_moved;
|
45
49
|
});
|
50
|
+
// int64 # Deprecated: used to return a count of the applicable files. Currently returns 0 always. On remote servers, it is not possible to reliably determine the number of affected files for every migration operation.
|
46
51
|
(0, _defineProperty2.default)(this, "getFilesTotal", function () {
|
47
52
|
return _this.attributes.files_total;
|
48
53
|
});
|
54
|
+
// string # The type of operation
|
49
55
|
(0, _defineProperty2.default)(this, "getOperation", function () {
|
50
56
|
return _this.attributes.operation;
|
51
57
|
});
|
58
|
+
// string # Region
|
52
59
|
(0, _defineProperty2.default)(this, "getRegion", function () {
|
53
60
|
return _this.attributes.region;
|
54
61
|
});
|
62
|
+
// string # Status
|
55
63
|
(0, _defineProperty2.default)(this, "getStatus", function () {
|
56
64
|
return _this.attributes.status;
|
57
65
|
});
|
66
|
+
// string # Link to download the log file for this migration.
|
58
67
|
(0, _defineProperty2.default)(this, "getLogUrl", function () {
|
59
68
|
return _this.attributes.log_url;
|
60
69
|
});
|
@@ -71,6 +80,8 @@ var FileMigration = /*#__PURE__*/(0, _createClass2.default)(function FileMigrati
|
|
71
80
|
});
|
72
81
|
this.options = _objectSpread({}, options);
|
73
82
|
});
|
83
|
+
// Parameters:
|
84
|
+
// id (required) - int64 - File Migration ID.
|
74
85
|
(0, _defineProperty2.default)(FileMigration, "find", /*#__PURE__*/function () {
|
75
86
|
var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(id) {
|
76
87
|
var params,
|
@@ -29,48 +29,63 @@ var FileUploadPart = /*#__PURE__*/(0, _createClass2.default)(function FileUpload
|
|
29
29
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
30
30
|
return !!_this.attributes.id;
|
31
31
|
});
|
32
|
+
// object # Content-Type and File to send
|
32
33
|
(0, _defineProperty2.default)(this, "getSend", function () {
|
33
34
|
return _this.attributes.send;
|
34
35
|
});
|
36
|
+
// string # Type of upload
|
35
37
|
(0, _defineProperty2.default)(this, "getAction", function () {
|
36
38
|
return _this.attributes.action;
|
37
39
|
});
|
40
|
+
// boolean # If `true`, this file exists and you may wish to ask the user for overwrite confirmation
|
38
41
|
(0, _defineProperty2.default)(this, "getAskAboutOverwrites", function () {
|
39
42
|
return _this.attributes.ask_about_overwrites;
|
40
43
|
});
|
44
|
+
// int64 # Number of parts in the upload
|
41
45
|
(0, _defineProperty2.default)(this, "getAvailableParts", function () {
|
42
46
|
return _this.attributes.available_parts;
|
43
47
|
});
|
48
|
+
// string # Date/time of when this Upload part expires and the URL cannot be used any more
|
44
49
|
(0, _defineProperty2.default)(this, "getExpires", function () {
|
45
50
|
return _this.attributes.expires;
|
46
51
|
});
|
52
|
+
// object # Additional upload headers to provide as part of the upload
|
47
53
|
(0, _defineProperty2.default)(this, "getHeaders", function () {
|
48
54
|
return _this.attributes.headers;
|
49
55
|
});
|
56
|
+
// string # HTTP Method to use for uploading the part, usually `PUT`
|
50
57
|
(0, _defineProperty2.default)(this, "getHttpMethod", function () {
|
51
58
|
return _this.attributes.http_method;
|
52
59
|
});
|
60
|
+
// int64 # Size in bytes for this part
|
53
61
|
(0, _defineProperty2.default)(this, "getNextPartsize", function () {
|
54
62
|
return _this.attributes.next_partsize;
|
55
63
|
});
|
64
|
+
// boolean # If `true`, multiple parts may be uploaded in parallel. If `false`, be sure to only upload one part at a time, in order.
|
56
65
|
(0, _defineProperty2.default)(this, "getParallelParts", function () {
|
57
66
|
return _this.attributes.parallel_parts;
|
58
67
|
});
|
68
|
+
// object # Additional HTTP parameters to send with the upload
|
59
69
|
(0, _defineProperty2.default)(this, "getParameters", function () {
|
60
70
|
return _this.attributes.parameters;
|
61
71
|
});
|
72
|
+
// int64 # Number of this upload part
|
62
73
|
(0, _defineProperty2.default)(this, "getPartNumber", function () {
|
63
74
|
return _this.attributes.part_number;
|
64
75
|
});
|
76
|
+
// int64 # Size in bytes for the next upload part
|
65
77
|
(0, _defineProperty2.default)(this, "getPartsize", function () {
|
66
78
|
return _this.attributes.partsize;
|
67
79
|
});
|
80
|
+
// string # New file path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
68
81
|
(0, _defineProperty2.default)(this, "getPath", function () {
|
69
82
|
return _this.attributes.path;
|
70
83
|
});
|
84
|
+
// string # Reference name for this upload part
|
71
85
|
(0, _defineProperty2.default)(this, "getRef", function () {
|
72
86
|
return _this.attributes.ref;
|
73
87
|
});
|
88
|
+
// string # URI to upload this part to
|
74
89
|
(0, _defineProperty2.default)(this, "getUploadUri", function () {
|
75
90
|
return _this.attributes.upload_uri;
|
76
91
|
});
|
package/lib/models/Folder.js
CHANGED
@@ -32,111 +32,130 @@ var Folder = /*#__PURE__*/(0, _createClass2.default)(function Folder() {
|
|
32
32
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
33
33
|
return !!_this.attributes.path;
|
34
34
|
});
|
35
|
+
// string # File/Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
35
36
|
(0, _defineProperty2.default)(this, "getPath", function () {
|
36
37
|
return _this.attributes.path;
|
37
38
|
});
|
38
39
|
(0, _defineProperty2.default)(this, "setPath", function (value) {
|
39
40
|
_this.attributes.path = value;
|
40
41
|
});
|
42
|
+
// string # File/Folder display name
|
41
43
|
(0, _defineProperty2.default)(this, "getDisplayName", function () {
|
42
44
|
return _this.attributes.display_name;
|
43
45
|
});
|
44
46
|
(0, _defineProperty2.default)(this, "setDisplayName", function (value) {
|
45
47
|
_this.attributes.display_name = value;
|
46
48
|
});
|
49
|
+
// string # Type: `directory` or `file`.
|
47
50
|
(0, _defineProperty2.default)(this, "getType", function () {
|
48
51
|
return _this.attributes.type;
|
49
52
|
});
|
50
53
|
(0, _defineProperty2.default)(this, "setType", function (value) {
|
51
54
|
_this.attributes.type = value;
|
52
55
|
});
|
56
|
+
// int64 # File/Folder size
|
53
57
|
(0, _defineProperty2.default)(this, "getSize", function () {
|
54
58
|
return _this.attributes.size;
|
55
59
|
});
|
56
60
|
(0, _defineProperty2.default)(this, "setSize", function (value) {
|
57
61
|
_this.attributes.size = value;
|
58
62
|
});
|
63
|
+
// date-time # File created date/time
|
59
64
|
(0, _defineProperty2.default)(this, "getCreatedAt", function () {
|
60
65
|
return _this.attributes.created_at;
|
61
66
|
});
|
67
|
+
// date-time # File last modified date/time, according to the server. This is the timestamp of the last Files.com operation of the file, regardless of what modified timestamp was sent.
|
62
68
|
(0, _defineProperty2.default)(this, "getMtime", function () {
|
63
69
|
return _this.attributes.mtime;
|
64
70
|
});
|
65
71
|
(0, _defineProperty2.default)(this, "setMtime", function (value) {
|
66
72
|
_this.attributes.mtime = value;
|
67
73
|
});
|
74
|
+
// date-time # File last modified date/time, according to the client who set it. Files.com allows desktop, FTP, SFTP, and WebDAV clients to set modified at times. This allows Desktop<->Cloud syncing to preserve modified at times.
|
68
75
|
(0, _defineProperty2.default)(this, "getProvidedMtime", function () {
|
69
76
|
return _this.attributes.provided_mtime;
|
70
77
|
});
|
71
78
|
(0, _defineProperty2.default)(this, "setProvidedMtime", function (value) {
|
72
79
|
_this.attributes.provided_mtime = value;
|
73
80
|
});
|
81
|
+
// string # File CRC32 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
|
74
82
|
(0, _defineProperty2.default)(this, "getCrc32", function () {
|
75
83
|
return _this.attributes.crc32;
|
76
84
|
});
|
77
85
|
(0, _defineProperty2.default)(this, "setCrc32", function (value) {
|
78
86
|
_this.attributes.crc32 = value;
|
79
87
|
});
|
88
|
+
// string # File MD5 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
|
80
89
|
(0, _defineProperty2.default)(this, "getMd5", function () {
|
81
90
|
return _this.attributes.md5;
|
82
91
|
});
|
83
92
|
(0, _defineProperty2.default)(this, "setMd5", function (value) {
|
84
93
|
_this.attributes.md5 = value;
|
85
94
|
});
|
95
|
+
// string # MIME Type. This is determined by the filename extension and is not stored separately internally.
|
86
96
|
(0, _defineProperty2.default)(this, "getMimeType", function () {
|
87
97
|
return _this.attributes.mime_type;
|
88
98
|
});
|
89
99
|
(0, _defineProperty2.default)(this, "setMimeType", function (value) {
|
90
100
|
_this.attributes.mime_type = value;
|
91
101
|
});
|
102
|
+
// string # Region location
|
92
103
|
(0, _defineProperty2.default)(this, "getRegion", function () {
|
93
104
|
return _this.attributes.region;
|
94
105
|
});
|
95
106
|
(0, _defineProperty2.default)(this, "setRegion", function (value) {
|
96
107
|
_this.attributes.region = value;
|
97
108
|
});
|
109
|
+
// string # A short string representing the current user's permissions. Can be `r`,`w`,`d`, `l` or any combination
|
98
110
|
(0, _defineProperty2.default)(this, "getPermissions", function () {
|
99
111
|
return _this.attributes.permissions;
|
100
112
|
});
|
101
113
|
(0, _defineProperty2.default)(this, "setPermissions", function (value) {
|
102
114
|
_this.attributes.permissions = value;
|
103
115
|
});
|
116
|
+
// boolean # Are subfolders locked and unable to be modified?
|
104
117
|
(0, _defineProperty2.default)(this, "getSubfoldersLocked", function () {
|
105
118
|
return _this.attributes.subfolders_locked;
|
106
119
|
});
|
107
120
|
(0, _defineProperty2.default)(this, "setSubfoldersLocked", function (value) {
|
108
121
|
_this.attributes.subfolders_locked = value;
|
109
122
|
});
|
123
|
+
// boolean # Is this folder locked and unable to be modified?
|
110
124
|
(0, _defineProperty2.default)(this, "getIsLocked", function () {
|
111
125
|
return _this.attributes.is_locked;
|
112
126
|
});
|
113
127
|
(0, _defineProperty2.default)(this, "setIsLocked", function (value) {
|
114
128
|
_this.attributes.is_locked = value;
|
115
129
|
});
|
130
|
+
// string # Link to download file. Provided only in response to a download request.
|
116
131
|
(0, _defineProperty2.default)(this, "getDownloadUri", function () {
|
117
132
|
return _this.attributes.download_uri;
|
118
133
|
});
|
119
134
|
(0, _defineProperty2.default)(this, "setDownloadUri", function (value) {
|
120
135
|
_this.attributes.download_uri = value;
|
121
136
|
});
|
137
|
+
// string # Bookmark/priority color of file/folder
|
122
138
|
(0, _defineProperty2.default)(this, "getPriorityColor", function () {
|
123
139
|
return _this.attributes.priority_color;
|
124
140
|
});
|
125
141
|
(0, _defineProperty2.default)(this, "setPriorityColor", function (value) {
|
126
142
|
_this.attributes.priority_color = value;
|
127
143
|
});
|
144
|
+
// int64 # File preview ID
|
128
145
|
(0, _defineProperty2.default)(this, "getPreviewId", function () {
|
129
146
|
return _this.attributes.preview_id;
|
130
147
|
});
|
131
148
|
(0, _defineProperty2.default)(this, "setPreviewId", function (value) {
|
132
149
|
_this.attributes.preview_id = value;
|
133
150
|
});
|
151
|
+
// Preview # File preview
|
134
152
|
(0, _defineProperty2.default)(this, "getPreview", function () {
|
135
153
|
return _this.attributes.preview;
|
136
154
|
});
|
137
155
|
(0, _defineProperty2.default)(this, "setPreview", function (value) {
|
138
156
|
_this.attributes.preview = value;
|
139
157
|
});
|
158
|
+
// boolean # Create parent directories if they do not exist?
|
140
159
|
(0, _defineProperty2.default)(this, "getMkdirParents", function () {
|
141
160
|
return _this.attributes.mkdir_parents;
|
142
161
|
});
|
@@ -161,6 +180,16 @@ var Folder = /*#__PURE__*/(0, _createClass2.default)(function Folder() {
|
|
161
180
|
});
|
162
181
|
this.options = _objectSpread({}, options);
|
163
182
|
});
|
183
|
+
// Parameters:
|
184
|
+
// cursor - string - Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
185
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
186
|
+
// path (required) - string - Path to operate on.
|
187
|
+
// filter - string - If specified, will filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
|
188
|
+
// preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
189
|
+
// search - string - If `search_all` is `true`, provide the search string here. Otherwise, this parameter acts like an alias of `filter`.
|
190
|
+
// search_all - boolean - Search entire site? If set, we will ignore the folder path provided and search the entire site. This is the same API used by the search bar in the UI. Search results are a best effort, not real time, and not guaranteed to match every file. This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
|
191
|
+
// with_previews - boolean - Include file previews?
|
192
|
+
// with_priority_color - boolean - Include file priority color information?
|
164
193
|
(0, _defineProperty2.default)(Folder, "listFor", /*#__PURE__*/function () {
|
165
194
|
var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(path) {
|
166
195
|
var _response$data;
|
@@ -239,6 +268,10 @@ var Folder = /*#__PURE__*/(0, _createClass2.default)(function Folder() {
|
|
239
268
|
return _ref3.apply(this, arguments);
|
240
269
|
};
|
241
270
|
}());
|
271
|
+
// Parameters:
|
272
|
+
// path (required) - string - Path to operate on.
|
273
|
+
// mkdir_parents - boolean - Create parent directories if they do not exist?
|
274
|
+
// provided_mtime - string - User provided modification time.
|
242
275
|
(0, _defineProperty2.default)(Folder, "create", /*#__PURE__*/function () {
|
243
276
|
var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(path) {
|
244
277
|
var params,
|
package/lib/models/FormField.js
CHANGED
@@ -29,27 +29,35 @@ var FormField = /*#__PURE__*/(0, _createClass2.default)(function FormField() {
|
|
29
29
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
30
30
|
return !!_this.attributes.id;
|
31
31
|
});
|
32
|
+
// int64 # Form field id
|
32
33
|
(0, _defineProperty2.default)(this, "getId", function () {
|
33
34
|
return _this.attributes.id;
|
34
35
|
});
|
36
|
+
// string # Label to be displayed
|
35
37
|
(0, _defineProperty2.default)(this, "getLabel", function () {
|
36
38
|
return _this.attributes.label;
|
37
39
|
});
|
40
|
+
// boolean # Is this a required field?
|
38
41
|
(0, _defineProperty2.default)(this, "getRequired", function () {
|
39
42
|
return _this.attributes.required;
|
40
43
|
});
|
44
|
+
// string # Help text to be displayed
|
41
45
|
(0, _defineProperty2.default)(this, "getHelpText", function () {
|
42
46
|
return _this.attributes.help_text;
|
43
47
|
});
|
48
|
+
// string # Type of Field
|
44
49
|
(0, _defineProperty2.default)(this, "getFieldType", function () {
|
45
50
|
return _this.attributes.field_type;
|
46
51
|
});
|
52
|
+
// array # Options to display for radio and dropdown
|
47
53
|
(0, _defineProperty2.default)(this, "getOptionsForSelect", function () {
|
48
54
|
return _this.attributes.options_for_select;
|
49
55
|
});
|
56
|
+
// string # Default option for radio and dropdown
|
50
57
|
(0, _defineProperty2.default)(this, "getDefaultOption", function () {
|
51
58
|
return _this.attributes.default_option;
|
52
59
|
});
|
60
|
+
// int64 # Form field set id
|
53
61
|
(0, _defineProperty2.default)(this, "getFormFieldSetId", function () {
|
54
62
|
return _this.attributes.form_field_set_id;
|
55
63
|
});
|
@@ -31,54 +31,68 @@ var FormFieldSet = /*#__PURE__*/(0, _createClass2.default)(function FormFieldSet
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// int64 # Form field set id
|
34
35
|
(0, _defineProperty2.default)(this, "getId", function () {
|
35
36
|
return _this.attributes.id;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setId", function (value) {
|
38
39
|
_this.attributes.id = value;
|
39
40
|
});
|
41
|
+
// string # Title to be displayed
|
40
42
|
(0, _defineProperty2.default)(this, "getTitle", function () {
|
41
43
|
return _this.attributes.title;
|
42
44
|
});
|
43
45
|
(0, _defineProperty2.default)(this, "setTitle", function (value) {
|
44
46
|
_this.attributes.title = value;
|
45
47
|
});
|
48
|
+
// array # Layout of the form
|
46
49
|
(0, _defineProperty2.default)(this, "getFormLayout", function () {
|
47
50
|
return _this.attributes.form_layout;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setFormLayout", function (value) {
|
50
53
|
_this.attributes.form_layout = value;
|
51
54
|
});
|
55
|
+
// array # Associated form fields
|
52
56
|
(0, _defineProperty2.default)(this, "getFormFields", function () {
|
53
57
|
return _this.attributes.form_fields;
|
54
58
|
});
|
55
59
|
(0, _defineProperty2.default)(this, "setFormFields", function (value) {
|
56
60
|
_this.attributes.form_fields = value;
|
57
61
|
});
|
62
|
+
// boolean # Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
|
58
63
|
(0, _defineProperty2.default)(this, "getSkipName", function () {
|
59
64
|
return _this.attributes.skip_name;
|
60
65
|
});
|
61
66
|
(0, _defineProperty2.default)(this, "setSkipName", function (value) {
|
62
67
|
_this.attributes.skip_name = value;
|
63
68
|
});
|
69
|
+
// boolean # Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
|
64
70
|
(0, _defineProperty2.default)(this, "getSkipEmail", function () {
|
65
71
|
return _this.attributes.skip_email;
|
66
72
|
});
|
67
73
|
(0, _defineProperty2.default)(this, "setSkipEmail", function (value) {
|
68
74
|
_this.attributes.skip_email = value;
|
69
75
|
});
|
76
|
+
// boolean # Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
|
70
77
|
(0, _defineProperty2.default)(this, "getSkipCompany", function () {
|
71
78
|
return _this.attributes.skip_company;
|
72
79
|
});
|
73
80
|
(0, _defineProperty2.default)(this, "setSkipCompany", function (value) {
|
74
81
|
_this.attributes.skip_company = value;
|
75
82
|
});
|
83
|
+
// int64 # User ID. Provide a value of `0` to operate the current session's user.
|
76
84
|
(0, _defineProperty2.default)(this, "getUserId", function () {
|
77
85
|
return _this.attributes.user_id;
|
78
86
|
});
|
79
87
|
(0, _defineProperty2.default)(this, "setUserId", function (value) {
|
80
88
|
_this.attributes.user_id = value;
|
81
89
|
});
|
90
|
+
// Parameters:
|
91
|
+
// title - string - Title to be displayed
|
92
|
+
// skip_email - boolean - Skip validating form email
|
93
|
+
// skip_name - boolean - Skip validating form name
|
94
|
+
// skip_company - boolean - Skip validating company
|
95
|
+
// form_fields - array(object)
|
82
96
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
83
97
|
var params,
|
84
98
|
response,
|
@@ -221,6 +235,10 @@ var FormFieldSet = /*#__PURE__*/(0, _createClass2.default)(function FormFieldSet
|
|
221
235
|
});
|
222
236
|
this.options = _objectSpread({}, options);
|
223
237
|
});
|
238
|
+
// Parameters:
|
239
|
+
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
240
|
+
// cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
241
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
224
242
|
(0, _defineProperty2.default)(FormFieldSet, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
|
225
243
|
var _response$data;
|
226
244
|
var params,
|
@@ -268,6 +286,8 @@ var FormFieldSet = /*#__PURE__*/(0, _createClass2.default)(function FormFieldSet
|
|
268
286
|
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
269
287
|
return FormFieldSet.list(params, options);
|
270
288
|
});
|
289
|
+
// Parameters:
|
290
|
+
// id (required) - int64 - Form Field Set ID.
|
271
291
|
(0, _defineProperty2.default)(FormFieldSet, "find", /*#__PURE__*/function () {
|
272
292
|
var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
|
273
293
|
var params,
|
@@ -318,6 +338,13 @@ var FormFieldSet = /*#__PURE__*/(0, _createClass2.default)(function FormFieldSet
|
|
318
338
|
var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
|
319
339
|
return FormFieldSet.find(id, params, options);
|
320
340
|
});
|
341
|
+
// Parameters:
|
342
|
+
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
343
|
+
// title - string - Title to be displayed
|
344
|
+
// skip_email - boolean - Skip validating form email
|
345
|
+
// skip_name - boolean - Skip validating form name
|
346
|
+
// skip_company - boolean - Skip validating company
|
347
|
+
// form_fields - array(object)
|
321
348
|
(0, _defineProperty2.default)(FormFieldSet, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
|
322
349
|
var params,
|
323
350
|
options,
|
package/lib/models/Group.js
CHANGED
@@ -31,42 +31,53 @@ var Group = /*#__PURE__*/(0, _createClass2.default)(function Group() {
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// int64 # Group ID
|
34
35
|
(0, _defineProperty2.default)(this, "getId", function () {
|
35
36
|
return _this.attributes.id;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setId", function (value) {
|
38
39
|
_this.attributes.id = value;
|
39
40
|
});
|
41
|
+
// string # Group name
|
40
42
|
(0, _defineProperty2.default)(this, "getName", function () {
|
41
43
|
return _this.attributes.name;
|
42
44
|
});
|
43
45
|
(0, _defineProperty2.default)(this, "setName", function (value) {
|
44
46
|
_this.attributes.name = value;
|
45
47
|
});
|
48
|
+
// string # Comma-delimited list of user IDs who are group administrators (separated by commas)
|
46
49
|
(0, _defineProperty2.default)(this, "getAdminIds", function () {
|
47
50
|
return _this.attributes.admin_ids;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setAdminIds", function (value) {
|
50
53
|
_this.attributes.admin_ids = value;
|
51
54
|
});
|
55
|
+
// string # Notes about this group
|
52
56
|
(0, _defineProperty2.default)(this, "getNotes", function () {
|
53
57
|
return _this.attributes.notes;
|
54
58
|
});
|
55
59
|
(0, _defineProperty2.default)(this, "setNotes", function (value) {
|
56
60
|
_this.attributes.notes = value;
|
57
61
|
});
|
62
|
+
// string # Comma-delimited list of user IDs who belong to this group (separated by commas)
|
58
63
|
(0, _defineProperty2.default)(this, "getUserIds", function () {
|
59
64
|
return _this.attributes.user_ids;
|
60
65
|
});
|
61
66
|
(0, _defineProperty2.default)(this, "setUserIds", function (value) {
|
62
67
|
_this.attributes.user_ids = value;
|
63
68
|
});
|
69
|
+
// string # Comma-delimited list of usernames who belong to this group (separated by commas)
|
64
70
|
(0, _defineProperty2.default)(this, "getUsernames", function () {
|
65
71
|
return _this.attributes.usernames;
|
66
72
|
});
|
67
73
|
(0, _defineProperty2.default)(this, "setUsernames", function (value) {
|
68
74
|
_this.attributes.usernames = value;
|
69
75
|
});
|
76
|
+
// Parameters:
|
77
|
+
// name - string - Group name.
|
78
|
+
// notes - string - Group notes.
|
79
|
+
// user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
80
|
+
// admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
70
81
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
71
82
|
var params,
|
72
83
|
response,
|
@@ -221,6 +232,17 @@ var Group = /*#__PURE__*/(0, _createClass2.default)(function Group() {
|
|
221
232
|
});
|
222
233
|
this.options = _objectSpread({}, options);
|
223
234
|
});
|
235
|
+
// Parameters:
|
236
|
+
// cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
237
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
238
|
+
// sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `name`.
|
239
|
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
240
|
+
// filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `name`.
|
241
|
+
// filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name`.
|
242
|
+
// filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
243
|
+
// filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `name`.
|
244
|
+
// filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name`.
|
245
|
+
// ids - string - Comma-separated list of group ids to include in results.
|
224
246
|
(0, _defineProperty2.default)(Group, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
|
225
247
|
var _response$data;
|
226
248
|
var params,
|
@@ -268,6 +290,8 @@ var Group = /*#__PURE__*/(0, _createClass2.default)(function Group() {
|
|
268
290
|
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
269
291
|
return Group.list(params, options);
|
270
292
|
});
|
293
|
+
// Parameters:
|
294
|
+
// id (required) - int64 - Group ID.
|
271
295
|
(0, _defineProperty2.default)(Group, "find", /*#__PURE__*/function () {
|
272
296
|
var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
|
273
297
|
var params,
|
@@ -318,6 +342,11 @@ var Group = /*#__PURE__*/(0, _createClass2.default)(function Group() {
|
|
318
342
|
var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
|
319
343
|
return Group.find(id, params, options);
|
320
344
|
});
|
345
|
+
// Parameters:
|
346
|
+
// name - string - Group name.
|
347
|
+
// notes - string - Group notes.
|
348
|
+
// user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
349
|
+
// admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
321
350
|
(0, _defineProperty2.default)(Group, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
|
322
351
|
var params,
|
323
352
|
options,
|
package/lib/models/GroupUser.js
CHANGED
@@ -31,42 +31,52 @@ var GroupUser = /*#__PURE__*/(0, _createClass2.default)(function GroupUser() {
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// string # Group name
|
34
35
|
(0, _defineProperty2.default)(this, "getGroupName", function () {
|
35
36
|
return _this.attributes.group_name;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setGroupName", function (value) {
|
38
39
|
_this.attributes.group_name = value;
|
39
40
|
});
|
41
|
+
// int64 # Group ID
|
40
42
|
(0, _defineProperty2.default)(this, "getGroupId", function () {
|
41
43
|
return _this.attributes.group_id;
|
42
44
|
});
|
43
45
|
(0, _defineProperty2.default)(this, "setGroupId", function (value) {
|
44
46
|
_this.attributes.group_id = value;
|
45
47
|
});
|
48
|
+
// int64 # User ID
|
46
49
|
(0, _defineProperty2.default)(this, "getUserId", function () {
|
47
50
|
return _this.attributes.user_id;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setUserId", function (value) {
|
50
53
|
_this.attributes.user_id = value;
|
51
54
|
});
|
55
|
+
// boolean # Is this user an administrator of this group?
|
52
56
|
(0, _defineProperty2.default)(this, "getAdmin", function () {
|
53
57
|
return _this.attributes.admin;
|
54
58
|
});
|
55
59
|
(0, _defineProperty2.default)(this, "setAdmin", function (value) {
|
56
60
|
_this.attributes.admin = value;
|
57
61
|
});
|
62
|
+
// array # A list of usernames for users in this group
|
58
63
|
(0, _defineProperty2.default)(this, "getUsernames", function () {
|
59
64
|
return _this.attributes.usernames;
|
60
65
|
});
|
61
66
|
(0, _defineProperty2.default)(this, "setUsernames", function (value) {
|
62
67
|
_this.attributes.usernames = value;
|
63
68
|
});
|
69
|
+
// int64 # Group User ID.
|
64
70
|
(0, _defineProperty2.default)(this, "getId", function () {
|
65
71
|
return _this.attributes.id;
|
66
72
|
});
|
67
73
|
(0, _defineProperty2.default)(this, "setId", function (value) {
|
68
74
|
_this.attributes.id = value;
|
69
75
|
});
|
76
|
+
// Parameters:
|
77
|
+
// group_id (required) - int64 - Group ID to add user to.
|
78
|
+
// user_id (required) - int64 - User ID to add to group.
|
79
|
+
// admin - boolean - Is the user a group administrator?
|
70
80
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
71
81
|
var params,
|
72
82
|
response,
|
@@ -159,6 +169,9 @@ var GroupUser = /*#__PURE__*/(0, _createClass2.default)(function GroupUser() {
|
|
159
169
|
}
|
160
170
|
}, _callee);
|
161
171
|
})));
|
172
|
+
// Parameters:
|
173
|
+
// group_id (required) - int64 - Group ID from which to remove user.
|
174
|
+
// user_id (required) - int64 - User ID to remove from group.
|
162
175
|
(0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
|
163
176
|
var params,
|
164
177
|
response,
|
@@ -277,6 +290,11 @@ var GroupUser = /*#__PURE__*/(0, _createClass2.default)(function GroupUser() {
|
|
277
290
|
});
|
278
291
|
this.options = _objectSpread({}, options);
|
279
292
|
});
|
293
|
+
// Parameters:
|
294
|
+
// user_id - int64 - User ID. If provided, will return group_users of this user.
|
295
|
+
// cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
296
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
297
|
+
// group_id - int64 - Group ID. If provided, will return group_users of this group.
|
280
298
|
(0, _defineProperty2.default)(GroupUser, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
|
281
299
|
var _response$data;
|
282
300
|
var params,
|
@@ -330,6 +348,10 @@ var GroupUser = /*#__PURE__*/(0, _createClass2.default)(function GroupUser() {
|
|
330
348
|
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
331
349
|
return GroupUser.list(params, options);
|
332
350
|
});
|
351
|
+
// Parameters:
|
352
|
+
// group_id (required) - int64 - Group ID to add user to.
|
353
|
+
// user_id (required) - int64 - User ID to add to group.
|
354
|
+
// admin - boolean - Is the user a group administrator?
|
333
355
|
(0, _defineProperty2.default)(GroupUser, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
|
334
356
|
var params,
|
335
357
|
options,
|