@credibledata/cred-cli 0.1.3 → 0.1.5
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/.prettierignore +2 -1
- package/README.md +0 -2
- package/bun.lock +182 -283
- package/dist/client/api.js +804 -111
- package/dist/client/api.js.map +1 -1
- package/dist/clientconfiguration.js +55 -13
- package/dist/clientconfiguration.js.map +1 -1
- package/dist/clientconfiguration.spec.js +305 -16
- package/dist/clientconfiguration.spec.js.map +1 -1
- package/dist/commands/add.js +6 -3
- package/dist/commands/add.js.map +1 -1
- package/dist/commands/connection/createconnections.js +18 -3
- package/dist/commands/connection/createconnections.js.map +1 -1
- package/dist/commands/connection/createconnections.spec.js +219 -0
- package/dist/commands/connection/createconnections.spec.js.map +1 -0
- package/dist/commands/connection/deleteconnection.spec.js +130 -0
- package/dist/commands/connection/deleteconnection.spec.js.map +1 -0
- package/dist/commands/connection/listconnections.js +9 -3
- package/dist/commands/connection/listconnections.js.map +1 -1
- package/dist/commands/connection/listconnections.spec.js +117 -0
- package/dist/commands/connection/listconnections.spec.js.map +1 -0
- package/dist/commands/group/addmember.js +2 -0
- package/dist/commands/group/addmember.js.map +1 -1
- package/dist/commands/group/addmember.spec.js +148 -0
- package/dist/commands/group/addmember.spec.js.map +1 -0
- package/dist/commands/group/creategroup.spec.js +122 -0
- package/dist/commands/group/creategroup.spec.js.map +1 -0
- package/dist/commands/group/deletegroup.spec.js +104 -0
- package/dist/commands/group/deletegroup.spec.js.map +1 -0
- package/dist/commands/group/getgroup.spec.js +111 -0
- package/dist/commands/group/getgroup.spec.js.map +1 -0
- package/dist/commands/group/listgroups.spec.js +118 -0
- package/dist/commands/group/listgroups.spec.js.map +1 -0
- package/dist/commands/group/removemember.js +1 -0
- package/dist/commands/group/removemember.js.map +1 -1
- package/dist/commands/group/removemember.spec.js +138 -0
- package/dist/commands/group/removemember.spec.js.map +1 -0
- package/dist/commands/groupaccesstoken/createToken.js +6 -2
- package/dist/commands/groupaccesstoken/createToken.js.map +1 -1
- package/dist/commands/groupaccesstoken/createToken.spec.js +127 -0
- package/dist/commands/groupaccesstoken/createToken.spec.js.map +1 -0
- package/dist/commands/groupaccesstoken/deleteToken.js.map +1 -1
- package/dist/commands/groupaccesstoken/deleteToken.spec.js +103 -0
- package/dist/commands/groupaccesstoken/deleteToken.spec.js.map +1 -0
- package/dist/commands/groupaccesstoken/groupContainer.js.map +1 -1
- package/dist/commands/groupaccesstoken/listTokens.js.map +1 -1
- package/dist/commands/groupaccesstoken/listTokens.spec.js +115 -0
- package/dist/commands/groupaccesstoken/listTokens.spec.js.map +1 -0
- package/dist/commands/list.js +10 -3
- package/dist/commands/list.js.map +1 -1
- package/dist/commands/misc/login.js +146 -22
- package/dist/commands/misc/login.js.map +1 -1
- package/dist/commands/misc/login.spec.js +111 -6
- package/dist/commands/misc/login.spec.js.map +1 -1
- package/dist/commands/misc/logout.spec.js +30 -0
- package/dist/commands/misc/logout.spec.js.map +1 -0
- package/dist/commands/misc/loopbackOAuth.js +110 -0
- package/dist/commands/misc/loopbackOAuth.js.map +1 -0
- package/dist/commands/misc/set-access-token.js.map +1 -1
- package/dist/commands/misc/set-access-token.spec.js +65 -0
- package/dist/commands/misc/set-access-token.spec.js.map +1 -0
- package/dist/commands/package/deletepackage.spec.js +136 -0
- package/dist/commands/package/deletepackage.spec.js.map +1 -0
- package/dist/commands/package/listpackages.js +10 -5
- package/dist/commands/package/listpackages.js.map +1 -1
- package/dist/commands/package/listpackages.spec.js +129 -0
- package/dist/commands/package/listpackages.spec.js.map +1 -0
- package/dist/commands/package/publish.js +23 -0
- package/dist/commands/package/publish.js.map +1 -1
- package/dist/commands/package/publish.spec.js +511 -0
- package/dist/commands/package/publish.spec.js.map +1 -0
- package/dist/commands/package/updatepackage.spec.js +50 -0
- package/dist/commands/package/updatepackage.spec.js.map +1 -1
- package/dist/commands/project/createproject.js +11 -1
- package/dist/commands/project/createproject.js.map +1 -1
- package/dist/commands/project/createproject.spec.js +154 -0
- package/dist/commands/project/createproject.spec.js.map +1 -0
- package/dist/commands/project/deleteproject.spec.js +106 -0
- package/dist/commands/project/deleteproject.spec.js.map +1 -0
- package/dist/commands/project/getproject.spec.js +99 -0
- package/dist/commands/project/getproject.spec.js.map +1 -0
- package/dist/commands/project/listprojects.js +13 -7
- package/dist/commands/project/listprojects.js.map +1 -1
- package/dist/commands/project/listprojects.spec.js +111 -0
- package/dist/commands/project/listprojects.spec.js.map +1 -0
- package/dist/commands/project/setproject.spec.js +58 -0
- package/dist/commands/project/setproject.spec.js.map +1 -0
- package/dist/commands/project/updateproject.js +68 -0
- package/dist/commands/project/updateproject.js.map +1 -0
- package/dist/commands/project/updateproject.spec.js +129 -0
- package/dist/commands/project/updateproject.spec.js.map +1 -0
- package/dist/commands/rm.js.map +1 -1
- package/dist/commands/update.js +13 -0
- package/dist/commands/update.js.map +1 -1
- package/dist/commands/version/listversions.spec.js +121 -0
- package/dist/commands/version/listversions.spec.js.map +1 -0
- package/dist/common/UserGroupId.spec.js +92 -0
- package/dist/common/UserGroupId.spec.js.map +1 -0
- package/dist/constants.js +49 -13
- package/dist/constants.js.map +1 -1
- package/dist/index.js +40 -18
- package/dist/index.js.map +1 -1
- package/dist/logger.spec.js +125 -0
- package/dist/logger.spec.js.map +1 -0
- package/dist/polyfills/file.polyfill.js.map +1 -1
- package/dist/utils.js +59 -0
- package/dist/utils.js.map +1 -1
- package/dist/utils.spec.js +158 -0
- package/dist/utils.spec.js.map +1 -0
- package/docker/Dockerfile.ci +11 -3
- package/eslint.config.mjs +45 -0
- package/generate-client.sh +5 -0
- package/package.json +24 -16
- package/src/client/.openapi-generator/FILES +1 -0
- package/src/client/api.ts +1999 -696
- package/src/clientconfiguration.spec.ts +394 -20
- package/src/clientconfiguration.ts +74 -15
- package/src/commands/add.ts +15 -6
- package/src/commands/connection/createconnections.spec.ts +403 -0
- package/src/commands/connection/createconnections.ts +30 -5
- package/src/commands/connection/deleteconnection.spec.ts +189 -0
- package/src/commands/connection/listconnections.spec.ts +132 -0
- package/src/commands/connection/listconnections.ts +22 -3
- package/src/commands/group/addmember.spec.ts +257 -0
- package/src/commands/group/addmember.ts +2 -0
- package/src/commands/group/creategroup.spec.ts +146 -0
- package/src/commands/group/deletegroup.spec.ts +120 -0
- package/src/commands/group/getgroup.spec.ts +129 -0
- package/src/commands/group/listgroups.spec.ts +137 -0
- package/src/commands/group/removemember.spec.ts +224 -0
- package/src/commands/group/removemember.ts +1 -0
- package/src/commands/groupaccesstoken/createToken.spec.ts +211 -0
- package/src/commands/groupaccesstoken/createToken.ts +55 -51
- package/src/commands/groupaccesstoken/deleteToken.spec.ts +147 -0
- package/src/commands/groupaccesstoken/deleteToken.ts +16 -11
- package/src/commands/groupaccesstoken/groupContainer.ts +51 -51
- package/src/commands/groupaccesstoken/listTokens.spec.ts +147 -0
- package/src/commands/groupaccesstoken/listTokens.ts +16 -11
- package/src/commands/list.ts +50 -9
- package/src/commands/misc/login.spec.ts +91 -6
- package/src/commands/misc/login.ts +208 -25
- package/src/commands/misc/logout.spec.ts +32 -0
- package/src/commands/misc/loopbackOAuth.ts +127 -0
- package/src/commands/misc/set-access-token.spec.ts +95 -0
- package/src/commands/misc/set-access-token.ts +16 -16
- package/src/commands/package/deletepackage.spec.ts +164 -0
- package/src/commands/package/listpackages.spec.ts +147 -0
- package/src/commands/package/listpackages.ts +28 -5
- package/src/commands/package/publish.spec.ts +597 -0
- package/src/commands/package/publish.ts +32 -0
- package/src/commands/package/updatepackage.spec.ts +98 -0
- package/src/commands/project/createproject.spec.ts +247 -0
- package/src/commands/project/createproject.ts +12 -1
- package/src/commands/project/deleteproject.spec.ts +123 -0
- package/src/commands/project/getproject.spec.ts +109 -0
- package/src/commands/project/listprojects.spec.ts +121 -0
- package/src/commands/project/listprojects.ts +33 -7
- package/src/commands/project/setproject.spec.ts +63 -0
- package/src/commands/project/updateproject.spec.ts +217 -0
- package/src/commands/project/updateproject.ts +82 -0
- package/src/commands/rm.ts +1 -6
- package/src/commands/update.ts +24 -1
- package/src/commands/version/listversions.spec.ts +138 -0
- package/src/common/UserGroupId.spec.ts +117 -0
- package/src/constants.ts +59 -13
- package/src/index.ts +46 -20
- package/src/logger.spec.ts +158 -0
- package/src/polyfills/file.polyfill.ts +1 -0
- package/src/utils.spec.ts +135 -0
- package/src/utils.ts +81 -0
- package/tsconfig.json +15 -18
- package/.eslintrc +0 -33
package/src/client/api.ts
CHANGED
|
@@ -36,6 +36,58 @@ export interface AddGroupMembersRequest {
|
|
|
36
36
|
*/
|
|
37
37
|
'members'?: Array<GroupMember>;
|
|
38
38
|
}
|
|
39
|
+
/**
|
|
40
|
+
* Represents a user bookmark for saving references to workspaces, models, and chats
|
|
41
|
+
* @export
|
|
42
|
+
* @interface Bookmark
|
|
43
|
+
*/
|
|
44
|
+
export interface Bookmark {
|
|
45
|
+
/**
|
|
46
|
+
* The organization name this bookmark belongs to
|
|
47
|
+
* @type {string}
|
|
48
|
+
* @memberof Bookmark
|
|
49
|
+
*/
|
|
50
|
+
'organizationName'?: string;
|
|
51
|
+
/**
|
|
52
|
+
* The username of the user who owns the bookmark
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof Bookmark
|
|
55
|
+
*/
|
|
56
|
+
'userName'?: string;
|
|
57
|
+
/**
|
|
58
|
+
* The type of object being bookmarked
|
|
59
|
+
* @type {string}
|
|
60
|
+
* @memberof Bookmark
|
|
61
|
+
*/
|
|
62
|
+
'bookmarkType': BookmarkBookmarkTypeEnum;
|
|
63
|
+
/**
|
|
64
|
+
* The unique identifier of the bookmarked object
|
|
65
|
+
* @type {string}
|
|
66
|
+
* @memberof Bookmark
|
|
67
|
+
*/
|
|
68
|
+
'objectId': string;
|
|
69
|
+
/**
|
|
70
|
+
* The workspace the bookmark is associated with (optional)
|
|
71
|
+
* @type {string}
|
|
72
|
+
* @memberof Bookmark
|
|
73
|
+
*/
|
|
74
|
+
'workspaceName'?: string;
|
|
75
|
+
/**
|
|
76
|
+
* ISO 8601 timestamp indicating when the bookmark was created
|
|
77
|
+
* @type {string}
|
|
78
|
+
* @memberof Bookmark
|
|
79
|
+
*/
|
|
80
|
+
'createdAt'?: string;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export const BookmarkBookmarkTypeEnum = {
|
|
84
|
+
Workspace: 'WORKSPACE',
|
|
85
|
+
Model: 'MODEL',
|
|
86
|
+
Chat: 'CHAT'
|
|
87
|
+
} as const;
|
|
88
|
+
|
|
89
|
+
export type BookmarkBookmarkTypeEnum = typeof BookmarkBookmarkTypeEnum[keyof typeof BookmarkBookmarkTypeEnum];
|
|
90
|
+
|
|
39
91
|
/**
|
|
40
92
|
*
|
|
41
93
|
* @export
|
|
@@ -43,19 +95,19 @@ export interface AddGroupMembersRequest {
|
|
|
43
95
|
*/
|
|
44
96
|
export interface Connection {
|
|
45
97
|
/**
|
|
46
|
-
* Resource path to the connection
|
|
98
|
+
* Resource path to the connection
|
|
47
99
|
* @type {string}
|
|
48
100
|
* @memberof Connection
|
|
49
101
|
*/
|
|
50
102
|
'resource'?: string;
|
|
51
103
|
/**
|
|
52
|
-
*
|
|
104
|
+
* Name of the connection
|
|
53
105
|
* @type {string}
|
|
54
106
|
* @memberof Connection
|
|
55
107
|
*/
|
|
56
108
|
'name'?: string;
|
|
57
109
|
/**
|
|
58
|
-
*
|
|
110
|
+
* Type of database connection
|
|
59
111
|
* @type {string}
|
|
60
112
|
* @memberof Connection
|
|
61
113
|
*/
|
|
@@ -96,18 +148,54 @@ export interface Connection {
|
|
|
96
148
|
* @memberof Connection
|
|
97
149
|
*/
|
|
98
150
|
'mysqlConnection'?: ConnectionMysqlConnection;
|
|
151
|
+
/**
|
|
152
|
+
*
|
|
153
|
+
* @type {ConnectionDuckdbConnection}
|
|
154
|
+
* @memberof Connection
|
|
155
|
+
*/
|
|
156
|
+
'duckdbConnection'?: ConnectionDuckdbConnection;
|
|
157
|
+
/**
|
|
158
|
+
*
|
|
159
|
+
* @type {ConnectionMotherduckConnection}
|
|
160
|
+
* @memberof Connection
|
|
161
|
+
*/
|
|
162
|
+
'motherduckConnection'?: ConnectionMotherduckConnection;
|
|
163
|
+
/**
|
|
164
|
+
*
|
|
165
|
+
* @type {ConnectionAllOfDucklakeConnection}
|
|
166
|
+
* @memberof Connection
|
|
167
|
+
*/
|
|
168
|
+
'ducklakeConnection'?: ConnectionAllOfDucklakeConnection;
|
|
99
169
|
/**
|
|
100
170
|
* The list of tables to include, in the format `{dataset/schema}.{table}`. The first part represents the dataset or schema, and the second part is the table name. The second part can be a literal `*` to include all tables.
|
|
101
171
|
* @type {Array<string>}
|
|
102
172
|
* @memberof Connection
|
|
103
173
|
*/
|
|
104
174
|
'includeTables'?: Array<string>;
|
|
175
|
+
/**
|
|
176
|
+
* Whether to exclude all tables.
|
|
177
|
+
* @type {boolean}
|
|
178
|
+
* @memberof Connection
|
|
179
|
+
*/
|
|
180
|
+
'excludeAllTables'?: boolean;
|
|
105
181
|
/**
|
|
106
182
|
* The list of tables to exclude, in the format `{dataset/schema}.{table}`. The first part represents the dataset or schema, and the second part is the table name. The second part can be a literal `*` to exclude all tables.
|
|
107
183
|
* @type {Array<string>}
|
|
108
184
|
* @memberof Connection
|
|
109
185
|
*/
|
|
110
186
|
'excludeTables'?: Array<string>;
|
|
187
|
+
/**
|
|
188
|
+
* Current indexing status of the connection. UNKNOWN means indexing has not started yet, PENDING means indexing is in progress, INDEXED means indexing finished successfully, SKIPPED means the connection is excluded from indexing, FAILED means indexing failed, RETRY means the connection was updated while indexing was in progress and will be re-indexed when the current job finishes.
|
|
189
|
+
* @type {string}
|
|
190
|
+
* @memberof Connection
|
|
191
|
+
*/
|
|
192
|
+
'indexingStatus'?: ConnectionIndexingStatusEnum;
|
|
193
|
+
/**
|
|
194
|
+
* ISO 8601 timestamp of when the indexing status was last updated
|
|
195
|
+
* @type {string}
|
|
196
|
+
* @memberof Connection
|
|
197
|
+
*/
|
|
198
|
+
'indexingStatusLastUpdated'?: string;
|
|
111
199
|
}
|
|
112
200
|
|
|
113
201
|
export const ConnectionTypeEnum = {
|
|
@@ -115,1034 +203,1574 @@ export const ConnectionTypeEnum = {
|
|
|
115
203
|
Bigquery: 'bigquery',
|
|
116
204
|
Snowflake: 'snowflake',
|
|
117
205
|
Trino: 'trino',
|
|
118
|
-
Mysql: 'mysql'
|
|
206
|
+
Mysql: 'mysql',
|
|
207
|
+
Duckdb: 'duckdb',
|
|
208
|
+
Motherduck: 'motherduck',
|
|
209
|
+
Ducklake: 'ducklake'
|
|
119
210
|
} as const;
|
|
120
211
|
|
|
121
212
|
export type ConnectionTypeEnum = typeof ConnectionTypeEnum[keyof typeof ConnectionTypeEnum];
|
|
213
|
+
export const ConnectionIndexingStatusEnum = {
|
|
214
|
+
Unknown: 'UNKNOWN',
|
|
215
|
+
Pending: 'PENDING',
|
|
216
|
+
Indexed: 'INDEXED',
|
|
217
|
+
Skipped: 'SKIPPED',
|
|
218
|
+
Failed: 'FAILED',
|
|
219
|
+
Retry: 'RETRY'
|
|
220
|
+
} as const;
|
|
221
|
+
|
|
222
|
+
export type ConnectionIndexingStatusEnum = typeof ConnectionIndexingStatusEnum[keyof typeof ConnectionIndexingStatusEnum];
|
|
122
223
|
|
|
123
224
|
/**
|
|
124
|
-
*
|
|
225
|
+
* Attached DuckDB database
|
|
125
226
|
* @export
|
|
126
|
-
* @interface
|
|
227
|
+
* @interface ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
127
228
|
*/
|
|
128
|
-
export interface
|
|
229
|
+
export interface ConnectionAllOfDuckdbConnectionAttachedDatabases {
|
|
129
230
|
/**
|
|
130
231
|
*
|
|
131
232
|
* @type {string}
|
|
132
|
-
* @memberof
|
|
133
|
-
*/
|
|
134
|
-
'dialectName'?: string;
|
|
135
|
-
/**
|
|
136
|
-
*
|
|
137
|
-
* @type {boolean}
|
|
138
|
-
* @memberof ConnectionAttributes
|
|
233
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
139
234
|
*/
|
|
140
|
-
'
|
|
235
|
+
'name'?: string;
|
|
141
236
|
/**
|
|
142
|
-
*
|
|
143
|
-
* @type {
|
|
144
|
-
* @memberof
|
|
237
|
+
* Type of database connection
|
|
238
|
+
* @type {string}
|
|
239
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
145
240
|
*/
|
|
146
|
-
'
|
|
241
|
+
'type'?: ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum;
|
|
147
242
|
/**
|
|
148
243
|
*
|
|
149
|
-
* @type {
|
|
150
|
-
* @memberof
|
|
244
|
+
* @type {ConnectionAttributes}
|
|
245
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
151
246
|
*/
|
|
152
|
-
'
|
|
153
|
-
}
|
|
154
|
-
/**
|
|
155
|
-
*
|
|
156
|
-
* @export
|
|
157
|
-
* @interface ConnectionBigqueryConnection
|
|
158
|
-
*/
|
|
159
|
-
export interface ConnectionBigqueryConnection {
|
|
247
|
+
'attributes'?: ConnectionAttributes;
|
|
160
248
|
/**
|
|
161
249
|
*
|
|
162
|
-
* @type {
|
|
163
|
-
* @memberof
|
|
250
|
+
* @type {ConnectionBigqueryConnection}
|
|
251
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
164
252
|
*/
|
|
165
|
-
'
|
|
253
|
+
'bigqueryConnection'?: ConnectionBigqueryConnection;
|
|
166
254
|
/**
|
|
167
255
|
*
|
|
168
|
-
* @type {
|
|
169
|
-
* @memberof
|
|
256
|
+
* @type {ConnectionSnowflakeConnection}
|
|
257
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
170
258
|
*/
|
|
171
|
-
'
|
|
259
|
+
'snowflakeConnection'?: ConnectionSnowflakeConnection;
|
|
172
260
|
/**
|
|
173
261
|
*
|
|
174
|
-
* @type {
|
|
175
|
-
* @memberof
|
|
262
|
+
* @type {ConnectionAllOfDuckdbConnectionPostgresConnection}
|
|
263
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
176
264
|
*/
|
|
177
|
-
'
|
|
265
|
+
'postgresConnection'?: ConnectionAllOfDuckdbConnectionPostgresConnection;
|
|
178
266
|
/**
|
|
179
267
|
*
|
|
180
|
-
* @type {
|
|
181
|
-
* @memberof
|
|
268
|
+
* @type {ConnectionGcsConnection}
|
|
269
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
182
270
|
*/
|
|
183
|
-
'
|
|
271
|
+
'gcsConnection'?: ConnectionGcsConnection;
|
|
184
272
|
/**
|
|
185
273
|
*
|
|
186
|
-
* @type {
|
|
187
|
-
* @memberof
|
|
274
|
+
* @type {ConnectionS3Connection}
|
|
275
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
188
276
|
*/
|
|
189
|
-
'
|
|
277
|
+
's3Connection'?: ConnectionS3Connection;
|
|
190
278
|
/**
|
|
191
279
|
*
|
|
192
|
-
* @type {
|
|
193
|
-
* @memberof
|
|
280
|
+
* @type {ConnectionAllOfDuckdbConnectionAzureConnection}
|
|
281
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
194
282
|
*/
|
|
195
|
-
'
|
|
283
|
+
'azureConnection'?: ConnectionAllOfDuckdbConnectionAzureConnection;
|
|
196
284
|
}
|
|
285
|
+
|
|
286
|
+
export const ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum = {
|
|
287
|
+
Bigquery: 'bigquery',
|
|
288
|
+
Snowflake: 'snowflake',
|
|
289
|
+
Postgres: 'postgres',
|
|
290
|
+
Gcs: 'gcs',
|
|
291
|
+
S3: 's3',
|
|
292
|
+
Azure: 'azure'
|
|
293
|
+
} as const;
|
|
294
|
+
|
|
295
|
+
export type ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum = typeof ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum[keyof typeof ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum];
|
|
296
|
+
|
|
197
297
|
/**
|
|
198
|
-
*
|
|
298
|
+
* Azure Data Lake Storage (ADLS Gen2) / Blob Storage connection configuration Supports https://, http://, abfss://, and az:// URL schemes.
|
|
199
299
|
* @export
|
|
200
|
-
* @interface
|
|
300
|
+
* @interface ConnectionAllOfDuckdbConnectionAzureConnection
|
|
201
301
|
*/
|
|
202
|
-
export interface
|
|
302
|
+
export interface ConnectionAllOfDuckdbConnectionAzureConnection {
|
|
203
303
|
/**
|
|
204
|
-
*
|
|
304
|
+
* Authentication method for Azure Storage
|
|
205
305
|
* @type {string}
|
|
206
|
-
* @memberof
|
|
306
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
207
307
|
*/
|
|
208
|
-
'
|
|
308
|
+
'authType': ConnectionAllOfDuckdbConnectionAzureConnectionAuthTypeEnum;
|
|
209
309
|
/**
|
|
210
|
-
*
|
|
211
|
-
* @type {
|
|
212
|
-
* @memberof
|
|
310
|
+
* Full SAS URL including token; required for sas_token auth. Supports single file, directory glob (*.ext), or recursive (**) patterns. Example: https://account.blob.core.windows.net/container/path/_*.parquet?sp=rl&st=...
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
213
313
|
*/
|
|
214
|
-
'
|
|
314
|
+
'sasUrl'?: string;
|
|
215
315
|
/**
|
|
216
|
-
*
|
|
316
|
+
* Azure AD tenant ID (required for service_principal)
|
|
217
317
|
* @type {string}
|
|
218
|
-
* @memberof
|
|
318
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
219
319
|
*/
|
|
220
|
-
'
|
|
320
|
+
'tenantId'?: string;
|
|
221
321
|
/**
|
|
222
|
-
*
|
|
322
|
+
* Azure AD application (client) ID (required for service_principal)
|
|
223
323
|
* @type {string}
|
|
224
|
-
* @memberof
|
|
324
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
225
325
|
*/
|
|
226
|
-
'
|
|
326
|
+
'clientId'?: string;
|
|
227
327
|
/**
|
|
228
|
-
*
|
|
328
|
+
* Azure AD client secret (required for service_principal)
|
|
229
329
|
* @type {string}
|
|
230
|
-
* @memberof
|
|
330
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
231
331
|
*/
|
|
232
|
-
'
|
|
332
|
+
'clientSecret'?: string;
|
|
333
|
+
/**
|
|
334
|
+
* Azure Storage account name (required for service_principal)
|
|
335
|
+
* @type {string}
|
|
336
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
337
|
+
*/
|
|
338
|
+
'accountName'?: string;
|
|
339
|
+
/**
|
|
340
|
+
* Azure file URL to query; required for service_principal auth. Supports single file, directory glob (*.ext), or recursive (**) patterns. Example: https://account.blob.core.windows.net/container/path/_**
|
|
341
|
+
* @type {string}
|
|
342
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
343
|
+
*/
|
|
344
|
+
'fileUrl'?: string;
|
|
233
345
|
}
|
|
346
|
+
|
|
347
|
+
export const ConnectionAllOfDuckdbConnectionAzureConnectionAuthTypeEnum = {
|
|
348
|
+
ServicePrincipal: 'service_principal',
|
|
349
|
+
SasToken: 'sas_token'
|
|
350
|
+
} as const;
|
|
351
|
+
|
|
352
|
+
export type ConnectionAllOfDuckdbConnectionAzureConnectionAuthTypeEnum = typeof ConnectionAllOfDuckdbConnectionAzureConnectionAuthTypeEnum[keyof typeof ConnectionAllOfDuckdbConnectionAzureConnectionAuthTypeEnum];
|
|
353
|
+
|
|
234
354
|
/**
|
|
235
|
-
*
|
|
355
|
+
* PostgreSQL database connection configuration
|
|
236
356
|
* @export
|
|
237
|
-
* @interface
|
|
357
|
+
* @interface ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
238
358
|
*/
|
|
239
|
-
export interface
|
|
359
|
+
export interface ConnectionAllOfDuckdbConnectionPostgresConnection {
|
|
240
360
|
/**
|
|
241
|
-
*
|
|
361
|
+
* PostgreSQL server hostname or IP address
|
|
242
362
|
* @type {string}
|
|
243
|
-
* @memberof
|
|
363
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
244
364
|
*/
|
|
245
365
|
'host'?: string;
|
|
246
366
|
/**
|
|
247
|
-
*
|
|
367
|
+
* PostgreSQL server port number
|
|
248
368
|
* @type {number}
|
|
249
|
-
* @memberof
|
|
369
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
250
370
|
*/
|
|
251
371
|
'port'?: number;
|
|
252
372
|
/**
|
|
253
|
-
*
|
|
373
|
+
* Name of the PostgreSQL database
|
|
254
374
|
* @type {string}
|
|
255
|
-
* @memberof
|
|
375
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
256
376
|
*/
|
|
257
377
|
'databaseName'?: string;
|
|
258
378
|
/**
|
|
259
|
-
*
|
|
379
|
+
* PostgreSQL username for authentication
|
|
260
380
|
* @type {string}
|
|
261
|
-
* @memberof
|
|
381
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
262
382
|
*/
|
|
263
383
|
'userName'?: string;
|
|
264
384
|
/**
|
|
265
|
-
*
|
|
385
|
+
* PostgreSQL password for authentication
|
|
266
386
|
* @type {string}
|
|
267
|
-
* @memberof
|
|
387
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
268
388
|
*/
|
|
269
389
|
'password'?: string;
|
|
270
390
|
/**
|
|
271
|
-
*
|
|
391
|
+
* Complete PostgreSQL connection string (alternative to individual parameters)
|
|
272
392
|
* @type {string}
|
|
273
|
-
* @memberof
|
|
393
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
274
394
|
*/
|
|
275
395
|
'connectionString'?: string;
|
|
276
396
|
}
|
|
277
397
|
/**
|
|
278
|
-
*
|
|
398
|
+
* DuckLake lakehouse connection configuration
|
|
279
399
|
* @export
|
|
280
|
-
* @interface
|
|
400
|
+
* @interface ConnectionAllOfDucklakeConnection
|
|
281
401
|
*/
|
|
282
|
-
export interface
|
|
402
|
+
export interface ConnectionAllOfDucklakeConnection {
|
|
283
403
|
/**
|
|
284
404
|
*
|
|
285
|
-
* @type {
|
|
286
|
-
* @memberof
|
|
405
|
+
* @type {ConnectionAllOfDucklakeConnectionStorage}
|
|
406
|
+
* @memberof ConnectionAllOfDucklakeConnection
|
|
287
407
|
*/
|
|
288
|
-
'
|
|
408
|
+
'storage': ConnectionAllOfDucklakeConnectionStorage;
|
|
289
409
|
/**
|
|
290
410
|
*
|
|
291
|
-
* @type {
|
|
292
|
-
* @memberof
|
|
411
|
+
* @type {ConnectionAllOfDucklakeConnectionCatalog}
|
|
412
|
+
* @memberof ConnectionAllOfDucklakeConnection
|
|
293
413
|
*/
|
|
294
|
-
'
|
|
414
|
+
'catalog': ConnectionAllOfDucklakeConnectionCatalog;
|
|
415
|
+
}
|
|
416
|
+
/**
|
|
417
|
+
* Catalog metadata connection configuration
|
|
418
|
+
* @export
|
|
419
|
+
* @interface ConnectionAllOfDucklakeConnectionCatalog
|
|
420
|
+
*/
|
|
421
|
+
export interface ConnectionAllOfDucklakeConnectionCatalog {
|
|
295
422
|
/**
|
|
296
423
|
*
|
|
297
|
-
* @type {
|
|
298
|
-
* @memberof
|
|
424
|
+
* @type {ConnectionPostgresConnection}
|
|
425
|
+
* @memberof ConnectionAllOfDucklakeConnectionCatalog
|
|
299
426
|
*/
|
|
300
|
-
'
|
|
427
|
+
'postgresConnection': ConnectionPostgresConnection;
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
430
|
+
* Data storage connection configuration (S3 or GCS)
|
|
431
|
+
* @export
|
|
432
|
+
* @interface ConnectionAllOfDucklakeConnectionStorage
|
|
433
|
+
*/
|
|
434
|
+
export interface ConnectionAllOfDucklakeConnectionStorage {
|
|
301
435
|
/**
|
|
302
|
-
*
|
|
436
|
+
* URL of the storage bucket (e.g. s3://my-bucket/path or gs://my-bucket/path)
|
|
303
437
|
* @type {string}
|
|
304
|
-
* @memberof
|
|
438
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorage
|
|
305
439
|
*/
|
|
306
|
-
'
|
|
440
|
+
'bucketUrl': string;
|
|
307
441
|
/**
|
|
308
442
|
*
|
|
309
|
-
* @type {
|
|
310
|
-
* @memberof
|
|
443
|
+
* @type {ConnectionAllOfDucklakeConnectionStorageS3Connection}
|
|
444
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorage
|
|
311
445
|
*/
|
|
312
|
-
'
|
|
446
|
+
's3Connection'?: ConnectionAllOfDucklakeConnectionStorageS3Connection;
|
|
313
447
|
/**
|
|
314
448
|
*
|
|
315
|
-
* @type {
|
|
316
|
-
* @memberof
|
|
449
|
+
* @type {ConnectionAllOfDucklakeConnectionStorageGcsConnection}
|
|
450
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorage
|
|
317
451
|
*/
|
|
318
|
-
'
|
|
452
|
+
'gcsConnection'?: ConnectionAllOfDucklakeConnectionStorageGcsConnection;
|
|
453
|
+
}
|
|
454
|
+
/**
|
|
455
|
+
* Google Cloud Storage connection configuration for data storage
|
|
456
|
+
* @export
|
|
457
|
+
* @interface ConnectionAllOfDucklakeConnectionStorageGcsConnection
|
|
458
|
+
*/
|
|
459
|
+
export interface ConnectionAllOfDucklakeConnectionStorageGcsConnection {
|
|
319
460
|
/**
|
|
320
|
-
*
|
|
461
|
+
* GCS HMAC access key ID
|
|
321
462
|
* @type {string}
|
|
322
|
-
* @memberof
|
|
463
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageGcsConnection
|
|
323
464
|
*/
|
|
324
|
-
'
|
|
465
|
+
'keyId': string;
|
|
325
466
|
/**
|
|
326
|
-
*
|
|
327
|
-
* @type {
|
|
328
|
-
* @memberof
|
|
467
|
+
* GCS HMAC secret key
|
|
468
|
+
* @type {string}
|
|
469
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageGcsConnection
|
|
329
470
|
*/
|
|
330
|
-
'
|
|
471
|
+
'secret': string;
|
|
331
472
|
}
|
|
332
473
|
/**
|
|
333
|
-
*
|
|
474
|
+
* AWS S3 connection configuration for data storage
|
|
334
475
|
* @export
|
|
335
|
-
* @interface
|
|
476
|
+
* @interface ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
336
477
|
*/
|
|
337
|
-
export interface
|
|
478
|
+
export interface ConnectionAllOfDucklakeConnectionStorageS3Connection {
|
|
338
479
|
/**
|
|
339
|
-
*
|
|
480
|
+
* AWS access key ID
|
|
340
481
|
* @type {string}
|
|
341
|
-
* @memberof
|
|
342
|
-
*/
|
|
343
|
-
'server'?: string;
|
|
344
|
-
/**
|
|
345
|
-
*
|
|
346
|
-
* @type {number}
|
|
347
|
-
* @memberof ConnectionTrinoConnection
|
|
482
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
348
483
|
*/
|
|
349
|
-
'
|
|
484
|
+
'accessKeyId': string;
|
|
350
485
|
/**
|
|
351
|
-
*
|
|
486
|
+
* AWS secret access key
|
|
352
487
|
* @type {string}
|
|
353
|
-
* @memberof
|
|
488
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
354
489
|
*/
|
|
355
|
-
'
|
|
490
|
+
'secretAccessKey': string;
|
|
356
491
|
/**
|
|
357
|
-
*
|
|
492
|
+
* AWS region (e.g., us-east-1)
|
|
358
493
|
* @type {string}
|
|
359
|
-
* @memberof
|
|
494
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
360
495
|
*/
|
|
361
|
-
'
|
|
496
|
+
'region'?: string;
|
|
362
497
|
/**
|
|
363
|
-
*
|
|
498
|
+
* Custom S3-compatible endpoint URL (optional, for MinIO, etc.)
|
|
364
499
|
* @type {string}
|
|
365
|
-
* @memberof
|
|
500
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
366
501
|
*/
|
|
367
|
-
'
|
|
502
|
+
'endpoint'?: string;
|
|
368
503
|
/**
|
|
369
|
-
*
|
|
504
|
+
* AWS session token for temporary credentials (optional)
|
|
370
505
|
* @type {string}
|
|
371
|
-
* @memberof
|
|
506
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
372
507
|
*/
|
|
373
|
-
'
|
|
508
|
+
'sessionToken'?: string;
|
|
374
509
|
}
|
|
375
510
|
/**
|
|
376
|
-
*
|
|
511
|
+
* Connection capabilities and configuration attributes
|
|
377
512
|
* @export
|
|
378
|
-
* @interface
|
|
513
|
+
* @interface ConnectionAttributes
|
|
379
514
|
*/
|
|
380
|
-
export interface
|
|
515
|
+
export interface ConnectionAttributes {
|
|
381
516
|
/**
|
|
382
|
-
*
|
|
517
|
+
* SQL dialect name for the connection
|
|
383
518
|
* @type {string}
|
|
384
|
-
* @memberof
|
|
519
|
+
* @memberof ConnectionAttributes
|
|
385
520
|
*/
|
|
386
|
-
'
|
|
521
|
+
'dialectName'?: string;
|
|
387
522
|
/**
|
|
388
|
-
*
|
|
389
|
-
* @type {
|
|
390
|
-
* @memberof
|
|
523
|
+
* Whether the connection uses connection pooling
|
|
524
|
+
* @type {boolean}
|
|
525
|
+
* @memberof ConnectionAttributes
|
|
391
526
|
*/
|
|
392
|
-
'
|
|
527
|
+
'isPool'?: boolean;
|
|
393
528
|
/**
|
|
394
|
-
*
|
|
395
|
-
* @type {
|
|
396
|
-
* @memberof
|
|
529
|
+
* Whether the connection supports persistent storage operations
|
|
530
|
+
* @type {boolean}
|
|
531
|
+
* @memberof ConnectionAttributes
|
|
397
532
|
*/
|
|
398
|
-
'
|
|
533
|
+
'canPersist'?: boolean;
|
|
399
534
|
/**
|
|
400
|
-
*
|
|
401
|
-
* @type {
|
|
402
|
-
* @memberof
|
|
535
|
+
* Whether the connection supports streaming query results
|
|
536
|
+
* @type {boolean}
|
|
537
|
+
* @memberof ConnectionAttributes
|
|
403
538
|
*/
|
|
404
|
-
'
|
|
405
|
-
/**
|
|
406
|
-
* ISO 8601 timestamp indicating when the document was last modified
|
|
407
|
-
* @type {string}
|
|
408
|
-
* @memberof Document
|
|
409
|
-
*/
|
|
410
|
-
'updatedAt'?: string;
|
|
539
|
+
'canStream'?: boolean;
|
|
411
540
|
}
|
|
412
|
-
|
|
413
|
-
export const DocumentTypeEnum = {
|
|
414
|
-
Workbook: 'workbook',
|
|
415
|
-
Dashboard: 'dashboard'
|
|
416
|
-
} as const;
|
|
417
|
-
|
|
418
|
-
export type DocumentTypeEnum = typeof DocumentTypeEnum[keyof typeof DocumentTypeEnum];
|
|
419
|
-
|
|
420
541
|
/**
|
|
421
|
-
*
|
|
542
|
+
* Google BigQuery database connection configuration
|
|
422
543
|
* @export
|
|
423
|
-
* @interface
|
|
544
|
+
* @interface ConnectionBigqueryConnection
|
|
424
545
|
*/
|
|
425
|
-
export interface
|
|
546
|
+
export interface ConnectionBigqueryConnection {
|
|
426
547
|
/**
|
|
427
|
-
*
|
|
548
|
+
* Default BigQuery project ID for queries
|
|
428
549
|
* @type {string}
|
|
429
|
-
* @memberof
|
|
550
|
+
* @memberof ConnectionBigqueryConnection
|
|
430
551
|
*/
|
|
431
|
-
'
|
|
552
|
+
'defaultProjectId'?: string;
|
|
432
553
|
/**
|
|
433
|
-
*
|
|
554
|
+
* BigQuery project ID for billing purposes
|
|
434
555
|
* @type {string}
|
|
435
|
-
* @memberof
|
|
556
|
+
* @memberof ConnectionBigqueryConnection
|
|
436
557
|
*/
|
|
437
|
-
'
|
|
558
|
+
'billingProjectId'?: string;
|
|
438
559
|
/**
|
|
439
|
-
*
|
|
560
|
+
* BigQuery dataset location/region
|
|
440
561
|
* @type {string}
|
|
441
|
-
* @memberof
|
|
562
|
+
* @memberof ConnectionBigqueryConnection
|
|
442
563
|
*/
|
|
443
|
-
'
|
|
564
|
+
'location'?: string;
|
|
444
565
|
/**
|
|
445
|
-
*
|
|
566
|
+
* JSON string containing Google Cloud service account credentials
|
|
446
567
|
* @type {string}
|
|
447
|
-
* @memberof
|
|
568
|
+
* @memberof ConnectionBigqueryConnection
|
|
448
569
|
*/
|
|
449
|
-
'
|
|
570
|
+
'serviceAccountKeyJson'?: string;
|
|
450
571
|
/**
|
|
451
|
-
*
|
|
572
|
+
* Maximum bytes to bill for query execution (prevents runaway costs)
|
|
452
573
|
* @type {string}
|
|
453
|
-
* @memberof
|
|
574
|
+
* @memberof ConnectionBigqueryConnection
|
|
454
575
|
*/
|
|
455
|
-
'
|
|
576
|
+
'maximumBytesBilled'?: string;
|
|
456
577
|
/**
|
|
457
|
-
*
|
|
578
|
+
* Query timeout in milliseconds
|
|
458
579
|
* @type {string}
|
|
459
|
-
* @memberof
|
|
580
|
+
* @memberof ConnectionBigqueryConnection
|
|
460
581
|
*/
|
|
461
|
-
'
|
|
582
|
+
'queryTimeoutMilliseconds'?: string;
|
|
462
583
|
}
|
|
463
|
-
|
|
464
|
-
export const DocumentPermissionPermissionEnum = {
|
|
465
|
-
Editor: 'editor',
|
|
466
|
-
Viewer: 'viewer'
|
|
467
|
-
} as const;
|
|
468
|
-
|
|
469
|
-
export type DocumentPermissionPermissionEnum = typeof DocumentPermissionPermissionEnum[keyof typeof DocumentPermissionPermissionEnum];
|
|
470
|
-
export const DocumentPermissionInheritedPermissionEnum = {
|
|
471
|
-
Manager: 'manager',
|
|
472
|
-
Viewer: 'viewer'
|
|
473
|
-
} as const;
|
|
474
|
-
|
|
475
|
-
export type DocumentPermissionInheritedPermissionEnum = typeof DocumentPermissionInheritedPermissionEnum[keyof typeof DocumentPermissionInheritedPermissionEnum];
|
|
476
|
-
|
|
477
584
|
/**
|
|
478
|
-
*
|
|
585
|
+
* DuckDB database connection configuration
|
|
479
586
|
* @export
|
|
480
|
-
* @interface
|
|
587
|
+
* @interface ConnectionDuckdbConnection
|
|
481
588
|
*/
|
|
482
|
-
export interface
|
|
589
|
+
export interface ConnectionDuckdbConnection {
|
|
483
590
|
/**
|
|
484
|
-
*
|
|
485
|
-
* @type {Array<
|
|
486
|
-
* @memberof
|
|
591
|
+
*
|
|
592
|
+
* @type {Array<ConnectionAllOfDuckdbConnectionAttachedDatabases>}
|
|
593
|
+
* @memberof ConnectionDuckdbConnection
|
|
487
594
|
*/
|
|
488
|
-
'
|
|
595
|
+
'attachedDatabases'?: Array<ConnectionAllOfDuckdbConnectionAttachedDatabases>;
|
|
489
596
|
}
|
|
490
597
|
/**
|
|
491
|
-
*
|
|
598
|
+
* Google Cloud Storage connection configuration for DuckDB
|
|
492
599
|
* @export
|
|
493
|
-
* @interface
|
|
600
|
+
* @interface ConnectionGcsConnection
|
|
494
601
|
*/
|
|
495
|
-
export interface
|
|
496
|
-
/**
|
|
497
|
-
* Standard identifier pattern for resource names
|
|
498
|
-
* @type {string}
|
|
499
|
-
* @memberof Group
|
|
500
|
-
*/
|
|
501
|
-
'organizationName'?: string;
|
|
602
|
+
export interface ConnectionGcsConnection {
|
|
502
603
|
/**
|
|
503
|
-
*
|
|
604
|
+
* GCS HMAC access key ID
|
|
504
605
|
* @type {string}
|
|
505
|
-
* @memberof
|
|
606
|
+
* @memberof ConnectionGcsConnection
|
|
506
607
|
*/
|
|
507
|
-
'
|
|
608
|
+
'keyId': string;
|
|
508
609
|
/**
|
|
509
|
-
*
|
|
610
|
+
* GCS HMAC secret key
|
|
510
611
|
* @type {string}
|
|
511
|
-
* @memberof
|
|
612
|
+
* @memberof ConnectionGcsConnection
|
|
512
613
|
*/
|
|
513
|
-
'
|
|
614
|
+
'secret': string;
|
|
615
|
+
}
|
|
616
|
+
/**
|
|
617
|
+
* MotherDuck database connection configuration
|
|
618
|
+
* @export
|
|
619
|
+
* @interface ConnectionMotherduckConnection
|
|
620
|
+
*/
|
|
621
|
+
export interface ConnectionMotherduckConnection {
|
|
514
622
|
/**
|
|
515
|
-
*
|
|
623
|
+
* MotherDuck access token
|
|
516
624
|
* @type {string}
|
|
517
|
-
* @memberof
|
|
625
|
+
* @memberof ConnectionMotherduckConnection
|
|
518
626
|
*/
|
|
519
|
-
'
|
|
627
|
+
'accessToken'?: string;
|
|
520
628
|
/**
|
|
521
|
-
*
|
|
629
|
+
* MotherDuck database name
|
|
522
630
|
* @type {string}
|
|
523
|
-
* @memberof
|
|
631
|
+
* @memberof ConnectionMotherduckConnection
|
|
524
632
|
*/
|
|
525
|
-
'
|
|
633
|
+
'database'?: string;
|
|
526
634
|
}
|
|
527
635
|
/**
|
|
528
|
-
*
|
|
636
|
+
* MySQL database connection configuration
|
|
529
637
|
* @export
|
|
530
|
-
* @interface
|
|
638
|
+
* @interface ConnectionMysqlConnection
|
|
531
639
|
*/
|
|
532
|
-
export interface
|
|
640
|
+
export interface ConnectionMysqlConnection {
|
|
533
641
|
/**
|
|
534
|
-
*
|
|
642
|
+
* MySQL server hostname or IP address
|
|
535
643
|
* @type {string}
|
|
536
|
-
* @memberof
|
|
644
|
+
* @memberof ConnectionMysqlConnection
|
|
537
645
|
*/
|
|
538
|
-
'
|
|
646
|
+
'host'?: string;
|
|
539
647
|
/**
|
|
540
|
-
*
|
|
541
|
-
* @type {
|
|
542
|
-
* @memberof
|
|
648
|
+
* MySQL server port number
|
|
649
|
+
* @type {number}
|
|
650
|
+
* @memberof ConnectionMysqlConnection
|
|
543
651
|
*/
|
|
544
|
-
'
|
|
652
|
+
'port'?: number;
|
|
545
653
|
/**
|
|
546
|
-
*
|
|
654
|
+
* Name of the MySQL database
|
|
547
655
|
* @type {string}
|
|
548
|
-
* @memberof
|
|
656
|
+
* @memberof ConnectionMysqlConnection
|
|
549
657
|
*/
|
|
550
|
-
'
|
|
658
|
+
'database'?: string;
|
|
551
659
|
/**
|
|
552
|
-
*
|
|
660
|
+
* MySQL username for authentication
|
|
553
661
|
* @type {string}
|
|
554
|
-
* @memberof
|
|
662
|
+
* @memberof ConnectionMysqlConnection
|
|
555
663
|
*/
|
|
556
|
-
'
|
|
664
|
+
'user'?: string;
|
|
557
665
|
/**
|
|
558
|
-
*
|
|
666
|
+
* MySQL password for authentication
|
|
559
667
|
* @type {string}
|
|
560
|
-
* @memberof
|
|
561
|
-
*/
|
|
562
|
-
'expiresAt'?: string;
|
|
563
|
-
/**
|
|
564
|
-
* Whether the token has expired
|
|
565
|
-
* @type {boolean}
|
|
566
|
-
* @memberof GroupAccessToken
|
|
668
|
+
* @memberof ConnectionMysqlConnection
|
|
567
669
|
*/
|
|
568
|
-
'
|
|
670
|
+
'password'?: string;
|
|
569
671
|
}
|
|
570
672
|
/**
|
|
571
|
-
*
|
|
673
|
+
* PostgreSQL connection for DuckLake metadata catalog
|
|
572
674
|
* @export
|
|
573
|
-
* @interface
|
|
675
|
+
* @interface ConnectionPostgresConnection
|
|
574
676
|
*/
|
|
575
|
-
export interface
|
|
677
|
+
export interface ConnectionPostgresConnection {
|
|
576
678
|
/**
|
|
577
|
-
*
|
|
679
|
+
* PostgreSQL server hostname or IP address
|
|
578
680
|
* @type {string}
|
|
579
|
-
* @memberof
|
|
681
|
+
* @memberof ConnectionPostgresConnection
|
|
580
682
|
*/
|
|
581
|
-
'
|
|
683
|
+
'host'?: string;
|
|
582
684
|
/**
|
|
583
|
-
*
|
|
685
|
+
* PostgreSQL server port number
|
|
686
|
+
* @type {number}
|
|
687
|
+
* @memberof ConnectionPostgresConnection
|
|
688
|
+
*/
|
|
689
|
+
'port'?: number;
|
|
690
|
+
/**
|
|
691
|
+
* Name of the PostgreSQL database
|
|
584
692
|
* @type {string}
|
|
585
|
-
* @memberof
|
|
693
|
+
* @memberof ConnectionPostgresConnection
|
|
586
694
|
*/
|
|
587
|
-
'
|
|
588
|
-
}
|
|
589
|
-
|
|
590
|
-
export const GroupMemberStatusEnum = {
|
|
591
|
-
Admin: 'admin',
|
|
592
|
-
Member: 'member'
|
|
593
|
-
} as const;
|
|
594
|
-
|
|
595
|
-
export type GroupMemberStatusEnum = typeof GroupMemberStatusEnum[keyof typeof GroupMemberStatusEnum];
|
|
596
|
-
|
|
597
|
-
/**
|
|
598
|
-
* Standard error response format used across all API endpoints
|
|
599
|
-
* @export
|
|
600
|
-
* @interface ModelError
|
|
601
|
-
*/
|
|
602
|
-
export interface ModelError {
|
|
695
|
+
'databaseName'?: string;
|
|
603
696
|
/**
|
|
604
|
-
*
|
|
697
|
+
* PostgreSQL username for authentication
|
|
605
698
|
* @type {string}
|
|
606
|
-
* @memberof
|
|
699
|
+
* @memberof ConnectionPostgresConnection
|
|
607
700
|
*/
|
|
608
|
-
'
|
|
701
|
+
'userName'?: string;
|
|
609
702
|
/**
|
|
610
|
-
*
|
|
703
|
+
* PostgreSQL password for authentication
|
|
611
704
|
* @type {string}
|
|
612
|
-
* @memberof
|
|
705
|
+
* @memberof ConnectionPostgresConnection
|
|
613
706
|
*/
|
|
614
|
-
'
|
|
707
|
+
'password'?: string;
|
|
708
|
+
/**
|
|
709
|
+
* Complete PostgreSQL connection string (alternative to individual parameters)
|
|
710
|
+
* @type {string}
|
|
711
|
+
* @memberof ConnectionPostgresConnection
|
|
712
|
+
*/
|
|
713
|
+
'connectionString'?: string;
|
|
615
714
|
}
|
|
616
715
|
/**
|
|
617
|
-
*
|
|
716
|
+
* AWS S3 connection configuration for DuckDB
|
|
618
717
|
* @export
|
|
619
|
-
* @interface
|
|
718
|
+
* @interface ConnectionS3Connection
|
|
620
719
|
*/
|
|
621
|
-
export interface
|
|
720
|
+
export interface ConnectionS3Connection {
|
|
622
721
|
/**
|
|
623
|
-
*
|
|
722
|
+
* AWS access key ID
|
|
624
723
|
* @type {string}
|
|
625
|
-
* @memberof
|
|
724
|
+
* @memberof ConnectionS3Connection
|
|
626
725
|
*/
|
|
627
|
-
'
|
|
726
|
+
'accessKeyId': string;
|
|
628
727
|
/**
|
|
629
|
-
*
|
|
728
|
+
* AWS secret access key
|
|
630
729
|
* @type {string}
|
|
631
|
-
* @memberof
|
|
730
|
+
* @memberof ConnectionS3Connection
|
|
632
731
|
*/
|
|
633
|
-
'
|
|
732
|
+
'secretAccessKey': string;
|
|
634
733
|
/**
|
|
635
|
-
*
|
|
734
|
+
* AWS region (e.g., us-east-1)
|
|
636
735
|
* @type {string}
|
|
637
|
-
* @memberof
|
|
736
|
+
* @memberof ConnectionS3Connection
|
|
638
737
|
*/
|
|
639
|
-
'
|
|
738
|
+
'region'?: string;
|
|
640
739
|
/**
|
|
641
|
-
*
|
|
740
|
+
* Custom S3-compatible endpoint URL (optional, for MinIO, etc.)
|
|
642
741
|
* @type {string}
|
|
643
|
-
* @memberof
|
|
742
|
+
* @memberof ConnectionS3Connection
|
|
644
743
|
*/
|
|
645
|
-
'
|
|
744
|
+
'endpoint'?: string;
|
|
745
|
+
/**
|
|
746
|
+
* AWS session token for temporary credentials (optional)
|
|
747
|
+
* @type {string}
|
|
748
|
+
* @memberof ConnectionS3Connection
|
|
749
|
+
*/
|
|
750
|
+
'sessionToken'?: string;
|
|
646
751
|
}
|
|
647
752
|
/**
|
|
648
|
-
*
|
|
753
|
+
* Snowflake database connection configuration
|
|
649
754
|
* @export
|
|
650
|
-
* @interface
|
|
755
|
+
* @interface ConnectionSnowflakeConnection
|
|
651
756
|
*/
|
|
652
|
-
export interface
|
|
757
|
+
export interface ConnectionSnowflakeConnection {
|
|
653
758
|
/**
|
|
654
|
-
*
|
|
759
|
+
* Snowflake account identifier
|
|
655
760
|
* @type {string}
|
|
656
|
-
* @memberof
|
|
761
|
+
* @memberof ConnectionSnowflakeConnection
|
|
657
762
|
*/
|
|
658
|
-
'
|
|
763
|
+
'account'?: string;
|
|
659
764
|
/**
|
|
660
|
-
*
|
|
765
|
+
* Snowflake username for authentication
|
|
661
766
|
* @type {string}
|
|
662
|
-
* @memberof
|
|
767
|
+
* @memberof ConnectionSnowflakeConnection
|
|
663
768
|
*/
|
|
664
|
-
'
|
|
769
|
+
'username'?: string;
|
|
665
770
|
/**
|
|
666
|
-
*
|
|
771
|
+
* Snowflake password for authentication
|
|
667
772
|
* @type {string}
|
|
668
|
-
* @memberof
|
|
773
|
+
* @memberof ConnectionSnowflakeConnection
|
|
669
774
|
*/
|
|
670
|
-
'
|
|
775
|
+
'password'?: string;
|
|
671
776
|
/**
|
|
672
|
-
*
|
|
777
|
+
* Snowflake private key for authentication
|
|
673
778
|
* @type {string}
|
|
674
|
-
* @memberof
|
|
779
|
+
* @memberof ConnectionSnowflakeConnection
|
|
675
780
|
*/
|
|
676
|
-
'
|
|
781
|
+
'privateKey'?: string;
|
|
677
782
|
/**
|
|
678
|
-
*
|
|
783
|
+
* Passphrase for the Snowflake private key
|
|
679
784
|
* @type {string}
|
|
680
|
-
* @memberof
|
|
785
|
+
* @memberof ConnectionSnowflakeConnection
|
|
681
786
|
*/
|
|
682
|
-
'
|
|
683
|
-
}
|
|
684
|
-
|
|
685
|
-
export const OrganizationPermissionPermissionEnum = {
|
|
686
|
-
Admin: 'admin',
|
|
687
|
-
Modeler: 'modeler',
|
|
688
|
-
Member: 'member'
|
|
689
|
-
} as const;
|
|
690
|
-
|
|
691
|
-
export type OrganizationPermissionPermissionEnum = typeof OrganizationPermissionPermissionEnum[keyof typeof OrganizationPermissionPermissionEnum];
|
|
692
|
-
|
|
693
|
-
/**
|
|
694
|
-
* Represents a Malloy data model package containing models, queries, and related resources
|
|
695
|
-
* @export
|
|
696
|
-
* @interface Package
|
|
697
|
-
*/
|
|
698
|
-
export interface Package {
|
|
787
|
+
'privateKeyPass'?: string;
|
|
699
788
|
/**
|
|
700
|
-
*
|
|
789
|
+
* Snowflake warehouse name
|
|
701
790
|
* @type {string}
|
|
702
|
-
* @memberof
|
|
791
|
+
* @memberof ConnectionSnowflakeConnection
|
|
703
792
|
*/
|
|
704
|
-
'
|
|
793
|
+
'warehouse'?: string;
|
|
705
794
|
/**
|
|
706
|
-
*
|
|
795
|
+
* Snowflake database name
|
|
707
796
|
* @type {string}
|
|
708
|
-
* @memberof
|
|
797
|
+
* @memberof ConnectionSnowflakeConnection
|
|
709
798
|
*/
|
|
710
|
-
'
|
|
711
|
-
/**
|
|
712
|
-
* Human-readable description of the package\'s purpose and contents
|
|
713
|
-
* @type {string}
|
|
714
|
-
* @memberof Package
|
|
715
|
-
*/
|
|
716
|
-
'description'?: string;
|
|
799
|
+
'database'?: string;
|
|
717
800
|
/**
|
|
718
|
-
*
|
|
801
|
+
* Snowflake schema name
|
|
719
802
|
* @type {string}
|
|
720
|
-
* @memberof
|
|
803
|
+
* @memberof ConnectionSnowflakeConnection
|
|
721
804
|
*/
|
|
722
|
-
'
|
|
805
|
+
'schema'?: string;
|
|
723
806
|
/**
|
|
724
|
-
*
|
|
807
|
+
* Snowflake role name
|
|
725
808
|
* @type {string}
|
|
726
|
-
* @memberof
|
|
809
|
+
* @memberof ConnectionSnowflakeConnection
|
|
727
810
|
*/
|
|
728
|
-
'
|
|
811
|
+
'role'?: string;
|
|
729
812
|
/**
|
|
730
|
-
*
|
|
813
|
+
* Query response timeout in milliseconds
|
|
731
814
|
* @type {number}
|
|
732
|
-
* @memberof
|
|
733
|
-
*/
|
|
734
|
-
'replicationCount'?: number;
|
|
735
|
-
/**
|
|
736
|
-
* Standard identifier pattern for resource names
|
|
737
|
-
* @type {string}
|
|
738
|
-
* @memberof Package
|
|
815
|
+
* @memberof ConnectionSnowflakeConnection
|
|
739
816
|
*/
|
|
740
|
-
'
|
|
817
|
+
'responseTimeoutMilliseconds'?: number;
|
|
741
818
|
}
|
|
742
819
|
/**
|
|
743
|
-
*
|
|
820
|
+
* Trino database connection configuration
|
|
744
821
|
* @export
|
|
745
|
-
* @interface
|
|
822
|
+
* @interface ConnectionTrinoConnection
|
|
746
823
|
*/
|
|
747
|
-
export interface
|
|
824
|
+
export interface ConnectionTrinoConnection {
|
|
748
825
|
/**
|
|
749
|
-
*
|
|
826
|
+
* Trino server hostname or IP address
|
|
750
827
|
* @type {string}
|
|
751
|
-
* @memberof
|
|
828
|
+
* @memberof ConnectionTrinoConnection
|
|
752
829
|
*/
|
|
753
|
-
'
|
|
830
|
+
'server'?: string;
|
|
754
831
|
/**
|
|
755
|
-
*
|
|
756
|
-
* @type {
|
|
757
|
-
* @memberof
|
|
832
|
+
* Trino server port number
|
|
833
|
+
* @type {number}
|
|
834
|
+
* @memberof ConnectionTrinoConnection
|
|
758
835
|
*/
|
|
759
|
-
'
|
|
836
|
+
'port'?: number;
|
|
760
837
|
/**
|
|
761
|
-
*
|
|
838
|
+
* Trino catalog name
|
|
762
839
|
* @type {string}
|
|
763
|
-
* @memberof
|
|
840
|
+
* @memberof ConnectionTrinoConnection
|
|
764
841
|
*/
|
|
765
|
-
'
|
|
842
|
+
'catalog'?: string;
|
|
766
843
|
/**
|
|
767
|
-
*
|
|
844
|
+
* Trino schema name
|
|
768
845
|
* @type {string}
|
|
769
|
-
* @memberof
|
|
846
|
+
* @memberof ConnectionTrinoConnection
|
|
770
847
|
*/
|
|
771
|
-
'
|
|
848
|
+
'schema'?: string;
|
|
772
849
|
/**
|
|
773
|
-
*
|
|
850
|
+
* Trino username for authentication
|
|
774
851
|
* @type {string}
|
|
775
|
-
* @memberof
|
|
852
|
+
* @memberof ConnectionTrinoConnection
|
|
776
853
|
*/
|
|
777
|
-
'
|
|
854
|
+
'user'?: string;
|
|
778
855
|
/**
|
|
779
|
-
*
|
|
856
|
+
* Trino password for authentication
|
|
780
857
|
* @type {string}
|
|
781
|
-
* @memberof
|
|
858
|
+
* @memberof ConnectionTrinoConnection
|
|
782
859
|
*/
|
|
783
|
-
'
|
|
860
|
+
'password'?: string;
|
|
784
861
|
/**
|
|
785
|
-
*
|
|
862
|
+
* Peaka API key for authentication with Peaka-hosted Trino clusters
|
|
786
863
|
* @type {string}
|
|
787
|
-
* @memberof
|
|
864
|
+
* @memberof ConnectionTrinoConnection
|
|
788
865
|
*/
|
|
789
|
-
'
|
|
866
|
+
'peakaKey'?: string;
|
|
790
867
|
}
|
|
791
|
-
|
|
792
|
-
export const PackagePermissionPermissionEnum = {
|
|
793
|
-
Admin: 'admin',
|
|
794
|
-
Modeler: 'modeler',
|
|
795
|
-
Viewer: 'viewer'
|
|
796
|
-
} as const;
|
|
797
|
-
|
|
798
|
-
export type PackagePermissionPermissionEnum = typeof PackagePermissionPermissionEnum[keyof typeof PackagePermissionPermissionEnum];
|
|
799
|
-
export const PackagePermissionInheritedPermissionEnum = {
|
|
800
|
-
Admin: 'admin',
|
|
801
|
-
Modeler: 'modeler',
|
|
802
|
-
Viewer: 'viewer'
|
|
803
|
-
} as const;
|
|
804
|
-
|
|
805
|
-
export type PackagePermissionInheritedPermissionEnum = typeof PackagePermissionInheritedPermissionEnum[keyof typeof PackagePermissionInheritedPermissionEnum];
|
|
806
|
-
|
|
807
868
|
/**
|
|
808
|
-
* Represents a
|
|
869
|
+
* Represents a document within a workspace, such as a workbook or dashboard
|
|
809
870
|
* @export
|
|
810
|
-
* @interface
|
|
871
|
+
* @interface Document
|
|
811
872
|
*/
|
|
812
|
-
export interface
|
|
873
|
+
export interface Document {
|
|
813
874
|
/**
|
|
814
|
-
*
|
|
875
|
+
* Path pattern supporting slashes, dots, and dashes
|
|
815
876
|
* @type {string}
|
|
816
|
-
* @memberof
|
|
877
|
+
* @memberof Document
|
|
817
878
|
*/
|
|
818
|
-
'
|
|
879
|
+
'path'?: string;
|
|
819
880
|
/**
|
|
820
|
-
*
|
|
881
|
+
* The content of the document, typically Malloy code or configuration
|
|
821
882
|
* @type {string}
|
|
822
|
-
* @memberof
|
|
883
|
+
* @memberof Document
|
|
823
884
|
*/
|
|
824
|
-
'
|
|
885
|
+
'content'?: string;
|
|
825
886
|
/**
|
|
826
|
-
*
|
|
887
|
+
* The type of document, determining its purpose and behavior
|
|
827
888
|
* @type {string}
|
|
828
|
-
* @memberof
|
|
889
|
+
* @memberof Document
|
|
890
|
+
*/
|
|
891
|
+
'type'?: DocumentTypeEnum;
|
|
892
|
+
/**
|
|
893
|
+
* ISO 8601 timestamp indicating when the document was created
|
|
894
|
+
* @type {string}
|
|
895
|
+
* @memberof Document
|
|
829
896
|
*/
|
|
830
897
|
'createdAt'?: string;
|
|
831
898
|
/**
|
|
832
|
-
* ISO 8601 timestamp indicating when the
|
|
899
|
+
* ISO 8601 timestamp indicating when the document was last modified
|
|
833
900
|
* @type {string}
|
|
834
|
-
* @memberof
|
|
901
|
+
* @memberof Document
|
|
835
902
|
*/
|
|
836
903
|
'updatedAt'?: string;
|
|
837
904
|
/**
|
|
838
|
-
*
|
|
839
|
-
* @type {
|
|
840
|
-
* @memberof
|
|
905
|
+
* The userId of the user who last modified this document
|
|
906
|
+
* @type {string}
|
|
907
|
+
* @memberof Document
|
|
841
908
|
*/
|
|
842
|
-
'
|
|
909
|
+
'modifiedBy'?: string;
|
|
910
|
+
/**
|
|
911
|
+
* Optional JSON metadata associated with the document (e.g. title, tags)
|
|
912
|
+
* @type {object}
|
|
913
|
+
* @memberof Document
|
|
914
|
+
*/
|
|
915
|
+
'metadata'?: object;
|
|
843
916
|
}
|
|
917
|
+
|
|
918
|
+
export const DocumentTypeEnum = {
|
|
919
|
+
Workbook: 'workbook',
|
|
920
|
+
Dashboard: 'dashboard',
|
|
921
|
+
ModelingChat: 'modeling_chat',
|
|
922
|
+
DataChat: 'data_chat',
|
|
923
|
+
AgentReport: 'agent_report',
|
|
924
|
+
AgentModelingFile: 'agent_modeling_file',
|
|
925
|
+
AgentHtmlReport: 'agent_html_report',
|
|
926
|
+
DraftAgentHtmlReport: 'draft_agent_html_report'
|
|
927
|
+
} as const;
|
|
928
|
+
|
|
929
|
+
export type DocumentTypeEnum = typeof DocumentTypeEnum[keyof typeof DocumentTypeEnum];
|
|
930
|
+
|
|
844
931
|
/**
|
|
845
|
-
* Represents a permission assignment for a user or group within a
|
|
932
|
+
* Represents a permission assignment for a user or group within a document
|
|
846
933
|
* @export
|
|
847
|
-
* @interface
|
|
934
|
+
* @interface DocumentPermission
|
|
848
935
|
*/
|
|
849
|
-
export interface
|
|
936
|
+
export interface DocumentPermission {
|
|
850
937
|
/**
|
|
851
938
|
* User or group identifier pattern (user must be valid email address, group is standard identifier)
|
|
852
939
|
* @type {string}
|
|
853
|
-
* @memberof
|
|
940
|
+
* @memberof DocumentPermission
|
|
854
941
|
*/
|
|
855
942
|
'userGroupId'?: string;
|
|
856
943
|
/**
|
|
857
944
|
* The role/permission level granted to the user or group
|
|
858
945
|
* @type {string}
|
|
859
|
-
* @memberof
|
|
946
|
+
* @memberof DocumentPermission
|
|
860
947
|
*/
|
|
861
|
-
'permission'?:
|
|
948
|
+
'permission'?: DocumentPermissionPermissionEnum;
|
|
949
|
+
/**
|
|
950
|
+
* The permission level inherited from parent workspace
|
|
951
|
+
* @type {string}
|
|
952
|
+
* @memberof DocumentPermission
|
|
953
|
+
*/
|
|
954
|
+
'inheritedPermission'?: DocumentPermissionInheritedPermissionEnum;
|
|
862
955
|
/**
|
|
863
956
|
* Optional message or note about the permission assignment
|
|
864
957
|
* @type {string}
|
|
865
|
-
* @memberof
|
|
958
|
+
* @memberof DocumentPermission
|
|
866
959
|
*/
|
|
867
960
|
'message'?: string;
|
|
868
961
|
/**
|
|
869
962
|
* ISO 8601 timestamp indicating when the permission was created
|
|
870
963
|
* @type {string}
|
|
871
|
-
* @memberof
|
|
964
|
+
* @memberof DocumentPermission
|
|
872
965
|
*/
|
|
873
966
|
'createdAt'?: string;
|
|
874
967
|
/**
|
|
875
968
|
* ISO 8601 timestamp indicating when the permission was last modified
|
|
876
969
|
* @type {string}
|
|
877
|
-
* @memberof
|
|
970
|
+
* @memberof DocumentPermission
|
|
878
971
|
*/
|
|
879
972
|
'updatedAt'?: string;
|
|
880
973
|
}
|
|
881
974
|
|
|
882
|
-
export const
|
|
883
|
-
|
|
884
|
-
Modeler: 'modeler',
|
|
975
|
+
export const DocumentPermissionPermissionEnum = {
|
|
976
|
+
Editor: 'editor',
|
|
885
977
|
Viewer: 'viewer'
|
|
886
978
|
} as const;
|
|
887
979
|
|
|
888
|
-
export type
|
|
980
|
+
export type DocumentPermissionPermissionEnum = typeof DocumentPermissionPermissionEnum[keyof typeof DocumentPermissionPermissionEnum];
|
|
981
|
+
export const DocumentPermissionInheritedPermissionEnum = {
|
|
982
|
+
Manager: 'manager',
|
|
983
|
+
Viewer: 'viewer'
|
|
984
|
+
} as const;
|
|
985
|
+
|
|
986
|
+
export type DocumentPermissionInheritedPermissionEnum = typeof DocumentPermissionInheritedPermissionEnum[keyof typeof DocumentPermissionInheritedPermissionEnum];
|
|
889
987
|
|
|
890
|
-
/**
|
|
891
|
-
* Represents project tutorial completion status and user preferences
|
|
892
|
-
* @export
|
|
893
|
-
* @interface ProjectTutorial
|
|
894
|
-
*/
|
|
895
|
-
export interface ProjectTutorial {
|
|
896
|
-
/**
|
|
897
|
-
* Whether the user has clicked the create model button during tutorial
|
|
898
|
-
* @type {boolean}
|
|
899
|
-
* @memberof ProjectTutorial
|
|
900
|
-
*/
|
|
901
|
-
'hasClickedCreateModel'?: boolean;
|
|
902
|
-
/**
|
|
903
|
-
* Whether to skip showing the model introduction tutorial
|
|
904
|
-
* @type {boolean}
|
|
905
|
-
* @memberof ProjectTutorial
|
|
906
|
-
*/
|
|
907
|
-
'doNotShowModelIntro'?: boolean;
|
|
908
|
-
/**
|
|
909
|
-
* Whether to skip showing the schema explorer tip
|
|
910
|
-
* @type {boolean}
|
|
911
|
-
* @memberof ProjectTutorial
|
|
912
|
-
*/
|
|
913
|
-
'doNotShowSchemaExplorerTip'?: boolean;
|
|
914
|
-
/**
|
|
915
|
-
* Whether to skip showing tutorial content in the home panel
|
|
916
|
-
* @type {boolean}
|
|
917
|
-
* @memberof ProjectTutorial
|
|
918
|
-
*/
|
|
919
|
-
'doNotShowTutorialInHomePanel'?: boolean;
|
|
920
|
-
}
|
|
921
988
|
/**
|
|
922
989
|
*
|
|
923
990
|
* @export
|
|
924
|
-
* @interface
|
|
991
|
+
* @interface GetGroupMembersResponse
|
|
925
992
|
*/
|
|
926
|
-
export interface
|
|
993
|
+
export interface GetGroupMembersResponse {
|
|
927
994
|
/**
|
|
928
|
-
* List of
|
|
995
|
+
* List of all group members (users and groups) with their status and CredibleResourceUri
|
|
929
996
|
* @type {Array<GroupMember>}
|
|
930
|
-
* @memberof
|
|
997
|
+
* @memberof GetGroupMembersResponse
|
|
931
998
|
*/
|
|
932
999
|
'members'?: Array<GroupMember>;
|
|
933
1000
|
}
|
|
934
1001
|
/**
|
|
935
|
-
*
|
|
1002
|
+
*
|
|
936
1003
|
* @export
|
|
937
|
-
* @interface
|
|
1004
|
+
* @interface GetOrganizationResponse
|
|
938
1005
|
*/
|
|
939
|
-
export interface
|
|
1006
|
+
export interface GetOrganizationResponse {
|
|
940
1007
|
/**
|
|
941
|
-
*
|
|
1008
|
+
* Standard identifier pattern for resource names
|
|
942
1009
|
* @type {string}
|
|
943
|
-
* @memberof
|
|
1010
|
+
* @memberof GetOrganizationResponse
|
|
944
1011
|
*/
|
|
945
|
-
'
|
|
1012
|
+
'name'?: string;
|
|
946
1013
|
/**
|
|
947
|
-
*
|
|
1014
|
+
* Human-readable name for the organization, displayed in user interfaces
|
|
948
1015
|
* @type {string}
|
|
949
|
-
* @memberof
|
|
1016
|
+
* @memberof GetOrganizationResponse
|
|
950
1017
|
*/
|
|
951
|
-
'
|
|
1018
|
+
'displayName'?: string;
|
|
1019
|
+
/**
|
|
1020
|
+
* ISO 8601 timestamp indicating when the organization was created
|
|
1021
|
+
* @type {string}
|
|
1022
|
+
* @memberof GetOrganizationResponse
|
|
1023
|
+
*/
|
|
1024
|
+
'createdAt'?: string;
|
|
1025
|
+
/**
|
|
1026
|
+
* ISO 8601 timestamp indicating when the organization was last modified
|
|
1027
|
+
* @type {string}
|
|
1028
|
+
* @memberof GetOrganizationResponse
|
|
1029
|
+
*/
|
|
1030
|
+
'updatedAt'?: string;
|
|
1031
|
+
/**
|
|
1032
|
+
* The current authenticated user\'s permission level within this organization
|
|
1033
|
+
* @type {string}
|
|
1034
|
+
* @memberof GetOrganizationResponse
|
|
1035
|
+
*/
|
|
1036
|
+
'userPermission'?: GetOrganizationResponseUserPermissionEnum;
|
|
952
1037
|
}
|
|
953
1038
|
|
|
954
|
-
export const
|
|
955
|
-
Admin: 'admin'
|
|
1039
|
+
export const GetOrganizationResponseUserPermissionEnum = {
|
|
1040
|
+
Admin: 'admin',
|
|
1041
|
+
Modeler: 'modeler',
|
|
1042
|
+
Member: 'member'
|
|
956
1043
|
} as const;
|
|
957
1044
|
|
|
958
|
-
export type
|
|
1045
|
+
export type GetOrganizationResponseUserPermissionEnum = typeof GetOrganizationResponseUserPermissionEnum[keyof typeof GetOrganizationResponseUserPermissionEnum];
|
|
959
1046
|
|
|
960
1047
|
/**
|
|
961
|
-
* Represents
|
|
1048
|
+
* Represents a user group for organizing users and managing group-based permissions
|
|
962
1049
|
* @export
|
|
963
|
-
* @interface
|
|
1050
|
+
* @interface Group
|
|
964
1051
|
*/
|
|
965
|
-
export interface
|
|
1052
|
+
export interface Group {
|
|
966
1053
|
/**
|
|
967
|
-
*
|
|
968
|
-
* @type {
|
|
969
|
-
* @memberof
|
|
1054
|
+
* Standard identifier pattern for resource names
|
|
1055
|
+
* @type {string}
|
|
1056
|
+
* @memberof Group
|
|
970
1057
|
*/
|
|
971
|
-
'
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
1058
|
+
'organizationName'?: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* Standard identifier pattern for resource names
|
|
1061
|
+
* @type {string}
|
|
1062
|
+
* @memberof Group
|
|
1063
|
+
*/
|
|
1064
|
+
'groupName'?: string;
|
|
1065
|
+
/**
|
|
1066
|
+
* Human-readable description of the group\'s purpose and membership
|
|
1067
|
+
* @type {string}
|
|
1068
|
+
* @memberof Group
|
|
1069
|
+
*/
|
|
1070
|
+
'description'?: string;
|
|
1071
|
+
/**
|
|
1072
|
+
* ISO 8601 timestamp indicating when the group was created
|
|
1073
|
+
* @type {string}
|
|
1074
|
+
* @memberof Group
|
|
1075
|
+
*/
|
|
1076
|
+
'createdAt'?: string;
|
|
1077
|
+
/**
|
|
1078
|
+
* ISO 8601 timestamp indicating when the group was last modified
|
|
1079
|
+
* @type {string}
|
|
1080
|
+
* @memberof Group
|
|
1081
|
+
*/
|
|
1082
|
+
'updatedAt'?: string;
|
|
1083
|
+
}
|
|
1084
|
+
/**
|
|
1085
|
+
* Represents an access token/key for a service account
|
|
975
1086
|
* @export
|
|
976
|
-
* @interface
|
|
1087
|
+
* @interface GroupAccessToken
|
|
977
1088
|
*/
|
|
978
|
-
export interface
|
|
1089
|
+
export interface GroupAccessToken {
|
|
979
1090
|
/**
|
|
980
|
-
*
|
|
1091
|
+
* Standard identifier pattern for resource names
|
|
981
1092
|
* @type {string}
|
|
982
|
-
* @memberof
|
|
1093
|
+
* @memberof GroupAccessToken
|
|
983
1094
|
*/
|
|
984
|
-
'
|
|
1095
|
+
'name'?: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* The JWT token (only returned when creating a new token)
|
|
1098
|
+
* @type {string}
|
|
1099
|
+
* @memberof GroupAccessToken
|
|
1100
|
+
*/
|
|
1101
|
+
'jwtToken'?: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* Standard identifier pattern for resource names
|
|
1104
|
+
* @type {string}
|
|
1105
|
+
* @memberof GroupAccessToken
|
|
1106
|
+
*/
|
|
1107
|
+
'groupName'?: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* ISO 8601 timestamp indicating when the token was created
|
|
1110
|
+
* @type {string}
|
|
1111
|
+
* @memberof GroupAccessToken
|
|
1112
|
+
*/
|
|
1113
|
+
'createdAt'?: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* ISO 8601 timestamp indicating when the token expires
|
|
1116
|
+
* @type {string}
|
|
1117
|
+
* @memberof GroupAccessToken
|
|
1118
|
+
*/
|
|
1119
|
+
'expiresAt'?: string;
|
|
1120
|
+
/**
|
|
1121
|
+
* Whether the token has expired
|
|
1122
|
+
* @type {boolean}
|
|
1123
|
+
* @memberof GroupAccessToken
|
|
1124
|
+
*/
|
|
1125
|
+
'expired'?: boolean;
|
|
1126
|
+
}
|
|
1127
|
+
/**
|
|
1128
|
+
* Represents a member of a group with their role and status
|
|
1129
|
+
* @export
|
|
1130
|
+
* @interface GroupMember
|
|
1131
|
+
*/
|
|
1132
|
+
export interface GroupMember {
|
|
1133
|
+
/**
|
|
1134
|
+
* User or group identifier pattern (user must be valid email address, group is standard identifier)
|
|
1135
|
+
* @type {string}
|
|
1136
|
+
* @memberof GroupMember
|
|
1137
|
+
*/
|
|
1138
|
+
'userGroupId'?: string;
|
|
1139
|
+
/**
|
|
1140
|
+
* The membership role within the group, determining permissions and capabilities
|
|
1141
|
+
* @type {string}
|
|
1142
|
+
* @memberof GroupMember
|
|
1143
|
+
*/
|
|
1144
|
+
'status'?: GroupMemberStatusEnum;
|
|
985
1145
|
}
|
|
986
1146
|
|
|
987
|
-
export const
|
|
1147
|
+
export const GroupMemberStatusEnum = {
|
|
988
1148
|
Admin: 'admin',
|
|
989
1149
|
Member: 'member'
|
|
990
1150
|
} as const;
|
|
991
1151
|
|
|
992
|
-
export type
|
|
1152
|
+
export type GroupMemberStatusEnum = typeof GroupMemberStatusEnum[keyof typeof GroupMemberStatusEnum];
|
|
993
1153
|
|
|
994
1154
|
/**
|
|
995
|
-
*
|
|
1155
|
+
* Status of the indexing process. Possible values: unknown (initial state, indexing not yet started), indexing (currently being processed), indexed (successfully indexed and ready for use), failed (indexing process encountered an error).
|
|
996
1156
|
* @export
|
|
997
|
-
* @
|
|
1157
|
+
* @enum {string}
|
|
998
1158
|
*/
|
|
999
|
-
export interface UpdateWorkspaceRequest {
|
|
1000
|
-
[key: string]: any;
|
|
1001
1159
|
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
'
|
|
1008
|
-
}
|
|
1160
|
+
export const IndexStatus = {
|
|
1161
|
+
Unknown: 'unknown',
|
|
1162
|
+
Indexing: 'indexing',
|
|
1163
|
+
Indexed: 'indexed',
|
|
1164
|
+
Failed: 'failed',
|
|
1165
|
+
Retry: 'retry'
|
|
1166
|
+
} as const;
|
|
1167
|
+
|
|
1168
|
+
export type IndexStatus = typeof IndexStatus[keyof typeof IndexStatus];
|
|
1169
|
+
|
|
1170
|
+
|
|
1009
1171
|
/**
|
|
1010
|
-
*
|
|
1172
|
+
* Standard error response format used across all API endpoints
|
|
1011
1173
|
* @export
|
|
1012
|
-
* @interface
|
|
1174
|
+
* @interface ModelError
|
|
1013
1175
|
*/
|
|
1014
|
-
export interface
|
|
1176
|
+
export interface ModelError {
|
|
1015
1177
|
/**
|
|
1016
|
-
*
|
|
1178
|
+
* Machine-readable error code that identifies the specific error condition. Common codes include: - `VALIDATION_ERROR`: Request validation failed - `AUTHENTICATION_REQUIRED`: Valid authentication is required - `INSUFFICIENT_PERMISSIONS`: User lacks required permissions - `RESOURCE_NOT_FOUND`: Requested resource does not exist - `CONFLICT`: Resource state conflict (e.g., duplicate name) - `RATE_LIMIT_EXCEEDED`: API rate limit exceeded - `INTERNAL_ERROR`: Unexpected server error
|
|
1017
1179
|
* @type {string}
|
|
1018
|
-
* @memberof
|
|
1180
|
+
* @memberof ModelError
|
|
1019
1181
|
*/
|
|
1020
|
-
'
|
|
1182
|
+
'code'?: string;
|
|
1021
1183
|
/**
|
|
1022
|
-
*
|
|
1184
|
+
* Human-readable error message providing details about what went wrong
|
|
1023
1185
|
* @type {string}
|
|
1024
|
-
* @memberof
|
|
1186
|
+
* @memberof ModelError
|
|
1025
1187
|
*/
|
|
1026
|
-
'
|
|
1188
|
+
'message'?: string;
|
|
1189
|
+
}
|
|
1190
|
+
/**
|
|
1191
|
+
* Represents an organization entity that serves as the top-level container for all resources
|
|
1192
|
+
* @export
|
|
1193
|
+
* @interface Organization
|
|
1194
|
+
*/
|
|
1195
|
+
export interface Organization {
|
|
1027
1196
|
/**
|
|
1028
|
-
*
|
|
1197
|
+
* Standard identifier pattern for resource names
|
|
1029
1198
|
* @type {string}
|
|
1030
|
-
* @memberof
|
|
1199
|
+
* @memberof Organization
|
|
1031
1200
|
*/
|
|
1032
|
-
'
|
|
1201
|
+
'name'?: string;
|
|
1033
1202
|
/**
|
|
1034
|
-
*
|
|
1203
|
+
* Human-readable name for the organization, displayed in user interfaces
|
|
1035
1204
|
* @type {string}
|
|
1036
|
-
* @memberof
|
|
1205
|
+
* @memberof Organization
|
|
1037
1206
|
*/
|
|
1038
|
-
'
|
|
1207
|
+
'displayName'?: string;
|
|
1039
1208
|
/**
|
|
1040
|
-
*
|
|
1209
|
+
* ISO 8601 timestamp indicating when the organization was created
|
|
1041
1210
|
* @type {string}
|
|
1042
|
-
* @memberof
|
|
1211
|
+
* @memberof Organization
|
|
1043
1212
|
*/
|
|
1044
|
-
'
|
|
1213
|
+
'createdAt'?: string;
|
|
1045
1214
|
/**
|
|
1046
|
-
*
|
|
1215
|
+
* ISO 8601 timestamp indicating when the organization was last modified
|
|
1047
1216
|
* @type {string}
|
|
1048
|
-
* @memberof
|
|
1049
|
-
*/
|
|
1050
|
-
'businessRole'?: string;
|
|
1051
|
-
/**
|
|
1052
|
-
*
|
|
1053
|
-
* @type {TutorialStatus}
|
|
1054
|
-
* @memberof User
|
|
1217
|
+
* @memberof Organization
|
|
1055
1218
|
*/
|
|
1056
|
-
'
|
|
1219
|
+
'updatedAt'?: string;
|
|
1057
1220
|
}
|
|
1058
1221
|
/**
|
|
1059
|
-
* Represents a
|
|
1222
|
+
* Represents a permission assignment for a user or group within an organization
|
|
1060
1223
|
* @export
|
|
1061
|
-
* @interface
|
|
1224
|
+
* @interface OrganizationPermission
|
|
1062
1225
|
*/
|
|
1063
|
-
export interface
|
|
1226
|
+
export interface OrganizationPermission {
|
|
1064
1227
|
/**
|
|
1065
|
-
*
|
|
1228
|
+
* User or group identifier pattern (user must be valid email address, group is standard identifier)
|
|
1066
1229
|
* @type {string}
|
|
1067
|
-
* @memberof
|
|
1230
|
+
* @memberof OrganizationPermission
|
|
1068
1231
|
*/
|
|
1069
|
-
'
|
|
1232
|
+
'userGroupId'?: string;
|
|
1070
1233
|
/**
|
|
1071
|
-
*
|
|
1234
|
+
* The role/permission level granted to the user or group
|
|
1072
1235
|
* @type {string}
|
|
1073
|
-
* @memberof
|
|
1236
|
+
* @memberof OrganizationPermission
|
|
1074
1237
|
*/
|
|
1075
|
-
'
|
|
1238
|
+
'permission'?: OrganizationPermissionPermissionEnum;
|
|
1076
1239
|
/**
|
|
1077
|
-
*
|
|
1240
|
+
* Optional message or note about the permission assignment
|
|
1078
1241
|
* @type {string}
|
|
1079
|
-
* @memberof
|
|
1242
|
+
* @memberof OrganizationPermission
|
|
1080
1243
|
*/
|
|
1081
|
-
'
|
|
1244
|
+
'message'?: string;
|
|
1082
1245
|
/**
|
|
1083
|
-
*
|
|
1246
|
+
* ISO 8601 timestamp indicating when the permission was created
|
|
1084
1247
|
* @type {string}
|
|
1085
|
-
* @memberof
|
|
1248
|
+
* @memberof OrganizationPermission
|
|
1086
1249
|
*/
|
|
1087
|
-
'
|
|
1250
|
+
'createdAt'?: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* ISO 8601 timestamp indicating when the permission was last modified
|
|
1253
|
+
* @type {string}
|
|
1254
|
+
* @memberof OrganizationPermission
|
|
1255
|
+
*/
|
|
1256
|
+
'updatedAt'?: string;
|
|
1088
1257
|
}
|
|
1089
1258
|
|
|
1090
|
-
export const
|
|
1091
|
-
|
|
1092
|
-
|
|
1259
|
+
export const OrganizationPermissionPermissionEnum = {
|
|
1260
|
+
Admin: 'admin',
|
|
1261
|
+
Modeler: 'modeler',
|
|
1262
|
+
Member: 'member'
|
|
1093
1263
|
} as const;
|
|
1094
1264
|
|
|
1095
|
-
export type
|
|
1265
|
+
export type OrganizationPermissionPermissionEnum = typeof OrganizationPermissionPermissionEnum[keyof typeof OrganizationPermissionPermissionEnum];
|
|
1096
1266
|
|
|
1097
1267
|
/**
|
|
1098
|
-
* Represents a
|
|
1268
|
+
* Represents a Malloy data model package containing models, queries, and related resources
|
|
1099
1269
|
* @export
|
|
1100
|
-
* @interface
|
|
1270
|
+
* @interface Package
|
|
1101
1271
|
*/
|
|
1102
|
-
export interface
|
|
1272
|
+
export interface Package {
|
|
1103
1273
|
/**
|
|
1104
1274
|
* Standard identifier pattern for resource names
|
|
1105
1275
|
* @type {string}
|
|
1106
|
-
* @memberof
|
|
1276
|
+
* @memberof Package
|
|
1107
1277
|
*/
|
|
1108
1278
|
'name'?: string;
|
|
1109
1279
|
/**
|
|
1110
|
-
*
|
|
1280
|
+
* Semantic version number pattern (e.g., 1.0.0)
|
|
1111
1281
|
* @type {string}
|
|
1112
|
-
* @memberof
|
|
1282
|
+
* @memberof Package
|
|
1113
1283
|
*/
|
|
1114
|
-
'
|
|
1284
|
+
'latestVersion'?: string;
|
|
1115
1285
|
/**
|
|
1116
|
-
* Human-readable description of the
|
|
1286
|
+
* Human-readable description of the package\'s purpose and contents
|
|
1117
1287
|
* @type {string}
|
|
1118
|
-
* @memberof
|
|
1288
|
+
* @memberof Package
|
|
1119
1289
|
*/
|
|
1120
|
-
'
|
|
1290
|
+
'description'?: string;
|
|
1121
1291
|
/**
|
|
1122
|
-
* ISO 8601 timestamp indicating when the
|
|
1292
|
+
* ISO 8601 timestamp indicating when the package was first created
|
|
1123
1293
|
* @type {string}
|
|
1124
|
-
* @memberof
|
|
1294
|
+
* @memberof Package
|
|
1125
1295
|
*/
|
|
1126
1296
|
'createdAt'?: string;
|
|
1127
1297
|
/**
|
|
1128
|
-
* ISO 8601 timestamp indicating when the
|
|
1298
|
+
* ISO 8601 timestamp indicating when the package was last modified
|
|
1129
1299
|
* @type {string}
|
|
1130
|
-
* @memberof
|
|
1300
|
+
* @memberof Package
|
|
1131
1301
|
*/
|
|
1132
1302
|
'updatedAt'?: string;
|
|
1133
1303
|
/**
|
|
1134
|
-
*
|
|
1135
|
-
* @type {
|
|
1136
|
-
* @memberof
|
|
1304
|
+
* Number of replicas for high availability and performance. When sent on create, this value is stored as-is (within min/max). When omitted on create, Credible manages it for you. When omitted on update, the existing value is left unchanged.
|
|
1305
|
+
* @type {number}
|
|
1306
|
+
* @memberof Package
|
|
1137
1307
|
*/
|
|
1138
|
-
'
|
|
1308
|
+
'replicationCount'?: number;
|
|
1309
|
+
/**
|
|
1310
|
+
* Resource identifier pattern supporting slashes, dots, dashes, and colons
|
|
1311
|
+
* @type {string}
|
|
1312
|
+
* @memberof Package
|
|
1313
|
+
*/
|
|
1314
|
+
'resourceIdentifier'?: string;
|
|
1315
|
+
/**
|
|
1316
|
+
*
|
|
1317
|
+
* @type {IndexStatus}
|
|
1318
|
+
* @memberof Package
|
|
1319
|
+
*/
|
|
1320
|
+
'indexStatus'?: IndexStatus;
|
|
1139
1321
|
}
|
|
1322
|
+
|
|
1323
|
+
|
|
1140
1324
|
/**
|
|
1141
|
-
* Represents a permission assignment for a user or
|
|
1325
|
+
* Represents a permission assignment for a user, group, or workspace within a package
|
|
1142
1326
|
* @export
|
|
1143
|
-
* @interface
|
|
1327
|
+
* @interface PackagePermission
|
|
1144
1328
|
*/
|
|
1145
|
-
export interface
|
|
1329
|
+
export interface PackagePermission {
|
|
1330
|
+
/**
|
|
1331
|
+
* User or group identifier pattern (user must be valid email address, group is standard identifier)
|
|
1332
|
+
* @type {string}
|
|
1333
|
+
* @memberof PackagePermission
|
|
1334
|
+
*/
|
|
1335
|
+
'userGroupId'?: string;
|
|
1336
|
+
/**
|
|
1337
|
+
* Standard identifier pattern for resource names
|
|
1338
|
+
* @type {string}
|
|
1339
|
+
* @memberof PackagePermission
|
|
1340
|
+
*/
|
|
1341
|
+
'workspace'?: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* The role/permission level granted to the user, group, or workspace
|
|
1344
|
+
* @type {string}
|
|
1345
|
+
* @memberof PackagePermission
|
|
1346
|
+
*/
|
|
1347
|
+
'permission'?: PackagePermissionPermissionEnum;
|
|
1348
|
+
/**
|
|
1349
|
+
* The permission level inherited from parent project or organization
|
|
1350
|
+
* @type {string}
|
|
1351
|
+
* @memberof PackagePermission
|
|
1352
|
+
*/
|
|
1353
|
+
'inheritedPermission'?: PackagePermissionInheritedPermissionEnum;
|
|
1354
|
+
/**
|
|
1355
|
+
* Optional message or note about the permission assignment
|
|
1356
|
+
* @type {string}
|
|
1357
|
+
* @memberof PackagePermission
|
|
1358
|
+
*/
|
|
1359
|
+
'message'?: string;
|
|
1360
|
+
/**
|
|
1361
|
+
* ISO 8601 timestamp indicating when the permission was created
|
|
1362
|
+
* @type {string}
|
|
1363
|
+
* @memberof PackagePermission
|
|
1364
|
+
*/
|
|
1365
|
+
'createdAt'?: string;
|
|
1366
|
+
/**
|
|
1367
|
+
* ISO 8601 timestamp indicating when the permission was last modified
|
|
1368
|
+
* @type {string}
|
|
1369
|
+
* @memberof PackagePermission
|
|
1370
|
+
*/
|
|
1371
|
+
'updatedAt'?: string;
|
|
1372
|
+
}
|
|
1373
|
+
|
|
1374
|
+
export const PackagePermissionPermissionEnum = {
|
|
1375
|
+
Admin: 'admin',
|
|
1376
|
+
Modeler: 'modeler',
|
|
1377
|
+
Viewer: 'viewer'
|
|
1378
|
+
} as const;
|
|
1379
|
+
|
|
1380
|
+
export type PackagePermissionPermissionEnum = typeof PackagePermissionPermissionEnum[keyof typeof PackagePermissionPermissionEnum];
|
|
1381
|
+
export const PackagePermissionInheritedPermissionEnum = {
|
|
1382
|
+
Admin: 'admin',
|
|
1383
|
+
Modeler: 'modeler',
|
|
1384
|
+
Viewer: 'viewer'
|
|
1385
|
+
} as const;
|
|
1386
|
+
|
|
1387
|
+
export type PackagePermissionInheritedPermissionEnum = typeof PackagePermissionInheritedPermissionEnum[keyof typeof PackagePermissionInheritedPermissionEnum];
|
|
1388
|
+
|
|
1389
|
+
/**
|
|
1390
|
+
* Represents a project entity that serves as a container for packages and related resources
|
|
1391
|
+
* @export
|
|
1392
|
+
* @interface Project
|
|
1393
|
+
*/
|
|
1394
|
+
export interface Project {
|
|
1395
|
+
/**
|
|
1396
|
+
* Standard identifier pattern for resource names
|
|
1397
|
+
* @type {string}
|
|
1398
|
+
* @memberof Project
|
|
1399
|
+
*/
|
|
1400
|
+
'name'?: string;
|
|
1401
|
+
/**
|
|
1402
|
+
* Markdown-formatted documentation describing the project\'s purpose and contents
|
|
1403
|
+
* @type {string}
|
|
1404
|
+
* @memberof Project
|
|
1405
|
+
*/
|
|
1406
|
+
'readme'?: string;
|
|
1407
|
+
/**
|
|
1408
|
+
* ISO 8601 timestamp indicating when the project was created
|
|
1409
|
+
* @type {string}
|
|
1410
|
+
* @memberof Project
|
|
1411
|
+
*/
|
|
1412
|
+
'createdAt'?: string;
|
|
1413
|
+
/**
|
|
1414
|
+
* ISO 8601 timestamp indicating when the project was last modified
|
|
1415
|
+
* @type {string}
|
|
1416
|
+
* @memberof Project
|
|
1417
|
+
*/
|
|
1418
|
+
'updatedAt'?: string;
|
|
1419
|
+
/**
|
|
1420
|
+
* Number of replicas for high availability and performance. When sent on create, this value is stored as-is (within min/max). When omitted on create, Credible manages it for you. When omitted on update, the existing value is left unchanged.
|
|
1421
|
+
* @type {number}
|
|
1422
|
+
* @memberof Project
|
|
1423
|
+
*/
|
|
1424
|
+
'replicationCount'?: number;
|
|
1425
|
+
}
|
|
1426
|
+
/**
|
|
1427
|
+
* Represents a permission assignment for a user or group within a project
|
|
1428
|
+
* @export
|
|
1429
|
+
* @interface ProjectPermission
|
|
1430
|
+
*/
|
|
1431
|
+
export interface ProjectPermission {
|
|
1432
|
+
/**
|
|
1433
|
+
* User or group identifier pattern (user must be valid email address, group is standard identifier)
|
|
1434
|
+
* @type {string}
|
|
1435
|
+
* @memberof ProjectPermission
|
|
1436
|
+
*/
|
|
1437
|
+
'userGroupId'?: string;
|
|
1438
|
+
/**
|
|
1439
|
+
* The role/permission level granted to the user or group
|
|
1440
|
+
* @type {string}
|
|
1441
|
+
* @memberof ProjectPermission
|
|
1442
|
+
*/
|
|
1443
|
+
'permission'?: ProjectPermissionPermissionEnum;
|
|
1444
|
+
/**
|
|
1445
|
+
* Optional message or note about the permission assignment
|
|
1446
|
+
* @type {string}
|
|
1447
|
+
* @memberof ProjectPermission
|
|
1448
|
+
*/
|
|
1449
|
+
'message'?: string;
|
|
1450
|
+
/**
|
|
1451
|
+
* ISO 8601 timestamp indicating when the permission was created
|
|
1452
|
+
* @type {string}
|
|
1453
|
+
* @memberof ProjectPermission
|
|
1454
|
+
*/
|
|
1455
|
+
'createdAt'?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* ISO 8601 timestamp indicating when the permission was last modified
|
|
1458
|
+
* @type {string}
|
|
1459
|
+
* @memberof ProjectPermission
|
|
1460
|
+
*/
|
|
1461
|
+
'updatedAt'?: string;
|
|
1462
|
+
}
|
|
1463
|
+
|
|
1464
|
+
export const ProjectPermissionPermissionEnum = {
|
|
1465
|
+
Admin: 'admin',
|
|
1466
|
+
Modeler: 'modeler',
|
|
1467
|
+
Viewer: 'viewer'
|
|
1468
|
+
} as const;
|
|
1469
|
+
|
|
1470
|
+
export type ProjectPermissionPermissionEnum = typeof ProjectPermissionPermissionEnum[keyof typeof ProjectPermissionPermissionEnum];
|
|
1471
|
+
|
|
1472
|
+
/**
|
|
1473
|
+
* Represents project tutorial completion status and user preferences
|
|
1474
|
+
* @export
|
|
1475
|
+
* @interface ProjectTutorial
|
|
1476
|
+
*/
|
|
1477
|
+
export interface ProjectTutorial {
|
|
1478
|
+
/**
|
|
1479
|
+
* Whether the user has clicked the create model button during tutorial
|
|
1480
|
+
* @type {boolean}
|
|
1481
|
+
* @memberof ProjectTutorial
|
|
1482
|
+
*/
|
|
1483
|
+
'hasClickedCreateModel'?: boolean;
|
|
1484
|
+
/**
|
|
1485
|
+
* Whether to skip showing the model introduction tutorial
|
|
1486
|
+
* @type {boolean}
|
|
1487
|
+
* @memberof ProjectTutorial
|
|
1488
|
+
*/
|
|
1489
|
+
'doNotShowModelIntro'?: boolean;
|
|
1490
|
+
/**
|
|
1491
|
+
* Whether to skip showing the schema explorer tip
|
|
1492
|
+
* @type {boolean}
|
|
1493
|
+
* @memberof ProjectTutorial
|
|
1494
|
+
*/
|
|
1495
|
+
'doNotShowSchemaExplorerTip'?: boolean;
|
|
1496
|
+
/**
|
|
1497
|
+
* Whether to skip showing tutorial content in the home panel
|
|
1498
|
+
* @type {boolean}
|
|
1499
|
+
* @memberof ProjectTutorial
|
|
1500
|
+
*/
|
|
1501
|
+
'doNotShowTutorialInHomePanel'?: boolean;
|
|
1502
|
+
}
|
|
1503
|
+
/**
|
|
1504
|
+
*
|
|
1505
|
+
* @export
|
|
1506
|
+
* @interface RemoveGroupMembersRequest
|
|
1507
|
+
*/
|
|
1508
|
+
export interface RemoveGroupMembersRequest {
|
|
1509
|
+
/**
|
|
1510
|
+
* List of members to remove (only member CredibleResourceUri is required)
|
|
1511
|
+
* @type {Array<GroupMember>}
|
|
1512
|
+
* @memberof RemoveGroupMembersRequest
|
|
1513
|
+
*/
|
|
1514
|
+
'members'?: Array<GroupMember>;
|
|
1515
|
+
}
|
|
1516
|
+
/**
|
|
1517
|
+
* Represents a system-level permission assignment for administrative functions
|
|
1518
|
+
* @export
|
|
1519
|
+
* @interface SystemPermission
|
|
1520
|
+
*/
|
|
1521
|
+
export interface SystemPermission {
|
|
1522
|
+
/**
|
|
1523
|
+
* The email address of the user to grant system permissions to
|
|
1524
|
+
* @type {string}
|
|
1525
|
+
* @memberof SystemPermission
|
|
1526
|
+
*/
|
|
1527
|
+
'userEmail'?: string;
|
|
1528
|
+
/**
|
|
1529
|
+
* The system-level permission role to grant
|
|
1530
|
+
* @type {string}
|
|
1531
|
+
* @memberof SystemPermission
|
|
1532
|
+
*/
|
|
1533
|
+
'permission'?: SystemPermissionPermissionEnum;
|
|
1534
|
+
}
|
|
1535
|
+
|
|
1536
|
+
export const SystemPermissionPermissionEnum = {
|
|
1537
|
+
Admin: 'admin'
|
|
1538
|
+
} as const;
|
|
1539
|
+
|
|
1540
|
+
export type SystemPermissionPermissionEnum = typeof SystemPermissionPermissionEnum[keyof typeof SystemPermissionPermissionEnum];
|
|
1541
|
+
|
|
1542
|
+
/**
|
|
1543
|
+
* Represents the tutorial completion status and user preferences for onboarding
|
|
1544
|
+
* @export
|
|
1545
|
+
* @interface TutorialStatus
|
|
1546
|
+
*/
|
|
1547
|
+
export interface TutorialStatus {
|
|
1548
|
+
/**
|
|
1549
|
+
*
|
|
1550
|
+
* @type {ProjectTutorial}
|
|
1551
|
+
* @memberof TutorialStatus
|
|
1552
|
+
*/
|
|
1553
|
+
'projectTutorial'?: ProjectTutorial;
|
|
1554
|
+
}
|
|
1555
|
+
/**
|
|
1556
|
+
*
|
|
1557
|
+
* @export
|
|
1558
|
+
* @interface UpdateGroupMemberStatusRequest
|
|
1559
|
+
*/
|
|
1560
|
+
export interface UpdateGroupMemberStatusRequest {
|
|
1561
|
+
/**
|
|
1562
|
+
* The new status for the member
|
|
1563
|
+
* @type {string}
|
|
1564
|
+
* @memberof UpdateGroupMemberStatusRequest
|
|
1565
|
+
*/
|
|
1566
|
+
'status'?: UpdateGroupMemberStatusRequestStatusEnum;
|
|
1567
|
+
}
|
|
1568
|
+
|
|
1569
|
+
export const UpdateGroupMemberStatusRequestStatusEnum = {
|
|
1570
|
+
Admin: 'admin',
|
|
1571
|
+
Member: 'member'
|
|
1572
|
+
} as const;
|
|
1573
|
+
|
|
1574
|
+
export type UpdateGroupMemberStatusRequestStatusEnum = typeof UpdateGroupMemberStatusRequestStatusEnum[keyof typeof UpdateGroupMemberStatusRequestStatusEnum];
|
|
1575
|
+
|
|
1576
|
+
/**
|
|
1577
|
+
* Workspace update data
|
|
1578
|
+
* @export
|
|
1579
|
+
* @interface UpdateWorkspaceRequest
|
|
1580
|
+
*/
|
|
1581
|
+
export interface UpdateWorkspaceRequest {
|
|
1582
|
+
[key: string]: any;
|
|
1583
|
+
|
|
1584
|
+
/**
|
|
1585
|
+
* Updated description of the workspace
|
|
1586
|
+
* @type {string}
|
|
1587
|
+
* @memberof UpdateWorkspaceRequest
|
|
1588
|
+
*/
|
|
1589
|
+
'description'?: string;
|
|
1590
|
+
}
|
|
1591
|
+
/**
|
|
1592
|
+
* Represents a user account with profile information and tutorial status
|
|
1593
|
+
* @export
|
|
1594
|
+
* @interface User
|
|
1595
|
+
*/
|
|
1596
|
+
export interface User {
|
|
1597
|
+
/**
|
|
1598
|
+
* Standard identifier pattern for resource names
|
|
1599
|
+
* @type {string}
|
|
1600
|
+
* @memberof User
|
|
1601
|
+
*/
|
|
1602
|
+
'userName'?: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* User\'s password (only included in create/update requests, never in responses)
|
|
1605
|
+
* @type {string}
|
|
1606
|
+
* @memberof User
|
|
1607
|
+
*/
|
|
1608
|
+
'password'?: string;
|
|
1609
|
+
/**
|
|
1610
|
+
* User\'s email address, used for authentication and notifications
|
|
1611
|
+
* @type {string}
|
|
1612
|
+
* @memberof User
|
|
1613
|
+
*/
|
|
1614
|
+
'email'?: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* User\'s first name
|
|
1617
|
+
* @type {string}
|
|
1618
|
+
* @memberof User
|
|
1619
|
+
*/
|
|
1620
|
+
'firstName'?: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* User\'s last name
|
|
1623
|
+
* @type {string}
|
|
1624
|
+
* @memberof User
|
|
1625
|
+
*/
|
|
1626
|
+
'lastName'?: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* User\'s business role or job title
|
|
1629
|
+
* @type {string}
|
|
1630
|
+
* @memberof User
|
|
1631
|
+
*/
|
|
1632
|
+
'businessRole'?: string;
|
|
1633
|
+
/**
|
|
1634
|
+
*
|
|
1635
|
+
* @type {TutorialStatus}
|
|
1636
|
+
* @memberof User
|
|
1637
|
+
*/
|
|
1638
|
+
'tutorialStatus'?: TutorialStatus;
|
|
1639
|
+
}
|
|
1640
|
+
/**
|
|
1641
|
+
* Represents a specific version of a package with metadata and lifecycle information
|
|
1642
|
+
* @export
|
|
1643
|
+
* @interface Version
|
|
1644
|
+
*/
|
|
1645
|
+
export interface Version {
|
|
1646
|
+
/**
|
|
1647
|
+
* Semantic version number pattern (e.g., 1.0.0)
|
|
1648
|
+
* @type {string}
|
|
1649
|
+
* @memberof Version
|
|
1650
|
+
*/
|
|
1651
|
+
'id'?: string;
|
|
1652
|
+
/**
|
|
1653
|
+
* ISO 8601 timestamp indicating when this version was created
|
|
1654
|
+
* @type {string}
|
|
1655
|
+
* @memberof Version
|
|
1656
|
+
*/
|
|
1657
|
+
'createdAt'?: string;
|
|
1658
|
+
/**
|
|
1659
|
+
* ISO 8601 timestamp indicating when this version was last modified
|
|
1660
|
+
* @type {string}
|
|
1661
|
+
* @memberof Version
|
|
1662
|
+
*/
|
|
1663
|
+
'updatedAt'?: string;
|
|
1664
|
+
/**
|
|
1665
|
+
* Current status of the package version, controlling its availability
|
|
1666
|
+
* @type {string}
|
|
1667
|
+
* @memberof Version
|
|
1668
|
+
*/
|
|
1669
|
+
'archiveStatus'?: VersionArchiveStatusEnum;
|
|
1670
|
+
/**
|
|
1671
|
+
*
|
|
1672
|
+
* @type {IndexStatus}
|
|
1673
|
+
* @memberof Version
|
|
1674
|
+
*/
|
|
1675
|
+
'indexStatus'?: IndexStatus;
|
|
1676
|
+
/**
|
|
1677
|
+
*
|
|
1678
|
+
* @type {VersionIndexingMetadata}
|
|
1679
|
+
* @memberof Version
|
|
1680
|
+
*/
|
|
1681
|
+
'metadata'?: VersionIndexingMetadata;
|
|
1682
|
+
}
|
|
1683
|
+
|
|
1684
|
+
export const VersionArchiveStatusEnum = {
|
|
1685
|
+
Archive: 'archive',
|
|
1686
|
+
Unarchive: 'unarchive',
|
|
1687
|
+
ErrorState: 'error_state'
|
|
1688
|
+
} as const;
|
|
1689
|
+
|
|
1690
|
+
export type VersionArchiveStatusEnum = typeof VersionArchiveStatusEnum[keyof typeof VersionArchiveStatusEnum];
|
|
1691
|
+
|
|
1692
|
+
/**
|
|
1693
|
+
* Metadata from indexing failures, attached to a package version
|
|
1694
|
+
* @export
|
|
1695
|
+
* @interface VersionIndexingMetadata
|
|
1696
|
+
*/
|
|
1697
|
+
export interface VersionIndexingMetadata {
|
|
1698
|
+
/**
|
|
1699
|
+
* User-friendly error message explaining why indexing failed
|
|
1700
|
+
* @type {string}
|
|
1701
|
+
* @memberof VersionIndexingMetadata
|
|
1702
|
+
*/
|
|
1703
|
+
'displayErrorMessage'?: string;
|
|
1704
|
+
/**
|
|
1705
|
+
* Detailed error message
|
|
1706
|
+
* @type {string}
|
|
1707
|
+
* @memberof VersionIndexingMetadata
|
|
1708
|
+
*/
|
|
1709
|
+
'rawErrorMessage'?: string;
|
|
1710
|
+
}
|
|
1711
|
+
/**
|
|
1712
|
+
* Represents a collaborative workspace for team-based data modeling and analysis
|
|
1713
|
+
* @export
|
|
1714
|
+
* @interface Workspace
|
|
1715
|
+
*/
|
|
1716
|
+
export interface Workspace {
|
|
1717
|
+
/**
|
|
1718
|
+
* Workspace name pattern - allows any characters, 1-63 chars (matches controlplane validation)
|
|
1719
|
+
* @type {string}
|
|
1720
|
+
* @memberof Workspace
|
|
1721
|
+
*/
|
|
1722
|
+
'name'?: string;
|
|
1723
|
+
/**
|
|
1724
|
+
*
|
|
1725
|
+
* @type {string}
|
|
1726
|
+
* @memberof Workspace
|
|
1727
|
+
*/
|
|
1728
|
+
'description'?: string;
|
|
1729
|
+
/**
|
|
1730
|
+
* Human-readable description of the workspace\'s purpose and scope
|
|
1731
|
+
* @type {string}
|
|
1732
|
+
* @memberof Workspace
|
|
1733
|
+
*/
|
|
1734
|
+
'groupName'?: string;
|
|
1735
|
+
/**
|
|
1736
|
+
* ISO 8601 timestamp indicating when the workspace was created
|
|
1737
|
+
* @type {string}
|
|
1738
|
+
* @memberof Workspace
|
|
1739
|
+
*/
|
|
1740
|
+
'createdAt'?: string;
|
|
1741
|
+
/**
|
|
1742
|
+
* ISO 8601 timestamp indicating when the workspace was last modified
|
|
1743
|
+
* @type {string}
|
|
1744
|
+
* @memberof Workspace
|
|
1745
|
+
*/
|
|
1746
|
+
'updatedAt'?: string;
|
|
1747
|
+
/**
|
|
1748
|
+
* Array of package resource identifiers that are accessible in this workspace
|
|
1749
|
+
* @type {Array<string>}
|
|
1750
|
+
* @memberof Workspace
|
|
1751
|
+
*/
|
|
1752
|
+
'packages'?: Array<string>;
|
|
1753
|
+
/**
|
|
1754
|
+
* The type of workspace. PersonalInfra for personal workspaces, Group for shared workspaces.
|
|
1755
|
+
* @type {string}
|
|
1756
|
+
* @memberof Workspace
|
|
1757
|
+
*/
|
|
1758
|
+
'workspaceType'?: WorkspaceWorkspaceTypeEnum;
|
|
1759
|
+
}
|
|
1760
|
+
|
|
1761
|
+
export const WorkspaceWorkspaceTypeEnum = {
|
|
1762
|
+
PersonalInfra: 'PersonalInfra',
|
|
1763
|
+
Group: 'Group'
|
|
1764
|
+
} as const;
|
|
1765
|
+
|
|
1766
|
+
export type WorkspaceWorkspaceTypeEnum = typeof WorkspaceWorkspaceTypeEnum[keyof typeof WorkspaceWorkspaceTypeEnum];
|
|
1767
|
+
|
|
1768
|
+
/**
|
|
1769
|
+
* Represents a permission assignment for a user or group within a workspace
|
|
1770
|
+
* @export
|
|
1771
|
+
* @interface WorkspacePermission
|
|
1772
|
+
*/
|
|
1773
|
+
export interface WorkspacePermission {
|
|
1146
1774
|
/**
|
|
1147
1775
|
* User or group identifier pattern (user must be valid email address, group is standard identifier)
|
|
1148
1776
|
* @type {string}
|
|
@@ -1154,33 +1782,426 @@ export interface WorkspacePermission {
|
|
|
1154
1782
|
* @type {string}
|
|
1155
1783
|
* @memberof WorkspacePermission
|
|
1156
1784
|
*/
|
|
1157
|
-
'permission'?: WorkspacePermissionPermissionEnum;
|
|
1785
|
+
'permission'?: WorkspacePermissionPermissionEnum;
|
|
1786
|
+
/**
|
|
1787
|
+
* Optional message or note about the permission assignment
|
|
1788
|
+
* @type {string}
|
|
1789
|
+
* @memberof WorkspacePermission
|
|
1790
|
+
*/
|
|
1791
|
+
'message'?: string;
|
|
1792
|
+
/**
|
|
1793
|
+
* ISO 8601 timestamp indicating when the permission was created
|
|
1794
|
+
* @type {string}
|
|
1795
|
+
* @memberof WorkspacePermission
|
|
1796
|
+
*/
|
|
1797
|
+
'createdAt'?: string;
|
|
1798
|
+
/**
|
|
1799
|
+
* ISO 8601 timestamp indicating when the permission was last modified
|
|
1800
|
+
* @type {string}
|
|
1801
|
+
* @memberof WorkspacePermission
|
|
1802
|
+
*/
|
|
1803
|
+
'updatedAt'?: string;
|
|
1804
|
+
}
|
|
1805
|
+
|
|
1806
|
+
export const WorkspacePermissionPermissionEnum = {
|
|
1807
|
+
Manager: 'manager',
|
|
1808
|
+
Viewer: 'viewer'
|
|
1809
|
+
} as const;
|
|
1810
|
+
|
|
1811
|
+
export type WorkspacePermissionPermissionEnum = typeof WorkspacePermissionPermissionEnum[keyof typeof WorkspacePermissionPermissionEnum];
|
|
1812
|
+
|
|
1813
|
+
|
|
1814
|
+
/**
|
|
1815
|
+
* BookmarksApi - axios parameter creator
|
|
1816
|
+
* @export
|
|
1817
|
+
*/
|
|
1818
|
+
export const BookmarksApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1819
|
+
return {
|
|
1820
|
+
/**
|
|
1821
|
+
* Creates a new bookmark for the current user within the organization. Bookmarks allow users to save references to workspaces, models, and chat conversations. **Authorization**: Requires read access to the organization. **Constraints**: Users can only create bookmarks for themselves. Duplicate bookmarks (same type and objectId) are not allowed.
|
|
1822
|
+
* @summary Create a new bookmark
|
|
1823
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
1824
|
+
* @param {Bookmark} bookmark
|
|
1825
|
+
* @param {*} [options] Override http request option.
|
|
1826
|
+
* @throws {RequiredError}
|
|
1827
|
+
*/
|
|
1828
|
+
createBookmark: async (organizationName: string, bookmark: Bookmark, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1829
|
+
// verify required parameter 'organizationName' is not null or undefined
|
|
1830
|
+
assertParamExists('createBookmark', 'organizationName', organizationName)
|
|
1831
|
+
// verify required parameter 'bookmark' is not null or undefined
|
|
1832
|
+
assertParamExists('createBookmark', 'bookmark', bookmark)
|
|
1833
|
+
const localVarPath = `/organizations/{organizationName}/bookmarks`
|
|
1834
|
+
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)));
|
|
1835
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1836
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1837
|
+
let baseOptions;
|
|
1838
|
+
if (configuration) {
|
|
1839
|
+
baseOptions = configuration.baseOptions;
|
|
1840
|
+
}
|
|
1841
|
+
|
|
1842
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1843
|
+
const localVarHeaderParameter = {} as any;
|
|
1844
|
+
const localVarQueryParameter = {} as any;
|
|
1845
|
+
|
|
1846
|
+
|
|
1847
|
+
|
|
1848
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1849
|
+
|
|
1850
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1851
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1852
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1853
|
+
localVarRequestOptions.data = serializeDataIfNeeded(bookmark, localVarRequestOptions, configuration)
|
|
1854
|
+
|
|
1855
|
+
return {
|
|
1856
|
+
url: toPathString(localVarUrlObj),
|
|
1857
|
+
options: localVarRequestOptions,
|
|
1858
|
+
};
|
|
1859
|
+
},
|
|
1860
|
+
/**
|
|
1861
|
+
* Deletes a specific bookmark for the current user. This operation cannot be undone. **Authorization**: Requires read access to the organization. **Constraints**: Users can only delete their own bookmarks.
|
|
1862
|
+
* @summary Delete a bookmark
|
|
1863
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
1864
|
+
* @param {DeleteBookmarkBookmarkTypeEnum} bookmarkType The type of bookmark
|
|
1865
|
+
* @param {string} objectId The unique identifier of the bookmarked object
|
|
1866
|
+
* @param {*} [options] Override http request option.
|
|
1867
|
+
* @throws {RequiredError}
|
|
1868
|
+
*/
|
|
1869
|
+
deleteBookmark: async (organizationName: string, bookmarkType: DeleteBookmarkBookmarkTypeEnum, objectId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1870
|
+
// verify required parameter 'organizationName' is not null or undefined
|
|
1871
|
+
assertParamExists('deleteBookmark', 'organizationName', organizationName)
|
|
1872
|
+
// verify required parameter 'bookmarkType' is not null or undefined
|
|
1873
|
+
assertParamExists('deleteBookmark', 'bookmarkType', bookmarkType)
|
|
1874
|
+
// verify required parameter 'objectId' is not null or undefined
|
|
1875
|
+
assertParamExists('deleteBookmark', 'objectId', objectId)
|
|
1876
|
+
const localVarPath = `/organizations/{organizationName}/bookmarks/{bookmarkType}`
|
|
1877
|
+
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)))
|
|
1878
|
+
.replace(`{${"bookmarkType"}}`, encodeURIComponent(String(bookmarkType)));
|
|
1879
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1880
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1881
|
+
let baseOptions;
|
|
1882
|
+
if (configuration) {
|
|
1883
|
+
baseOptions = configuration.baseOptions;
|
|
1884
|
+
}
|
|
1885
|
+
|
|
1886
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
1887
|
+
const localVarHeaderParameter = {} as any;
|
|
1888
|
+
const localVarQueryParameter = {} as any;
|
|
1889
|
+
|
|
1890
|
+
if (objectId !== undefined) {
|
|
1891
|
+
localVarQueryParameter['objectId'] = objectId;
|
|
1892
|
+
}
|
|
1893
|
+
|
|
1894
|
+
|
|
1895
|
+
|
|
1896
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1897
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1898
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1899
|
+
|
|
1900
|
+
return {
|
|
1901
|
+
url: toPathString(localVarUrlObj),
|
|
1902
|
+
options: localVarRequestOptions,
|
|
1903
|
+
};
|
|
1904
|
+
},
|
|
1905
|
+
/**
|
|
1906
|
+
* Retrieves a specific bookmark for the current user by type and object ID. **Authorization**: Requires read access to the organization. **Constraints**: Users can only access their own bookmarks.
|
|
1907
|
+
* @summary Get a specific bookmark
|
|
1908
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
1909
|
+
* @param {GetBookmarkBookmarkTypeEnum} bookmarkType The type of bookmark
|
|
1910
|
+
* @param {string} objectId The unique identifier of the bookmarked object
|
|
1911
|
+
* @param {*} [options] Override http request option.
|
|
1912
|
+
* @throws {RequiredError}
|
|
1913
|
+
*/
|
|
1914
|
+
getBookmark: async (organizationName: string, bookmarkType: GetBookmarkBookmarkTypeEnum, objectId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1915
|
+
// verify required parameter 'organizationName' is not null or undefined
|
|
1916
|
+
assertParamExists('getBookmark', 'organizationName', organizationName)
|
|
1917
|
+
// verify required parameter 'bookmarkType' is not null or undefined
|
|
1918
|
+
assertParamExists('getBookmark', 'bookmarkType', bookmarkType)
|
|
1919
|
+
// verify required parameter 'objectId' is not null or undefined
|
|
1920
|
+
assertParamExists('getBookmark', 'objectId', objectId)
|
|
1921
|
+
const localVarPath = `/organizations/{organizationName}/bookmarks/{bookmarkType}`
|
|
1922
|
+
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)))
|
|
1923
|
+
.replace(`{${"bookmarkType"}}`, encodeURIComponent(String(bookmarkType)));
|
|
1924
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1925
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1926
|
+
let baseOptions;
|
|
1927
|
+
if (configuration) {
|
|
1928
|
+
baseOptions = configuration.baseOptions;
|
|
1929
|
+
}
|
|
1930
|
+
|
|
1931
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1932
|
+
const localVarHeaderParameter = {} as any;
|
|
1933
|
+
const localVarQueryParameter = {} as any;
|
|
1934
|
+
|
|
1935
|
+
if (objectId !== undefined) {
|
|
1936
|
+
localVarQueryParameter['objectId'] = objectId;
|
|
1937
|
+
}
|
|
1938
|
+
|
|
1939
|
+
|
|
1940
|
+
|
|
1941
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1942
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1943
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1944
|
+
|
|
1945
|
+
return {
|
|
1946
|
+
url: toPathString(localVarUrlObj),
|
|
1947
|
+
options: localVarRequestOptions,
|
|
1948
|
+
};
|
|
1949
|
+
},
|
|
1950
|
+
/**
|
|
1951
|
+
* Retrieves all bookmarks for the current user within the specified organization. Optionally filter by bookmark type. **Authorization**: Requires read access to the organization. **Filtering**: Use `bookmarkType` parameter to filter by type (WORKSPACE, MODEL, CHAT).
|
|
1952
|
+
* @summary List bookmarks for current user
|
|
1953
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
1954
|
+
* @param {ListBookmarksBookmarkTypeEnum} [bookmarkType] Optional filter by bookmark type
|
|
1955
|
+
* @param {*} [options] Override http request option.
|
|
1956
|
+
* @throws {RequiredError}
|
|
1957
|
+
*/
|
|
1958
|
+
listBookmarks: async (organizationName: string, bookmarkType?: ListBookmarksBookmarkTypeEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1959
|
+
// verify required parameter 'organizationName' is not null or undefined
|
|
1960
|
+
assertParamExists('listBookmarks', 'organizationName', organizationName)
|
|
1961
|
+
const localVarPath = `/organizations/{organizationName}/bookmarks`
|
|
1962
|
+
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)));
|
|
1963
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1964
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1965
|
+
let baseOptions;
|
|
1966
|
+
if (configuration) {
|
|
1967
|
+
baseOptions = configuration.baseOptions;
|
|
1968
|
+
}
|
|
1969
|
+
|
|
1970
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1971
|
+
const localVarHeaderParameter = {} as any;
|
|
1972
|
+
const localVarQueryParameter = {} as any;
|
|
1973
|
+
|
|
1974
|
+
if (bookmarkType !== undefined) {
|
|
1975
|
+
localVarQueryParameter['bookmarkType'] = bookmarkType;
|
|
1976
|
+
}
|
|
1977
|
+
|
|
1978
|
+
|
|
1979
|
+
|
|
1980
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1981
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1982
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1983
|
+
|
|
1984
|
+
return {
|
|
1985
|
+
url: toPathString(localVarUrlObj),
|
|
1986
|
+
options: localVarRequestOptions,
|
|
1987
|
+
};
|
|
1988
|
+
},
|
|
1989
|
+
}
|
|
1990
|
+
};
|
|
1991
|
+
|
|
1992
|
+
/**
|
|
1993
|
+
* BookmarksApi - functional programming interface
|
|
1994
|
+
* @export
|
|
1995
|
+
*/
|
|
1996
|
+
export const BookmarksApiFp = function(configuration?: Configuration) {
|
|
1997
|
+
const localVarAxiosParamCreator = BookmarksApiAxiosParamCreator(configuration)
|
|
1998
|
+
return {
|
|
1999
|
+
/**
|
|
2000
|
+
* Creates a new bookmark for the current user within the organization. Bookmarks allow users to save references to workspaces, models, and chat conversations. **Authorization**: Requires read access to the organization. **Constraints**: Users can only create bookmarks for themselves. Duplicate bookmarks (same type and objectId) are not allowed.
|
|
2001
|
+
* @summary Create a new bookmark
|
|
2002
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2003
|
+
* @param {Bookmark} bookmark
|
|
2004
|
+
* @param {*} [options] Override http request option.
|
|
2005
|
+
* @throws {RequiredError}
|
|
2006
|
+
*/
|
|
2007
|
+
async createBookmark(organizationName: string, bookmark: Bookmark, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Bookmark>> {
|
|
2008
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createBookmark(organizationName, bookmark, options);
|
|
2009
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2010
|
+
const localVarOperationServerBasePath = operationServerMap['BookmarksApi.createBookmark']?.[localVarOperationServerIndex]?.url;
|
|
2011
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2012
|
+
},
|
|
2013
|
+
/**
|
|
2014
|
+
* Deletes a specific bookmark for the current user. This operation cannot be undone. **Authorization**: Requires read access to the organization. **Constraints**: Users can only delete their own bookmarks.
|
|
2015
|
+
* @summary Delete a bookmark
|
|
2016
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2017
|
+
* @param {DeleteBookmarkBookmarkTypeEnum} bookmarkType The type of bookmark
|
|
2018
|
+
* @param {string} objectId The unique identifier of the bookmarked object
|
|
2019
|
+
* @param {*} [options] Override http request option.
|
|
2020
|
+
* @throws {RequiredError}
|
|
2021
|
+
*/
|
|
2022
|
+
async deleteBookmark(organizationName: string, bookmarkType: DeleteBookmarkBookmarkTypeEnum, objectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
2023
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBookmark(organizationName, bookmarkType, objectId, options);
|
|
2024
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2025
|
+
const localVarOperationServerBasePath = operationServerMap['BookmarksApi.deleteBookmark']?.[localVarOperationServerIndex]?.url;
|
|
2026
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2027
|
+
},
|
|
2028
|
+
/**
|
|
2029
|
+
* Retrieves a specific bookmark for the current user by type and object ID. **Authorization**: Requires read access to the organization. **Constraints**: Users can only access their own bookmarks.
|
|
2030
|
+
* @summary Get a specific bookmark
|
|
2031
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2032
|
+
* @param {GetBookmarkBookmarkTypeEnum} bookmarkType The type of bookmark
|
|
2033
|
+
* @param {string} objectId The unique identifier of the bookmarked object
|
|
2034
|
+
* @param {*} [options] Override http request option.
|
|
2035
|
+
* @throws {RequiredError}
|
|
2036
|
+
*/
|
|
2037
|
+
async getBookmark(organizationName: string, bookmarkType: GetBookmarkBookmarkTypeEnum, objectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Bookmark>> {
|
|
2038
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBookmark(organizationName, bookmarkType, objectId, options);
|
|
2039
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2040
|
+
const localVarOperationServerBasePath = operationServerMap['BookmarksApi.getBookmark']?.[localVarOperationServerIndex]?.url;
|
|
2041
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2042
|
+
},
|
|
2043
|
+
/**
|
|
2044
|
+
* Retrieves all bookmarks for the current user within the specified organization. Optionally filter by bookmark type. **Authorization**: Requires read access to the organization. **Filtering**: Use `bookmarkType` parameter to filter by type (WORKSPACE, MODEL, CHAT).
|
|
2045
|
+
* @summary List bookmarks for current user
|
|
2046
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2047
|
+
* @param {ListBookmarksBookmarkTypeEnum} [bookmarkType] Optional filter by bookmark type
|
|
2048
|
+
* @param {*} [options] Override http request option.
|
|
2049
|
+
* @throws {RequiredError}
|
|
2050
|
+
*/
|
|
2051
|
+
async listBookmarks(organizationName: string, bookmarkType?: ListBookmarksBookmarkTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Bookmark>>> {
|
|
2052
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listBookmarks(organizationName, bookmarkType, options);
|
|
2053
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2054
|
+
const localVarOperationServerBasePath = operationServerMap['BookmarksApi.listBookmarks']?.[localVarOperationServerIndex]?.url;
|
|
2055
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2056
|
+
},
|
|
2057
|
+
}
|
|
2058
|
+
};
|
|
2059
|
+
|
|
2060
|
+
/**
|
|
2061
|
+
* BookmarksApi - factory interface
|
|
2062
|
+
* @export
|
|
2063
|
+
*/
|
|
2064
|
+
export const BookmarksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
2065
|
+
const localVarFp = BookmarksApiFp(configuration)
|
|
2066
|
+
return {
|
|
2067
|
+
/**
|
|
2068
|
+
* Creates a new bookmark for the current user within the organization. Bookmarks allow users to save references to workspaces, models, and chat conversations. **Authorization**: Requires read access to the organization. **Constraints**: Users can only create bookmarks for themselves. Duplicate bookmarks (same type and objectId) are not allowed.
|
|
2069
|
+
* @summary Create a new bookmark
|
|
2070
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2071
|
+
* @param {Bookmark} bookmark
|
|
2072
|
+
* @param {*} [options] Override http request option.
|
|
2073
|
+
* @throws {RequiredError}
|
|
2074
|
+
*/
|
|
2075
|
+
createBookmark(organizationName: string, bookmark: Bookmark, options?: RawAxiosRequestConfig): AxiosPromise<Bookmark> {
|
|
2076
|
+
return localVarFp.createBookmark(organizationName, bookmark, options).then((request) => request(axios, basePath));
|
|
2077
|
+
},
|
|
2078
|
+
/**
|
|
2079
|
+
* Deletes a specific bookmark for the current user. This operation cannot be undone. **Authorization**: Requires read access to the organization. **Constraints**: Users can only delete their own bookmarks.
|
|
2080
|
+
* @summary Delete a bookmark
|
|
2081
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2082
|
+
* @param {DeleteBookmarkBookmarkTypeEnum} bookmarkType The type of bookmark
|
|
2083
|
+
* @param {string} objectId The unique identifier of the bookmarked object
|
|
2084
|
+
* @param {*} [options] Override http request option.
|
|
2085
|
+
* @throws {RequiredError}
|
|
2086
|
+
*/
|
|
2087
|
+
deleteBookmark(organizationName: string, bookmarkType: DeleteBookmarkBookmarkTypeEnum, objectId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
2088
|
+
return localVarFp.deleteBookmark(organizationName, bookmarkType, objectId, options).then((request) => request(axios, basePath));
|
|
2089
|
+
},
|
|
2090
|
+
/**
|
|
2091
|
+
* Retrieves a specific bookmark for the current user by type and object ID. **Authorization**: Requires read access to the organization. **Constraints**: Users can only access their own bookmarks.
|
|
2092
|
+
* @summary Get a specific bookmark
|
|
2093
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2094
|
+
* @param {GetBookmarkBookmarkTypeEnum} bookmarkType The type of bookmark
|
|
2095
|
+
* @param {string} objectId The unique identifier of the bookmarked object
|
|
2096
|
+
* @param {*} [options] Override http request option.
|
|
2097
|
+
* @throws {RequiredError}
|
|
2098
|
+
*/
|
|
2099
|
+
getBookmark(organizationName: string, bookmarkType: GetBookmarkBookmarkTypeEnum, objectId: string, options?: RawAxiosRequestConfig): AxiosPromise<Bookmark> {
|
|
2100
|
+
return localVarFp.getBookmark(organizationName, bookmarkType, objectId, options).then((request) => request(axios, basePath));
|
|
2101
|
+
},
|
|
2102
|
+
/**
|
|
2103
|
+
* Retrieves all bookmarks for the current user within the specified organization. Optionally filter by bookmark type. **Authorization**: Requires read access to the organization. **Filtering**: Use `bookmarkType` parameter to filter by type (WORKSPACE, MODEL, CHAT).
|
|
2104
|
+
* @summary List bookmarks for current user
|
|
2105
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2106
|
+
* @param {ListBookmarksBookmarkTypeEnum} [bookmarkType] Optional filter by bookmark type
|
|
2107
|
+
* @param {*} [options] Override http request option.
|
|
2108
|
+
* @throws {RequiredError}
|
|
2109
|
+
*/
|
|
2110
|
+
listBookmarks(organizationName: string, bookmarkType?: ListBookmarksBookmarkTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<Bookmark>> {
|
|
2111
|
+
return localVarFp.listBookmarks(organizationName, bookmarkType, options).then((request) => request(axios, basePath));
|
|
2112
|
+
},
|
|
2113
|
+
};
|
|
2114
|
+
};
|
|
2115
|
+
|
|
2116
|
+
/**
|
|
2117
|
+
* BookmarksApi - object-oriented interface
|
|
2118
|
+
* @export
|
|
2119
|
+
* @class BookmarksApi
|
|
2120
|
+
* @extends {BaseAPI}
|
|
2121
|
+
*/
|
|
2122
|
+
export class BookmarksApi extends BaseAPI {
|
|
2123
|
+
/**
|
|
2124
|
+
* Creates a new bookmark for the current user within the organization. Bookmarks allow users to save references to workspaces, models, and chat conversations. **Authorization**: Requires read access to the organization. **Constraints**: Users can only create bookmarks for themselves. Duplicate bookmarks (same type and objectId) are not allowed.
|
|
2125
|
+
* @summary Create a new bookmark
|
|
2126
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2127
|
+
* @param {Bookmark} bookmark
|
|
2128
|
+
* @param {*} [options] Override http request option.
|
|
2129
|
+
* @throws {RequiredError}
|
|
2130
|
+
* @memberof BookmarksApi
|
|
2131
|
+
*/
|
|
2132
|
+
public createBookmark(organizationName: string, bookmark: Bookmark, options?: RawAxiosRequestConfig) {
|
|
2133
|
+
return BookmarksApiFp(this.configuration).createBookmark(organizationName, bookmark, options).then((request) => request(this.axios, this.basePath));
|
|
2134
|
+
}
|
|
2135
|
+
|
|
1158
2136
|
/**
|
|
1159
|
-
*
|
|
1160
|
-
* @
|
|
1161
|
-
* @
|
|
2137
|
+
* Deletes a specific bookmark for the current user. This operation cannot be undone. **Authorization**: Requires read access to the organization. **Constraints**: Users can only delete their own bookmarks.
|
|
2138
|
+
* @summary Delete a bookmark
|
|
2139
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2140
|
+
* @param {DeleteBookmarkBookmarkTypeEnum} bookmarkType The type of bookmark
|
|
2141
|
+
* @param {string} objectId The unique identifier of the bookmarked object
|
|
2142
|
+
* @param {*} [options] Override http request option.
|
|
2143
|
+
* @throws {RequiredError}
|
|
2144
|
+
* @memberof BookmarksApi
|
|
1162
2145
|
*/
|
|
1163
|
-
|
|
2146
|
+
public deleteBookmark(organizationName: string, bookmarkType: DeleteBookmarkBookmarkTypeEnum, objectId: string, options?: RawAxiosRequestConfig) {
|
|
2147
|
+
return BookmarksApiFp(this.configuration).deleteBookmark(organizationName, bookmarkType, objectId, options).then((request) => request(this.axios, this.basePath));
|
|
2148
|
+
}
|
|
2149
|
+
|
|
1164
2150
|
/**
|
|
1165
|
-
*
|
|
1166
|
-
* @
|
|
1167
|
-
* @
|
|
2151
|
+
* Retrieves a specific bookmark for the current user by type and object ID. **Authorization**: Requires read access to the organization. **Constraints**: Users can only access their own bookmarks.
|
|
2152
|
+
* @summary Get a specific bookmark
|
|
2153
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2154
|
+
* @param {GetBookmarkBookmarkTypeEnum} bookmarkType The type of bookmark
|
|
2155
|
+
* @param {string} objectId The unique identifier of the bookmarked object
|
|
2156
|
+
* @param {*} [options] Override http request option.
|
|
2157
|
+
* @throws {RequiredError}
|
|
2158
|
+
* @memberof BookmarksApi
|
|
1168
2159
|
*/
|
|
1169
|
-
|
|
2160
|
+
public getBookmark(organizationName: string, bookmarkType: GetBookmarkBookmarkTypeEnum, objectId: string, options?: RawAxiosRequestConfig) {
|
|
2161
|
+
return BookmarksApiFp(this.configuration).getBookmark(organizationName, bookmarkType, objectId, options).then((request) => request(this.axios, this.basePath));
|
|
2162
|
+
}
|
|
2163
|
+
|
|
1170
2164
|
/**
|
|
1171
|
-
*
|
|
1172
|
-
* @
|
|
1173
|
-
* @
|
|
2165
|
+
* Retrieves all bookmarks for the current user within the specified organization. Optionally filter by bookmark type. **Authorization**: Requires read access to the organization. **Filtering**: Use `bookmarkType` parameter to filter by type (WORKSPACE, MODEL, CHAT).
|
|
2166
|
+
* @summary List bookmarks for current user
|
|
2167
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
2168
|
+
* @param {ListBookmarksBookmarkTypeEnum} [bookmarkType] Optional filter by bookmark type
|
|
2169
|
+
* @param {*} [options] Override http request option.
|
|
2170
|
+
* @throws {RequiredError}
|
|
2171
|
+
* @memberof BookmarksApi
|
|
1174
2172
|
*/
|
|
1175
|
-
|
|
2173
|
+
public listBookmarks(organizationName: string, bookmarkType?: ListBookmarksBookmarkTypeEnum, options?: RawAxiosRequestConfig) {
|
|
2174
|
+
return BookmarksApiFp(this.configuration).listBookmarks(organizationName, bookmarkType, options).then((request) => request(this.axios, this.basePath));
|
|
2175
|
+
}
|
|
1176
2176
|
}
|
|
1177
2177
|
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
2178
|
+
/**
|
|
2179
|
+
* @export
|
|
2180
|
+
*/
|
|
2181
|
+
export const DeleteBookmarkBookmarkTypeEnum = {
|
|
2182
|
+
Workspace: 'WORKSPACE',
|
|
2183
|
+
Model: 'MODEL',
|
|
2184
|
+
Chat: 'CHAT'
|
|
1181
2185
|
} as const;
|
|
1182
|
-
|
|
1183
|
-
|
|
2186
|
+
export type DeleteBookmarkBookmarkTypeEnum = typeof DeleteBookmarkBookmarkTypeEnum[keyof typeof DeleteBookmarkBookmarkTypeEnum];
|
|
2187
|
+
/**
|
|
2188
|
+
* @export
|
|
2189
|
+
*/
|
|
2190
|
+
export const GetBookmarkBookmarkTypeEnum = {
|
|
2191
|
+
Workspace: 'WORKSPACE',
|
|
2192
|
+
Model: 'MODEL',
|
|
2193
|
+
Chat: 'CHAT'
|
|
2194
|
+
} as const;
|
|
2195
|
+
export type GetBookmarkBookmarkTypeEnum = typeof GetBookmarkBookmarkTypeEnum[keyof typeof GetBookmarkBookmarkTypeEnum];
|
|
2196
|
+
/**
|
|
2197
|
+
* @export
|
|
2198
|
+
*/
|
|
2199
|
+
export const ListBookmarksBookmarkTypeEnum = {
|
|
2200
|
+
Workspace: 'WORKSPACE',
|
|
2201
|
+
Model: 'MODEL',
|
|
2202
|
+
Chat: 'CHAT'
|
|
2203
|
+
} as const;
|
|
2204
|
+
export type ListBookmarksBookmarkTypeEnum = typeof ListBookmarksBookmarkTypeEnum[keyof typeof ListBookmarksBookmarkTypeEnum];
|
|
1184
2205
|
|
|
1185
2206
|
|
|
1186
2207
|
/**
|
|
@@ -1323,14 +2344,16 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
1323
2344
|
};
|
|
1324
2345
|
},
|
|
1325
2346
|
/**
|
|
1326
|
-
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions.
|
|
2347
|
+
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions. **Response**: Returns array of connection objects with configuration details. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
1327
2348
|
* @summary List database connections
|
|
1328
2349
|
* @param {string} organizationName The unique identifier of the organization
|
|
1329
2350
|
* @param {string} projectName The unique identifier of the project
|
|
2351
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
2352
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
1330
2353
|
* @param {*} [options] Override http request option.
|
|
1331
2354
|
* @throws {RequiredError}
|
|
1332
2355
|
*/
|
|
1333
|
-
listConnections: async (organizationName: string, projectName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2356
|
+
listConnections: async (organizationName: string, projectName: string, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1334
2357
|
// verify required parameter 'organizationName' is not null or undefined
|
|
1335
2358
|
assertParamExists('listConnections', 'organizationName', organizationName)
|
|
1336
2359
|
// verify required parameter 'projectName' is not null or undefined
|
|
@@ -1349,6 +2372,14 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
1349
2372
|
const localVarHeaderParameter = {} as any;
|
|
1350
2373
|
const localVarQueryParameter = {} as any;
|
|
1351
2374
|
|
|
2375
|
+
if (limit !== undefined) {
|
|
2376
|
+
localVarQueryParameter['limit'] = limit;
|
|
2377
|
+
}
|
|
2378
|
+
|
|
2379
|
+
if (offset !== undefined) {
|
|
2380
|
+
localVarQueryParameter['offset'] = offset;
|
|
2381
|
+
}
|
|
2382
|
+
|
|
1352
2383
|
|
|
1353
2384
|
|
|
1354
2385
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1463,15 +2494,17 @@ export const ConnectionsApiFp = function(configuration?: Configuration) {
|
|
|
1463
2494
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1464
2495
|
},
|
|
1465
2496
|
/**
|
|
1466
|
-
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions.
|
|
2497
|
+
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions. **Response**: Returns array of connection objects with configuration details. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
1467
2498
|
* @summary List database connections
|
|
1468
2499
|
* @param {string} organizationName The unique identifier of the organization
|
|
1469
2500
|
* @param {string} projectName The unique identifier of the project
|
|
2501
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
2502
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
1470
2503
|
* @param {*} [options] Override http request option.
|
|
1471
2504
|
* @throws {RequiredError}
|
|
1472
2505
|
*/
|
|
1473
|
-
async listConnections(organizationName: string, projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Connection>>> {
|
|
1474
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listConnections(organizationName, projectName, options);
|
|
2506
|
+
async listConnections(organizationName: string, projectName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Connection>>> {
|
|
2507
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listConnections(organizationName, projectName, limit, offset, options);
|
|
1475
2508
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1476
2509
|
const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.listConnections']?.[localVarOperationServerIndex]?.url;
|
|
1477
2510
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1540,15 +2573,17 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
|
|
|
1540
2573
|
return localVarFp.getConnection(organizationName, projectName, connectionName, options).then((request) => request(axios, basePath));
|
|
1541
2574
|
},
|
|
1542
2575
|
/**
|
|
1543
|
-
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions.
|
|
2576
|
+
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions. **Response**: Returns array of connection objects with configuration details. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
1544
2577
|
* @summary List database connections
|
|
1545
2578
|
* @param {string} organizationName The unique identifier of the organization
|
|
1546
2579
|
* @param {string} projectName The unique identifier of the project
|
|
2580
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
2581
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
1547
2582
|
* @param {*} [options] Override http request option.
|
|
1548
2583
|
* @throws {RequiredError}
|
|
1549
2584
|
*/
|
|
1550
|
-
listConnections(organizationName: string, projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Connection>> {
|
|
1551
|
-
return localVarFp.listConnections(organizationName, projectName, options).then((request) => request(axios, basePath));
|
|
2585
|
+
listConnections(organizationName: string, projectName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Connection>> {
|
|
2586
|
+
return localVarFp.listConnections(organizationName, projectName, limit, offset, options).then((request) => request(axios, basePath));
|
|
1552
2587
|
},
|
|
1553
2588
|
/**
|
|
1554
2589
|
* Updates the configuration of an existing database connection, including credentials, settings, and connection parameters. **Authorization**: Requires project admin permissions. **Security**: Credentials are encrypted and stored securely. **Validation**: Tests connection before saving changes.
|
|
@@ -1617,16 +2652,18 @@ export class ConnectionsApi extends BaseAPI {
|
|
|
1617
2652
|
}
|
|
1618
2653
|
|
|
1619
2654
|
/**
|
|
1620
|
-
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions.
|
|
2655
|
+
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions. **Response**: Returns array of connection objects with configuration details. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
1621
2656
|
* @summary List database connections
|
|
1622
2657
|
* @param {string} organizationName The unique identifier of the organization
|
|
1623
2658
|
* @param {string} projectName The unique identifier of the project
|
|
2659
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
2660
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
1624
2661
|
* @param {*} [options] Override http request option.
|
|
1625
2662
|
* @throws {RequiredError}
|
|
1626
2663
|
* @memberof ConnectionsApi
|
|
1627
2664
|
*/
|
|
1628
|
-
public listConnections(organizationName: string, projectName: string, options?: RawAxiosRequestConfig) {
|
|
1629
|
-
return ConnectionsApiFp(this.configuration).listConnections(organizationName, projectName, options).then((request) => request(this.axios, this.basePath));
|
|
2665
|
+
public listConnections(organizationName: string, projectName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) {
|
|
2666
|
+
return ConnectionsApiFp(this.configuration).listConnections(organizationName, projectName, limit, offset, options).then((request) => request(this.axios, this.basePath));
|
|
1630
2667
|
}
|
|
1631
2668
|
|
|
1632
2669
|
/**
|
|
@@ -2461,10 +3498,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2461
3498
|
* @summary List workspace documents
|
|
2462
3499
|
* @param {string} organizationName The unique identifier of the organization
|
|
2463
3500
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
3501
|
+
* @param {boolean} [retrieveContent] If true, include the document content in the response. Defaults to false.
|
|
2464
3502
|
* @param {*} [options] Override http request option.
|
|
2465
3503
|
* @throws {RequiredError}
|
|
2466
3504
|
*/
|
|
2467
|
-
listDocuments: async (organizationName: string, workspaceName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3505
|
+
listDocuments: async (organizationName: string, workspaceName: string, retrieveContent?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2468
3506
|
// verify required parameter 'organizationName' is not null or undefined
|
|
2469
3507
|
assertParamExists('listDocuments', 'organizationName', organizationName)
|
|
2470
3508
|
// verify required parameter 'workspaceName' is not null or undefined
|
|
@@ -2483,6 +3521,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2483
3521
|
const localVarHeaderParameter = {} as any;
|
|
2484
3522
|
const localVarQueryParameter = {} as any;
|
|
2485
3523
|
|
|
3524
|
+
if (retrieveContent !== undefined) {
|
|
3525
|
+
localVarQueryParameter['retrieveContent'] = retrieveContent;
|
|
3526
|
+
}
|
|
3527
|
+
|
|
2486
3528
|
|
|
2487
3529
|
|
|
2488
3530
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2602,11 +3644,12 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
2602
3644
|
* @summary List workspace documents
|
|
2603
3645
|
* @param {string} organizationName The unique identifier of the organization
|
|
2604
3646
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
3647
|
+
* @param {boolean} [retrieveContent] If true, include the document content in the response. Defaults to false.
|
|
2605
3648
|
* @param {*} [options] Override http request option.
|
|
2606
3649
|
* @throws {RequiredError}
|
|
2607
3650
|
*/
|
|
2608
|
-
async listDocuments(organizationName: string, workspaceName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Document>>> {
|
|
2609
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(organizationName, workspaceName, options);
|
|
3651
|
+
async listDocuments(organizationName: string, workspaceName: string, retrieveContent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Document>>> {
|
|
3652
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(organizationName, workspaceName, retrieveContent, options);
|
|
2610
3653
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2611
3654
|
const localVarOperationServerBasePath = operationServerMap['DocumentsApi.listDocuments']?.[localVarOperationServerIndex]?.url;
|
|
2612
3655
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2680,11 +3723,12 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
2680
3723
|
* @summary List workspace documents
|
|
2681
3724
|
* @param {string} organizationName The unique identifier of the organization
|
|
2682
3725
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
3726
|
+
* @param {boolean} [retrieveContent] If true, include the document content in the response. Defaults to false.
|
|
2683
3727
|
* @param {*} [options] Override http request option.
|
|
2684
3728
|
* @throws {RequiredError}
|
|
2685
3729
|
*/
|
|
2686
|
-
listDocuments(organizationName: string, workspaceName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Document>> {
|
|
2687
|
-
return localVarFp.listDocuments(organizationName, workspaceName, options).then((request) => request(axios, basePath));
|
|
3730
|
+
listDocuments(organizationName: string, workspaceName: string, retrieveContent?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Array<Document>> {
|
|
3731
|
+
return localVarFp.listDocuments(organizationName, workspaceName, retrieveContent, options).then((request) => request(axios, basePath));
|
|
2688
3732
|
},
|
|
2689
3733
|
/**
|
|
2690
3734
|
* Updates the content and metadata of an existing document within the workspace. **Authorization**: Requires document editor or workspace manager permissions. **Content**: Supports updating document content, type, and other properties.
|
|
@@ -2758,12 +3802,13 @@ export class DocumentsApi extends BaseAPI {
|
|
|
2758
3802
|
* @summary List workspace documents
|
|
2759
3803
|
* @param {string} organizationName The unique identifier of the organization
|
|
2760
3804
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
3805
|
+
* @param {boolean} [retrieveContent] If true, include the document content in the response. Defaults to false.
|
|
2761
3806
|
* @param {*} [options] Override http request option.
|
|
2762
3807
|
* @throws {RequiredError}
|
|
2763
3808
|
* @memberof DocumentsApi
|
|
2764
3809
|
*/
|
|
2765
|
-
public listDocuments(organizationName: string, workspaceName: string, options?: RawAxiosRequestConfig) {
|
|
2766
|
-
return DocumentsApiFp(this.configuration).listDocuments(organizationName, workspaceName, options).then((request) => request(this.axios, this.basePath));
|
|
3810
|
+
public listDocuments(organizationName: string, workspaceName: string, retrieveContent?: boolean, options?: RawAxiosRequestConfig) {
|
|
3811
|
+
return DocumentsApiFp(this.configuration).listDocuments(organizationName, workspaceName, retrieveContent, options).then((request) => request(this.axios, this.basePath));
|
|
2767
3812
|
}
|
|
2768
3813
|
|
|
2769
3814
|
/**
|
|
@@ -4294,14 +5339,13 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4294
5339
|
};
|
|
4295
5340
|
},
|
|
4296
5341
|
/**
|
|
4297
|
-
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details.
|
|
5342
|
+
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details. The response includes the current user\'s permission level (admin, modeler, or member) within the organization. **Authorization**: Requires read access to the specified organization.
|
|
4298
5343
|
* @summary Get organization details
|
|
4299
5344
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4300
|
-
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
4301
5345
|
* @param {*} [options] Override http request option.
|
|
4302
5346
|
* @throws {RequiredError}
|
|
4303
5347
|
*/
|
|
4304
|
-
getOrganization: async (organizationName: string,
|
|
5348
|
+
getOrganization: async (organizationName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4305
5349
|
// verify required parameter 'organizationName' is not null or undefined
|
|
4306
5350
|
assertParamExists('getOrganization', 'organizationName', organizationName)
|
|
4307
5351
|
const localVarPath = `/organizations/{organizationName}`
|
|
@@ -4317,10 +5361,78 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4317
5361
|
const localVarHeaderParameter = {} as any;
|
|
4318
5362
|
const localVarQueryParameter = {} as any;
|
|
4319
5363
|
|
|
4320
|
-
|
|
4321
|
-
|
|
5364
|
+
|
|
5365
|
+
|
|
5366
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5367
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5368
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5369
|
+
|
|
5370
|
+
return {
|
|
5371
|
+
url: toPathString(localVarUrlObj),
|
|
5372
|
+
options: localVarRequestOptions,
|
|
5373
|
+
};
|
|
5374
|
+
},
|
|
5375
|
+
/**
|
|
5376
|
+
* Retrieves basic user information for a user within an organization context. This endpoint verifies that both the caller and the target user are members of the specified organization before returning user data. **Security**: Returns 404 (not 403) if the target user doesn\'t exist or is not a member of the organization. This prevents information leakage about user existence. **Authorization**: Requires read access to the organization (caller must be a member). **Response**: Returns only basic user fields (userName, email) for privacy.
|
|
5377
|
+
* @summary Get user within organization context
|
|
5378
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
5379
|
+
* @param {string} userName The username (email) of the user to retrieve
|
|
5380
|
+
* @param {*} [options] Override http request option.
|
|
5381
|
+
* @throws {RequiredError}
|
|
5382
|
+
*/
|
|
5383
|
+
getOrganizationUser: async (organizationName: string, userName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5384
|
+
// verify required parameter 'organizationName' is not null or undefined
|
|
5385
|
+
assertParamExists('getOrganizationUser', 'organizationName', organizationName)
|
|
5386
|
+
// verify required parameter 'userName' is not null or undefined
|
|
5387
|
+
assertParamExists('getOrganizationUser', 'userName', userName)
|
|
5388
|
+
const localVarPath = `/organizations/{organizationName}/users/{userName}`
|
|
5389
|
+
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)))
|
|
5390
|
+
.replace(`{${"userName"}}`, encodeURIComponent(String(userName)));
|
|
5391
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5392
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5393
|
+
let baseOptions;
|
|
5394
|
+
if (configuration) {
|
|
5395
|
+
baseOptions = configuration.baseOptions;
|
|
5396
|
+
}
|
|
5397
|
+
|
|
5398
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5399
|
+
const localVarHeaderParameter = {} as any;
|
|
5400
|
+
const localVarQueryParameter = {} as any;
|
|
5401
|
+
|
|
5402
|
+
|
|
5403
|
+
|
|
5404
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5405
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5406
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
5407
|
+
|
|
5408
|
+
return {
|
|
5409
|
+
url: toPathString(localVarUrlObj),
|
|
5410
|
+
options: localVarRequestOptions,
|
|
5411
|
+
};
|
|
5412
|
+
},
|
|
5413
|
+
/**
|
|
5414
|
+
* Retrieves all users that are members of the specified organization, returning basic user information (userName, email) for each. **Authorization**: Requires read access to the organization (caller must be a member). **Response**: Returns array of user objects with basic fields only.
|
|
5415
|
+
* @summary List users in organization
|
|
5416
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
5417
|
+
* @param {*} [options] Override http request option.
|
|
5418
|
+
* @throws {RequiredError}
|
|
5419
|
+
*/
|
|
5420
|
+
listOrganizationUsers: async (organizationName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5421
|
+
// verify required parameter 'organizationName' is not null or undefined
|
|
5422
|
+
assertParamExists('listOrganizationUsers', 'organizationName', organizationName)
|
|
5423
|
+
const localVarPath = `/organizations/{organizationName}/users`
|
|
5424
|
+
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)));
|
|
5425
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5426
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5427
|
+
let baseOptions;
|
|
5428
|
+
if (configuration) {
|
|
5429
|
+
baseOptions = configuration.baseOptions;
|
|
4322
5430
|
}
|
|
4323
5431
|
|
|
5432
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5433
|
+
const localVarHeaderParameter = {} as any;
|
|
5434
|
+
const localVarQueryParameter = {} as any;
|
|
5435
|
+
|
|
4324
5436
|
|
|
4325
5437
|
|
|
4326
5438
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4333,12 +5445,14 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4333
5445
|
};
|
|
4334
5446
|
},
|
|
4335
5447
|
/**
|
|
4336
|
-
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations.
|
|
5448
|
+
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations. **Rate Limiting**: Standard rate limits apply. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
4337
5449
|
* @summary List all organizations
|
|
5450
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
5451
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
4338
5452
|
* @param {*} [options] Override http request option.
|
|
4339
5453
|
* @throws {RequiredError}
|
|
4340
5454
|
*/
|
|
4341
|
-
listOrganizations: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5455
|
+
listOrganizations: async (limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4342
5456
|
const localVarPath = `/organizations`;
|
|
4343
5457
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4344
5458
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -4351,6 +5465,14 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4351
5465
|
const localVarHeaderParameter = {} as any;
|
|
4352
5466
|
const localVarQueryParameter = {} as any;
|
|
4353
5467
|
|
|
5468
|
+
if (limit !== undefined) {
|
|
5469
|
+
localVarQueryParameter['limit'] = limit;
|
|
5470
|
+
}
|
|
5471
|
+
|
|
5472
|
+
if (offset !== undefined) {
|
|
5473
|
+
localVarQueryParameter['offset'] = offset;
|
|
5474
|
+
}
|
|
5475
|
+
|
|
4354
5476
|
|
|
4355
5477
|
|
|
4356
5478
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4439,27 +5561,55 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
|
|
|
4439
5561
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4440
5562
|
},
|
|
4441
5563
|
/**
|
|
4442
|
-
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details.
|
|
5564
|
+
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details. The response includes the current user\'s permission level (admin, modeler, or member) within the organization. **Authorization**: Requires read access to the specified organization.
|
|
4443
5565
|
* @summary Get organization details
|
|
4444
5566
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4445
|
-
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
4446
5567
|
* @param {*} [options] Override http request option.
|
|
4447
5568
|
* @throws {RequiredError}
|
|
4448
5569
|
*/
|
|
4449
|
-
async getOrganization(organizationName: string,
|
|
4450
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganization(organizationName,
|
|
5570
|
+
async getOrganization(organizationName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrganizationResponse>> {
|
|
5571
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganization(organizationName, options);
|
|
4451
5572
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4452
5573
|
const localVarOperationServerBasePath = operationServerMap['OrganizationsApi.getOrganization']?.[localVarOperationServerIndex]?.url;
|
|
4453
5574
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4454
5575
|
},
|
|
4455
5576
|
/**
|
|
4456
|
-
* Retrieves a
|
|
5577
|
+
* Retrieves basic user information for a user within an organization context. This endpoint verifies that both the caller and the target user are members of the specified organization before returning user data. **Security**: Returns 404 (not 403) if the target user doesn\'t exist or is not a member of the organization. This prevents information leakage about user existence. **Authorization**: Requires read access to the organization (caller must be a member). **Response**: Returns only basic user fields (userName, email) for privacy.
|
|
5578
|
+
* @summary Get user within organization context
|
|
5579
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
5580
|
+
* @param {string} userName The username (email) of the user to retrieve
|
|
5581
|
+
* @param {*} [options] Override http request option.
|
|
5582
|
+
* @throws {RequiredError}
|
|
5583
|
+
*/
|
|
5584
|
+
async getOrganizationUser(organizationName: string, userName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>> {
|
|
5585
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrganizationUser(organizationName, userName, options);
|
|
5586
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5587
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationsApi.getOrganizationUser']?.[localVarOperationServerIndex]?.url;
|
|
5588
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5589
|
+
},
|
|
5590
|
+
/**
|
|
5591
|
+
* Retrieves all users that are members of the specified organization, returning basic user information (userName, email) for each. **Authorization**: Requires read access to the organization (caller must be a member). **Response**: Returns array of user objects with basic fields only.
|
|
5592
|
+
* @summary List users in organization
|
|
5593
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
5594
|
+
* @param {*} [options] Override http request option.
|
|
5595
|
+
* @throws {RequiredError}
|
|
5596
|
+
*/
|
|
5597
|
+
async listOrganizationUsers(organizationName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<User>>> {
|
|
5598
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrganizationUsers(organizationName, options);
|
|
5599
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5600
|
+
const localVarOperationServerBasePath = operationServerMap['OrganizationsApi.listOrganizationUsers']?.[localVarOperationServerIndex]?.url;
|
|
5601
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5602
|
+
},
|
|
5603
|
+
/**
|
|
5604
|
+
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations. **Rate Limiting**: Standard rate limits apply. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
4457
5605
|
* @summary List all organizations
|
|
5606
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
5607
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
4458
5608
|
* @param {*} [options] Override http request option.
|
|
4459
5609
|
* @throws {RequiredError}
|
|
4460
5610
|
*/
|
|
4461
|
-
async listOrganizations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Organization>>> {
|
|
4462
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrganizations(options);
|
|
5611
|
+
async listOrganizations(limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Organization>>> {
|
|
5612
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrganizations(limit, offset, options);
|
|
4463
5613
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4464
5614
|
const localVarOperationServerBasePath = operationServerMap['OrganizationsApi.listOrganizations']?.[localVarOperationServerIndex]?.url;
|
|
4465
5615
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -4509,24 +5659,46 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
|
|
|
4509
5659
|
return localVarFp.deleteOrganization(organizationName, options).then((request) => request(axios, basePath));
|
|
4510
5660
|
},
|
|
4511
5661
|
/**
|
|
4512
|
-
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details.
|
|
5662
|
+
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details. The response includes the current user\'s permission level (admin, modeler, or member) within the organization. **Authorization**: Requires read access to the specified organization.
|
|
4513
5663
|
* @summary Get organization details
|
|
4514
5664
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4515
|
-
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
4516
5665
|
* @param {*} [options] Override http request option.
|
|
4517
5666
|
* @throws {RequiredError}
|
|
4518
5667
|
*/
|
|
4519
|
-
getOrganization(organizationName: string,
|
|
4520
|
-
return localVarFp.getOrganization(organizationName,
|
|
5668
|
+
getOrganization(organizationName: string, options?: RawAxiosRequestConfig): AxiosPromise<GetOrganizationResponse> {
|
|
5669
|
+
return localVarFp.getOrganization(organizationName, options).then((request) => request(axios, basePath));
|
|
5670
|
+
},
|
|
5671
|
+
/**
|
|
5672
|
+
* Retrieves basic user information for a user within an organization context. This endpoint verifies that both the caller and the target user are members of the specified organization before returning user data. **Security**: Returns 404 (not 403) if the target user doesn\'t exist or is not a member of the organization. This prevents information leakage about user existence. **Authorization**: Requires read access to the organization (caller must be a member). **Response**: Returns only basic user fields (userName, email) for privacy.
|
|
5673
|
+
* @summary Get user within organization context
|
|
5674
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
5675
|
+
* @param {string} userName The username (email) of the user to retrieve
|
|
5676
|
+
* @param {*} [options] Override http request option.
|
|
5677
|
+
* @throws {RequiredError}
|
|
5678
|
+
*/
|
|
5679
|
+
getOrganizationUser(organizationName: string, userName: string, options?: RawAxiosRequestConfig): AxiosPromise<User> {
|
|
5680
|
+
return localVarFp.getOrganizationUser(organizationName, userName, options).then((request) => request(axios, basePath));
|
|
5681
|
+
},
|
|
5682
|
+
/**
|
|
5683
|
+
* Retrieves all users that are members of the specified organization, returning basic user information (userName, email) for each. **Authorization**: Requires read access to the organization (caller must be a member). **Response**: Returns array of user objects with basic fields only.
|
|
5684
|
+
* @summary List users in organization
|
|
5685
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
5686
|
+
* @param {*} [options] Override http request option.
|
|
5687
|
+
* @throws {RequiredError}
|
|
5688
|
+
*/
|
|
5689
|
+
listOrganizationUsers(organizationName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<User>> {
|
|
5690
|
+
return localVarFp.listOrganizationUsers(organizationName, options).then((request) => request(axios, basePath));
|
|
4521
5691
|
},
|
|
4522
5692
|
/**
|
|
4523
|
-
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations.
|
|
5693
|
+
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations. **Rate Limiting**: Standard rate limits apply. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
4524
5694
|
* @summary List all organizations
|
|
5695
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
5696
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
4525
5697
|
* @param {*} [options] Override http request option.
|
|
4526
5698
|
* @throws {RequiredError}
|
|
4527
5699
|
*/
|
|
4528
|
-
listOrganizations(options?: RawAxiosRequestConfig): AxiosPromise<Array<Organization>> {
|
|
4529
|
-
return localVarFp.listOrganizations(options).then((request) => request(axios, basePath));
|
|
5700
|
+
listOrganizations(limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Organization>> {
|
|
5701
|
+
return localVarFp.listOrganizations(limit, offset, options).then((request) => request(axios, basePath));
|
|
4530
5702
|
},
|
|
4531
5703
|
/**
|
|
4532
5704
|
* Partially updates an organization\'s details. Only the provided fields will be updated. This operation allows for selective updates without requiring all organization fields. **Authorization**: Requires organization admin permissions. **Validation**: All provided fields are validated according to their schema constraints. **Side Effects**: Updates the organization\'s `updatedAt` timestamp.
|
|
@@ -4574,27 +5746,53 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
4574
5746
|
}
|
|
4575
5747
|
|
|
4576
5748
|
/**
|
|
4577
|
-
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details.
|
|
5749
|
+
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details. The response includes the current user\'s permission level (admin, modeler, or member) within the organization. **Authorization**: Requires read access to the specified organization.
|
|
4578
5750
|
* @summary Get organization details
|
|
4579
5751
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4580
|
-
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
4581
5752
|
* @param {*} [options] Override http request option.
|
|
4582
5753
|
* @throws {RequiredError}
|
|
4583
5754
|
* @memberof OrganizationsApi
|
|
4584
5755
|
*/
|
|
4585
|
-
public getOrganization(organizationName: string,
|
|
4586
|
-
return OrganizationsApiFp(this.configuration).getOrganization(organizationName,
|
|
5756
|
+
public getOrganization(organizationName: string, options?: RawAxiosRequestConfig) {
|
|
5757
|
+
return OrganizationsApiFp(this.configuration).getOrganization(organizationName, options).then((request) => request(this.axios, this.basePath));
|
|
5758
|
+
}
|
|
5759
|
+
|
|
5760
|
+
/**
|
|
5761
|
+
* Retrieves basic user information for a user within an organization context. This endpoint verifies that both the caller and the target user are members of the specified organization before returning user data. **Security**: Returns 404 (not 403) if the target user doesn\'t exist or is not a member of the organization. This prevents information leakage about user existence. **Authorization**: Requires read access to the organization (caller must be a member). **Response**: Returns only basic user fields (userName, email) for privacy.
|
|
5762
|
+
* @summary Get user within organization context
|
|
5763
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
5764
|
+
* @param {string} userName The username (email) of the user to retrieve
|
|
5765
|
+
* @param {*} [options] Override http request option.
|
|
5766
|
+
* @throws {RequiredError}
|
|
5767
|
+
* @memberof OrganizationsApi
|
|
5768
|
+
*/
|
|
5769
|
+
public getOrganizationUser(organizationName: string, userName: string, options?: RawAxiosRequestConfig) {
|
|
5770
|
+
return OrganizationsApiFp(this.configuration).getOrganizationUser(organizationName, userName, options).then((request) => request(this.axios, this.basePath));
|
|
5771
|
+
}
|
|
5772
|
+
|
|
5773
|
+
/**
|
|
5774
|
+
* Retrieves all users that are members of the specified organization, returning basic user information (userName, email) for each. **Authorization**: Requires read access to the organization (caller must be a member). **Response**: Returns array of user objects with basic fields only.
|
|
5775
|
+
* @summary List users in organization
|
|
5776
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
5777
|
+
* @param {*} [options] Override http request option.
|
|
5778
|
+
* @throws {RequiredError}
|
|
5779
|
+
* @memberof OrganizationsApi
|
|
5780
|
+
*/
|
|
5781
|
+
public listOrganizationUsers(organizationName: string, options?: RawAxiosRequestConfig) {
|
|
5782
|
+
return OrganizationsApiFp(this.configuration).listOrganizationUsers(organizationName, options).then((request) => request(this.axios, this.basePath));
|
|
4587
5783
|
}
|
|
4588
5784
|
|
|
4589
5785
|
/**
|
|
4590
|
-
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations.
|
|
5786
|
+
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations. **Rate Limiting**: Standard rate limits apply. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
4591
5787
|
* @summary List all organizations
|
|
5788
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
5789
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
4592
5790
|
* @param {*} [options] Override http request option.
|
|
4593
5791
|
* @throws {RequiredError}
|
|
4594
5792
|
* @memberof OrganizationsApi
|
|
4595
5793
|
*/
|
|
4596
|
-
public listOrganizations(options?: RawAxiosRequestConfig) {
|
|
4597
|
-
return OrganizationsApiFp(this.configuration).listOrganizations(options).then((request) => request(this.axios, this.basePath));
|
|
5794
|
+
public listOrganizations(limit?: number, offset?: number, options?: RawAxiosRequestConfig) {
|
|
5795
|
+
return OrganizationsApiFp(this.configuration).listOrganizations(limit, offset, options).then((request) => request(this.axios, this.basePath));
|
|
4598
5796
|
}
|
|
4599
5797
|
|
|
4600
5798
|
/**
|
|
@@ -5280,21 +6478,18 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5280
6478
|
};
|
|
5281
6479
|
},
|
|
5282
6480
|
/**
|
|
5283
|
-
*
|
|
5284
|
-
* @summary List packages
|
|
6481
|
+
* Returns a list of package resource identifiers under the given organization that the current user has access to. By default returns only packages the user can share (admin/modeler role). Set `onlyShareable=false` to include all readable packages (including viewer access). **Note**: This endpoint provides cross-project package visibility. It aggregates packages from all projects within the organization that the user has access to. **Authorization**: Requires read access to the organization. **Response**: Returns array of package resource identifiers.
|
|
6482
|
+
* @summary List accessible packages by organization
|
|
5285
6483
|
* @param {string} organizationName The unique identifier of the organization
|
|
5286
|
-
* @param {
|
|
6484
|
+
* @param {boolean} [onlyShareable] When true, returns only packages the user can share (admin/modeler). When false, returns all readable packages.
|
|
5287
6485
|
* @param {*} [options] Override http request option.
|
|
5288
6486
|
* @throws {RequiredError}
|
|
5289
6487
|
*/
|
|
5290
|
-
|
|
6488
|
+
listOrganizationPackages: async (organizationName: string, onlyShareable?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5291
6489
|
// verify required parameter 'organizationName' is not null or undefined
|
|
5292
|
-
assertParamExists('
|
|
5293
|
-
|
|
5294
|
-
|
|
5295
|
-
const localVarPath = `/organizations/{organizationName}/projects/{projectName}/packages`
|
|
5296
|
-
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)))
|
|
5297
|
-
.replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
|
|
6490
|
+
assertParamExists('listOrganizationPackages', 'organizationName', organizationName)
|
|
6491
|
+
const localVarPath = `/organizations/{organizationName}/packages`
|
|
6492
|
+
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)));
|
|
5298
6493
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5299
6494
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5300
6495
|
let baseOptions;
|
|
@@ -5306,6 +6501,10 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5306
6501
|
const localVarHeaderParameter = {} as any;
|
|
5307
6502
|
const localVarQueryParameter = {} as any;
|
|
5308
6503
|
|
|
6504
|
+
if (onlyShareable !== undefined) {
|
|
6505
|
+
localVarQueryParameter['onlyShareable'] = onlyShareable;
|
|
6506
|
+
}
|
|
6507
|
+
|
|
5309
6508
|
|
|
5310
6509
|
|
|
5311
6510
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5318,18 +6517,23 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5318
6517
|
};
|
|
5319
6518
|
},
|
|
5320
6519
|
/**
|
|
5321
|
-
*
|
|
5322
|
-
* @summary List
|
|
6520
|
+
* Retrieves all packages within the specified project, including metadata such as names, descriptions, latest versions, and creation timestamps. **Authorization**: Requires read access to the project. **Response**: Returns array of package objects with full metadata. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
6521
|
+
* @summary List packages in project
|
|
5323
6522
|
* @param {string} organizationName The unique identifier of the organization
|
|
6523
|
+
* @param {string} projectName The unique identifier of the project
|
|
6524
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
6525
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
5324
6526
|
* @param {*} [options] Override http request option.
|
|
5325
|
-
* @deprecated
|
|
5326
6527
|
* @throws {RequiredError}
|
|
5327
6528
|
*/
|
|
5328
|
-
|
|
6529
|
+
listPackages: async (organizationName: string, projectName: string, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5329
6530
|
// verify required parameter 'organizationName' is not null or undefined
|
|
5330
|
-
assertParamExists('
|
|
5331
|
-
|
|
5332
|
-
|
|
6531
|
+
assertParamExists('listPackages', 'organizationName', organizationName)
|
|
6532
|
+
// verify required parameter 'projectName' is not null or undefined
|
|
6533
|
+
assertParamExists('listPackages', 'projectName', projectName)
|
|
6534
|
+
const localVarPath = `/organizations/{organizationName}/projects/{projectName}/packages`
|
|
6535
|
+
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)))
|
|
6536
|
+
.replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
|
|
5333
6537
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5334
6538
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5335
6539
|
let baseOptions;
|
|
@@ -5341,6 +6545,14 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5341
6545
|
const localVarHeaderParameter = {} as any;
|
|
5342
6546
|
const localVarQueryParameter = {} as any;
|
|
5343
6547
|
|
|
6548
|
+
if (limit !== undefined) {
|
|
6549
|
+
localVarQueryParameter['limit'] = limit;
|
|
6550
|
+
}
|
|
6551
|
+
|
|
6552
|
+
if (offset !== undefined) {
|
|
6553
|
+
localVarQueryParameter['offset'] = offset;
|
|
6554
|
+
}
|
|
6555
|
+
|
|
5344
6556
|
|
|
5345
6557
|
|
|
5346
6558
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5461,31 +6673,33 @@ export const PackagesApiFp = function(configuration?: Configuration) {
|
|
|
5461
6673
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5462
6674
|
},
|
|
5463
6675
|
/**
|
|
5464
|
-
*
|
|
5465
|
-
* @summary List packages
|
|
6676
|
+
* Returns a list of package resource identifiers under the given organization that the current user has access to. By default returns only packages the user can share (admin/modeler role). Set `onlyShareable=false` to include all readable packages (including viewer access). **Note**: This endpoint provides cross-project package visibility. It aggregates packages from all projects within the organization that the user has access to. **Authorization**: Requires read access to the organization. **Response**: Returns array of package resource identifiers.
|
|
6677
|
+
* @summary List accessible packages by organization
|
|
5466
6678
|
* @param {string} organizationName The unique identifier of the organization
|
|
5467
|
-
* @param {
|
|
6679
|
+
* @param {boolean} [onlyShareable] When true, returns only packages the user can share (admin/modeler). When false, returns all readable packages.
|
|
5468
6680
|
* @param {*} [options] Override http request option.
|
|
5469
6681
|
* @throws {RequiredError}
|
|
5470
6682
|
*/
|
|
5471
|
-
async
|
|
5472
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6683
|
+
async listOrganizationPackages(organizationName: string, onlyShareable?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
|
|
6684
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrganizationPackages(organizationName, onlyShareable, options);
|
|
5473
6685
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5474
|
-
const localVarOperationServerBasePath = operationServerMap['PackagesApi.
|
|
6686
|
+
const localVarOperationServerBasePath = operationServerMap['PackagesApi.listOrganizationPackages']?.[localVarOperationServerIndex]?.url;
|
|
5475
6687
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5476
6688
|
},
|
|
5477
6689
|
/**
|
|
5478
|
-
*
|
|
5479
|
-
* @summary List
|
|
6690
|
+
* Retrieves all packages within the specified project, including metadata such as names, descriptions, latest versions, and creation timestamps. **Authorization**: Requires read access to the project. **Response**: Returns array of package objects with full metadata. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
6691
|
+
* @summary List packages in project
|
|
5480
6692
|
* @param {string} organizationName The unique identifier of the organization
|
|
6693
|
+
* @param {string} projectName The unique identifier of the project
|
|
6694
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
6695
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
5481
6696
|
* @param {*} [options] Override http request option.
|
|
5482
|
-
* @deprecated
|
|
5483
6697
|
* @throws {RequiredError}
|
|
5484
6698
|
*/
|
|
5485
|
-
async
|
|
5486
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
6699
|
+
async listPackages(organizationName: string, projectName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Package>>> {
|
|
6700
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPackages(organizationName, projectName, limit, offset, options);
|
|
5487
6701
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5488
|
-
const localVarOperationServerBasePath = operationServerMap['PackagesApi.
|
|
6702
|
+
const localVarOperationServerBasePath = operationServerMap['PackagesApi.listPackages']?.[localVarOperationServerIndex]?.url;
|
|
5489
6703
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5490
6704
|
},
|
|
5491
6705
|
/**
|
|
@@ -5556,26 +6770,28 @@ export const PackagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
5556
6770
|
return localVarFp.getPackage(organizationName, projectName, packageName, checkAdmin, options).then((request) => request(axios, basePath));
|
|
5557
6771
|
},
|
|
5558
6772
|
/**
|
|
5559
|
-
*
|
|
5560
|
-
* @summary List packages
|
|
6773
|
+
* Returns a list of package resource identifiers under the given organization that the current user has access to. By default returns only packages the user can share (admin/modeler role). Set `onlyShareable=false` to include all readable packages (including viewer access). **Note**: This endpoint provides cross-project package visibility. It aggregates packages from all projects within the organization that the user has access to. **Authorization**: Requires read access to the organization. **Response**: Returns array of package resource identifiers.
|
|
6774
|
+
* @summary List accessible packages by organization
|
|
5561
6775
|
* @param {string} organizationName The unique identifier of the organization
|
|
5562
|
-
* @param {
|
|
6776
|
+
* @param {boolean} [onlyShareable] When true, returns only packages the user can share (admin/modeler). When false, returns all readable packages.
|
|
5563
6777
|
* @param {*} [options] Override http request option.
|
|
5564
6778
|
* @throws {RequiredError}
|
|
5565
6779
|
*/
|
|
5566
|
-
|
|
5567
|
-
return localVarFp.
|
|
6780
|
+
listOrganizationPackages(organizationName: string, onlyShareable?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
|
|
6781
|
+
return localVarFp.listOrganizationPackages(organizationName, onlyShareable, options).then((request) => request(axios, basePath));
|
|
5568
6782
|
},
|
|
5569
6783
|
/**
|
|
5570
|
-
*
|
|
5571
|
-
* @summary List
|
|
6784
|
+
* Retrieves all packages within the specified project, including metadata such as names, descriptions, latest versions, and creation timestamps. **Authorization**: Requires read access to the project. **Response**: Returns array of package objects with full metadata. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
6785
|
+
* @summary List packages in project
|
|
5572
6786
|
* @param {string} organizationName The unique identifier of the organization
|
|
6787
|
+
* @param {string} projectName The unique identifier of the project
|
|
6788
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
6789
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
5573
6790
|
* @param {*} [options] Override http request option.
|
|
5574
|
-
* @deprecated
|
|
5575
6791
|
* @throws {RequiredError}
|
|
5576
6792
|
*/
|
|
5577
|
-
|
|
5578
|
-
return localVarFp.
|
|
6793
|
+
listPackages(organizationName: string, projectName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Package>> {
|
|
6794
|
+
return localVarFp.listPackages(organizationName, projectName, limit, offset, options).then((request) => request(axios, basePath));
|
|
5579
6795
|
},
|
|
5580
6796
|
/**
|
|
5581
6797
|
* Updates the metadata and configuration of an existing package, including description, settings, and other package-level properties. **Authorization**: Requires package admin or modeler permissions. **Validation**: Updates are validated against package constraints and naming rules.
|
|
@@ -5648,29 +6864,31 @@ export class PackagesApi extends BaseAPI {
|
|
|
5648
6864
|
}
|
|
5649
6865
|
|
|
5650
6866
|
/**
|
|
5651
|
-
*
|
|
5652
|
-
* @summary List packages
|
|
6867
|
+
* Returns a list of package resource identifiers under the given organization that the current user has access to. By default returns only packages the user can share (admin/modeler role). Set `onlyShareable=false` to include all readable packages (including viewer access). **Note**: This endpoint provides cross-project package visibility. It aggregates packages from all projects within the organization that the user has access to. **Authorization**: Requires read access to the organization. **Response**: Returns array of package resource identifiers.
|
|
6868
|
+
* @summary List accessible packages by organization
|
|
5653
6869
|
* @param {string} organizationName The unique identifier of the organization
|
|
5654
|
-
* @param {
|
|
6870
|
+
* @param {boolean} [onlyShareable] When true, returns only packages the user can share (admin/modeler). When false, returns all readable packages.
|
|
5655
6871
|
* @param {*} [options] Override http request option.
|
|
5656
6872
|
* @throws {RequiredError}
|
|
5657
6873
|
* @memberof PackagesApi
|
|
5658
6874
|
*/
|
|
5659
|
-
public
|
|
5660
|
-
return PackagesApiFp(this.configuration).
|
|
6875
|
+
public listOrganizationPackages(organizationName: string, onlyShareable?: boolean, options?: RawAxiosRequestConfig) {
|
|
6876
|
+
return PackagesApiFp(this.configuration).listOrganizationPackages(organizationName, onlyShareable, options).then((request) => request(this.axios, this.basePath));
|
|
5661
6877
|
}
|
|
5662
6878
|
|
|
5663
6879
|
/**
|
|
5664
|
-
*
|
|
5665
|
-
* @summary List
|
|
6880
|
+
* Retrieves all packages within the specified project, including metadata such as names, descriptions, latest versions, and creation timestamps. **Authorization**: Requires read access to the project. **Response**: Returns array of package objects with full metadata. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
6881
|
+
* @summary List packages in project
|
|
5666
6882
|
* @param {string} organizationName The unique identifier of the organization
|
|
6883
|
+
* @param {string} projectName The unique identifier of the project
|
|
6884
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
6885
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
5667
6886
|
* @param {*} [options] Override http request option.
|
|
5668
|
-
* @deprecated
|
|
5669
6887
|
* @throws {RequiredError}
|
|
5670
6888
|
* @memberof PackagesApi
|
|
5671
6889
|
*/
|
|
5672
|
-
public
|
|
5673
|
-
return PackagesApiFp(this.configuration).
|
|
6890
|
+
public listPackages(organizationName: string, projectName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) {
|
|
6891
|
+
return PackagesApiFp(this.configuration).listPackages(organizationName, projectName, limit, offset, options).then((request) => request(this.axios, this.basePath));
|
|
5674
6892
|
}
|
|
5675
6893
|
|
|
5676
6894
|
/**
|
|
@@ -6397,13 +7615,15 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
6397
7615
|
};
|
|
6398
7616
|
},
|
|
6399
7617
|
/**
|
|
6400
|
-
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata.
|
|
7618
|
+
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
6401
7619
|
* @summary List projects in organization
|
|
6402
7620
|
* @param {string} organizationName The unique identifier of the organization
|
|
7621
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
7622
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
6403
7623
|
* @param {*} [options] Override http request option.
|
|
6404
7624
|
* @throws {RequiredError}
|
|
6405
7625
|
*/
|
|
6406
|
-
listProjects: async (organizationName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
7626
|
+
listProjects: async (organizationName: string, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6407
7627
|
// verify required parameter 'organizationName' is not null or undefined
|
|
6408
7628
|
assertParamExists('listProjects', 'organizationName', organizationName)
|
|
6409
7629
|
const localVarPath = `/organizations/{organizationName}/projects`
|
|
@@ -6419,6 +7639,14 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
6419
7639
|
const localVarHeaderParameter = {} as any;
|
|
6420
7640
|
const localVarQueryParameter = {} as any;
|
|
6421
7641
|
|
|
7642
|
+
if (limit !== undefined) {
|
|
7643
|
+
localVarQueryParameter['limit'] = limit;
|
|
7644
|
+
}
|
|
7645
|
+
|
|
7646
|
+
if (offset !== undefined) {
|
|
7647
|
+
localVarQueryParameter['offset'] = offset;
|
|
7648
|
+
}
|
|
7649
|
+
|
|
6422
7650
|
|
|
6423
7651
|
|
|
6424
7652
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6528,14 +7756,16 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
6528
7756
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6529
7757
|
},
|
|
6530
7758
|
/**
|
|
6531
|
-
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata.
|
|
7759
|
+
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
6532
7760
|
* @summary List projects in organization
|
|
6533
7761
|
* @param {string} organizationName The unique identifier of the organization
|
|
7762
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
7763
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
6534
7764
|
* @param {*} [options] Override http request option.
|
|
6535
7765
|
* @throws {RequiredError}
|
|
6536
7766
|
*/
|
|
6537
|
-
async listProjects(organizationName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Project>>> {
|
|
6538
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listProjects(organizationName, options);
|
|
7767
|
+
async listProjects(organizationName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Project>>> {
|
|
7768
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProjects(organizationName, limit, offset, options);
|
|
6539
7769
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6540
7770
|
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.listProjects']?.[localVarOperationServerIndex]?.url;
|
|
6541
7771
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -6600,14 +7830,16 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
6600
7830
|
return localVarFp.getProject(organizationName, projectName, checkAdmin, options).then((request) => request(axios, basePath));
|
|
6601
7831
|
},
|
|
6602
7832
|
/**
|
|
6603
|
-
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata.
|
|
7833
|
+
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
6604
7834
|
* @summary List projects in organization
|
|
6605
7835
|
* @param {string} organizationName The unique identifier of the organization
|
|
7836
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
7837
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
6606
7838
|
* @param {*} [options] Override http request option.
|
|
6607
7839
|
* @throws {RequiredError}
|
|
6608
7840
|
*/
|
|
6609
|
-
listProjects(organizationName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Project>> {
|
|
6610
|
-
return localVarFp.listProjects(organizationName, options).then((request) => request(axios, basePath));
|
|
7841
|
+
listProjects(organizationName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<Project>> {
|
|
7842
|
+
return localVarFp.listProjects(organizationName, limit, offset, options).then((request) => request(axios, basePath));
|
|
6611
7843
|
},
|
|
6612
7844
|
/**
|
|
6613
7845
|
* Partially updates a project\'s details. Only the provided fields will be updated. This operation allows for selective updates without requiring all project fields. **Authorization**: Requires project admin permissions. **Validation**: All provided fields are validated according to their schema constraints. **Side Effects**: Updates the project\'s `updatedAt` timestamp.
|
|
@@ -6672,15 +7904,17 @@ export class ProjectsApi extends BaseAPI {
|
|
|
6672
7904
|
}
|
|
6673
7905
|
|
|
6674
7906
|
/**
|
|
6675
|
-
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata.
|
|
7907
|
+
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata. **Pagination**: Supports offset-based pagination with limit and offset parameters.
|
|
6676
7908
|
* @summary List projects in organization
|
|
6677
7909
|
* @param {string} organizationName The unique identifier of the organization
|
|
7910
|
+
* @param {number} [limit] Maximum number of items to return. Use -1 or omit to return all results. Valid values: -1 (all results) or 1–100.
|
|
7911
|
+
* @param {number} [offset] Number of items to skip before starting to return results
|
|
6678
7912
|
* @param {*} [options] Override http request option.
|
|
6679
7913
|
* @throws {RequiredError}
|
|
6680
7914
|
* @memberof ProjectsApi
|
|
6681
7915
|
*/
|
|
6682
|
-
public listProjects(organizationName: string, options?: RawAxiosRequestConfig) {
|
|
6683
|
-
return ProjectsApiFp(this.configuration).listProjects(organizationName, options).then((request) => request(this.axios, this.basePath));
|
|
7916
|
+
public listProjects(organizationName: string, limit?: number, offset?: number, options?: RawAxiosRequestConfig) {
|
|
7917
|
+
return ProjectsApiFp(this.configuration).listProjects(organizationName, limit, offset, options).then((request) => request(this.axios, this.basePath));
|
|
6684
7918
|
}
|
|
6685
7919
|
|
|
6686
7920
|
/**
|
|
@@ -8060,6 +9294,40 @@ export const WorkspacesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
8060
9294
|
|
|
8061
9295
|
|
|
8062
9296
|
|
|
9297
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9298
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9299
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
9300
|
+
|
|
9301
|
+
return {
|
|
9302
|
+
url: toPathString(localVarUrlObj),
|
|
9303
|
+
options: localVarRequestOptions,
|
|
9304
|
+
};
|
|
9305
|
+
},
|
|
9306
|
+
/**
|
|
9307
|
+
* Gets or creates a personal workspace for the current user. This workspace is private and only the user has permissions to read and write documents in it. **Authorization**: Requires only organization member permissions. The user does not need \'can_create_workspace\' permission as personal workspaces are automatically provisioned. **Features**: Personal workspace for storing user-specific documents like chat histories.
|
|
9308
|
+
* @summary Get or create personal workspace
|
|
9309
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
9310
|
+
* @param {*} [options] Override http request option.
|
|
9311
|
+
* @throws {RequiredError}
|
|
9312
|
+
*/
|
|
9313
|
+
getOrCreatePersonalWorkspace: async (organizationName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
9314
|
+
// verify required parameter 'organizationName' is not null or undefined
|
|
9315
|
+
assertParamExists('getOrCreatePersonalWorkspace', 'organizationName', organizationName)
|
|
9316
|
+
const localVarPath = `/organizations/{organizationName}/workspaces/personal`
|
|
9317
|
+
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)));
|
|
9318
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9319
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9320
|
+
let baseOptions;
|
|
9321
|
+
if (configuration) {
|
|
9322
|
+
baseOptions = configuration.baseOptions;
|
|
9323
|
+
}
|
|
9324
|
+
|
|
9325
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
9326
|
+
const localVarHeaderParameter = {} as any;
|
|
9327
|
+
const localVarQueryParameter = {} as any;
|
|
9328
|
+
|
|
9329
|
+
|
|
9330
|
+
|
|
8063
9331
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8064
9332
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8065
9333
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -8233,6 +9501,19 @@ export const WorkspacesApiFp = function(configuration?: Configuration) {
|
|
|
8233
9501
|
const localVarOperationServerBasePath = operationServerMap['WorkspacesApi.deleteWorkspace']?.[localVarOperationServerIndex]?.url;
|
|
8234
9502
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8235
9503
|
},
|
|
9504
|
+
/**
|
|
9505
|
+
* Gets or creates a personal workspace for the current user. This workspace is private and only the user has permissions to read and write documents in it. **Authorization**: Requires only organization member permissions. The user does not need \'can_create_workspace\' permission as personal workspaces are automatically provisioned. **Features**: Personal workspace for storing user-specific documents like chat histories.
|
|
9506
|
+
* @summary Get or create personal workspace
|
|
9507
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
9508
|
+
* @param {*} [options] Override http request option.
|
|
9509
|
+
* @throws {RequiredError}
|
|
9510
|
+
*/
|
|
9511
|
+
async getOrCreatePersonalWorkspace(organizationName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Workspace>> {
|
|
9512
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrCreatePersonalWorkspace(organizationName, options);
|
|
9513
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9514
|
+
const localVarOperationServerBasePath = operationServerMap['WorkspacesApi.getOrCreatePersonalWorkspace']?.[localVarOperationServerIndex]?.url;
|
|
9515
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9516
|
+
},
|
|
8236
9517
|
/**
|
|
8237
9518
|
* Retrieves detailed information about a specific workspace, including its metadata, associated packages, and configuration settings.
|
|
8238
9519
|
* @summary Get workspace details
|
|
@@ -8309,6 +9590,16 @@ export const WorkspacesApiFactory = function (configuration?: Configuration, bas
|
|
|
8309
9590
|
deleteWorkspace(organizationName: string, workspaceName: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
8310
9591
|
return localVarFp.deleteWorkspace(organizationName, workspaceName, options).then((request) => request(axios, basePath));
|
|
8311
9592
|
},
|
|
9593
|
+
/**
|
|
9594
|
+
* Gets or creates a personal workspace for the current user. This workspace is private and only the user has permissions to read and write documents in it. **Authorization**: Requires only organization member permissions. The user does not need \'can_create_workspace\' permission as personal workspaces are automatically provisioned. **Features**: Personal workspace for storing user-specific documents like chat histories.
|
|
9595
|
+
* @summary Get or create personal workspace
|
|
9596
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
9597
|
+
* @param {*} [options] Override http request option.
|
|
9598
|
+
* @throws {RequiredError}
|
|
9599
|
+
*/
|
|
9600
|
+
getOrCreatePersonalWorkspace(organizationName: string, options?: RawAxiosRequestConfig): AxiosPromise<Workspace> {
|
|
9601
|
+
return localVarFp.getOrCreatePersonalWorkspace(organizationName, options).then((request) => request(axios, basePath));
|
|
9602
|
+
},
|
|
8312
9603
|
/**
|
|
8313
9604
|
* Retrieves detailed information about a specific workspace, including its metadata, associated packages, and configuration settings.
|
|
8314
9605
|
* @summary Get workspace details
|
|
@@ -8380,6 +9671,18 @@ export class WorkspacesApi extends BaseAPI {
|
|
|
8380
9671
|
return WorkspacesApiFp(this.configuration).deleteWorkspace(organizationName, workspaceName, options).then((request) => request(this.axios, this.basePath));
|
|
8381
9672
|
}
|
|
8382
9673
|
|
|
9674
|
+
/**
|
|
9675
|
+
* Gets or creates a personal workspace for the current user. This workspace is private and only the user has permissions to read and write documents in it. **Authorization**: Requires only organization member permissions. The user does not need \'can_create_workspace\' permission as personal workspaces are automatically provisioned. **Features**: Personal workspace for storing user-specific documents like chat histories.
|
|
9676
|
+
* @summary Get or create personal workspace
|
|
9677
|
+
* @param {string} organizationName The unique identifier of the organization
|
|
9678
|
+
* @param {*} [options] Override http request option.
|
|
9679
|
+
* @throws {RequiredError}
|
|
9680
|
+
* @memberof WorkspacesApi
|
|
9681
|
+
*/
|
|
9682
|
+
public getOrCreatePersonalWorkspace(organizationName: string, options?: RawAxiosRequestConfig) {
|
|
9683
|
+
return WorkspacesApiFp(this.configuration).getOrCreatePersonalWorkspace(organizationName, options).then((request) => request(this.axios, this.basePath));
|
|
9684
|
+
}
|
|
9685
|
+
|
|
8383
9686
|
/**
|
|
8384
9687
|
* Retrieves detailed information about a specific workspace, including its metadata, associated packages, and configuration settings.
|
|
8385
9688
|
* @summary Get workspace details
|