Skip to content

Commit ec94c1c

Browse files
[Bot] push changes from Files.com
1 parent aea2bb0 commit ec94c1c

10 files changed

Lines changed: 769 additions & 11 deletions

File tree

_VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.2.605
1+
1.2.606

docs/models/MetadataCategory.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# MetadataCategory
2+
3+
## Example MetadataCategory Object
4+
5+
```
6+
{
7+
"id": 1,
8+
"name": "Approval Workflow",
9+
"definitions": {
10+
"Approval Status": [
11+
"Under Review",
12+
"Approved",
13+
"Rejected"
14+
],
15+
"Reviewer": [
16+
17+
]
18+
},
19+
"default_columns": [
20+
"Approval Status"
21+
]
22+
}
23+
```
24+
25+
* `id` (int64): Metadata Category ID
26+
* `name` (string): Name of the metadata category.
27+
* `definitions` (hash(string,array(string))): Map of key names to arrays of allowed values. An empty array means free-form text.
28+
* `default_columns` (array(string)): Metadata keys that should appear as columns in the UI by default.
29+
30+
---
31+
32+
## List Metadata Categories
33+
34+
```
35+
await MetadataCategory.list
36+
```
37+
38+
39+
### Parameters
40+
41+
* `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.
42+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
43+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
44+
45+
---
46+
47+
## Show Metadata Category
48+
49+
```
50+
await MetadataCategory.find(id)
51+
```
52+
53+
54+
### Parameters
55+
56+
* `id` (int64): Required - Metadata Category ID.
57+
58+
---
59+
60+
## Create Metadata Category
61+
62+
```
63+
await MetadataCategory.create({
64+
'name': "Approval Workflow",
65+
'default_columns': ["Approval Status"],
66+
})
67+
```
68+
69+
70+
### Parameters
71+
72+
* `name` (string): Required - Name of the metadata category.
73+
* `default_columns` (array(string)): Metadata keys that should appear as columns in the UI by default.
74+
75+
---
76+
77+
## Update Metadata Category
78+
79+
```
80+
const metadata_category = await MetadataCategory.find(id)
81+
82+
await metadata_category.update({
83+
'name': "Approval Workflow",
84+
'default_columns': ["Approval Status"],
85+
})
86+
```
87+
88+
### Parameters
89+
90+
* `id` (int64): Required - Metadata Category ID.
91+
* `name` (string): Name of the metadata category.
92+
* `default_columns` (array(string)): Metadata keys that should appear as columns in the UI by default.
93+
94+
### Example Response
95+
96+
```json
97+
{
98+
"id": 1,
99+
"name": "Approval Workflow",
100+
"definitions": {
101+
"Approval Status": [
102+
"Under Review",
103+
"Approved",
104+
"Rejected"
105+
],
106+
"Reviewer": [
107+
108+
]
109+
},
110+
"default_columns": [
111+
"Approval Status"
112+
]
113+
}
114+
```
115+
116+
---
117+
118+
## Delete Metadata Category
119+
120+
```
121+
const metadata_category = await MetadataCategory.find(id)
122+
123+
await metadata_category.delete()
124+
```
125+
126+
### Parameters
127+
128+
* `id` (int64): Required - Metadata Category ID.
129+

docs/models/Notification.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@
88
"path": "",
99
"group_id": 1,
1010
"group_name": "example",
11+
"group_ids": [
12+
1
13+
],
14+
"group_names": [
15+
"example"
16+
],
1117
"triggering_group_ids": [
1218
1
1319
],
@@ -40,6 +46,8 @@
4046
* `path` (string): Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
4147
* `group_id` (int64): ID of Group to receive notifications
4248
* `group_name` (string): Group name, if a Group ID is set
49+
* `group_ids` (array(int64)): Group IDs when the notification requires multiple groups
50+
* `group_names` (array(string)): Group names when the notification requires multiple groups
4351
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
4452
* `triggering_user_ids` (array(int64)): If set, will only notify on actions made one of the specified users
4553
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
@@ -116,6 +124,7 @@ await Notification.create({
116124
'triggering_user_ids': [1],
117125
'trigger_by_share_recipients': true,
118126
'group_id': 1,
127+
'group_ids': [1],
119128
'username': "User",
120129
})
121130
```
@@ -138,6 +147,7 @@ await Notification.create({
138147
* `triggering_user_ids` (array(int64)): If set, will only notify on actions made one of the specified users
139148
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
140149
* `group_id` (int64): The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
150+
* `group_ids` (string): Group IDs when the notification requires multiple groups. If sent as a string, it should be comma-delimited.
141151
* `path` (string): Path
142152
* `username` (string): The username of the user to notify. Provide `user_id`, `username` or `group_id`.
143153

@@ -190,6 +200,12 @@ await notification.update({
190200
"path": "",
191201
"group_id": 1,
192202
"group_name": "example",
203+
"group_ids": [
204+
1
205+
],
206+
"group_names": [
207+
"example"
208+
],
193209
"triggering_group_ids": [
194210
1
195211
],

lib/Files.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var apiKey;
1212
var baseUrl = 'https://app.files.com';
1313
var sessionId = null;
1414
var language = null;
15-
var version = '1.2.605';
15+
var version = '1.2.606';
1616
var userAgent = "Files.com JavaScript SDK v".concat(version);
1717
var logLevel = _Logger.LogLevel.INFO;
1818
var debugRequest = false;

0 commit comments

Comments
 (0)