-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathdata-connections.d.ts
676 lines (674 loc) · 28.6 KB
/
data-connections.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
import { A as ApiCallOptions } from './invoke-fetch-types-BXn-uSF5.js';
import './auth-types-PkN9CAF_.js';
type ActionDeleteRequest = {
connections: {
/** ID of connection */
id: string;
/** Connection name */
name?: string;
}[];
};
type ActionDuplicateRequest = {
/** ID of the source connection being duplicated */
id: string;
/** Optional name for the duplicated connection, must be unique in the target scope. If not specified, a name will be automatically generated */
name?: string;
/** Optional credential password, specify to override credential embedded (or associated) with the source connection */
qPassword?: string;
/** Optional credential username, specify to override credential embedded (or associated) with the source connection */
qUsername?: string;
/** Optional target space ID for the duplicated connection. If not specified, the duplicated connection will be in the same space as the source connection */
spaceId?: string;
};
type ActionUpdateRequest = {
connections: {
/** Connection ID */
id: string;
/** Connection name */
name?: string;
/** User ID to which the connection will be updated. If not present, the connection's owner wont be changed */
ownerId?: string;
/** Space ID to which the connection will be updated. If not present, the connection's space wont be changed. If it is empty string, then the connection will be moved to the personal space of the user identified by ownerId (If ownerId is undefined, then the connection will be in oroginal owner's personal space) */
spaceId?: string;
/** Space type. Required when spaceId is specified */
spaceType?: "personal" | "shared" | "managed" | "data";
}[];
};
type BulkResponse = {
data?: {
error?: Error;
/** ID of the resource */
id: string;
/** Status code of operation on resource identified by ID */
status: number;
}[];
};
/**
* Schema used to create a connection with given connection string (i.e. qConnectStatement) along with other metadata
*/
type ConnectionCreate = {
/** ID of the datasource associated with this connection */
datasourceID: string;
/** App ID */
owner?: string;
/** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
qArchitecture?: 0 | 1;
/** Connection string for the data connection */
qConnectStatement: string;
/** String that contains connection specific secret (or password) that requires encryption before persist to database. This field is connection level secret */
qConnectionSecret?: string;
/** ID of the credential associated with the connection */
qCredentialsID?: string;
/** Name of the credential associated with the connection */
qCredentialsName?: string;
/** Unique identifier (UUID) for the data connection as specified by the Sense engine. A UUID will be generated automatically if this field is not specified or empty */
qEngineObjectID?: string;
/** Unique identifier (UUID) for the data connection. A UUID will be generated automatically if qID is not specified or empty */
qID?: string;
/** Indicates the type of user associated with the data connection. */
qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
/** Descriptive name of the data connection */
qName: string;
/** Any logon password associated with the data connection (connector encoded) */
qPassword?: string;
/** Indicates whether or not to create a credential-less connection */
qSeparateCredentials?: boolean;
/** Type of connection - indicates connection provider type */
qType: string;
/** Any logon username associated with the data connection */
qUsername?: string;
/** QRI string of the connection. The string will be persisted to mongo when the request is originated from trusted client (i.e. dcaas) to avoid invalid QRi string. */
qriInRequest?: string;
/** ID of the space to which the connection belongs */
space?: string;
/** List of tags attached to the connection (allow max 32 tags) */
tags?: string[];
};
/**
* Essential fields of a connection
*/
type ConnectionCreateResponse = {
/** Datetime when the connection was created */
created?: string;
links?: Link;
/** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
privileges: Privilege[];
/** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
qArchitecture: 0 | 1;
/** Connection string for the data connection */
qConnectStatement: string;
/** ID of the credential associated with the connection */
qCredentialsID?: string;
/** Name of the credential associated with the connection */
qCredentialsName?: string;
/** Unique identifier (UUID) for the data connection, must be same as qID */
qEngineObjectID: string;
/** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
qID: string;
/** Indicates the type of user associated with the data connection. */
qLogOn: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
/** Descriptive name of the data connection */
qName: string;
/** Reference key of credential in redis */
qReferenceKey?: string;
/** Indicates whether or not this is a credential-less connection */
qSeparateCredentials: boolean;
/** Type of connection - indicates connection provider type */
qType: string;
/** ID of the space to which the connection belongs */
space?: string;
/** Datetime when the connection was last updated */
updated?: string;
/** User ID of the connection's creator */
user?: string;
};
/**
* Essential fields of a connection
*/
type ConnectionGet = {
/** List of connection parsed from connection string (only available when query parseConnection=true is set) */
connectionProperties?: unknown;
/** Datetime when the connection was created */
created: string;
/** Data source ID */
datasourceID?: string;
links?: Link;
/** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
privileges: Privilege[];
/** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
qArchitecture: 0 | 1;
/** Connection string for the data connection */
qConnectStatement: string;
/** String that contains connection specific secret (or password). This field will not be included in response of GET /data-connections, will only be included in the response of GET /data-connections/{qID} */
qConnectionSecret?: string;
/** ID of the credential associated with the connection */
qCredentialsID?: string;
/** Unique identifier (UUID) for the data connection, must be same as qID */
qEngineObjectID: string;
/** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
qID: string;
/** Indicates the type of user associated with the data connection */
qLogOn: 0 | 1;
/** Descriptive name of the data connection */
qName: string;
/** Indicates whether or not this is a credential-less connection */
qSeparateCredentials: boolean;
/** Type of connection, i.e. provider type of underlying connector */
qType: string;
/** Encrypted base Qri string */
qri?: string;
/** ID of the space to which the connection belongs */
space?: string;
/** List of tags attached to the connection */
tags?: string[];
/** Tenant ID of the connection's creator */
tenant: string;
/** Datetime when the connection was last updated */
updated: string;
/** User ID of the connection's creator */
user: string;
};
type ConnectionUpdate = {
/** ID of the datasource associated with this connection */
datasourceID?: string;
/** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
qArchitecture?: 0 | 1;
/** Connection string for the data connection */
qConnectStatement: string;
/** String that contains connection level secret (or password). If this field presents in request, then existing connection secret will be updated to its value. If is an empty string, then existing connection secret will be cleared. If this field is missing, existing secret will not be updated. */
qConnectionSecret?: string;
/** ID of the credential associated with the connection */
qCredentialsID?: string;
/** Name of the credential associated with the connection */
qCredentialsName?: string;
/** Unique identifier for the data connection as specified by the Sense engine */
qEngineObjectID: string;
/** Unique identifier for the data connection */
qID: string;
/** Indicates the type of user associated with the data connection. */
qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
/** Descriptive name of the data connection */
qName: string;
/** Any logon password associated with the data connection */
qPassword?: string;
/** Indicates whether or not this is a credential-less connection */
qSeparateCredentials?: boolean;
/** Type of connection - indicates connection provider type */
qType: string;
/** Any logon username associated with the data connection */
qUsername?: string;
/** ID of the space to which the connection belongs */
space?: string;
};
type Connections = {
data?: ConnectionGet[];
errors?: Errors;
links?: TopLevelLink;
meta?: Meta;
};
/**
* Schema used to create a connection using a list of connection properties for given datasource
*/
type DcaasConnectionCreate = {
/** When set to true, only authentication URL will be returned (i.e. no connection will be created) if datasource supports OAuth, and other properties set in the request will ignored. This property will be ignored if the request is not OAuth or datasource doesn't support OAuth */
authUrlOnly?: boolean;
/** Connection properties required to create dataconnection for the given datasource, which is defined by the response of 'GET /v1/data-sources/:{datasourceId}/api-specs' */
connectionProperties: unknown;
/** ID of the datasource of the connection */
datasourceID: string;
/** Descriptive name of the data connection */
qName: string;
/** ID of the space in which the connection shall be created. Connection will be created in user's personal space if undefined */
space?: string;
/** List of tags attached to the connection (allow max 31 tags) */
tags?: string[];
};
/**
* Authentication URL response for OAuth datasources (when authUrlOnly is set to true in request)
*/
type DcaasConnectionCreateAuthResponse = {
/** Authentication URL used to generate authentication code for datasources supporting OAuth */
authUrl: string;
};
type Error = {
/** Unique internal error code */
code?: string;
/** More concrete details */
detail?: string;
/** HTTP status code */
status?: number;
/** A summary in english explaining what went wrong */
title?: string;
};
type Errors = Error[];
type Link = {
/** Link to current query */
self: {
/** URL pointing to the resource */
href: string;
};
};
type Meta = {
/** Total count of resources being requested. */
count?: number;
};
type PatchRequest = {
patchData: {
/** Operation type */
op?: "add" | "replace" | "remove";
/** Path to the target field to be patched */
path?: string;
/** The value used for the patch, only needed for 'add' or 'replace'. Value type could be either string or integer, should match with the type of the target field */
value?: string;
}[];
};
/**
* Access type allowed on associated data connection
* @example
* "list"
*/
type Privilege = "list" | "update" | "delete" | "read" | "change_owner" | "change_space";
type ResponseErrors = {
errors?: Errors;
};
type TopLevelLink = {
/** URL link to next page of requested resources (available to paged request only) */
next?: {
/** URL pointing to the next page of resources */
href: string;
};
/** URL link to previous page of requested resources (available to paged request only) */
prev?: {
/** URL pointing to the previous page of resources */
href: string;
};
/** Link to current query */
self: {
/** URL pointing to the resource */
href: string;
};
};
/**
* Gets a list of connections
* @example
* getDataConnections(
* {
* dataName: "data",
* extended: false,
* spaceId: "611bcebaeec1203d88211ac4",
* personal: false,
* owner: "928e2a66-01ba-4678-aa32-e74c213896fa",
* ownedByMe: true,
* limit: 30,
* sort: "+qName",
* page: "page=JwAAAAljcmVhdGVkAPfQ-sx0AQAAB19pZABfb93nZcM4SN1M0e8A",
* noDatafiles: true,
* userId: "6K9xjsItDexffolu5vg1oWYkY8x7f-0G",
* caseinsensitive: true,
* locale: "en",
* includeQris: true
* }
* )
*
* @param query an object with query parameters
* @throws GetDataConnectionsHttpError
*/
declare const getDataConnections: (query: {
/** Sort results will be returned in case insensitive order if set to true (Only used along with sort query) */
caseinsensitive?: boolean;
/** Provides an alternate name to be used for data[] element in GET response. */
dataName?: string;
/** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
extended?: boolean;
/** Filtering resources by properties (filterable properties only) using SCIM filter string. Note the filter string only applies to connections managed by data-connections service, i.e. filtering doesn't apply to DataFile connections. When filtering on datetime property (e.g. created, updated), datetime should be in RFC3339 format. */
filter?: string;
/** Base Qri (encrypted) will be returned when the query is set to true, default is false */
includeQris?: boolean;
/** Number of resources to be returned (between 1 and 100) */
limit?: number;
/** ICU locale ID, used only when caseinsensitive is set to true, default to 'en' if undefined */
locale?: string;
/** Datafiles connections will not be returned if set to true */
noDatafiles?: boolean;
/** Filtering on connections, return connections owned by the caller if set to true (doesn't apply to datafiles connections) */
ownedByMe?: boolean;
/** Filtering on datafile connections by owner (i.e. app) ID. */
owner?: string;
/** Pagination cursor string, which is generated automatically in previous pagination query. */
page?: string;
/** Filtering on personal connections, ignored if spaceId is defined in same request */
personal?: boolean;
/** Name of field sort on for pagination, with prefix with + or - indicating ascending or descending order. When used for data-connections, sort field only applies to non-datafiles connections. Whatever sorting order is, datafiles connections will be returned after all regular connections being returned. */
sort?: string;
/** Filtering on connections by space ID */
spaceId?: string;
/** Filtering on userId. Requires admin role if specified userId doesn't match that is defined in JWT. */
userId?: string;
}, options?: ApiCallOptions) => Promise<GetDataConnectionsHttpResponse>;
type GetDataConnectionsHttpResponse = {
data: Connections;
headers: Headers;
status: 200;
prev?: (options?: ApiCallOptions) => Promise<GetDataConnectionsHttpResponse>;
next?: (options?: ApiCallOptions) => Promise<GetDataConnectionsHttpResponse>;
};
type GetDataConnectionsHttpError = {
data: ResponseErrors;
headers: Headers;
status: 400 | 500 | 502;
};
/**
* Creates a new connection. Depending on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.
*
* @param body an object with the body content
* @throws CreateDataConnectionHttpError
*/
declare const createDataConnection: (body: ConnectionCreate | DcaasConnectionCreate, options?: ApiCallOptions) => Promise<CreateDataConnectionHttpResponse>;
type CreateDataConnectionHttpResponse = {
data: ConnectionCreateResponse | DcaasConnectionCreateAuthResponse;
headers: Headers;
status: 201;
};
type CreateDataConnectionHttpError = {
data: ResponseErrors;
headers: Headers;
status: 400 | 403 | 404 | 409;
};
/**
* Delete multiple connections, only available to Admin
*
* @param body an object with the body content
* @throws DeleteDataConnectionsHttpError
*/
declare const deleteDataConnections: (body: ActionDeleteRequest, options?: ApiCallOptions) => Promise<DeleteDataConnectionsHttpResponse>;
type DeleteDataConnectionsHttpResponse = {
data: BulkResponse;
headers: Headers;
status: 207;
};
type DeleteDataConnectionsHttpError = {
data: ResponseErrors;
headers: Headers;
status: 400 | 403;
};
/**
* Duplicate a connection
*
* @param body an object with the body content
* @throws DuplicateDataAConnectionHttpError
*/
declare const duplicateDataAConnection: (body: ActionDuplicateRequest, options?: ApiCallOptions) => Promise<DuplicateDataAConnectionHttpResponse>;
type DuplicateDataAConnectionHttpResponse = {
data: ConnectionCreateResponse;
headers: Headers;
status: 201;
};
type DuplicateDataAConnectionHttpError = {
data: ResponseErrors;
headers: Headers;
status: 400 | 403 | 404 | 409;
};
/**
* Update multiple connections, only available to Admin. When update is to change ownership of a connection, the credentials associated with the connection will NOT be transferred to the new owner, and new owner is expected to provide their own credentials for the connection.
*
* @param body an object with the body content
* @throws UpdateDataConnectionsHttpError
*/
declare const updateDataConnections: (body: ActionUpdateRequest, options?: ApiCallOptions) => Promise<UpdateDataConnectionsHttpResponse>;
type UpdateDataConnectionsHttpResponse = {
data: BulkResponse;
headers: Headers;
status: 207;
};
type UpdateDataConnectionsHttpError = {
data: ResponseErrors;
headers: Headers;
status: 400 | 403;
};
/**
* Deletes the specified data connection by ID (or by name when type=connectionname is set in query)
* @example
* deleteDataConnection(
* "82ee7b44-0c4d-491b-bd38-82640c0430a5",
* {
* type: "connectionname",
* spaceId: "611bcebaeec1203d88211ac4"
* }
* )
*
* @param qID Connection ID
* @param query an object with query parameters
* @throws DeleteDataConnectionHttpError
*/
declare const deleteDataConnection: (qID: string, query: {
/** Filtering on connections by space ID */
spaceId?: string;
/** Connection / credential ID defined in path become connection / credential name when this query parameter is set */
type?: "connectionname" | "credentialname";
}, options?: ApiCallOptions) => Promise<DeleteDataConnectionHttpResponse>;
type DeleteDataConnectionHttpResponse = {
data: void;
headers: Headers;
status: 204;
};
type DeleteDataConnectionHttpError = {
data: ResponseErrors;
headers: Headers;
status: 403 | 404;
};
/**
* Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."
* @example
* getDataConnection(
* "82ee7b44-0c4d-491b-bd38-82640c0430a5",
* {
* extended: false,
* type: "connectionname",
* credentialId: "22379dc5-076e-4fec-ae20-5529a8a57dc2",
* byCredentialName: false,
* spaceId: "611bcebaeec1203d88211ac4",
* noCache: false,
* parseConnection: true
* }
* )
*
* @param qID Connection ID
* @param query an object with query parameters
* @throws GetDataConnectionHttpError
*/
declare const getDataConnection: (qID: string, query: {
/** If set to true, credentialId in the query will be interpreted as credential's name */
byCredentialName?: boolean;
/** Credential ID */
credentialId?: string;
/** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
extended?: boolean;
/** datafiles connections will be returned from cache by default (if data-connections is configured to use cache), this query parameter is used disable this default behavior, e.g. return an update-to-date datafiles connection if the query is set to true */
noCache?: boolean;
/** List of connection properties shall be returned when the query is set to true, default is false */
parseConnection?: boolean;
/** Filtering on connections by space ID */
spaceId?: string;
/** Connection / credential ID defined in path become connection / credential name when this query parameter is set */
type?: "connectionname" | "credentialname";
}, options?: ApiCallOptions) => Promise<GetDataConnectionHttpResponse>;
type GetDataConnectionHttpResponse = {
data: ConnectionGet;
headers: Headers;
status: 200;
};
type GetDataConnectionHttpError = {
data: ResponseErrors;
headers: Headers;
status: 400 | 403 | 404 | 500;
};
/**
* Patches a connection specified by connection ID (or by name when type=connectionname is set in query).
*
* @param qID Connection ID
* @param query an object with query parameters
* @param body an object with the body content
* @throws PatchDataConnectionHttpError
*/
declare const patchDataConnection: (qID: string, query: {
/** Connection / credential ID defined in path become connection / credential name when this query parameter is set */
type?: "connectionname" | "credentialname";
}, body: PatchRequest, options?: ApiCallOptions) => Promise<PatchDataConnectionHttpResponse>;
type PatchDataConnectionHttpResponse = {
data: void;
headers: Headers;
status: 204;
};
type PatchDataConnectionHttpError = {
data: ResponseErrors;
headers: Headers;
status: 400 | 403 | 404 | 409;
};
/**
* Updates a connection specified by connection ID (or by name when type=connectionname is set in query). Depends on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.
*
* @param qID Connection ID
* @param query an object with query parameters
* @param body an object with the body content
* @throws UpdateDataConnectionHttpError
*/
declare const updateDataConnection: (qID: string, query: {
/** Filtering on connections by space ID */
spaceId?: string;
/** Connection / credential ID defined in path become connection / credential name when this query parameter is set */
type?: "connectionname" | "credentialname";
}, body: ConnectionUpdate, options?: ApiCallOptions) => Promise<UpdateDataConnectionHttpResponse>;
type UpdateDataConnectionHttpResponse = {
data: void;
headers: Headers;
status: 204;
};
type UpdateDataConnectionHttpError = {
data: ResponseErrors;
headers: Headers;
status: 400 | 403 | 404 | 409;
};
/**
* Clears the cache for data-connections api requests.
*/
declare function clearCache(): void;
interface DataConnectionsAPI {
/**
* Gets a list of connections
* @example
* getDataConnections(
* {
* dataName: "data",
* extended: false,
* spaceId: "611bcebaeec1203d88211ac4",
* personal: false,
* owner: "928e2a66-01ba-4678-aa32-e74c213896fa",
* ownedByMe: true,
* limit: 30,
* sort: "+qName",
* page: "page=JwAAAAljcmVhdGVkAPfQ-sx0AQAAB19pZABfb93nZcM4SN1M0e8A",
* noDatafiles: true,
* userId: "6K9xjsItDexffolu5vg1oWYkY8x7f-0G",
* caseinsensitive: true,
* locale: "en",
* includeQris: true
* }
* )
*
* @param query an object with query parameters
* @throws GetDataConnectionsHttpError
*/
getDataConnections: typeof getDataConnections;
/**
* Creates a new connection. Depending on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.
*
* @param body an object with the body content
* @throws CreateDataConnectionHttpError
*/
createDataConnection: typeof createDataConnection;
/**
* Delete multiple connections, only available to Admin
*
* @param body an object with the body content
* @throws DeleteDataConnectionsHttpError
*/
deleteDataConnections: typeof deleteDataConnections;
/**
* Duplicate a connection
*
* @param body an object with the body content
* @throws DuplicateDataAConnectionHttpError
*/
duplicateDataAConnection: typeof duplicateDataAConnection;
/**
* Update multiple connections, only available to Admin. When update is to change ownership of a connection, the credentials associated with the connection will NOT be transferred to the new owner, and new owner is expected to provide their own credentials for the connection.
*
* @param body an object with the body content
* @throws UpdateDataConnectionsHttpError
*/
updateDataConnections: typeof updateDataConnections;
/**
* Deletes the specified data connection by ID (or by name when type=connectionname is set in query)
* @example
* deleteDataConnection(
* "82ee7b44-0c4d-491b-bd38-82640c0430a5",
* {
* type: "connectionname",
* spaceId: "611bcebaeec1203d88211ac4"
* }
* )
*
* @param qID Connection ID
* @param query an object with query parameters
* @throws DeleteDataConnectionHttpError
*/
deleteDataConnection: typeof deleteDataConnection;
/**
* Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."
* @example
* getDataConnection(
* "82ee7b44-0c4d-491b-bd38-82640c0430a5",
* {
* extended: false,
* type: "connectionname",
* credentialId: "22379dc5-076e-4fec-ae20-5529a8a57dc2",
* byCredentialName: false,
* spaceId: "611bcebaeec1203d88211ac4",
* noCache: false,
* parseConnection: true
* }
* )
*
* @param qID Connection ID
* @param query an object with query parameters
* @throws GetDataConnectionHttpError
*/
getDataConnection: typeof getDataConnection;
/**
* Patches a connection specified by connection ID (or by name when type=connectionname is set in query).
*
* @param qID Connection ID
* @param query an object with query parameters
* @param body an object with the body content
* @throws PatchDataConnectionHttpError
*/
patchDataConnection: typeof patchDataConnection;
/**
* Updates a connection specified by connection ID (or by name when type=connectionname is set in query). Depends on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.
*
* @param qID Connection ID
* @param query an object with query parameters
* @param body an object with the body content
* @throws UpdateDataConnectionHttpError
*/
updateDataConnection: typeof updateDataConnection;
/**
* Clears the cache for data-connections api requests.
*/
clearCache: typeof clearCache;
}
/**
* Functions for the data-connections api
*/
declare const dataConnectionsExport: DataConnectionsAPI;
export { type ActionDeleteRequest, type ActionDuplicateRequest, type ActionUpdateRequest, type BulkResponse, type ConnectionCreate, type ConnectionCreateResponse, type ConnectionGet, type ConnectionUpdate, type Connections, type CreateDataConnectionHttpError, type CreateDataConnectionHttpResponse, type DataConnectionsAPI, type DcaasConnectionCreate, type DcaasConnectionCreateAuthResponse, type DeleteDataConnectionHttpError, type DeleteDataConnectionHttpResponse, type DeleteDataConnectionsHttpError, type DeleteDataConnectionsHttpResponse, type DuplicateDataAConnectionHttpError, type DuplicateDataAConnectionHttpResponse, type Error, type Errors, type GetDataConnectionHttpError, type GetDataConnectionHttpResponse, type GetDataConnectionsHttpError, type GetDataConnectionsHttpResponse, type Link, type Meta, type PatchDataConnectionHttpError, type PatchDataConnectionHttpResponse, type PatchRequest, type Privilege, type ResponseErrors, type TopLevelLink, type UpdateDataConnectionHttpError, type UpdateDataConnectionHttpResponse, type UpdateDataConnectionsHttpError, type UpdateDataConnectionsHttpResponse, clearCache, createDataConnection, dataConnectionsExport as default, deleteDataConnection, deleteDataConnections, duplicateDataAConnection, getDataConnection, getDataConnections, patchDataConnection, updateDataConnection, updateDataConnections };