@qlik/api 0.0.1

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.
Files changed (160) hide show
  1. package/LICENSE +17 -0
  2. package/README.md +8 -0
  3. package/api-keys.d.mts +313 -0
  4. package/api-keys.d.ts +313 -0
  5. package/api-keys.js +76 -0
  6. package/api-keys.mjs +76 -0
  7. package/apps.d.mts +1921 -0
  8. package/apps.d.ts +1921 -0
  9. package/apps.js +331 -0
  10. package/apps.mjs +331 -0
  11. package/audits.d.mts +262 -0
  12. package/audits.d.ts +262 -0
  13. package/audits.js +63 -0
  14. package/audits.mjs +63 -0
  15. package/auth-CSVTXOZX.js +36 -0
  16. package/auth-TE272Q34.mjs +36 -0
  17. package/auth-types-nnUcWhuU.d.mts +98 -0
  18. package/auth-types-nnUcWhuU.d.ts +98 -0
  19. package/auth.d.mts +26 -0
  20. package/auth.d.ts +26 -0
  21. package/auth.js +13 -0
  22. package/auth.mjs +13 -0
  23. package/automations.d.mts +638 -0
  24. package/automations.d.ts +638 -0
  25. package/automations.js +166 -0
  26. package/automations.mjs +166 -0
  27. package/brands.d.mts +614 -0
  28. package/brands.d.ts +614 -0
  29. package/brands.js +118 -0
  30. package/brands.mjs +118 -0
  31. package/chunk-3YE7EI7I.mjs +17 -0
  32. package/chunk-4ES65KO3.js +57 -0
  33. package/chunk-4FLMND6T.js +25 -0
  34. package/chunk-4OMEH5SW.mjs +1337 -0
  35. package/chunk-CKPJE4IA.mjs +57 -0
  36. package/chunk-GUQBHY3H.mjs +25 -0
  37. package/chunk-OULT3V2U.js +17 -0
  38. package/chunk-WM7FQU2U.mjs +21 -0
  39. package/chunk-XASXL2NC.js +1337 -0
  40. package/chunk-ZT4C7KCQ.js +21 -0
  41. package/collections.d.mts +535 -0
  42. package/collections.d.ts +535 -0
  43. package/collections.js +100 -0
  44. package/collections.mjs +100 -0
  45. package/csp-origins.d.mts +258 -0
  46. package/csp-origins.d.ts +258 -0
  47. package/csp-origins.js +66 -0
  48. package/csp-origins.mjs +66 -0
  49. package/data-assets.d.mts +195 -0
  50. package/data-assets.d.ts +195 -0
  51. package/data-assets.js +61 -0
  52. package/data-assets.mjs +61 -0
  53. package/data-connections.d.mts +527 -0
  54. package/data-connections.d.ts +527 -0
  55. package/data-connections.js +96 -0
  56. package/data-connections.mjs +96 -0
  57. package/data-credentials.d.mts +188 -0
  58. package/data-credentials.d.ts +188 -0
  59. package/data-credentials.js +56 -0
  60. package/data-credentials.mjs +56 -0
  61. package/data-files.d.mts +471 -0
  62. package/data-files.d.ts +471 -0
  63. package/data-files.js +116 -0
  64. package/data-files.mjs +116 -0
  65. package/docs/examples.md +4 -0
  66. package/enigma-session-4L373ALV.mjs +10196 -0
  67. package/enigma-session-TEB53FAF.js +10196 -0
  68. package/esm-4X3DKK5D.js +63 -0
  69. package/esm-SOWVJKOQ.mjs +63 -0
  70. package/extensions.d.mts +257 -0
  71. package/extensions.d.ts +257 -0
  72. package/extensions.js +74 -0
  73. package/extensions.mjs +74 -0
  74. package/global.types-Eto4uYwy.d.mts +102 -0
  75. package/global.types-hIvp-WdX.d.ts +102 -0
  76. package/glossaries.d.mts +1041 -0
  77. package/glossaries.d.ts +1041 -0
  78. package/glossaries.js +225 -0
  79. package/glossaries.mjs +225 -0
  80. package/groups.d.mts +379 -0
  81. package/groups.d.ts +379 -0
  82. package/groups.js +83 -0
  83. package/groups.mjs +83 -0
  84. package/identity-providers.d.mts +492 -0
  85. package/identity-providers.d.ts +492 -0
  86. package/identity-providers.js +80 -0
  87. package/identity-providers.mjs +80 -0
  88. package/index.d.mts +142 -0
  89. package/index.d.ts +142 -0
  90. package/index.js +678 -0
  91. package/index.mjs +678 -0
  92. package/invoke-fetch-MSSJAZ7K.mjs +14 -0
  93. package/invoke-fetch-PEI54KZO.js +14 -0
  94. package/items.d.mts +501 -0
  95. package/items.d.ts +501 -0
  96. package/items.js +84 -0
  97. package/items.mjs +84 -0
  98. package/licenses.d.mts +436 -0
  99. package/licenses.d.ts +436 -0
  100. package/licenses.js +87 -0
  101. package/licenses.mjs +87 -0
  102. package/package.json +264 -0
  103. package/qix-EU7PXRZ6.mjs +573 -0
  104. package/qix-RLTISYTB.js +573 -0
  105. package/qix.d.mts +11543 -0
  106. package/qix.d.ts +11543 -0
  107. package/qix.js +9 -0
  108. package/qix.mjs +9 -0
  109. package/quotas.d.mts +105 -0
  110. package/quotas.d.ts +105 -0
  111. package/quotas.js +31 -0
  112. package/quotas.mjs +31 -0
  113. package/reload-tasks.d.mts +222 -0
  114. package/reload-tasks.d.ts +222 -0
  115. package/reload-tasks.js +59 -0
  116. package/reload-tasks.mjs +59 -0
  117. package/reloads.d.mts +189 -0
  118. package/reloads.d.ts +189 -0
  119. package/reloads.js +44 -0
  120. package/reloads.mjs +44 -0
  121. package/roles.d.mts +150 -0
  122. package/roles.d.ts +150 -0
  123. package/roles.js +30 -0
  124. package/roles.mjs +30 -0
  125. package/spaces.d.mts +524 -0
  126. package/spaces.d.ts +524 -0
  127. package/spaces.js +118 -0
  128. package/spaces.mjs +118 -0
  129. package/temp-contents.d.mts +222 -0
  130. package/temp-contents.d.ts +222 -0
  131. package/temp-contents.js +60 -0
  132. package/temp-contents.mjs +60 -0
  133. package/tenants.d.mts +276 -0
  134. package/tenants.d.ts +276 -0
  135. package/tenants.js +68 -0
  136. package/tenants.mjs +68 -0
  137. package/themes.d.mts +235 -0
  138. package/themes.d.ts +235 -0
  139. package/themes.js +74 -0
  140. package/themes.mjs +74 -0
  141. package/transports.d.mts +298 -0
  142. package/transports.d.ts +298 -0
  143. package/transports.js +62 -0
  144. package/transports.mjs +62 -0
  145. package/users.d.mts +544 -0
  146. package/users.d.ts +544 -0
  147. package/users.js +99 -0
  148. package/users.mjs +99 -0
  149. package/web-integrations.d.mts +246 -0
  150. package/web-integrations.d.ts +246 -0
  151. package/web-integrations.js +59 -0
  152. package/web-integrations.mjs +59 -0
  153. package/web-notifications.d.mts +220 -0
  154. package/web-notifications.d.ts +220 -0
  155. package/web-notifications.js +66 -0
  156. package/web-notifications.mjs +66 -0
  157. package/webhooks.d.mts +422 -0
  158. package/webhooks.d.ts +422 -0
  159. package/webhooks.js +100 -0
  160. package/webhooks.mjs +100 -0
@@ -0,0 +1,527 @@
1
+ import { A as ApiCallOptions } from './global.types-hIvp-WdX.js';
2
+ import './auth-types-nnUcWhuU.js';
3
+
4
+ type ActionDeleteRequest = {
5
+ connections: {
6
+ /** ID of connection */
7
+ id: string;
8
+ /** Connection name */
9
+ name?: string;
10
+ }[];
11
+ };
12
+ type ActionDuplicateRequest = {
13
+ /** ID of the source connection being duplicated */
14
+ id: string;
15
+ /** Optional name for the duplicated connection, must be unique in the target scope. If not specified, a name will be automatically generated */
16
+ name?: string;
17
+ /** Optional credential password, specify to override credential embedded (or associated) with the source connection */
18
+ qPassword?: string;
19
+ /** Optional credential username, specify to override credential embedded (or associated) with the source connection */
20
+ qUsername?: string;
21
+ /** Optional target space ID for the duplicated connection. If not specified, the duplicated connection will be in the same space as the source connection */
22
+ spaceId?: string;
23
+ };
24
+ type ActionUpdateRequest = {
25
+ connections: {
26
+ /** Connection ID */
27
+ id: string;
28
+ /** Connection name */
29
+ name?: string;
30
+ /** User ID to which the connection will be updated. If not present, the connection's owner wont be changed */
31
+ ownerId?: string;
32
+ /** 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) */
33
+ spaceId?: string;
34
+ /** Space type. Required when spaceId is specified */
35
+ spaceType?: "personal" | "shared" | "managed" | "data";
36
+ }[];
37
+ };
38
+ type BulkResponse = {
39
+ data?: {
40
+ error?: Error;
41
+ /** ID of the resource */
42
+ id: string;
43
+ /** Status code of operation on resource identified by ID */
44
+ status: number;
45
+ }[];
46
+ };
47
+ type Connection = {
48
+ /** Datetime when the connection was created */
49
+ created: string;
50
+ /** Data source ID */
51
+ datasourceID?: string;
52
+ links?: Link;
53
+ /** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
54
+ privileges: Privilege[];
55
+ /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
56
+ qArchitecture: 0 | 1;
57
+ /** Connection string for the data connection */
58
+ qConnectStatement: string;
59
+ /** 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 /data0connections/{qID} */
60
+ qConnectionSecret?: string;
61
+ /** ID of the credential associated with the connection */
62
+ qCredentialsID?: string;
63
+ /** Name of the credential associated with the connection */
64
+ qCredentialsName?: string;
65
+ /** Unique identifier (UUID) for the data connection, must be same as qID */
66
+ qEngineObjectID: string;
67
+ /** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
68
+ qID: string;
69
+ /** Indicates the type of user associated with the data connection */
70
+ qLogOn: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
71
+ /** Descriptive name of the data connection */
72
+ qName: string;
73
+ /** Reference key of credential in redis */
74
+ qReferenceKey?: string;
75
+ /** Indicates whether or not this is a credential-less connection */
76
+ qSeparateCredentials: boolean;
77
+ /** Type of connection - indicates connection provider type */
78
+ qType: string;
79
+ /** Encrypted base Qri string */
80
+ qri?: string;
81
+ /** ID of the space to which the connection belongs */
82
+ space?: string;
83
+ /** Tenant ID of the connection's creator (Only when extended=true in query) */
84
+ tenant?: string;
85
+ /** Datetime when the connection was last updated */
86
+ updated: string;
87
+ /** User ID of the connection's creator */
88
+ user: string;
89
+ };
90
+ type ConnectionCreate = {
91
+ /** ID of the datasource associated with this connection */
92
+ datasourceID: string;
93
+ /** ID of the cloud app that owns this connection */
94
+ owner?: string;
95
+ /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
96
+ qArchitecture?: 0 | 1;
97
+ /** Connection string for the data connection */
98
+ qConnectStatement: string;
99
+ /** String that contains connection specific secret (or password) that requires encryption before persist to database. This field is connection level secret */
100
+ qConnectionSecret?: string;
101
+ /** ID of the credential associated with the connection */
102
+ qCredentialsID?: string;
103
+ /** Name of the credential associated with the connection */
104
+ qCredentialsName?: string;
105
+ /** 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 */
106
+ qEngineObjectID?: string;
107
+ /** Unique identifier (UUID) for the data connection. A UUID will be generated automatically if qID is not specified or empty */
108
+ qID?: string;
109
+ /** Indicates the type of user associated with the data connection. */
110
+ qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
111
+ /** Descriptive name of the data connection */
112
+ qName: string;
113
+ /** Any logon password associated with the data connection */
114
+ qPassword?: string;
115
+ /** Indicates whether or not to create a credential-less connection */
116
+ qSeparateCredentials?: boolean;
117
+ /** Type of connection - indicates connection provider type */
118
+ qType: string;
119
+ /** Any logon username associated with the data connection */
120
+ qUsername?: string;
121
+ /** 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. */
122
+ qriInRequest?: string;
123
+ /** ID of the space to which the connection belongs */
124
+ space?: string;
125
+ };
126
+ type ConnectionCreateResponse = {
127
+ /** Datetime when the connection was created */
128
+ created?: string;
129
+ links?: Link;
130
+ privileges: Privilege[];
131
+ /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
132
+ qArchitecture: 0 | 1;
133
+ /** Connection string for the data connection */
134
+ qConnectStatement: string;
135
+ /** ID of the credential associated with the connection */
136
+ qCredentialsID?: string;
137
+ /** Name of the credential associated with the connection */
138
+ qCredentialsName?: string;
139
+ /** Unique identifier (UUID) for the data connection, must be same as qID */
140
+ qEngineObjectID: string;
141
+ /** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
142
+ qID: string;
143
+ /** Indicates the type of user associated with the data connection. */
144
+ qLogOn: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
145
+ /** Descriptive name of the data connection */
146
+ qName: string;
147
+ /** Reference key of credential in redis */
148
+ qReferenceKey?: string;
149
+ /** Indicates whether or not this is a credential-less connection */
150
+ qSeparateCredentials: boolean;
151
+ /** Type of connection - indicates connection provider type */
152
+ qType: string;
153
+ /** ID of the space to which the connection belongs */
154
+ space?: string;
155
+ /** Datetime when the connection was last updated */
156
+ updated?: string;
157
+ /** User ID of the connection's creator */
158
+ user?: string;
159
+ };
160
+ type ConnectionUpdate = {
161
+ /** ID of the datasource associated with this connection */
162
+ datasourceID?: string;
163
+ /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
164
+ qArchitecture?: 0 | 1;
165
+ /** Connection string for the data connection */
166
+ qConnectStatement: string;
167
+ /** 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 eixsting connection secret will be cleared. If this field is missing, existing secret will not be updated. */
168
+ qConnectionSecret?: string;
169
+ /** ID of the credential associated with the connection */
170
+ qCredentialsID?: string;
171
+ /** Name of the credential associated with the connection */
172
+ qCredentialsName?: string;
173
+ /** Unique identifier for the data connection as specified by the Sense engine */
174
+ qEngineObjectID: string;
175
+ /** Unique identifier for the data connection */
176
+ qID: string;
177
+ /** Indicates the type of user associated with the data connection. */
178
+ qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
179
+ /** Descriptive name of the data connection */
180
+ qName: string;
181
+ /** Any logon password associated with the data connection */
182
+ qPassword?: string;
183
+ /** Indicates whether or not this is a credential-less connection */
184
+ qSeparateCredentials?: boolean;
185
+ /** Type of connection - indicates connection provider type */
186
+ qType: string;
187
+ /** Any logon username associated with the data connection */
188
+ qUsername?: string;
189
+ /** ID of the space to which the connection belongs */
190
+ space?: string;
191
+ };
192
+ type Connections = {
193
+ data?: Connection[];
194
+ errors?: Errors;
195
+ links?: TopLevelLink;
196
+ meta?: Meta;
197
+ };
198
+ type Error = {
199
+ /** Unique internal error code */
200
+ code?: string;
201
+ /** More concrete details */
202
+ detail?: string;
203
+ /** A summary in english explaining what went wrong */
204
+ title?: string;
205
+ };
206
+ type Errors = Error[];
207
+ type Link = {
208
+ /** Link to cirrent query */
209
+ self: {
210
+ href: string;
211
+ };
212
+ };
213
+ type Meta = {
214
+ /** Total count of resources being requested. */
215
+ count?: number;
216
+ };
217
+ type PatchRequest = {
218
+ patchData: {
219
+ /** Operation type */
220
+ op?: "add" | "replace" | "remove";
221
+ /** Path to the target field to be patched */
222
+ path?: string;
223
+ /** 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 */
224
+ value?: string;
225
+ }[];
226
+ };
227
+ type Privilege = "list" | "update" | "delete" | "read";
228
+ type ResponseErrors = {
229
+ errors?: Errors;
230
+ };
231
+ type TopLevelLink = {
232
+ /** URL link to next page of requested resources (available to paged request only) */
233
+ next?: {
234
+ href: string;
235
+ };
236
+ /** URL link to previous page of requested resources (available to paged request only) */
237
+ prev?: {
238
+ href: string;
239
+ };
240
+ /** Link to cirrent query */
241
+ self: {
242
+ href: string;
243
+ };
244
+ };
245
+ /**
246
+ * Gets a list of connections
247
+ * @param query an object with query parameters
248
+ * @throws GetDataConnectionsHttpError
249
+ */
250
+ declare const getDataConnections: (query: {
251
+ /** Sort results will be returned in case insensitive order if set to true (Only used along with sort query) */
252
+ caseinsensitive?: boolean;
253
+ /** Provides an alternate name to be used for data[] element in GET response. */
254
+ dataName?: string;
255
+ /** Returns extended list of properties when set to true. */
256
+ extended?: boolean;
257
+ /** Base Qri (encrypted) will be returned when the query is set to true, default is false */
258
+ includeQris?: boolean;
259
+ /** Number of resources to be returned */
260
+ limit?: number;
261
+ /** ICU locale ID, used only when caseinsensitive is set to true, default to 'en' if undefined */
262
+ locale?: string;
263
+ /** Datafiles connections will not be returned if set to true */
264
+ noDatafiles?: boolean;
265
+ /** Filtering on conneections, return connections owned by the caller if set to true (doesn't apply to datafiles connectionos) */
266
+ ownedByMe?: boolean;
267
+ /** Filtering on datafile connections by owner (i.e. app) ID. */
268
+ owner?: string;
269
+ /** Pagination sursor string, which is generated auotmatically in previous pagination query. */
270
+ page?: string;
271
+ /** Filtering on connections, connections in personal space will be returned if set to true */
272
+ personal?: boolean;
273
+ /** 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. */
274
+ sort?: string;
275
+ /** Filtering on connections by space ID */
276
+ spaceId?: string;
277
+ /** Filtering on userId. Requires admin role if specified userId doesn't match that is defined in JWT. */
278
+ userId?: string;
279
+ }, options?: ApiCallOptions) => Promise<GetDataConnectionsHttpResponse>;
280
+ type GetDataConnectionsHttpResponse = {
281
+ data: Connections;
282
+ headers: Headers;
283
+ status: number;
284
+ prev?: (options?: ApiCallOptions) => Promise<GetDataConnectionsHttpResponse>;
285
+ next?: (options?: ApiCallOptions) => Promise<GetDataConnectionsHttpResponse>;
286
+ };
287
+ type GetDataConnectionsHttpError = {
288
+ data: ResponseErrors;
289
+ headers: Headers;
290
+ status: number;
291
+ };
292
+ /**
293
+ * Creates a connection. Depends on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.
294
+ * @param body an object with the body content
295
+ * @throws CreateDataConnectionHttpError
296
+ */
297
+ declare const createDataConnection: (body: ConnectionCreate, options?: ApiCallOptions) => Promise<CreateDataConnectionHttpResponse>;
298
+ type CreateDataConnectionHttpResponse = {
299
+ data: ConnectionCreateResponse;
300
+ headers: Headers;
301
+ status: number;
302
+ };
303
+ type CreateDataConnectionHttpError = {
304
+ data: ResponseErrors;
305
+ headers: Headers;
306
+ status: number;
307
+ };
308
+ /**
309
+ * Delete multiple connections, only available to Admin
310
+ * @param body an object with the body content
311
+ * @throws DeleteDataConnectionsHttpError
312
+ */
313
+ declare const deleteDataConnections: (body: ActionDeleteRequest, options?: ApiCallOptions) => Promise<DeleteDataConnectionsHttpResponse>;
314
+ type DeleteDataConnectionsHttpResponse = {
315
+ data: BulkResponse;
316
+ headers: Headers;
317
+ status: number;
318
+ };
319
+ type DeleteDataConnectionsHttpError = {
320
+ data: ResponseErrors;
321
+ headers: Headers;
322
+ status: number;
323
+ };
324
+ /**
325
+ * Duplicate a connection
326
+ * @param body an object with the body content
327
+ * @throws DuplicateDataAConnectionHttpError
328
+ */
329
+ declare const duplicateDataAConnection: (body: ActionDuplicateRequest, options?: ApiCallOptions) => Promise<DuplicateDataAConnectionHttpResponse>;
330
+ type DuplicateDataAConnectionHttpResponse = {
331
+ data: ConnectionCreateResponse;
332
+ headers: Headers;
333
+ status: number;
334
+ };
335
+ type DuplicateDataAConnectionHttpError = {
336
+ data: ResponseErrors;
337
+ headers: Headers;
338
+ status: number;
339
+ };
340
+ /**
341
+ * Update multiple connections, only available to Admin
342
+ * @param body an object with the body content
343
+ * @throws UpdateDataConnectionsHttpError
344
+ */
345
+ declare const updateDataConnections: (body: ActionUpdateRequest, options?: ApiCallOptions) => Promise<UpdateDataConnectionsHttpResponse>;
346
+ type UpdateDataConnectionsHttpResponse = {
347
+ data: BulkResponse;
348
+ headers: Headers;
349
+ status: number;
350
+ };
351
+ type UpdateDataConnectionsHttpError = {
352
+ data: ResponseErrors;
353
+ headers: Headers;
354
+ status: number;
355
+ };
356
+ /**
357
+ * Deletes the specified data connection by ID (or by name when type=connectionname is set in query)
358
+ * @param qID Connection ID
359
+ * @param query an object with query parameters
360
+ * @throws DeleteDataConnectionHttpError
361
+ */
362
+ declare const deleteDataConnection: (qID: string, query: {
363
+ /** Filtering on connections by space ID */
364
+ spaceId?: string;
365
+ /** Connection / credential ID defined in path become connection / credential name when this query parameter is set */
366
+ type?: "connectionname" | "credentialname";
367
+ }, options?: ApiCallOptions) => Promise<DeleteDataConnectionHttpResponse>;
368
+ type DeleteDataConnectionHttpResponse = {
369
+ data: void;
370
+ headers: Headers;
371
+ status: number;
372
+ };
373
+ type DeleteDataConnectionHttpError = {
374
+ data: ResponseErrors;
375
+ headers: Headers;
376
+ status: number;
377
+ };
378
+ /**
379
+ * Gets a connection by connection ID (or by name when type=connectionname is set in query)
380
+ * @param qID Connection ID
381
+ * @param query an object with query parameters
382
+ * @throws GetDataConnectionHttpError
383
+ */
384
+ declare const getDataConnection: (qID: string, query: {
385
+ /** If set to true, credentialId in the query will be intepreted as credential's name */
386
+ byCredentialName?: boolean;
387
+ /** Credential ID */
388
+ credentialId?: string;
389
+ /** Returns extended list of properties when set to true. */
390
+ extended?: boolean;
391
+ /** 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 */
392
+ noCache?: boolean;
393
+ /** Filtering on connections by space ID */
394
+ spaceId?: string;
395
+ /** Connection / credential ID defined in path become connection / credential name when this query parameter is set */
396
+ type?: "connectionname" | "credentialname";
397
+ }, options?: ApiCallOptions) => Promise<GetDataConnectionHttpResponse>;
398
+ type GetDataConnectionHttpResponse = {
399
+ data: Connection;
400
+ headers: Headers;
401
+ status: number;
402
+ };
403
+ type GetDataConnectionHttpError = {
404
+ data: ResponseErrors;
405
+ headers: Headers;
406
+ status: number;
407
+ };
408
+ /**
409
+ * Patches a connection specified by connection ID (or by name when type=connectionname is set in query).
410
+ * @param qID Connection ID
411
+ * @param query an object with query parameters
412
+ * @param body an object with the body content
413
+ * @throws PatchDataConnectionHttpError
414
+ */
415
+ declare const patchDataConnection: (qID: string, query: {
416
+ /** Connection / credential ID defined in path become connection / credential name when this query parameter is set */
417
+ type?: "connectionname" | "credentialname";
418
+ }, body: PatchRequest, options?: ApiCallOptions) => Promise<PatchDataConnectionHttpResponse>;
419
+ type PatchDataConnectionHttpResponse = {
420
+ data: void;
421
+ headers: Headers;
422
+ status: number;
423
+ };
424
+ type PatchDataConnectionHttpError = {
425
+ data: ResponseErrors;
426
+ headers: Headers;
427
+ status: number;
428
+ };
429
+ /**
430
+ * 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.
431
+ * @param qID Connection ID
432
+ * @param query an object with query parameters
433
+ * @param body an object with the body content
434
+ * @throws UpdateDataConnectionHttpError
435
+ */
436
+ declare const updateDataConnection: (qID: string, query: {
437
+ /** Filtering on connections by space ID */
438
+ spaceId?: string;
439
+ /** Connection / credential ID defined in path become connection / credential name when this query parameter is set */
440
+ type?: "connectionname" | "credentialname";
441
+ }, body: ConnectionUpdate, options?: ApiCallOptions) => Promise<UpdateDataConnectionHttpResponse>;
442
+ type UpdateDataConnectionHttpResponse = {
443
+ data: void;
444
+ headers: Headers;
445
+ status: number;
446
+ };
447
+ type UpdateDataConnectionHttpError = {
448
+ data: ResponseErrors;
449
+ headers: Headers;
450
+ status: number;
451
+ };
452
+ /**
453
+ * Clears the cache for data-connections api requests.
454
+ */
455
+ declare function clearCache(): void;
456
+ interface DataConnectionsAPI {
457
+ /**
458
+ * Gets a list of connections
459
+ * @param query an object with query parameters
460
+ * @throws GetDataConnectionsHttpError
461
+ */
462
+ getDataConnections: typeof getDataConnections;
463
+ /**
464
+ * Creates a connection. Depends on the fields defined in the request body, credentials embedded (or associated) in the connection can be updated or created.
465
+ * @param body an object with the body content
466
+ * @throws CreateDataConnectionHttpError
467
+ */
468
+ createDataConnection: typeof createDataConnection;
469
+ /**
470
+ * Delete multiple connections, only available to Admin
471
+ * @param body an object with the body content
472
+ * @throws DeleteDataConnectionsHttpError
473
+ */
474
+ deleteDataConnections: typeof deleteDataConnections;
475
+ /**
476
+ * Duplicate a connection
477
+ * @param body an object with the body content
478
+ * @throws DuplicateDataAConnectionHttpError
479
+ */
480
+ duplicateDataAConnection: typeof duplicateDataAConnection;
481
+ /**
482
+ * Update multiple connections, only available to Admin
483
+ * @param body an object with the body content
484
+ * @throws UpdateDataConnectionsHttpError
485
+ */
486
+ updateDataConnections: typeof updateDataConnections;
487
+ /**
488
+ * Deletes the specified data connection by ID (or by name when type=connectionname is set in query)
489
+ * @param qID Connection ID
490
+ * @param query an object with query parameters
491
+ * @throws DeleteDataConnectionHttpError
492
+ */
493
+ deleteDataConnection: typeof deleteDataConnection;
494
+ /**
495
+ * Gets a connection by connection ID (or by name when type=connectionname is set in query)
496
+ * @param qID Connection ID
497
+ * @param query an object with query parameters
498
+ * @throws GetDataConnectionHttpError
499
+ */
500
+ getDataConnection: typeof getDataConnection;
501
+ /**
502
+ * Patches a connection specified by connection ID (or by name when type=connectionname is set in query).
503
+ * @param qID Connection ID
504
+ * @param query an object with query parameters
505
+ * @param body an object with the body content
506
+ * @throws PatchDataConnectionHttpError
507
+ */
508
+ patchDataConnection: typeof patchDataConnection;
509
+ /**
510
+ * 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.
511
+ * @param qID Connection ID
512
+ * @param query an object with query parameters
513
+ * @param body an object with the body content
514
+ * @throws UpdateDataConnectionHttpError
515
+ */
516
+ updateDataConnection: typeof updateDataConnection;
517
+ /**
518
+ * Clears the cache for data-connections api requests.
519
+ */
520
+ clearCache: typeof clearCache;
521
+ }
522
+ /**
523
+ * Functions for the data-connections api
524
+ */
525
+ declare const dataConnectionsExport: DataConnectionsAPI;
526
+
527
+ export { type ActionDeleteRequest, type ActionDuplicateRequest, type ActionUpdateRequest, type BulkResponse, type Connection, type ConnectionCreate, type ConnectionCreateResponse, type ConnectionUpdate, type Connections, type CreateDataConnectionHttpError, type CreateDataConnectionHttpResponse, type DataConnectionsAPI, 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 };
@@ -0,0 +1,96 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
+
3
+
4
+ var _chunkOULT3V2Ujs = require('./chunk-OULT3V2U.js');
5
+ require('./chunk-ZT4C7KCQ.js');
6
+
7
+ // src/public/rest/data-connections.ts
8
+ var getDataConnections = async (query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-connections", {
9
+ method: "get",
10
+ pathTemplate: "/api/v1/data-connections",
11
+ query,
12
+ options
13
+ });
14
+ var createDataConnection = async (body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-connections", {
15
+ method: "post",
16
+ pathTemplate: "/api/v1/data-connections",
17
+ body,
18
+ options
19
+ });
20
+ var deleteDataConnections = async (body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-connections", {
21
+ method: "post",
22
+ pathTemplate: "/api/v1/data-connections/actions/delete",
23
+ body,
24
+ options
25
+ });
26
+ var duplicateDataAConnection = async (body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-connections", {
27
+ method: "post",
28
+ pathTemplate: "/api/v1/data-connections/actions/duplicate",
29
+ body,
30
+ options
31
+ });
32
+ var updateDataConnections = async (body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-connections", {
33
+ method: "post",
34
+ pathTemplate: "/api/v1/data-connections/actions/update",
35
+ body,
36
+ options
37
+ });
38
+ var deleteDataConnection = async (qID, query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-connections", {
39
+ method: "delete",
40
+ pathTemplate: "/api/v1/data-connections/{qID}",
41
+ pathVariables: { qID },
42
+ query,
43
+ options
44
+ });
45
+ var getDataConnection = async (qID, query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-connections", {
46
+ method: "get",
47
+ pathTemplate: "/api/v1/data-connections/{qID}",
48
+ pathVariables: { qID },
49
+ query,
50
+ options
51
+ });
52
+ var patchDataConnection = async (qID, query, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-connections", {
53
+ method: "patch",
54
+ pathTemplate: "/api/v1/data-connections/{qID}",
55
+ pathVariables: { qID },
56
+ query,
57
+ body,
58
+ options
59
+ });
60
+ var updateDataConnection = async (qID, query, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "data-connections", {
61
+ method: "put",
62
+ pathTemplate: "/api/v1/data-connections/{qID}",
63
+ pathVariables: { qID },
64
+ query,
65
+ body,
66
+ options
67
+ });
68
+ function clearCache() {
69
+ return _chunkOULT3V2Ujs.clearApiCache.call(void 0, "data-connections");
70
+ }
71
+ var dataConnectionsExport = {
72
+ getDataConnections,
73
+ createDataConnection,
74
+ deleteDataConnections,
75
+ duplicateDataAConnection,
76
+ updateDataConnections,
77
+ deleteDataConnection,
78
+ getDataConnection,
79
+ patchDataConnection,
80
+ updateDataConnection,
81
+ clearCache
82
+ };
83
+ var data_connections_default = dataConnectionsExport;
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ exports.clearCache = clearCache; exports.createDataConnection = createDataConnection; exports.default = data_connections_default; exports.deleteDataConnection = deleteDataConnection; exports.deleteDataConnections = deleteDataConnections; exports.duplicateDataAConnection = duplicateDataAConnection; exports.getDataConnection = getDataConnection; exports.getDataConnections = getDataConnections; exports.patchDataConnection = patchDataConnection; exports.updateDataConnection = updateDataConnection; exports.updateDataConnections = updateDataConnections;