You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/models/ApiKey.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,8 @@
17
17
"name": "My Main API Key",
18
18
"permission_set": "full",
19
19
"platform": "win32",
20
+
"site_id": 1,
21
+
"site_name": "example",
20
22
"url": "example",
21
23
"user_id": 1
22
24
}
@@ -35,6 +37,8 @@
35
37
*`name` (string): Internal name for the API Key. For your use.
36
38
*`permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
37
39
*`platform` (string): If this API key represents a Desktop app, what platform was it created on?
40
+
*`site_id` (int64): Site ID
41
+
*`site_name` (string): Site Name
38
42
*`url` (string): URL for API host.
39
43
*`user_id` (int64): User ID for the owner of this API Key. May be blank for Site-wide API Keys.
40
44
*`path` (string): Folder path restriction for `office_integration` permission set API keys.
@@ -55,7 +59,7 @@ await ApiKey.list({
55
59
*`user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
56
60
*`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.
57
61
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
58
-
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
62
+
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `expires_at`.
59
63
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
60
64
*`filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
61
65
*`filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.
Copy file name to clipboardExpand all lines: docs/models/AutomationRun.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ await AutomationRun.list({
54
54
*`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.
55
55
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
56
56
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
57
-
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
57
+
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
58
58
*`automation_id` (int64): Required - ID of the associated Automation.
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
314
328
// 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.
315
329
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
316
-
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
330
+
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `expires_at`.
317
331
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
318
332
// filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
319
333
// filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.
// 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.
108
108
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
109
109
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
110
-
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
110
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
111
111
// automation_id (required) - int64 - ID of the associated Automation.
Copy file name to clipboardExpand all lines: src/models/ApiKey.js
+15-1Lines changed: 15 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -115,6 +115,20 @@ class ApiKey {
115
115
this.attributes.platform=value
116
116
}
117
117
118
+
// int64 # Site ID
119
+
getSiteId=()=>this.attributes.site_id
120
+
121
+
setSiteId=value=>{
122
+
this.attributes.site_id=value
123
+
}
124
+
125
+
// string # Site Name
126
+
getSiteName=()=>this.attributes.site_name
127
+
128
+
setSiteName=value=>{
129
+
this.attributes.site_name=value
130
+
}
131
+
118
132
// string # URL for API host.
119
133
getUrl=()=>this.attributes.url
120
134
@@ -223,7 +237,7 @@ class ApiKey {
223
237
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
224
238
// 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.
225
239
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
226
-
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
240
+
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `expires_at`.
227
241
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
228
242
// filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
229
243
// filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.
Copy file name to clipboardExpand all lines: src/models/AutomationRun.js
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,7 @@ class AutomationRun {
75
75
// 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.
76
76
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
77
77
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
78
-
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
78
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
79
79
// automation_id (required) - int64 - ID of the associated Automation.
0 commit comments