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
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,10 +93,10 @@ await ApiKey.create({
93
93
'user_id': 1,
94
94
'description': "example",
95
95
'expires_at': "2000-01-01T01:00:00Z",
96
-
'permission_set': "full",
97
96
'name': "My Main API Key",
98
97
'aws_style_credentials': true,
99
98
'path': "shared/docs",
99
+
'permission_set': "full",
100
100
})
101
101
```
102
102
@@ -106,10 +106,10 @@ await ApiKey.create({
106
106
*`user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
107
107
*`description` (string): User-supplied description of API key.
108
108
*`expires_at` (string): API Key expiration date
109
-
*`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.
110
109
*`name` (string): Required - Internal name for the API Key. For your use.
111
110
*`aws_style_credentials` (boolean): If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
112
111
*`path` (string): Folder path restriction for `office_integration` permission set API keys.
112
+
*`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.
*`description` (string): User-supplied description of API key.
161
160
*`expires_at` (string): API Key expiration date
162
-
*`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.
163
161
*`name` (string): Internal name for the API Key. For your use.
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.
// description - string - User-supplied description of API key.
146
146
// expires_at - string - API Key expiration date
147
-
// 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.
148
147
// name - string - Internal name for the API Key. For your use.
thrownewerrors.InvalidParameterError("Bad parameter: permission_set must be of type String, received ".concat((0,_utils.getType)(params.permission_set)));
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
449
442
// description - string - User-supplied description of API key.
450
443
// expires_at - string - API Key expiration date
451
-
// 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.
452
444
// name (required) - string - Internal name for the API Key. For your use.
453
445
// aws_style_credentials - boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
454
446
// path - string - Folder path restriction for `office_integration` permission set API keys.
447
+
// 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.
thrownewerrors.InvalidParameterError("Bad parameter: permission_set must be of type String, received ".concat((0,_utils.getType)(params.permission_set)));
486
+
thrownewerrors.InvalidParameterError("Bad parameter: name must be of type String, received ".concat((0,_utils.getType)(params.name)));
thrownewerrors.InvalidParameterError("Bad parameter: path must be of type String, received ".concat((0,_utils.getType)(params.path)));
498
+
thrownewerrors.InvalidParameterError("Bad parameter: permission_set must be of type String, received ".concat((0,_utils.getType)(params.permission_set)));
// 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
+5-10Lines changed: 5 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -139,7 +139,6 @@ class ApiKey {
139
139
// Parameters:
140
140
// description - string - User-supplied description of API key.
141
141
// expires_at - string - API Key expiration date
142
-
// 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.
143
142
// name - string - Internal name for the API Key. For your use.
144
143
update=async(params={})=>{
145
144
if(!this.attributes.id){
@@ -163,10 +162,6 @@ class ApiKey {
163
162
thrownewerrors.InvalidParameterError(`Bad parameter: expires_at must be of type String, received ${getType(params.expires_at)}`)
thrownewerrors.InvalidParameterError(`Bad parameter: permission_set must be of type String, received ${getType(params.permission_set)}`)
168
-
}
169
-
170
165
if(params.name&&!isString(params.name)){
171
166
thrownewerrors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params.name)}`)
172
167
}
@@ -290,10 +285,10 @@ class ApiKey {
290
285
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
291
286
// description - string - User-supplied description of API key.
292
287
// expires_at - string - API Key expiration date
293
-
// 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.
294
288
// name (required) - string - Internal name for the API Key. For your use.
295
289
// aws_style_credentials - boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
296
290
// path - string - Folder path restriction for `office_integration` permission set API keys.
291
+
// 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.
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