@qlik/api 2.2.0 → 2.3.0

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 (231) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/{auth-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-DipDBQQ5.js} +258 -54
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +6 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-D11iO7ZV.js +0 -65
  163. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  164. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  165. package/chunks/automations-BGy83EBO.d.ts +0 -797
  166. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  167. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  168. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  169. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  170. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  171. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  172. package/chunks/consumption-DerFk437.d.ts +0 -182
  173. package/chunks/core-DQXNZdnf.d.ts +0 -12
  174. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  175. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  176. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  177. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  178. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  179. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  180. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  181. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  182. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  183. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  184. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  185. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  186. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  187. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  188. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  189. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  190. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  191. package/chunks/groups-C86-UG7S.d.ts +0 -511
  192. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  193. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  194. package/chunks/interceptors-DTYm37AU.js +0 -104
  195. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  196. package/chunks/ip-policies-DXlf172B.js +0 -108
  197. package/chunks/items-C-jzqvFW.d.ts +0 -536
  198. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  199. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  200. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  201. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  202. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  203. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  204. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  205. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  206. package/chunks/qix-CYQsLyGQ.js +0 -40
  207. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  208. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  209. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  210. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  211. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  212. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  213. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  214. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  215. package/chunks/spaces-BK823t-b.d.ts +0 -780
  216. package/chunks/tasks-COKDfShO.d.ts +0 -564
  217. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  218. package/chunks/tenants-Bhn86519.d.ts +0 -361
  219. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  220. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  221. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  222. package/chunks/users-BSOBU_fg.d.ts +0 -675
  223. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  224. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  225. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  226. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  227. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  228. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  229. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  230. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  231. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,678 +0,0 @@
1
- import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/data-connections.d.ts
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
- /**
48
- * Schema used to create a connection with given connection string (i.e. qConnectStatement) along with other metadata
49
- */
50
- type ConnectionCreate = {
51
- /** ID of the datasource associated with this connection */
52
- datasourceID: string;
53
- /** App ID */
54
- owner?: string;
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) that requires encryption before persist to database. This field is connection level secret */
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 as specified by the Sense engine. A UUID will be generated automatically if this field is not specified or empty */
66
- qEngineObjectID?: string;
67
- /** Unique identifier (UUID) for the data connection. A UUID will be generated automatically if qID is not specified or empty */
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
- /** Any logon password associated with the data connection (connector encoded) */
74
- qPassword?: string;
75
- /** Indicates whether or not to create a credential-less connection */
76
- qSeparateCredentials?: boolean;
77
- /** Type of connection - indicates connection provider type */
78
- qType: string;
79
- /** Any logon username associated with the data connection */
80
- qUsername?: string;
81
- /** 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. */
82
- qriInRequest?: string;
83
- /** ID of the space to which the connection belongs */
84
- space?: string;
85
- /** List of tags attached to the connection (allow max 32 tags) */
86
- tags?: string[];
87
- };
88
- /**
89
- * Essential fields of a connection
90
- */
91
- type ConnectionCreateResponse = {
92
- /** Datetime when the connection was created */
93
- created?: string;
94
- links?: Link;
95
- /** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
96
- privileges: Privilege[];
97
- /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
98
- qArchitecture: 0 | 1;
99
- /** Connection string for the data connection */
100
- qConnectStatement: 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, must be same as qID */
106
- qEngineObjectID: string;
107
- /** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
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
- /** Reference key of credential in redis */
114
- qReferenceKey?: string;
115
- /** Indicates whether or not this is a credential-less connection */
116
- qSeparateCredentials: boolean;
117
- /** Type of connection - indicates connection provider type */
118
- qType: string;
119
- /** ID of the space to which the connection belongs */
120
- space?: string;
121
- /** Datetime when the connection was last updated */
122
- updated?: string;
123
- /** User ID of the connection's creator */
124
- user?: string;
125
- };
126
- /**
127
- * Essential fields of a connection
128
- */
129
- type ConnectionGet = {
130
- /** List of connection parsed from connection string (only available when query parseConnection=true is set) */
131
- connectionProperties?: unknown;
132
- /** Datetime when the connection was created */
133
- created?: string;
134
- /** Data source ID */
135
- datasourceID?: string;
136
- links: Link;
137
- /** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
138
- privileges: Privilege[];
139
- /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
140
- qArchitecture: 0 | 1;
141
- /** Connection string for the data connection */
142
- qConnectStatement: string;
143
- /** 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} */
144
- qConnectionSecret?: string;
145
- /** ID of the credential associated with the connection */
146
- qCredentialsID?: string;
147
- /** Unique identifier (UUID) for the data connection, must be same as qID */
148
- qEngineObjectID: string;
149
- /** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
150
- qID: string;
151
- /** Indicates the type of user associated with the data connection */
152
- qLogOn: 0 | 1;
153
- /** Descriptive name of the data connection */
154
- qName: string;
155
- /** Indicates whether or not this is a credential-less connection */
156
- qSeparateCredentials?: boolean;
157
- /** Type of connection, i.e. provider type of underlying connector */
158
- qType: string;
159
- /** Encrypted base Qri string (filterable using SCIM filter, e.g. filter='qri co "snowflake"') */
160
- qri?: string;
161
- /** ID of the space to which the connection belongs */
162
- space?: string;
163
- /** List of tags attached to the connection */
164
- tags?: string[];
165
- /** Tenant ID of the connection's creator */
166
- tenant: string;
167
- /** Datetime when the connection was last updated */
168
- updated?: string;
169
- /** User ID of the connection's creator */
170
- user?: string;
171
- };
172
- type ConnectionUpdate = {
173
- /** ID of the datasource associated with this connection */
174
- datasourceID?: string;
175
- /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
176
- qArchitecture?: 0 | 1;
177
- /** Connection string for the data connection */
178
- qConnectStatement: string;
179
- /** 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. */
180
- qConnectionSecret?: string;
181
- /** ID of the credential associated with the connection */
182
- qCredentialsID?: string;
183
- /** Name of the credential associated with the connection */
184
- qCredentialsName?: string;
185
- /** Unique identifier for the data connection as specified by the Sense engine */
186
- qEngineObjectID: string;
187
- /** Unique identifier for the data connection */
188
- qID: string;
189
- /** Indicates the type of user associated with the data connection. */
190
- qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
191
- /** Descriptive name of the data connection */
192
- qName: string;
193
- /** Any logon password associated with the data connection */
194
- qPassword?: string;
195
- /** Indicates whether or not this is a credential-less connection */
196
- qSeparateCredentials?: boolean;
197
- /** Type of connection - indicates connection provider type */
198
- qType: string;
199
- /** Any logon username associated with the data connection */
200
- qUsername?: string;
201
- /** ID of the space to which the connection belongs */
202
- space?: string;
203
- };
204
- type Connections = {
205
- data?: ConnectionGet[];
206
- errors?: Errors;
207
- links?: TopLevelLink;
208
- meta?: Meta;
209
- };
210
- /**
211
- * Schema used to create a connection using a list of connection properties for given datasource
212
- */
213
- type DcaasConnectionCreate = {
214
- /** 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 */
215
- authUrlOnly?: boolean;
216
- /** Connection properties required to create dataconnection for the given datasource, which is defined by the response of 'GET /v1/data-sources/:{datasourceId}/api-specs' */
217
- connectionProperties: unknown;
218
- /** ID of the datasource of the connection */
219
- datasourceID: string;
220
- /** Descriptive name of the data connection */
221
- qName: string;
222
- /** ID of the space in which the connection shall be created. Connection will be created in user's personal space if undefined */
223
- space?: string;
224
- /** List of tags attached to the connection (allow max 31 tags) */
225
- tags?: string[];
226
- };
227
- /**
228
- * Authentication URL response for OAuth datasources (when authUrlOnly is set to true in request)
229
- */
230
- type DcaasConnectionCreateAuthResponse = {
231
- /** Authentication URL used to generate authentication code for datasources supporting OAuth */
232
- authUrl: string;
233
- };
234
- type Error = {
235
- /** Unique internal error code */
236
- code?: string;
237
- /** More concrete details */
238
- detail?: string;
239
- /** HTTP status code */
240
- status?: number;
241
- /** A summary in english explaining what went wrong */
242
- title?: string;
243
- };
244
- type Errors = Error[];
245
- type Link = {
246
- /** Link to current query */
247
- self: {
248
- /** URL pointing to the resource */
249
- href: string;
250
- };
251
- };
252
- type Meta = {
253
- /** Total count of resources being requested. */
254
- count?: number;
255
- };
256
- type PatchRequest = {
257
- /** Operation type */
258
- op: "add" | "replace" | "remove";
259
- /** Path to the target field to be patched */
260
- path: string;
261
- /** Value used for the patch. Required only for `add` or `replace` operations. The value type should match the type of the target field. */
262
- value?: string | boolean | number | unknown[];
263
- }[];
264
- /**
265
- * Access type allowed on associated data connection
266
- * @example
267
- * "list"
268
- */
269
- type Privilege = "list" | "update" | "delete" | "read" | "change_owner" | "change_space";
270
- type ResponseErrors = {
271
- errors?: Errors;
272
- };
273
- type TopLevelLink = {
274
- /** URL link to next page of requested resources (available to paged request only) */
275
- next?: {
276
- /** URL pointing to the next page of resources */
277
- href: string;
278
- };
279
- /** URL link to previous page of requested resources (available to paged request only) */
280
- prev?: {
281
- /** URL pointing to the previous page of resources */
282
- href: string;
283
- };
284
- /** Link to current query */
285
- self: {
286
- /** URL pointing to the resource */
287
- href: string;
288
- };
289
- };
290
- /**
291
- * Gets a list of connections
292
- * @example
293
- * getDataConnections(
294
- * {
295
- * dataName: "data",
296
- * extended: false,
297
- * spaceId: "611bcebaeec1203d88211ac4",
298
- * personal: false,
299
- * owner: "928e2a66-01ba-4678-aa32-e74c213896fa",
300
- * ownedByMe: true,
301
- * limit: 30,
302
- * sort: "+qName",
303
- * page: "page=JwAAAAljcmVhdGVkAPfQ-sx0AQAAB19pZABfb93nZcM4SN1M0e8A",
304
- * noDatafiles: true,
305
- * userId: "6K9xjsItDexffolu5vg1oWYkY8x7f-0G",
306
- * caseinsensitive: true,
307
- * locale: "en",
308
- * includeQris: true,
309
- * includeDisabled: true
310
- * }
311
- * )
312
- *
313
- * @param query an object with query parameters
314
- * @throws GetDataConnectionsHttpError
315
- */
316
- declare function getDataConnections(query: {
317
- /** Sort results will be returned in case insensitive order if set to true (Only used along with sort query) */
318
- caseinsensitive?: boolean;
319
- /** Provides an alternate name to be used for data[] element in GET response. */
320
- dataName?: string;
321
- /** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
322
- extended?: boolean;
323
- /** 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. */
324
- filter?: string;
325
- /** Includes connections that uses disabled datasources */
326
- includeDisabled?: boolean;
327
- /** Base Qri (encrypted) will be returned when the query is set to true, default is false */
328
- includeQris?: boolean;
329
- /** Number of resources to be returned (between 1 and 100) */
330
- limit?: number;
331
- /** ICU locale ID, used only when caseinsensitive is set to true, default to 'en' if undefined */
332
- locale?: string;
333
- /** Datafiles connections will not be returned if set to true */
334
- noDatafiles?: boolean;
335
- /** Filtering on connections, return connections owned by the caller if set to true (doesn't apply to datafiles connections) */
336
- ownedByMe?: boolean;
337
- /** Filtering on datafile connections by owner (i.e. app) ID. */
338
- owner?: string;
339
- /** Pagination cursor string, which is generated automatically in previous pagination query. */
340
- page?: string;
341
- /** Filtering on personal connections, ignored if spaceId is defined in same request */
342
- personal?: boolean;
343
- /** 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. */
344
- sort?: string;
345
- /** Filtering on connections by space ID */
346
- spaceId?: string;
347
- /** Filtering on userId. Requires admin role if specified userId doesn't match that is defined in JWT. */
348
- userId?: string;
349
- }, options?: ApiCallOptions): Promise<GetDataConnectionsHttpResponse>;
350
- type GetDataConnectionsHttpResponse = {
351
- data: Connections;
352
- headers: Headers;
353
- status: 200;
354
- prev?: (options?: ApiCallOptions) => Promise<GetDataConnectionsHttpResponse>;
355
- next?: (options?: ApiCallOptions) => Promise<GetDataConnectionsHttpResponse>;
356
- };
357
- type GetDataConnectionsHttpError = {
358
- data: ResponseErrors;
359
- headers: Headers;
360
- status: 400 | 500 | 502;
361
- };
362
- /**
363
- * 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.
364
- *
365
- * @param body an object with the body content
366
- * @throws CreateDataConnectionHttpError
367
- */
368
- declare function createDataConnection(body: ConnectionCreate | DcaasConnectionCreate, options?: ApiCallOptions): Promise<CreateDataConnectionHttpResponse>;
369
- type CreateDataConnectionHttpResponse = {
370
- data: ConnectionCreateResponse | DcaasConnectionCreateAuthResponse;
371
- headers: Headers;
372
- status: 201;
373
- };
374
- type CreateDataConnectionHttpError = {
375
- data: ResponseErrors;
376
- headers: Headers;
377
- status: 400 | 403 | 404 | 409;
378
- };
379
- /**
380
- * Delete multiple connections, only available to Admin
381
- *
382
- * @param body an object with the body content
383
- * @throws DeleteDataConnectionsHttpError
384
- */
385
- declare function deleteDataConnections(body: ActionDeleteRequest, options?: ApiCallOptions): Promise<DeleteDataConnectionsHttpResponse>;
386
- type DeleteDataConnectionsHttpResponse = {
387
- data: BulkResponse;
388
- headers: Headers;
389
- status: 207;
390
- };
391
- type DeleteDataConnectionsHttpError = {
392
- data: ResponseErrors;
393
- headers: Headers;
394
- status: 400 | 403;
395
- };
396
- /**
397
- * Duplicate a connection
398
- *
399
- * @param body an object with the body content
400
- * @throws DuplicateDataAConnectionHttpError
401
- */
402
- declare function duplicateDataAConnection(body: ActionDuplicateRequest, options?: ApiCallOptions): Promise<DuplicateDataAConnectionHttpResponse>;
403
- type DuplicateDataAConnectionHttpResponse = {
404
- data: ConnectionCreateResponse;
405
- headers: Headers;
406
- status: 201;
407
- };
408
- type DuplicateDataAConnectionHttpError = {
409
- data: ResponseErrors;
410
- headers: Headers;
411
- status: 400 | 403 | 404 | 409;
412
- };
413
- /**
414
- * 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.
415
- *
416
- * @param body an object with the body content
417
- * @throws UpdateDataConnectionsHttpError
418
- */
419
- declare function updateDataConnections(body: ActionUpdateRequest, options?: ApiCallOptions): Promise<UpdateDataConnectionsHttpResponse>;
420
- type UpdateDataConnectionsHttpResponse = {
421
- data: BulkResponse;
422
- headers: Headers;
423
- status: 207;
424
- };
425
- type UpdateDataConnectionsHttpError = {
426
- data: ResponseErrors;
427
- headers: Headers;
428
- status: 400 | 403;
429
- };
430
- /**
431
- * Deletes the specified data connection by ID (or by name when type=connectionname is set in query)
432
- * @example
433
- * deleteDataConnection(
434
- * "82ee7b44-0c4d-491b-bd38-82640c0430a5",
435
- * {
436
- * type: "connectionname",
437
- * spaceId: "611bcebaeec1203d88211ac4"
438
- * }
439
- * )
440
- *
441
- * @param qID Connection ID
442
- * @param query an object with query parameters
443
- * @throws DeleteDataConnectionHttpError
444
- */
445
- declare function deleteDataConnection(qID: string, query: {
446
- /** Filtering on connections by space ID */
447
- spaceId?: string;
448
- /** The connection ID in the path becomes a connection name when this query parameter is set. */
449
- type?: "connectionname";
450
- }, options?: ApiCallOptions): Promise<DeleteDataConnectionHttpResponse>;
451
- type DeleteDataConnectionHttpResponse = {
452
- data: void;
453
- headers: Headers;
454
- status: 204;
455
- };
456
- type DeleteDataConnectionHttpError = {
457
- data: ResponseErrors;
458
- headers: Headers;
459
- status: 403 | 404;
460
- };
461
- /**
462
- * Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."
463
- * @example
464
- * getDataConnection(
465
- * "82ee7b44-0c4d-491b-bd38-82640c0430a5",
466
- * {
467
- * extended: false,
468
- * type: "connectionname",
469
- * credentialId: "22379dc5-076e-4fec-ae20-5529a8a57dc2",
470
- * byCredentialName: false,
471
- * spaceId: "611bcebaeec1203d88211ac4",
472
- * noCache: false,
473
- * parseConnection: true
474
- * }
475
- * )
476
- *
477
- * @param qID Connection ID
478
- * @param query an object with query parameters
479
- * @throws GetDataConnectionHttpError
480
- */
481
- declare function getDataConnection(qID: string, query: {
482
- /** If set to true, credentialId in the query will be interpreted as credential's name */
483
- byCredentialName?: boolean;
484
- /** Credential ID */
485
- credentialId?: string;
486
- /** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
487
- extended?: boolean;
488
- /** 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 */
489
- noCache?: boolean;
490
- /** List of connection properties shall be returned when the query is set to true, default is false */
491
- parseConnection?: boolean;
492
- /** Filtering on connections by space ID */
493
- spaceId?: string;
494
- /** The connection ID in the path becomes a connection name when this query parameter is set. */
495
- type?: "connectionname";
496
- }, options?: ApiCallOptions): Promise<GetDataConnectionHttpResponse>;
497
- type GetDataConnectionHttpResponse = {
498
- data: ConnectionGet;
499
- headers: Headers;
500
- status: 200;
501
- };
502
- type GetDataConnectionHttpError = {
503
- data: ResponseErrors;
504
- headers: Headers;
505
- status: 400 | 403 | 404 | 500;
506
- };
507
- /**
508
- * Patches a connection specified by connection ID (or by name when type=connectionname is set in query).
509
- *
510
- * @param qID Connection ID
511
- * @param query an object with query parameters
512
- * @param body an object with the body content
513
- * @throws PatchDataConnectionHttpError
514
- */
515
- declare function patchDataConnection(qID: string, query: {
516
- /** The connection ID in the path becomes a connection name when this query parameter is set. */
517
- type?: "connectionname";
518
- }, body: PatchRequest, options?: ApiCallOptions): Promise<PatchDataConnectionHttpResponse>;
519
- type PatchDataConnectionHttpResponse = {
520
- data: void;
521
- headers: Headers;
522
- status: 204;
523
- };
524
- type PatchDataConnectionHttpError = {
525
- data: ResponseErrors;
526
- headers: Headers;
527
- status: 400 | 403 | 404 | 409;
528
- };
529
- /**
530
- * 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.
531
- *
532
- * @param qID Connection ID
533
- * @param query an object with query parameters
534
- * @param body an object with the body content
535
- * @throws UpdateDataConnectionHttpError
536
- */
537
- declare function updateDataConnection(qID: string, query: {
538
- /** Filtering on connections by space ID */
539
- spaceId?: string;
540
- /** The connection ID in the path becomes a connection name when this query parameter is set. */
541
- type?: "connectionname";
542
- }, body: ConnectionUpdate, options?: ApiCallOptions): Promise<UpdateDataConnectionHttpResponse>;
543
- type UpdateDataConnectionHttpResponse = {
544
- data: void;
545
- headers: Headers;
546
- status: 204;
547
- };
548
- type UpdateDataConnectionHttpError = {
549
- data: ResponseErrors;
550
- headers: Headers;
551
- status: 400 | 403 | 404 | 409;
552
- };
553
- /**
554
- * Clears the cache for data-connections api requests.
555
- */
556
- declare function clearCache(): void;
557
- type DataConnectionsAPI = {
558
- /**
559
- * Gets a list of connections
560
- * @example
561
- * getDataConnections(
562
- * {
563
- * dataName: "data",
564
- * extended: false,
565
- * spaceId: "611bcebaeec1203d88211ac4",
566
- * personal: false,
567
- * owner: "928e2a66-01ba-4678-aa32-e74c213896fa",
568
- * ownedByMe: true,
569
- * limit: 30,
570
- * sort: "+qName",
571
- * page: "page=JwAAAAljcmVhdGVkAPfQ-sx0AQAAB19pZABfb93nZcM4SN1M0e8A",
572
- * noDatafiles: true,
573
- * userId: "6K9xjsItDexffolu5vg1oWYkY8x7f-0G",
574
- * caseinsensitive: true,
575
- * locale: "en",
576
- * includeQris: true,
577
- * includeDisabled: true
578
- * }
579
- * )
580
- *
581
- * @param query an object with query parameters
582
- * @throws GetDataConnectionsHttpError
583
- */
584
- getDataConnections: typeof getDataConnections;
585
- /**
586
- * 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.
587
- *
588
- * @param body an object with the body content
589
- * @throws CreateDataConnectionHttpError
590
- */
591
- createDataConnection: typeof createDataConnection;
592
- /**
593
- * Delete multiple connections, only available to Admin
594
- *
595
- * @param body an object with the body content
596
- * @throws DeleteDataConnectionsHttpError
597
- */
598
- deleteDataConnections: typeof deleteDataConnections;
599
- /**
600
- * Duplicate a connection
601
- *
602
- * @param body an object with the body content
603
- * @throws DuplicateDataAConnectionHttpError
604
- */
605
- duplicateDataAConnection: typeof duplicateDataAConnection;
606
- /**
607
- * 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.
608
- *
609
- * @param body an object with the body content
610
- * @throws UpdateDataConnectionsHttpError
611
- */
612
- updateDataConnections: typeof updateDataConnections;
613
- /**
614
- * Deletes the specified data connection by ID (or by name when type=connectionname is set in query)
615
- * @example
616
- * deleteDataConnection(
617
- * "82ee7b44-0c4d-491b-bd38-82640c0430a5",
618
- * {
619
- * type: "connectionname",
620
- * spaceId: "611bcebaeec1203d88211ac4"
621
- * }
622
- * )
623
- *
624
- * @param qID Connection ID
625
- * @param query an object with query parameters
626
- * @throws DeleteDataConnectionHttpError
627
- */
628
- deleteDataConnection: typeof deleteDataConnection;
629
- /**
630
- * Retrieves a connection by connection ID, or by name when the query parameter "type" is set to "connectionname."
631
- * @example
632
- * getDataConnection(
633
- * "82ee7b44-0c4d-491b-bd38-82640c0430a5",
634
- * {
635
- * extended: false,
636
- * type: "connectionname",
637
- * credentialId: "22379dc5-076e-4fec-ae20-5529a8a57dc2",
638
- * byCredentialName: false,
639
- * spaceId: "611bcebaeec1203d88211ac4",
640
- * noCache: false,
641
- * parseConnection: true
642
- * }
643
- * )
644
- *
645
- * @param qID Connection ID
646
- * @param query an object with query parameters
647
- * @throws GetDataConnectionHttpError
648
- */
649
- getDataConnection: typeof getDataConnection;
650
- /**
651
- * Patches a connection specified by connection ID (or by name when type=connectionname is set in query).
652
- *
653
- * @param qID Connection ID
654
- * @param query an object with query parameters
655
- * @param body an object with the body content
656
- * @throws PatchDataConnectionHttpError
657
- */
658
- patchDataConnection: typeof patchDataConnection;
659
- /**
660
- * 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.
661
- *
662
- * @param qID Connection ID
663
- * @param query an object with query parameters
664
- * @param body an object with the body content
665
- * @throws UpdateDataConnectionHttpError
666
- */
667
- updateDataConnection: typeof updateDataConnection;
668
- /**
669
- * Clears the cache for data-connections api requests.
670
- */
671
- clearCache: typeof clearCache;
672
- };
673
- /**
674
- * Functions for the data-connections api
675
- */
676
- declare const dataConnectionsExport: DataConnectionsAPI;
677
- //#endregion
678
- export { PatchDataConnectionHttpResponse as A, createDataConnection as B, GetDataConnectionHttpError as C, Link as D, GetDataConnectionsHttpResponse as E, UpdateDataConnectionHttpError as F, getDataConnection as G, deleteDataConnection as H, UpdateDataConnectionHttpResponse as I, updateDataConnection as J, getDataConnections as K, UpdateDataConnectionsHttpError as L, Privilege as M, ResponseErrors as N, Meta as O, TopLevelLink as P, UpdateDataConnectionsHttpResponse as R, Errors as S, GetDataConnectionsHttpError as T, deleteDataConnections as U, dataConnectionsExport as V, duplicateDataAConnection as W, updateDataConnections as Y, DeleteDataConnectionsHttpError as _, ConnectionCreate as a, DuplicateDataAConnectionHttpResponse as b, ConnectionUpdate as c, CreateDataConnectionHttpResponse as d, DataConnectionsAPI as f, DeleteDataConnectionHttpResponse as g, DeleteDataConnectionHttpError as h, BulkResponse as i, PatchRequest as j, PatchDataConnectionHttpError as k, Connections as l, DcaasConnectionCreateAuthResponse as m, ActionDuplicateRequest as n, ConnectionCreateResponse as o, DcaasConnectionCreate as p, patchDataConnection as q, ActionUpdateRequest as r, ConnectionGet as s, ActionDeleteRequest as t, CreateDataConnectionHttpError as u, DeleteDataConnectionsHttpResponse as v, GetDataConnectionHttpResponse as w, Error as x, DuplicateDataAConnectionHttpError as y, clearCache as z };