@credibledata/cred-cli 0.1.4 → 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 +796 -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 +3 -0
- package/package.json +24 -16
- package/src/client/.openapi-generator/FILES +1 -0
- package/src/client/api.ts +1347 -161
- 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
|
|
@@ -108,18 +160,42 @@ export interface Connection {
|
|
|
108
160
|
* @memberof Connection
|
|
109
161
|
*/
|
|
110
162
|
'motherduckConnection'?: ConnectionMotherduckConnection;
|
|
163
|
+
/**
|
|
164
|
+
*
|
|
165
|
+
* @type {ConnectionAllOfDucklakeConnection}
|
|
166
|
+
* @memberof Connection
|
|
167
|
+
*/
|
|
168
|
+
'ducklakeConnection'?: ConnectionAllOfDucklakeConnection;
|
|
111
169
|
/**
|
|
112
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.
|
|
113
171
|
* @type {Array<string>}
|
|
114
172
|
* @memberof Connection
|
|
115
173
|
*/
|
|
116
174
|
'includeTables'?: Array<string>;
|
|
175
|
+
/**
|
|
176
|
+
* Whether to exclude all tables.
|
|
177
|
+
* @type {boolean}
|
|
178
|
+
* @memberof Connection
|
|
179
|
+
*/
|
|
180
|
+
'excludeAllTables'?: boolean;
|
|
117
181
|
/**
|
|
118
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.
|
|
119
183
|
* @type {Array<string>}
|
|
120
184
|
* @memberof Connection
|
|
121
185
|
*/
|
|
122
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;
|
|
123
199
|
}
|
|
124
200
|
|
|
125
201
|
export const ConnectionTypeEnum = {
|
|
@@ -129,10 +205,21 @@ export const ConnectionTypeEnum = {
|
|
|
129
205
|
Trino: 'trino',
|
|
130
206
|
Mysql: 'mysql',
|
|
131
207
|
Duckdb: 'duckdb',
|
|
132
|
-
Motherduck: 'motherduck'
|
|
208
|
+
Motherduck: 'motherduck',
|
|
209
|
+
Ducklake: 'ducklake'
|
|
133
210
|
} as const;
|
|
134
211
|
|
|
135
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];
|
|
136
223
|
|
|
137
224
|
/**
|
|
138
225
|
* Attached DuckDB database
|
|
@@ -172,20 +259,254 @@ export interface ConnectionAllOfDuckdbConnectionAttachedDatabases {
|
|
|
172
259
|
'snowflakeConnection'?: ConnectionSnowflakeConnection;
|
|
173
260
|
/**
|
|
174
261
|
*
|
|
175
|
-
* @type {
|
|
262
|
+
* @type {ConnectionAllOfDuckdbConnectionPostgresConnection}
|
|
176
263
|
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
177
264
|
*/
|
|
178
|
-
'postgresConnection'?:
|
|
265
|
+
'postgresConnection'?: ConnectionAllOfDuckdbConnectionPostgresConnection;
|
|
266
|
+
/**
|
|
267
|
+
*
|
|
268
|
+
* @type {ConnectionGcsConnection}
|
|
269
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
270
|
+
*/
|
|
271
|
+
'gcsConnection'?: ConnectionGcsConnection;
|
|
272
|
+
/**
|
|
273
|
+
*
|
|
274
|
+
* @type {ConnectionS3Connection}
|
|
275
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
276
|
+
*/
|
|
277
|
+
's3Connection'?: ConnectionS3Connection;
|
|
278
|
+
/**
|
|
279
|
+
*
|
|
280
|
+
* @type {ConnectionAllOfDuckdbConnectionAzureConnection}
|
|
281
|
+
* @memberof ConnectionAllOfDuckdbConnectionAttachedDatabases
|
|
282
|
+
*/
|
|
283
|
+
'azureConnection'?: ConnectionAllOfDuckdbConnectionAzureConnection;
|
|
179
284
|
}
|
|
180
285
|
|
|
181
286
|
export const ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum = {
|
|
182
287
|
Bigquery: 'bigquery',
|
|
183
288
|
Snowflake: 'snowflake',
|
|
184
|
-
Postgres: 'postgres'
|
|
289
|
+
Postgres: 'postgres',
|
|
290
|
+
Gcs: 'gcs',
|
|
291
|
+
S3: 's3',
|
|
292
|
+
Azure: 'azure'
|
|
185
293
|
} as const;
|
|
186
294
|
|
|
187
295
|
export type ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum = typeof ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum[keyof typeof ConnectionAllOfDuckdbConnectionAttachedDatabasesTypeEnum];
|
|
188
296
|
|
|
297
|
+
/**
|
|
298
|
+
* Azure Data Lake Storage (ADLS Gen2) / Blob Storage connection configuration Supports https://, http://, abfss://, and az:// URL schemes.
|
|
299
|
+
* @export
|
|
300
|
+
* @interface ConnectionAllOfDuckdbConnectionAzureConnection
|
|
301
|
+
*/
|
|
302
|
+
export interface ConnectionAllOfDuckdbConnectionAzureConnection {
|
|
303
|
+
/**
|
|
304
|
+
* Authentication method for Azure Storage
|
|
305
|
+
* @type {string}
|
|
306
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
307
|
+
*/
|
|
308
|
+
'authType': ConnectionAllOfDuckdbConnectionAzureConnectionAuthTypeEnum;
|
|
309
|
+
/**
|
|
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
|
|
313
|
+
*/
|
|
314
|
+
'sasUrl'?: string;
|
|
315
|
+
/**
|
|
316
|
+
* Azure AD tenant ID (required for service_principal)
|
|
317
|
+
* @type {string}
|
|
318
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
319
|
+
*/
|
|
320
|
+
'tenantId'?: string;
|
|
321
|
+
/**
|
|
322
|
+
* Azure AD application (client) ID (required for service_principal)
|
|
323
|
+
* @type {string}
|
|
324
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
325
|
+
*/
|
|
326
|
+
'clientId'?: string;
|
|
327
|
+
/**
|
|
328
|
+
* Azure AD client secret (required for service_principal)
|
|
329
|
+
* @type {string}
|
|
330
|
+
* @memberof ConnectionAllOfDuckdbConnectionAzureConnection
|
|
331
|
+
*/
|
|
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;
|
|
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
|
+
|
|
354
|
+
/**
|
|
355
|
+
* PostgreSQL database connection configuration
|
|
356
|
+
* @export
|
|
357
|
+
* @interface ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
358
|
+
*/
|
|
359
|
+
export interface ConnectionAllOfDuckdbConnectionPostgresConnection {
|
|
360
|
+
/**
|
|
361
|
+
* PostgreSQL server hostname or IP address
|
|
362
|
+
* @type {string}
|
|
363
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
364
|
+
*/
|
|
365
|
+
'host'?: string;
|
|
366
|
+
/**
|
|
367
|
+
* PostgreSQL server port number
|
|
368
|
+
* @type {number}
|
|
369
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
370
|
+
*/
|
|
371
|
+
'port'?: number;
|
|
372
|
+
/**
|
|
373
|
+
* Name of the PostgreSQL database
|
|
374
|
+
* @type {string}
|
|
375
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
376
|
+
*/
|
|
377
|
+
'databaseName'?: string;
|
|
378
|
+
/**
|
|
379
|
+
* PostgreSQL username for authentication
|
|
380
|
+
* @type {string}
|
|
381
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
382
|
+
*/
|
|
383
|
+
'userName'?: string;
|
|
384
|
+
/**
|
|
385
|
+
* PostgreSQL password for authentication
|
|
386
|
+
* @type {string}
|
|
387
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
388
|
+
*/
|
|
389
|
+
'password'?: string;
|
|
390
|
+
/**
|
|
391
|
+
* Complete PostgreSQL connection string (alternative to individual parameters)
|
|
392
|
+
* @type {string}
|
|
393
|
+
* @memberof ConnectionAllOfDuckdbConnectionPostgresConnection
|
|
394
|
+
*/
|
|
395
|
+
'connectionString'?: string;
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* DuckLake lakehouse connection configuration
|
|
399
|
+
* @export
|
|
400
|
+
* @interface ConnectionAllOfDucklakeConnection
|
|
401
|
+
*/
|
|
402
|
+
export interface ConnectionAllOfDucklakeConnection {
|
|
403
|
+
/**
|
|
404
|
+
*
|
|
405
|
+
* @type {ConnectionAllOfDucklakeConnectionStorage}
|
|
406
|
+
* @memberof ConnectionAllOfDucklakeConnection
|
|
407
|
+
*/
|
|
408
|
+
'storage': ConnectionAllOfDucklakeConnectionStorage;
|
|
409
|
+
/**
|
|
410
|
+
*
|
|
411
|
+
* @type {ConnectionAllOfDucklakeConnectionCatalog}
|
|
412
|
+
* @memberof ConnectionAllOfDucklakeConnection
|
|
413
|
+
*/
|
|
414
|
+
'catalog': ConnectionAllOfDucklakeConnectionCatalog;
|
|
415
|
+
}
|
|
416
|
+
/**
|
|
417
|
+
* Catalog metadata connection configuration
|
|
418
|
+
* @export
|
|
419
|
+
* @interface ConnectionAllOfDucklakeConnectionCatalog
|
|
420
|
+
*/
|
|
421
|
+
export interface ConnectionAllOfDucklakeConnectionCatalog {
|
|
422
|
+
/**
|
|
423
|
+
*
|
|
424
|
+
* @type {ConnectionPostgresConnection}
|
|
425
|
+
* @memberof ConnectionAllOfDucklakeConnectionCatalog
|
|
426
|
+
*/
|
|
427
|
+
'postgresConnection': ConnectionPostgresConnection;
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
430
|
+
* Data storage connection configuration (S3 or GCS)
|
|
431
|
+
* @export
|
|
432
|
+
* @interface ConnectionAllOfDucklakeConnectionStorage
|
|
433
|
+
*/
|
|
434
|
+
export interface ConnectionAllOfDucklakeConnectionStorage {
|
|
435
|
+
/**
|
|
436
|
+
* URL of the storage bucket (e.g. s3://my-bucket/path or gs://my-bucket/path)
|
|
437
|
+
* @type {string}
|
|
438
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorage
|
|
439
|
+
*/
|
|
440
|
+
'bucketUrl': string;
|
|
441
|
+
/**
|
|
442
|
+
*
|
|
443
|
+
* @type {ConnectionAllOfDucklakeConnectionStorageS3Connection}
|
|
444
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorage
|
|
445
|
+
*/
|
|
446
|
+
's3Connection'?: ConnectionAllOfDucklakeConnectionStorageS3Connection;
|
|
447
|
+
/**
|
|
448
|
+
*
|
|
449
|
+
* @type {ConnectionAllOfDucklakeConnectionStorageGcsConnection}
|
|
450
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorage
|
|
451
|
+
*/
|
|
452
|
+
'gcsConnection'?: ConnectionAllOfDucklakeConnectionStorageGcsConnection;
|
|
453
|
+
}
|
|
454
|
+
/**
|
|
455
|
+
* Google Cloud Storage connection configuration for data storage
|
|
456
|
+
* @export
|
|
457
|
+
* @interface ConnectionAllOfDucklakeConnectionStorageGcsConnection
|
|
458
|
+
*/
|
|
459
|
+
export interface ConnectionAllOfDucklakeConnectionStorageGcsConnection {
|
|
460
|
+
/**
|
|
461
|
+
* GCS HMAC access key ID
|
|
462
|
+
* @type {string}
|
|
463
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageGcsConnection
|
|
464
|
+
*/
|
|
465
|
+
'keyId': string;
|
|
466
|
+
/**
|
|
467
|
+
* GCS HMAC secret key
|
|
468
|
+
* @type {string}
|
|
469
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageGcsConnection
|
|
470
|
+
*/
|
|
471
|
+
'secret': string;
|
|
472
|
+
}
|
|
473
|
+
/**
|
|
474
|
+
* AWS S3 connection configuration for data storage
|
|
475
|
+
* @export
|
|
476
|
+
* @interface ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
477
|
+
*/
|
|
478
|
+
export interface ConnectionAllOfDucklakeConnectionStorageS3Connection {
|
|
479
|
+
/**
|
|
480
|
+
* AWS access key ID
|
|
481
|
+
* @type {string}
|
|
482
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
483
|
+
*/
|
|
484
|
+
'accessKeyId': string;
|
|
485
|
+
/**
|
|
486
|
+
* AWS secret access key
|
|
487
|
+
* @type {string}
|
|
488
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
489
|
+
*/
|
|
490
|
+
'secretAccessKey': string;
|
|
491
|
+
/**
|
|
492
|
+
* AWS region (e.g., us-east-1)
|
|
493
|
+
* @type {string}
|
|
494
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
495
|
+
*/
|
|
496
|
+
'region'?: string;
|
|
497
|
+
/**
|
|
498
|
+
* Custom S3-compatible endpoint URL (optional, for MinIO, etc.)
|
|
499
|
+
* @type {string}
|
|
500
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
501
|
+
*/
|
|
502
|
+
'endpoint'?: string;
|
|
503
|
+
/**
|
|
504
|
+
* AWS session token for temporary credentials (optional)
|
|
505
|
+
* @type {string}
|
|
506
|
+
* @memberof ConnectionAllOfDucklakeConnectionStorageS3Connection
|
|
507
|
+
*/
|
|
508
|
+
'sessionToken'?: string;
|
|
509
|
+
}
|
|
189
510
|
/**
|
|
190
511
|
* Connection capabilities and configuration attributes
|
|
191
512
|
* @export
|
|
@@ -273,6 +594,25 @@ export interface ConnectionDuckdbConnection {
|
|
|
273
594
|
*/
|
|
274
595
|
'attachedDatabases'?: Array<ConnectionAllOfDuckdbConnectionAttachedDatabases>;
|
|
275
596
|
}
|
|
597
|
+
/**
|
|
598
|
+
* Google Cloud Storage connection configuration for DuckDB
|
|
599
|
+
* @export
|
|
600
|
+
* @interface ConnectionGcsConnection
|
|
601
|
+
*/
|
|
602
|
+
export interface ConnectionGcsConnection {
|
|
603
|
+
/**
|
|
604
|
+
* GCS HMAC access key ID
|
|
605
|
+
* @type {string}
|
|
606
|
+
* @memberof ConnectionGcsConnection
|
|
607
|
+
*/
|
|
608
|
+
'keyId': string;
|
|
609
|
+
/**
|
|
610
|
+
* GCS HMAC secret key
|
|
611
|
+
* @type {string}
|
|
612
|
+
* @memberof ConnectionGcsConnection
|
|
613
|
+
*/
|
|
614
|
+
'secret': string;
|
|
615
|
+
}
|
|
276
616
|
/**
|
|
277
617
|
* MotherDuck database connection configuration
|
|
278
618
|
* @export
|
|
@@ -330,7 +670,7 @@ export interface ConnectionMysqlConnection {
|
|
|
330
670
|
'password'?: string;
|
|
331
671
|
}
|
|
332
672
|
/**
|
|
333
|
-
* PostgreSQL
|
|
673
|
+
* PostgreSQL connection for DuckLake metadata catalog
|
|
334
674
|
* @export
|
|
335
675
|
* @interface ConnectionPostgresConnection
|
|
336
676
|
*/
|
|
@@ -372,6 +712,43 @@ export interface ConnectionPostgresConnection {
|
|
|
372
712
|
*/
|
|
373
713
|
'connectionString'?: string;
|
|
374
714
|
}
|
|
715
|
+
/**
|
|
716
|
+
* AWS S3 connection configuration for DuckDB
|
|
717
|
+
* @export
|
|
718
|
+
* @interface ConnectionS3Connection
|
|
719
|
+
*/
|
|
720
|
+
export interface ConnectionS3Connection {
|
|
721
|
+
/**
|
|
722
|
+
* AWS access key ID
|
|
723
|
+
* @type {string}
|
|
724
|
+
* @memberof ConnectionS3Connection
|
|
725
|
+
*/
|
|
726
|
+
'accessKeyId': string;
|
|
727
|
+
/**
|
|
728
|
+
* AWS secret access key
|
|
729
|
+
* @type {string}
|
|
730
|
+
* @memberof ConnectionS3Connection
|
|
731
|
+
*/
|
|
732
|
+
'secretAccessKey': string;
|
|
733
|
+
/**
|
|
734
|
+
* AWS region (e.g., us-east-1)
|
|
735
|
+
* @type {string}
|
|
736
|
+
* @memberof ConnectionS3Connection
|
|
737
|
+
*/
|
|
738
|
+
'region'?: string;
|
|
739
|
+
/**
|
|
740
|
+
* Custom S3-compatible endpoint URL (optional, for MinIO, etc.)
|
|
741
|
+
* @type {string}
|
|
742
|
+
* @memberof ConnectionS3Connection
|
|
743
|
+
*/
|
|
744
|
+
'endpoint'?: string;
|
|
745
|
+
/**
|
|
746
|
+
* AWS session token for temporary credentials (optional)
|
|
747
|
+
* @type {string}
|
|
748
|
+
* @memberof ConnectionS3Connection
|
|
749
|
+
*/
|
|
750
|
+
'sessionToken'?: string;
|
|
751
|
+
}
|
|
375
752
|
/**
|
|
376
753
|
* Snowflake database connection configuration
|
|
377
754
|
* @export
|
|
@@ -524,11 +901,29 @@ export interface Document {
|
|
|
524
901
|
* @memberof Document
|
|
525
902
|
*/
|
|
526
903
|
'updatedAt'?: string;
|
|
904
|
+
/**
|
|
905
|
+
* The userId of the user who last modified this document
|
|
906
|
+
* @type {string}
|
|
907
|
+
* @memberof Document
|
|
908
|
+
*/
|
|
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;
|
|
527
916
|
}
|
|
528
917
|
|
|
529
918
|
export const DocumentTypeEnum = {
|
|
530
919
|
Workbook: 'workbook',
|
|
531
|
-
Dashboard: 'dashboard'
|
|
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'
|
|
532
927
|
} as const;
|
|
533
928
|
|
|
534
929
|
export type DocumentTypeEnum = typeof DocumentTypeEnum[keyof typeof DocumentTypeEnum];
|
|
@@ -604,52 +999,98 @@ export interface GetGroupMembersResponse {
|
|
|
604
999
|
'members'?: Array<GroupMember>;
|
|
605
1000
|
}
|
|
606
1001
|
/**
|
|
607
|
-
*
|
|
1002
|
+
*
|
|
608
1003
|
* @export
|
|
609
|
-
* @interface
|
|
1004
|
+
* @interface GetOrganizationResponse
|
|
610
1005
|
*/
|
|
611
|
-
export interface
|
|
612
|
-
/**
|
|
613
|
-
* Standard identifier pattern for resource names
|
|
614
|
-
* @type {string}
|
|
615
|
-
* @memberof Group
|
|
616
|
-
*/
|
|
617
|
-
'organizationName'?: string;
|
|
1006
|
+
export interface GetOrganizationResponse {
|
|
618
1007
|
/**
|
|
619
1008
|
* Standard identifier pattern for resource names
|
|
620
1009
|
* @type {string}
|
|
621
|
-
* @memberof
|
|
1010
|
+
* @memberof GetOrganizationResponse
|
|
622
1011
|
*/
|
|
623
|
-
'
|
|
1012
|
+
'name'?: string;
|
|
624
1013
|
/**
|
|
625
|
-
* Human-readable
|
|
1014
|
+
* Human-readable name for the organization, displayed in user interfaces
|
|
626
1015
|
* @type {string}
|
|
627
|
-
* @memberof
|
|
1016
|
+
* @memberof GetOrganizationResponse
|
|
628
1017
|
*/
|
|
629
|
-
'
|
|
1018
|
+
'displayName'?: string;
|
|
630
1019
|
/**
|
|
631
|
-
* ISO 8601 timestamp indicating when the
|
|
1020
|
+
* ISO 8601 timestamp indicating when the organization was created
|
|
632
1021
|
* @type {string}
|
|
633
|
-
* @memberof
|
|
1022
|
+
* @memberof GetOrganizationResponse
|
|
634
1023
|
*/
|
|
635
1024
|
'createdAt'?: string;
|
|
636
1025
|
/**
|
|
637
|
-
* ISO 8601 timestamp indicating when the
|
|
1026
|
+
* ISO 8601 timestamp indicating when the organization was last modified
|
|
638
1027
|
* @type {string}
|
|
639
|
-
* @memberof
|
|
1028
|
+
* @memberof GetOrganizationResponse
|
|
640
1029
|
*/
|
|
641
1030
|
'updatedAt'?: string;
|
|
642
|
-
}
|
|
643
|
-
/**
|
|
644
|
-
* Represents an access token/key for a service account
|
|
645
|
-
* @export
|
|
646
|
-
* @interface GroupAccessToken
|
|
647
|
-
*/
|
|
648
|
-
export interface GroupAccessToken {
|
|
649
1031
|
/**
|
|
650
|
-
*
|
|
1032
|
+
* The current authenticated user\'s permission level within this organization
|
|
651
1033
|
* @type {string}
|
|
652
|
-
* @memberof
|
|
1034
|
+
* @memberof GetOrganizationResponse
|
|
1035
|
+
*/
|
|
1036
|
+
'userPermission'?: GetOrganizationResponseUserPermissionEnum;
|
|
1037
|
+
}
|
|
1038
|
+
|
|
1039
|
+
export const GetOrganizationResponseUserPermissionEnum = {
|
|
1040
|
+
Admin: 'admin',
|
|
1041
|
+
Modeler: 'modeler',
|
|
1042
|
+
Member: 'member'
|
|
1043
|
+
} as const;
|
|
1044
|
+
|
|
1045
|
+
export type GetOrganizationResponseUserPermissionEnum = typeof GetOrganizationResponseUserPermissionEnum[keyof typeof GetOrganizationResponseUserPermissionEnum];
|
|
1046
|
+
|
|
1047
|
+
/**
|
|
1048
|
+
* Represents a user group for organizing users and managing group-based permissions
|
|
1049
|
+
* @export
|
|
1050
|
+
* @interface Group
|
|
1051
|
+
*/
|
|
1052
|
+
export interface Group {
|
|
1053
|
+
/**
|
|
1054
|
+
* Standard identifier pattern for resource names
|
|
1055
|
+
* @type {string}
|
|
1056
|
+
* @memberof Group
|
|
1057
|
+
*/
|
|
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
|
|
1086
|
+
* @export
|
|
1087
|
+
* @interface GroupAccessToken
|
|
1088
|
+
*/
|
|
1089
|
+
export interface GroupAccessToken {
|
|
1090
|
+
/**
|
|
1091
|
+
* Standard identifier pattern for resource names
|
|
1092
|
+
* @type {string}
|
|
1093
|
+
* @memberof GroupAccessToken
|
|
653
1094
|
*/
|
|
654
1095
|
'name'?: string;
|
|
655
1096
|
/**
|
|
@@ -710,6 +1151,23 @@ export const GroupMemberStatusEnum = {
|
|
|
710
1151
|
|
|
711
1152
|
export type GroupMemberStatusEnum = typeof GroupMemberStatusEnum[keyof typeof GroupMemberStatusEnum];
|
|
712
1153
|
|
|
1154
|
+
/**
|
|
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).
|
|
1156
|
+
* @export
|
|
1157
|
+
* @enum {string}
|
|
1158
|
+
*/
|
|
1159
|
+
|
|
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
|
+
|
|
713
1171
|
/**
|
|
714
1172
|
* Standard error response format used across all API endpoints
|
|
715
1173
|
* @export
|
|
@@ -843,18 +1301,26 @@ export interface Package {
|
|
|
843
1301
|
*/
|
|
844
1302
|
'updatedAt'?: string;
|
|
845
1303
|
/**
|
|
846
|
-
* Number of replicas for high availability and performance
|
|
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.
|
|
847
1305
|
* @type {number}
|
|
848
1306
|
* @memberof Package
|
|
849
1307
|
*/
|
|
850
1308
|
'replicationCount'?: number;
|
|
851
1309
|
/**
|
|
852
|
-
*
|
|
1310
|
+
* Resource identifier pattern supporting slashes, dots, dashes, and colons
|
|
853
1311
|
* @type {string}
|
|
854
1312
|
* @memberof Package
|
|
855
1313
|
*/
|
|
856
1314
|
'resourceIdentifier'?: string;
|
|
1315
|
+
/**
|
|
1316
|
+
*
|
|
1317
|
+
* @type {IndexStatus}
|
|
1318
|
+
* @memberof Package
|
|
1319
|
+
*/
|
|
1320
|
+
'indexStatus'?: IndexStatus;
|
|
857
1321
|
}
|
|
1322
|
+
|
|
1323
|
+
|
|
858
1324
|
/**
|
|
859
1325
|
* Represents a permission assignment for a user, group, or workspace within a package
|
|
860
1326
|
* @export
|
|
@@ -951,7 +1417,7 @@ export interface Project {
|
|
|
951
1417
|
*/
|
|
952
1418
|
'updatedAt'?: string;
|
|
953
1419
|
/**
|
|
954
|
-
* Number of replicas for high availability and performance
|
|
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.
|
|
955
1421
|
* @type {number}
|
|
956
1422
|
* @memberof Project
|
|
957
1423
|
*/
|
|
@@ -1201,6 +1667,18 @@ export interface Version {
|
|
|
1201
1667
|
* @memberof Version
|
|
1202
1668
|
*/
|
|
1203
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;
|
|
1204
1682
|
}
|
|
1205
1683
|
|
|
1206
1684
|
export const VersionArchiveStatusEnum = {
|
|
@@ -1211,6 +1689,25 @@ export const VersionArchiveStatusEnum = {
|
|
|
1211
1689
|
|
|
1212
1690
|
export type VersionArchiveStatusEnum = typeof VersionArchiveStatusEnum[keyof typeof VersionArchiveStatusEnum];
|
|
1213
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
|
+
}
|
|
1214
1711
|
/**
|
|
1215
1712
|
* Represents a collaborative workspace for team-based data modeling and analysis
|
|
1216
1713
|
* @export
|
|
@@ -1218,7 +1715,7 @@ export type VersionArchiveStatusEnum = typeof VersionArchiveStatusEnum[keyof typ
|
|
|
1218
1715
|
*/
|
|
1219
1716
|
export interface Workspace {
|
|
1220
1717
|
/**
|
|
1221
|
-
*
|
|
1718
|
+
* Workspace name pattern - allows any characters, 1-63 chars (matches controlplane validation)
|
|
1222
1719
|
* @type {string}
|
|
1223
1720
|
* @memberof Workspace
|
|
1224
1721
|
*/
|
|
@@ -1253,7 +1750,21 @@ export interface Workspace {
|
|
|
1253
1750
|
* @memberof Workspace
|
|
1254
1751
|
*/
|
|
1255
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;
|
|
1256
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
|
+
|
|
1257
1768
|
/**
|
|
1258
1769
|
* Represents a permission assignment for a user or group within a workspace
|
|
1259
1770
|
* @export
|
|
@@ -1271,33 +1782,426 @@ export interface WorkspacePermission {
|
|
|
1271
1782
|
* @type {string}
|
|
1272
1783
|
* @memberof WorkspacePermission
|
|
1273
1784
|
*/
|
|
1274
|
-
'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
|
+
|
|
1275
2136
|
/**
|
|
1276
|
-
*
|
|
1277
|
-
* @
|
|
1278
|
-
* @
|
|
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
|
|
1279
2145
|
*/
|
|
1280
|
-
|
|
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
|
+
|
|
1281
2150
|
/**
|
|
1282
|
-
*
|
|
1283
|
-
* @
|
|
1284
|
-
* @
|
|
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
|
|
1285
2159
|
*/
|
|
1286
|
-
|
|
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
|
+
|
|
1287
2164
|
/**
|
|
1288
|
-
*
|
|
1289
|
-
* @
|
|
1290
|
-
* @
|
|
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
|
|
1291
2172
|
*/
|
|
1292
|
-
|
|
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
|
+
}
|
|
1293
2176
|
}
|
|
1294
2177
|
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
2178
|
+
/**
|
|
2179
|
+
* @export
|
|
2180
|
+
*/
|
|
2181
|
+
export const DeleteBookmarkBookmarkTypeEnum = {
|
|
2182
|
+
Workspace: 'WORKSPACE',
|
|
2183
|
+
Model: 'MODEL',
|
|
2184
|
+
Chat: 'CHAT'
|
|
1298
2185
|
} as const;
|
|
1299
|
-
|
|
1300
|
-
|
|
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];
|
|
1301
2205
|
|
|
1302
2206
|
|
|
1303
2207
|
/**
|
|
@@ -1440,14 +2344,16 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
1440
2344
|
};
|
|
1441
2345
|
},
|
|
1442
2346
|
/**
|
|
1443
|
-
* 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.
|
|
1444
2348
|
* @summary List database connections
|
|
1445
2349
|
* @param {string} organizationName The unique identifier of the organization
|
|
1446
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
|
|
1447
2353
|
* @param {*} [options] Override http request option.
|
|
1448
2354
|
* @throws {RequiredError}
|
|
1449
2355
|
*/
|
|
1450
|
-
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> => {
|
|
1451
2357
|
// verify required parameter 'organizationName' is not null or undefined
|
|
1452
2358
|
assertParamExists('listConnections', 'organizationName', organizationName)
|
|
1453
2359
|
// verify required parameter 'projectName' is not null or undefined
|
|
@@ -1466,6 +2372,14 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
1466
2372
|
const localVarHeaderParameter = {} as any;
|
|
1467
2373
|
const localVarQueryParameter = {} as any;
|
|
1468
2374
|
|
|
2375
|
+
if (limit !== undefined) {
|
|
2376
|
+
localVarQueryParameter['limit'] = limit;
|
|
2377
|
+
}
|
|
2378
|
+
|
|
2379
|
+
if (offset !== undefined) {
|
|
2380
|
+
localVarQueryParameter['offset'] = offset;
|
|
2381
|
+
}
|
|
2382
|
+
|
|
1469
2383
|
|
|
1470
2384
|
|
|
1471
2385
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1580,15 +2494,17 @@ export const ConnectionsApiFp = function(configuration?: Configuration) {
|
|
|
1580
2494
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1581
2495
|
},
|
|
1582
2496
|
/**
|
|
1583
|
-
* 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.
|
|
1584
2498
|
* @summary List database connections
|
|
1585
2499
|
* @param {string} organizationName The unique identifier of the organization
|
|
1586
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
|
|
1587
2503
|
* @param {*} [options] Override http request option.
|
|
1588
2504
|
* @throws {RequiredError}
|
|
1589
2505
|
*/
|
|
1590
|
-
async listConnections(organizationName: string, projectName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Connection>>> {
|
|
1591
|
-
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);
|
|
1592
2508
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1593
2509
|
const localVarOperationServerBasePath = operationServerMap['ConnectionsApi.listConnections']?.[localVarOperationServerIndex]?.url;
|
|
1594
2510
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1657,15 +2573,17 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
|
|
|
1657
2573
|
return localVarFp.getConnection(organizationName, projectName, connectionName, options).then((request) => request(axios, basePath));
|
|
1658
2574
|
},
|
|
1659
2575
|
/**
|
|
1660
|
-
* 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.
|
|
1661
2577
|
* @summary List database connections
|
|
1662
2578
|
* @param {string} organizationName The unique identifier of the organization
|
|
1663
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
|
|
1664
2582
|
* @param {*} [options] Override http request option.
|
|
1665
2583
|
* @throws {RequiredError}
|
|
1666
2584
|
*/
|
|
1667
|
-
listConnections(organizationName: string, projectName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Connection>> {
|
|
1668
|
-
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));
|
|
1669
2587
|
},
|
|
1670
2588
|
/**
|
|
1671
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.
|
|
@@ -1734,16 +2652,18 @@ export class ConnectionsApi extends BaseAPI {
|
|
|
1734
2652
|
}
|
|
1735
2653
|
|
|
1736
2654
|
/**
|
|
1737
|
-
* 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.
|
|
1738
2656
|
* @summary List database connections
|
|
1739
2657
|
* @param {string} organizationName The unique identifier of the organization
|
|
1740
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
|
|
1741
2661
|
* @param {*} [options] Override http request option.
|
|
1742
2662
|
* @throws {RequiredError}
|
|
1743
2663
|
* @memberof ConnectionsApi
|
|
1744
2664
|
*/
|
|
1745
|
-
public listConnections(organizationName: string, projectName: string, options?: RawAxiosRequestConfig) {
|
|
1746
|
-
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));
|
|
1747
2667
|
}
|
|
1748
2668
|
|
|
1749
2669
|
/**
|
|
@@ -2578,10 +3498,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2578
3498
|
* @summary List workspace documents
|
|
2579
3499
|
* @param {string} organizationName The unique identifier of the organization
|
|
2580
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.
|
|
2581
3502
|
* @param {*} [options] Override http request option.
|
|
2582
3503
|
* @throws {RequiredError}
|
|
2583
3504
|
*/
|
|
2584
|
-
listDocuments: async (organizationName: string, workspaceName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3505
|
+
listDocuments: async (organizationName: string, workspaceName: string, retrieveContent?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2585
3506
|
// verify required parameter 'organizationName' is not null or undefined
|
|
2586
3507
|
assertParamExists('listDocuments', 'organizationName', organizationName)
|
|
2587
3508
|
// verify required parameter 'workspaceName' is not null or undefined
|
|
@@ -2600,6 +3521,10 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2600
3521
|
const localVarHeaderParameter = {} as any;
|
|
2601
3522
|
const localVarQueryParameter = {} as any;
|
|
2602
3523
|
|
|
3524
|
+
if (retrieveContent !== undefined) {
|
|
3525
|
+
localVarQueryParameter['retrieveContent'] = retrieveContent;
|
|
3526
|
+
}
|
|
3527
|
+
|
|
2603
3528
|
|
|
2604
3529
|
|
|
2605
3530
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2719,11 +3644,12 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
2719
3644
|
* @summary List workspace documents
|
|
2720
3645
|
* @param {string} organizationName The unique identifier of the organization
|
|
2721
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.
|
|
2722
3648
|
* @param {*} [options] Override http request option.
|
|
2723
3649
|
* @throws {RequiredError}
|
|
2724
3650
|
*/
|
|
2725
|
-
async listDocuments(organizationName: string, workspaceName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Document>>> {
|
|
2726
|
-
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);
|
|
2727
3653
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2728
3654
|
const localVarOperationServerBasePath = operationServerMap['DocumentsApi.listDocuments']?.[localVarOperationServerIndex]?.url;
|
|
2729
3655
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2797,11 +3723,12 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
2797
3723
|
* @summary List workspace documents
|
|
2798
3724
|
* @param {string} organizationName The unique identifier of the organization
|
|
2799
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.
|
|
2800
3727
|
* @param {*} [options] Override http request option.
|
|
2801
3728
|
* @throws {RequiredError}
|
|
2802
3729
|
*/
|
|
2803
|
-
listDocuments(organizationName: string, workspaceName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Document>> {
|
|
2804
|
-
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));
|
|
2805
3732
|
},
|
|
2806
3733
|
/**
|
|
2807
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.
|
|
@@ -2875,12 +3802,13 @@ export class DocumentsApi extends BaseAPI {
|
|
|
2875
3802
|
* @summary List workspace documents
|
|
2876
3803
|
* @param {string} organizationName The unique identifier of the organization
|
|
2877
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.
|
|
2878
3806
|
* @param {*} [options] Override http request option.
|
|
2879
3807
|
* @throws {RequiredError}
|
|
2880
3808
|
* @memberof DocumentsApi
|
|
2881
3809
|
*/
|
|
2882
|
-
public listDocuments(organizationName: string, workspaceName: string, options?: RawAxiosRequestConfig) {
|
|
2883
|
-
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));
|
|
2884
3812
|
}
|
|
2885
3813
|
|
|
2886
3814
|
/**
|
|
@@ -4411,14 +5339,13 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4411
5339
|
};
|
|
4412
5340
|
},
|
|
4413
5341
|
/**
|
|
4414
|
-
* 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.
|
|
4415
5343
|
* @summary Get organization details
|
|
4416
5344
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4417
|
-
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
4418
5345
|
* @param {*} [options] Override http request option.
|
|
4419
5346
|
* @throws {RequiredError}
|
|
4420
5347
|
*/
|
|
4421
|
-
getOrganization: async (organizationName: string,
|
|
5348
|
+
getOrganization: async (organizationName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4422
5349
|
// verify required parameter 'organizationName' is not null or undefined
|
|
4423
5350
|
assertParamExists('getOrganization', 'organizationName', organizationName)
|
|
4424
5351
|
const localVarPath = `/organizations/{organizationName}`
|
|
@@ -4434,10 +5361,78 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4434
5361
|
const localVarHeaderParameter = {} as any;
|
|
4435
5362
|
const localVarQueryParameter = {} as any;
|
|
4436
5363
|
|
|
4437
|
-
|
|
4438
|
-
|
|
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;
|
|
4439
5430
|
}
|
|
4440
5431
|
|
|
5432
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
5433
|
+
const localVarHeaderParameter = {} as any;
|
|
5434
|
+
const localVarQueryParameter = {} as any;
|
|
5435
|
+
|
|
4441
5436
|
|
|
4442
5437
|
|
|
4443
5438
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4450,12 +5445,14 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4450
5445
|
};
|
|
4451
5446
|
},
|
|
4452
5447
|
/**
|
|
4453
|
-
* 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.
|
|
4454
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
|
|
4455
5452
|
* @param {*} [options] Override http request option.
|
|
4456
5453
|
* @throws {RequiredError}
|
|
4457
5454
|
*/
|
|
4458
|
-
listOrganizations: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5455
|
+
listOrganizations: async (limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4459
5456
|
const localVarPath = `/organizations`;
|
|
4460
5457
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4461
5458
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -4468,6 +5465,14 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4468
5465
|
const localVarHeaderParameter = {} as any;
|
|
4469
5466
|
const localVarQueryParameter = {} as any;
|
|
4470
5467
|
|
|
5468
|
+
if (limit !== undefined) {
|
|
5469
|
+
localVarQueryParameter['limit'] = limit;
|
|
5470
|
+
}
|
|
5471
|
+
|
|
5472
|
+
if (offset !== undefined) {
|
|
5473
|
+
localVarQueryParameter['offset'] = offset;
|
|
5474
|
+
}
|
|
5475
|
+
|
|
4471
5476
|
|
|
4472
5477
|
|
|
4473
5478
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -4556,27 +5561,55 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
|
|
|
4556
5561
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4557
5562
|
},
|
|
4558
5563
|
/**
|
|
4559
|
-
* 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.
|
|
4560
5565
|
* @summary Get organization details
|
|
4561
5566
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4562
|
-
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
4563
5567
|
* @param {*} [options] Override http request option.
|
|
4564
5568
|
* @throws {RequiredError}
|
|
4565
5569
|
*/
|
|
4566
|
-
async getOrganization(organizationName: string,
|
|
4567
|
-
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);
|
|
4568
5572
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4569
5573
|
const localVarOperationServerBasePath = operationServerMap['OrganizationsApi.getOrganization']?.[localVarOperationServerIndex]?.url;
|
|
4570
5574
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4571
5575
|
},
|
|
4572
5576
|
/**
|
|
4573
|
-
* 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.
|
|
4574
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
|
|
4575
5608
|
* @param {*} [options] Override http request option.
|
|
4576
5609
|
* @throws {RequiredError}
|
|
4577
5610
|
*/
|
|
4578
|
-
async listOrganizations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Organization>>> {
|
|
4579
|
-
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);
|
|
4580
5613
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4581
5614
|
const localVarOperationServerBasePath = operationServerMap['OrganizationsApi.listOrganizations']?.[localVarOperationServerIndex]?.url;
|
|
4582
5615
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -4626,24 +5659,46 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
|
|
|
4626
5659
|
return localVarFp.deleteOrganization(organizationName, options).then((request) => request(axios, basePath));
|
|
4627
5660
|
},
|
|
4628
5661
|
/**
|
|
4629
|
-
* 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.
|
|
4630
5663
|
* @summary Get organization details
|
|
4631
5664
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4632
|
-
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
4633
5665
|
* @param {*} [options] Override http request option.
|
|
4634
5666
|
* @throws {RequiredError}
|
|
4635
5667
|
*/
|
|
4636
|
-
getOrganization(organizationName: string,
|
|
4637
|
-
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));
|
|
4638
5691
|
},
|
|
4639
5692
|
/**
|
|
4640
|
-
* 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.
|
|
4641
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
|
|
4642
5697
|
* @param {*} [options] Override http request option.
|
|
4643
5698
|
* @throws {RequiredError}
|
|
4644
5699
|
*/
|
|
4645
|
-
listOrganizations(options?: RawAxiosRequestConfig): AxiosPromise<Array<Organization>> {
|
|
4646
|
-
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));
|
|
4647
5702
|
},
|
|
4648
5703
|
/**
|
|
4649
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.
|
|
@@ -4691,27 +5746,53 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
4691
5746
|
}
|
|
4692
5747
|
|
|
4693
5748
|
/**
|
|
4694
|
-
* 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.
|
|
4695
5750
|
* @summary Get organization details
|
|
4696
5751
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4697
|
-
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
4698
5752
|
* @param {*} [options] Override http request option.
|
|
4699
5753
|
* @throws {RequiredError}
|
|
4700
5754
|
* @memberof OrganizationsApi
|
|
4701
5755
|
*/
|
|
4702
|
-
public getOrganization(organizationName: string,
|
|
4703
|
-
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));
|
|
4704
5783
|
}
|
|
4705
5784
|
|
|
4706
5785
|
/**
|
|
4707
|
-
* 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.
|
|
4708
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
|
|
4709
5790
|
* @param {*} [options] Override http request option.
|
|
4710
5791
|
* @throws {RequiredError}
|
|
4711
5792
|
* @memberof OrganizationsApi
|
|
4712
5793
|
*/
|
|
4713
|
-
public listOrganizations(options?: RawAxiosRequestConfig) {
|
|
4714
|
-
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));
|
|
4715
5796
|
}
|
|
4716
5797
|
|
|
4717
5798
|
/**
|
|
@@ -5397,21 +6478,18 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5397
6478
|
};
|
|
5398
6479
|
},
|
|
5399
6480
|
/**
|
|
5400
|
-
*
|
|
5401
|
-
* @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
|
|
5402
6483
|
* @param {string} organizationName The unique identifier of the organization
|
|
5403
|
-
* @param {
|
|
6484
|
+
* @param {boolean} [onlyShareable] When true, returns only packages the user can share (admin/modeler). When false, returns all readable packages.
|
|
5404
6485
|
* @param {*} [options] Override http request option.
|
|
5405
6486
|
* @throws {RequiredError}
|
|
5406
6487
|
*/
|
|
5407
|
-
|
|
6488
|
+
listOrganizationPackages: async (organizationName: string, onlyShareable?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5408
6489
|
// verify required parameter 'organizationName' is not null or undefined
|
|
5409
|
-
assertParamExists('
|
|
5410
|
-
|
|
5411
|
-
|
|
5412
|
-
const localVarPath = `/organizations/{organizationName}/projects/{projectName}/packages`
|
|
5413
|
-
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)))
|
|
5414
|
-
.replace(`{${"projectName"}}`, encodeURIComponent(String(projectName)));
|
|
6490
|
+
assertParamExists('listOrganizationPackages', 'organizationName', organizationName)
|
|
6491
|
+
const localVarPath = `/organizations/{organizationName}/packages`
|
|
6492
|
+
.replace(`{${"organizationName"}}`, encodeURIComponent(String(organizationName)));
|
|
5415
6493
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5416
6494
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5417
6495
|
let baseOptions;
|
|
@@ -5423,6 +6501,10 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5423
6501
|
const localVarHeaderParameter = {} as any;
|
|
5424
6502
|
const localVarQueryParameter = {} as any;
|
|
5425
6503
|
|
|
6504
|
+
if (onlyShareable !== undefined) {
|
|
6505
|
+
localVarQueryParameter['onlyShareable'] = onlyShareable;
|
|
6506
|
+
}
|
|
6507
|
+
|
|
5426
6508
|
|
|
5427
6509
|
|
|
5428
6510
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5435,18 +6517,23 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5435
6517
|
};
|
|
5436
6518
|
},
|
|
5437
6519
|
/**
|
|
5438
|
-
*
|
|
5439
|
-
* @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
|
|
5440
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
|
|
5441
6526
|
* @param {*} [options] Override http request option.
|
|
5442
|
-
* @deprecated
|
|
5443
6527
|
* @throws {RequiredError}
|
|
5444
6528
|
*/
|
|
5445
|
-
|
|
6529
|
+
listPackages: async (organizationName: string, projectName: string, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
5446
6530
|
// verify required parameter 'organizationName' is not null or undefined
|
|
5447
|
-
assertParamExists('
|
|
5448
|
-
|
|
5449
|
-
|
|
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)));
|
|
5450
6537
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5451
6538
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5452
6539
|
let baseOptions;
|
|
@@ -5458,6 +6545,14 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5458
6545
|
const localVarHeaderParameter = {} as any;
|
|
5459
6546
|
const localVarQueryParameter = {} as any;
|
|
5460
6547
|
|
|
6548
|
+
if (limit !== undefined) {
|
|
6549
|
+
localVarQueryParameter['limit'] = limit;
|
|
6550
|
+
}
|
|
6551
|
+
|
|
6552
|
+
if (offset !== undefined) {
|
|
6553
|
+
localVarQueryParameter['offset'] = offset;
|
|
6554
|
+
}
|
|
6555
|
+
|
|
5461
6556
|
|
|
5462
6557
|
|
|
5463
6558
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -5578,31 +6673,33 @@ export const PackagesApiFp = function(configuration?: Configuration) {
|
|
|
5578
6673
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5579
6674
|
},
|
|
5580
6675
|
/**
|
|
5581
|
-
*
|
|
5582
|
-
* @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
|
|
5583
6678
|
* @param {string} organizationName The unique identifier of the organization
|
|
5584
|
-
* @param {
|
|
6679
|
+
* @param {boolean} [onlyShareable] When true, returns only packages the user can share (admin/modeler). When false, returns all readable packages.
|
|
5585
6680
|
* @param {*} [options] Override http request option.
|
|
5586
6681
|
* @throws {RequiredError}
|
|
5587
6682
|
*/
|
|
5588
|
-
async
|
|
5589
|
-
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);
|
|
5590
6685
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5591
|
-
const localVarOperationServerBasePath = operationServerMap['PackagesApi.
|
|
6686
|
+
const localVarOperationServerBasePath = operationServerMap['PackagesApi.listOrganizationPackages']?.[localVarOperationServerIndex]?.url;
|
|
5592
6687
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5593
6688
|
},
|
|
5594
6689
|
/**
|
|
5595
|
-
*
|
|
5596
|
-
* @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
|
|
5597
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
|
|
5598
6696
|
* @param {*} [options] Override http request option.
|
|
5599
|
-
* @deprecated
|
|
5600
6697
|
* @throws {RequiredError}
|
|
5601
6698
|
*/
|
|
5602
|
-
async
|
|
5603
|
-
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);
|
|
5604
6701
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5605
|
-
const localVarOperationServerBasePath = operationServerMap['PackagesApi.
|
|
6702
|
+
const localVarOperationServerBasePath = operationServerMap['PackagesApi.listPackages']?.[localVarOperationServerIndex]?.url;
|
|
5606
6703
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5607
6704
|
},
|
|
5608
6705
|
/**
|
|
@@ -5673,26 +6770,28 @@ export const PackagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
5673
6770
|
return localVarFp.getPackage(organizationName, projectName, packageName, checkAdmin, options).then((request) => request(axios, basePath));
|
|
5674
6771
|
},
|
|
5675
6772
|
/**
|
|
5676
|
-
*
|
|
5677
|
-
* @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
|
|
5678
6775
|
* @param {string} organizationName The unique identifier of the organization
|
|
5679
|
-
* @param {
|
|
6776
|
+
* @param {boolean} [onlyShareable] When true, returns only packages the user can share (admin/modeler). When false, returns all readable packages.
|
|
5680
6777
|
* @param {*} [options] Override http request option.
|
|
5681
6778
|
* @throws {RequiredError}
|
|
5682
6779
|
*/
|
|
5683
|
-
|
|
5684
|
-
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));
|
|
5685
6782
|
},
|
|
5686
6783
|
/**
|
|
5687
|
-
*
|
|
5688
|
-
* @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
|
|
5689
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
|
|
5690
6790
|
* @param {*} [options] Override http request option.
|
|
5691
|
-
* @deprecated
|
|
5692
6791
|
* @throws {RequiredError}
|
|
5693
6792
|
*/
|
|
5694
|
-
|
|
5695
|
-
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));
|
|
5696
6795
|
},
|
|
5697
6796
|
/**
|
|
5698
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.
|
|
@@ -5765,29 +6864,31 @@ export class PackagesApi extends BaseAPI {
|
|
|
5765
6864
|
}
|
|
5766
6865
|
|
|
5767
6866
|
/**
|
|
5768
|
-
*
|
|
5769
|
-
* @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
|
|
5770
6869
|
* @param {string} organizationName The unique identifier of the organization
|
|
5771
|
-
* @param {
|
|
6870
|
+
* @param {boolean} [onlyShareable] When true, returns only packages the user can share (admin/modeler). When false, returns all readable packages.
|
|
5772
6871
|
* @param {*} [options] Override http request option.
|
|
5773
6872
|
* @throws {RequiredError}
|
|
5774
6873
|
* @memberof PackagesApi
|
|
5775
6874
|
*/
|
|
5776
|
-
public
|
|
5777
|
-
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));
|
|
5778
6877
|
}
|
|
5779
6878
|
|
|
5780
6879
|
/**
|
|
5781
|
-
*
|
|
5782
|
-
* @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
|
|
5783
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
|
|
5784
6886
|
* @param {*} [options] Override http request option.
|
|
5785
|
-
* @deprecated
|
|
5786
6887
|
* @throws {RequiredError}
|
|
5787
6888
|
* @memberof PackagesApi
|
|
5788
6889
|
*/
|
|
5789
|
-
public
|
|
5790
|
-
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));
|
|
5791
6892
|
}
|
|
5792
6893
|
|
|
5793
6894
|
/**
|
|
@@ -6514,13 +7615,15 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
6514
7615
|
};
|
|
6515
7616
|
},
|
|
6516
7617
|
/**
|
|
6517
|
-
* 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.
|
|
6518
7619
|
* @summary List projects in organization
|
|
6519
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
|
|
6520
7623
|
* @param {*} [options] Override http request option.
|
|
6521
7624
|
* @throws {RequiredError}
|
|
6522
7625
|
*/
|
|
6523
|
-
listProjects: async (organizationName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
7626
|
+
listProjects: async (organizationName: string, limit?: number, offset?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
6524
7627
|
// verify required parameter 'organizationName' is not null or undefined
|
|
6525
7628
|
assertParamExists('listProjects', 'organizationName', organizationName)
|
|
6526
7629
|
const localVarPath = `/organizations/{organizationName}/projects`
|
|
@@ -6536,6 +7639,14 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
6536
7639
|
const localVarHeaderParameter = {} as any;
|
|
6537
7640
|
const localVarQueryParameter = {} as any;
|
|
6538
7641
|
|
|
7642
|
+
if (limit !== undefined) {
|
|
7643
|
+
localVarQueryParameter['limit'] = limit;
|
|
7644
|
+
}
|
|
7645
|
+
|
|
7646
|
+
if (offset !== undefined) {
|
|
7647
|
+
localVarQueryParameter['offset'] = offset;
|
|
7648
|
+
}
|
|
7649
|
+
|
|
6539
7650
|
|
|
6540
7651
|
|
|
6541
7652
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -6645,14 +7756,16 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
6645
7756
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6646
7757
|
},
|
|
6647
7758
|
/**
|
|
6648
|
-
* 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.
|
|
6649
7760
|
* @summary List projects in organization
|
|
6650
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
|
|
6651
7764
|
* @param {*} [options] Override http request option.
|
|
6652
7765
|
* @throws {RequiredError}
|
|
6653
7766
|
*/
|
|
6654
|
-
async listProjects(organizationName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Project>>> {
|
|
6655
|
-
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);
|
|
6656
7769
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6657
7770
|
const localVarOperationServerBasePath = operationServerMap['ProjectsApi.listProjects']?.[localVarOperationServerIndex]?.url;
|
|
6658
7771
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -6717,14 +7830,16 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
6717
7830
|
return localVarFp.getProject(organizationName, projectName, checkAdmin, options).then((request) => request(axios, basePath));
|
|
6718
7831
|
},
|
|
6719
7832
|
/**
|
|
6720
|
-
* 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.
|
|
6721
7834
|
* @summary List projects in organization
|
|
6722
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
|
|
6723
7838
|
* @param {*} [options] Override http request option.
|
|
6724
7839
|
* @throws {RequiredError}
|
|
6725
7840
|
*/
|
|
6726
|
-
listProjects(organizationName: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Project>> {
|
|
6727
|
-
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));
|
|
6728
7843
|
},
|
|
6729
7844
|
/**
|
|
6730
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.
|
|
@@ -6789,15 +7904,17 @@ export class ProjectsApi extends BaseAPI {
|
|
|
6789
7904
|
}
|
|
6790
7905
|
|
|
6791
7906
|
/**
|
|
6792
|
-
* 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.
|
|
6793
7908
|
* @summary List projects in organization
|
|
6794
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
|
|
6795
7912
|
* @param {*} [options] Override http request option.
|
|
6796
7913
|
* @throws {RequiredError}
|
|
6797
7914
|
* @memberof ProjectsApi
|
|
6798
7915
|
*/
|
|
6799
|
-
public listProjects(organizationName: string, options?: RawAxiosRequestConfig) {
|
|
6800
|
-
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));
|
|
6801
7918
|
}
|
|
6802
7919
|
|
|
6803
7920
|
/**
|
|
@@ -8177,6 +9294,40 @@ export const WorkspacesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
8177
9294
|
|
|
8178
9295
|
|
|
8179
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
|
+
|
|
8180
9331
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
8181
9332
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
8182
9333
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -8350,6 +9501,19 @@ export const WorkspacesApiFp = function(configuration?: Configuration) {
|
|
|
8350
9501
|
const localVarOperationServerBasePath = operationServerMap['WorkspacesApi.deleteWorkspace']?.[localVarOperationServerIndex]?.url;
|
|
8351
9502
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8352
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
|
+
},
|
|
8353
9517
|
/**
|
|
8354
9518
|
* Retrieves detailed information about a specific workspace, including its metadata, associated packages, and configuration settings.
|
|
8355
9519
|
* @summary Get workspace details
|
|
@@ -8426,6 +9590,16 @@ export const WorkspacesApiFactory = function (configuration?: Configuration, bas
|
|
|
8426
9590
|
deleteWorkspace(organizationName: string, workspaceName: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
8427
9591
|
return localVarFp.deleteWorkspace(organizationName, workspaceName, options).then((request) => request(axios, basePath));
|
|
8428
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
|
+
},
|
|
8429
9603
|
/**
|
|
8430
9604
|
* Retrieves detailed information about a specific workspace, including its metadata, associated packages, and configuration settings.
|
|
8431
9605
|
* @summary Get workspace details
|
|
@@ -8497,6 +9671,18 @@ export class WorkspacesApi extends BaseAPI {
|
|
|
8497
9671
|
return WorkspacesApiFp(this.configuration).deleteWorkspace(organizationName, workspaceName, options).then((request) => request(this.axios, this.basePath));
|
|
8498
9672
|
}
|
|
8499
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
|
+
|
|
8500
9686
|
/**
|
|
8501
9687
|
* Retrieves detailed information about a specific workspace, including its metadata, associated packages, and configuration settings.
|
|
8502
9688
|
* @summary Get workspace details
|