@qlik/api 2.3.1 → 2.4.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 (167) hide show
  1. package/analytics/change-stores.d.ts +40 -76
  2. package/analytics/change-stores.js +9 -10
  3. package/analytics.d.ts +1 -2
  4. package/analytics.js +5 -6
  5. package/api-keys.d.ts +46 -100
  6. package/api-keys.js +3 -4
  7. package/apps.d.ts +334 -461
  8. package/apps.js +74 -6
  9. package/assistants.d.ts +172 -337
  10. package/assistants.js +3 -4
  11. package/audits.d.ts +41 -85
  12. package/audits.js +3 -4
  13. package/auth-types.d.ts +110 -1
  14. package/auth-types.js +22 -1
  15. package/auth.d.ts +1 -2
  16. package/auth.js +1 -1
  17. package/automation-connections.d.ts +44 -95
  18. package/automation-connections.js +3 -4
  19. package/automation-connectors.d.ts +10 -20
  20. package/automation-connectors.js +3 -4
  21. package/automations.d.ts +54 -112
  22. package/automations.js +3 -4
  23. package/automl-deployments.d.ts +17 -36
  24. package/automl-deployments.js +3 -4
  25. package/automl-predictions.d.ts +12 -24
  26. package/automl-predictions.js +3 -4
  27. package/banners.d.ts +8 -14
  28. package/banners.js +3 -4
  29. package/brands.d.ts +19 -39
  30. package/brands.js +3 -4
  31. package/chunks/auth-B8lJw7rm.js +31 -0
  32. package/chunks/{interceptors-2VSXImC9.js → boot-interceptors-DqRxTczb.js} +50 -150
  33. package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
  34. package/chunks/{invoke-fetch-CckTK7bh.js → invoke-fetch-DMAi6Fg3.js} +3 -3
  35. package/chunks/{invoke-fetch-D9lpiAb-.js → invoke-fetch-pMN6iqup.js} +2 -3
  36. package/chunks/platform-types-CECrZkOF.d.ts +29 -0
  37. package/chunks/{public-runtime-modules-BqxAMJ9M.js → public-runtime-modules-2KfyI2qM.js} +5 -5
  38. package/chunks/{qix-DpvHvpx7.js → qix-BdNrIA4s.js} +19 -20
  39. package/chunks/{qix-chunk-entrypoint-BXZPnE6J.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
  40. package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
  41. package/collections.d.ts +67 -144
  42. package/collections.js +3 -4
  43. package/conditions.d.ts +87 -190
  44. package/conditions.js +3 -4
  45. package/consumption.d.ts +35 -72
  46. package/consumption.js +3 -4
  47. package/core/ip-policies.d.ts +43 -93
  48. package/core/ip-policies.js +5 -6
  49. package/core.d.ts +1 -2
  50. package/core.js +5 -6
  51. package/csp-origins.d.ts +42 -85
  52. package/csp-origins.js +3 -4
  53. package/csrf-token.d.ts +6 -11
  54. package/csrf-token.js +3 -4
  55. package/data-alerts.d.ts +152 -325
  56. package/data-alerts.js +3 -4
  57. package/data-assets.d.ts +16 -31
  58. package/data-assets.js +3 -4
  59. package/data-connections.d.ts +123 -257
  60. package/data-connections.js +3 -4
  61. package/data-credentials.d.ts +36 -76
  62. package/data-credentials.js +3 -4
  63. package/data-files.d.ts +60 -121
  64. package/data-files.js +3 -4
  65. package/data-governance/data-products.d.ts +429 -0
  66. package/data-governance/data-products.js +212 -0
  67. package/data-governance.d.ts +13 -0
  68. package/data-governance.js +12 -0
  69. package/data-qualities.d.ts +11 -25
  70. package/data-qualities.js +3 -4
  71. package/data-sets.d.ts +28 -57
  72. package/data-sets.js +3 -4
  73. package/data-sources.d.ts +45 -97
  74. package/data-sources.js +3 -4
  75. package/data-stores.d.ts +53 -107
  76. package/data-stores.js +3 -4
  77. package/dcaas.d.ts +32 -67
  78. package/dcaas.js +3 -4
  79. package/di-projects.d.ts +111 -136
  80. package/di-projects.js +25 -4
  81. package/direct-access-agents.d.ts +29 -63
  82. package/direct-access-agents.js +3 -4
  83. package/encryption.d.ts +28 -59
  84. package/encryption.js +3 -4
  85. package/extensions.d.ts +35 -73
  86. package/extensions.js +3 -4
  87. package/global-types.d.ts +139 -1
  88. package/glossaries.d.ts +75 -158
  89. package/glossaries.js +3 -4
  90. package/groups.d.ts +58 -125
  91. package/groups.js +3 -4
  92. package/identity-providers.d.ts +148 -324
  93. package/identity-providers.js +3 -4
  94. package/index.d.ts +18 -4
  95. package/index.js +64 -19
  96. package/interceptors.d.ts +2 -3
  97. package/interceptors.js +104 -2
  98. package/invoke-fetch-types.d.ts +97 -1
  99. package/items.d.ts +85 -181
  100. package/items.js +3 -4
  101. package/knowledgebases.d.ts +137 -270
  102. package/knowledgebases.js +3 -4
  103. package/licenses.d.ts +71 -153
  104. package/licenses.js +3 -4
  105. package/lineage-graphs.d.ts +39 -85
  106. package/lineage-graphs.js +3 -4
  107. package/ml.d.ts +290 -621
  108. package/ml.js +3 -4
  109. package/notes.d.ts +9 -18
  110. package/notes.js +3 -4
  111. package/notifications.d.ts +14 -30
  112. package/notifications.js +3 -4
  113. package/oauth-clients.d.ts +98 -159
  114. package/oauth-clients.js +4 -5
  115. package/oauth-tokens.d.ts +16 -33
  116. package/oauth-tokens.js +3 -4
  117. package/package.json +6 -3
  118. package/qix.d.ts +46 -2
  119. package/qix.js +2 -3
  120. package/questions.d.ts +53 -110
  121. package/questions.js +3 -4
  122. package/quotas.d.ts +13 -26
  123. package/quotas.js +3 -4
  124. package/reload-tasks.d.ts +23 -46
  125. package/reload-tasks.js +3 -4
  126. package/reloads.d.ts +26 -52
  127. package/reloads.js +3 -4
  128. package/report-templates.d.ts +30 -63
  129. package/report-templates.js +3 -4
  130. package/reports.d.ts +111 -238
  131. package/reports.js +3 -4
  132. package/roles.d.ts +36 -77
  133. package/roles.js +3 -4
  134. package/sharing-tasks.d.ts +201 -427
  135. package/sharing-tasks.js +3 -4
  136. package/spaces.d.ts +71 -157
  137. package/spaces.js +3 -4
  138. package/tasks.d.ts +76 -164
  139. package/tasks.js +3 -4
  140. package/temp-contents.d.ts +17 -35
  141. package/temp-contents.js +3 -4
  142. package/tenant-settings.d.ts +298 -0
  143. package/tenant-settings.js +107 -0
  144. package/tenants.d.ts +31 -67
  145. package/tenants.js +3 -4
  146. package/themes.d.ts +27 -55
  147. package/themes.js +3 -4
  148. package/transports.d.ts +46 -106
  149. package/transports.js +3 -4
  150. package/ui-config.d.ts +8 -17
  151. package/ui-config.js +3 -4
  152. package/users.d.ts +80 -170
  153. package/users.js +3 -4
  154. package/web-integrations.d.ts +38 -83
  155. package/web-integrations.js +3 -4
  156. package/web-notifications.d.ts +14 -29
  157. package/web-notifications.js +3 -4
  158. package/webhooks.d.ts +77 -162
  159. package/webhooks.js +3 -4
  160. package/chunks/auth-XusKk8IA.js +0 -32
  161. package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
  162. package/chunks/auth-types-h43TVDpB.js +0 -24
  163. package/chunks/global-types-CEVAJebk.js +0 -1
  164. /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
  165. /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
  166. /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
  167. /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
package/data-alerts.js CHANGED
@@ -1,5 +1,5 @@
1
- import "./chunks/public-runtime-modules-BqxAMJ9M.js";
2
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
1
+ import "./chunks/public-runtime-modules-2KfyI2qM.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
3
3
 
4
4
  //#region src/public/rest/data-alerts.ts
5
5
  /**
@@ -279,7 +279,6 @@ const dataAlertsExport = {
279
279
  getDataAlertExecutionEvaluations,
280
280
  clearCache
281
281
  };
282
- var data_alerts_default = dataAlertsExport;
283
282
 
284
283
  //#endregion
285
- export { clearCache, createDataAlert, data_alerts_default as default, deleteDataAlert, deleteDataAlertExecution, getDataAlert, getDataAlertCondition, getDataAlertExecution, getDataAlertExecutionEvaluations, getDataAlertExecutions, getDataAlertExecutionsStats, getDataAlertRecipientStats, getDataAlerts, getDataAlertsSettings, patchDataAlert, setDataAlertsSettings, triggerDataAlerts, validateDataAlerts };
284
+ export { clearCache, createDataAlert, dataAlertsExport as default, deleteDataAlert, deleteDataAlertExecution, getDataAlert, getDataAlertCondition, getDataAlertExecution, getDataAlertExecutionEvaluations, getDataAlertExecutions, getDataAlertExecutionsStats, getDataAlertRecipientStats, getDataAlerts, getDataAlertsSettings, patchDataAlert, setDataAlertsSettings, triggerDataAlerts, validateDataAlerts };
package/data-assets.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
- import "./chunks/invoke-fetch-C1Z0RJYU.js";
1
+ import { ApiCallOptions } from "./invoke-fetch-types.js";
2
+ import "./chunks/invoke-fetch-DFc3yzaj.js";
3
3
 
4
4
  //#region src/public/rest/data-assets.d.ts
5
5
  type BatchIdDto = {
@@ -7,33 +7,23 @@ type BatchIdDto = {
7
7
  };
8
8
  type DataAsset = {
9
9
  appId?: string;
10
- appType: string;
11
- /** The value is automatically set by the application. User defined value is ignored. */
12
- readonly createdBy?: string;
13
- /** The value is automatically set by the application. User defined value is ignored. */
14
- readonly createdTime?: string;
15
- /** The date-time when the source data was last changed */
10
+ appType: string; /** The value is automatically set by the application. User defined value is ignored. */
11
+ readonly createdBy?: string; /** The value is automatically set by the application. User defined value is ignored. */
12
+ readonly createdTime?: string; /** The date-time when the source data was last changed */
16
13
  dataFreshness?: string;
17
14
  dataStoreInfo?: DataStoreInfo;
18
- description?: string;
19
- /** Only required when updating the resource. Must be null for new resources. */
20
- id?: string;
21
- /** The value is automatically set by the application. User defined value is ignored. */
22
- readonly lastModifiedBy?: string;
23
- /** The value is automatically set by the application. User defined value is ignored. */
15
+ description?: string; /** Only required when updating the resource. Must be null for new resources. */
16
+ id?: string; /** The value is automatically set by the application. User defined value is ignored. */
17
+ readonly lastModifiedBy?: string; /** The value is automatically set by the application. User defined value is ignored. */
24
18
  readonly lastModifiedTime?: string;
25
- name?: string;
26
- /** The value is automatically set by the application. */
27
- ownerId?: string;
28
- /** A Map of name-value pairs. */
19
+ name?: string; /** The value is automatically set by the application. */
20
+ ownerId?: string; /** A Map of name-value pairs. */
29
21
  properties?: Record<string, unknown>;
30
22
  spaceId?: string;
31
23
  tags?: string[];
32
24
  technicalDescription?: string;
33
- technicalName: string;
34
- /** The value is automatically set by the application. User defined value is ignored. */
35
- readonly tenantId?: string;
36
- /** Only required when updating the resource. Must be null for new resources. */
25
+ technicalName: string; /** The value is automatically set by the application. User defined value is ignored. */
26
+ readonly tenantId?: string; /** Only required when updating the resource. Must be null for new resources. */
37
27
  version?: number;
38
28
  };
39
29
  type DataStoreInfo = {
@@ -52,13 +42,9 @@ type ErrorResponse = {
52
42
  traceId?: string;
53
43
  };
54
44
  type JsonPatch = {
55
- /** A JSON Pointer path pointing to the location to move/copy from. */
56
- from?: string;
57
- /** The operation to be performed. */
58
- op: "add" | "remove" | "replace" | "move" | "copy" | "test";
59
- /** A JSON pointer to the property being affected. */
60
- path: string;
61
- /** The value to add, replace or test. */
45
+ /** A JSON Pointer path pointing to the location to move/copy from. */from?: string; /** The operation to be performed. */
46
+ op: "add" | "remove" | "replace" | "move" | "copy" | "test"; /** A JSON pointer to the property being affected. */
47
+ path: string; /** The value to add, replace or test. */
62
48
  value?: unknown;
63
49
  };
64
50
  /**
@@ -103,8 +89,7 @@ type CreateDataAssetHttpError = {
103
89
  * @throws GetDataAssetHttpError
104
90
  */
105
91
  declare function getDataAsset(dataAssetId: string, query: {
106
- /** Comma-separated fields to return in the response. */
107
- projections?: string[];
92
+ /** Comma-separated fields to return in the response. */projections?: string[];
108
93
  }, options?: ApiCallOptions): Promise<GetDataAssetHttpResponse>;
109
94
  type GetDataAssetHttpResponse = {
110
95
  data: DataAsset;
package/data-assets.js CHANGED
@@ -1,5 +1,5 @@
1
- import "./chunks/public-runtime-modules-BqxAMJ9M.js";
2
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
1
+ import "./chunks/public-runtime-modules-2KfyI2qM.js";
2
+ import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
3
3
 
4
4
  //#region src/public/rest/data-assets.ts
5
5
  /**
@@ -99,7 +99,6 @@ const dataAssetsExport = {
99
99
  updateDataAsset,
100
100
  clearCache
101
101
  };
102
- var data_assets_default = dataAssetsExport;
103
102
 
104
103
  //#endregion
105
- export { clearCache, createDataAsset, data_assets_default as default, deleteDataAssets, getDataAsset, patchDataAsset, updateDataAsset };
104
+ export { clearCache, createDataAsset, dataAssetsExport as default, deleteDataAssets, getDataAsset, patchDataAsset, updateDataAsset };
@@ -1,47 +1,33 @@
1
- import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
- import "./chunks/invoke-fetch-C1Z0RJYU.js";
1
+ import { ApiCallOptions } from "./invoke-fetch-types.js";
2
+ import "./chunks/invoke-fetch-DFc3yzaj.js";
3
3
 
4
4
  //#region src/public/rest/data-connections.d.ts
5
5
  type ActionDeleteRequest = {
6
6
  connections: {
7
- /** ID of connection */
8
- id: string;
9
- /** Connection name */
7
+ /** ID of connection */id: string; /** Connection name */
10
8
  name?: string;
11
9
  }[];
12
10
  };
13
11
  type ActionDuplicateRequest = {
14
- /** ID of the source connection being duplicated */
15
- id: string;
16
- /** Optional name for the duplicated connection, must be unique in the target scope. If not specified, a name will be automatically generated */
17
- name?: string;
18
- /** Optional credential password, specify to override credential embedded (or associated) with the source connection */
19
- qPassword?: string;
20
- /** Optional credential username, specify to override credential embedded (or associated) with the source connection */
21
- qUsername?: string;
22
- /** Optional target space ID for the duplicated connection. If not specified, the duplicated connection will be in the same space as the source connection */
12
+ /** 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 */
13
+ name?: string; /** Optional credential password, specify to override credential embedded (or associated) with the source connection */
14
+ qPassword?: string; /** Optional credential username, specify to override credential embedded (or associated) with the source connection */
15
+ 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 */
23
16
  spaceId?: string;
24
17
  };
25
18
  type ActionUpdateRequest = {
26
19
  connections: {
27
- /** Connection ID */
28
- id: string;
29
- /** Connection name */
30
- name?: string;
31
- /** User ID to which the connection will be updated. If not present, the connection's owner wont be changed */
32
- ownerId?: string;
33
- /** 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) */
34
- spaceId?: string;
35
- /** Space type. Required when spaceId is specified */
20
+ /** Connection ID */id: string; /** Connection name */
21
+ name?: string; /** User ID to which the connection will be updated. If not present, the connection's owner wont be changed */
22
+ 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) */
23
+ spaceId?: string; /** Space type. Required when spaceId is specified */
36
24
  spaceType?: "personal" | "shared" | "managed" | "data";
37
25
  }[];
38
26
  };
39
27
  type BulkResponse = {
40
28
  data?: {
41
- error?: Error;
42
- /** ID of the resource */
43
- id: string;
44
- /** Status code of operation on resource identified by ID */
29
+ error?: Error; /** ID of the resource */
30
+ id: string; /** Status code of operation on resource identified by ID */
45
31
  status: number;
46
32
  }[];
47
33
  };
@@ -49,157 +35,88 @@ type BulkResponse = {
49
35
  * Schema used to create a connection with given connection string (i.e. qConnectStatement) along with other metadata
50
36
  */
51
37
  type ConnectionCreate = {
52
- /** ID of the datasource associated with this connection */
53
- datasourceID: string;
54
- /** App ID */
55
- owner?: string;
56
- /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
57
- qArchitecture?: 0 | 1;
58
- /** Connection string for the data connection */
59
- qConnectStatement: string;
60
- /** String that contains connection specific secret (or password) that requires encryption before persist to database. This field is connection level secret */
61
- qConnectionSecret?: string;
62
- /** ID of the credential associated with the connection */
63
- qCredentialsID?: string;
64
- /** Name of the credential associated with the connection */
65
- qCredentialsName?: string;
66
- /** 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 */
67
- qEngineObjectID?: string;
68
- /** Unique identifier (UUID) for the data connection. A UUID will be generated automatically if qID is not specified or empty */
69
- qID?: string;
70
- /** Indicates the type of user associated with the data connection. */
71
- qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
72
- /** Descriptive name of the data connection */
73
- qName: string;
74
- /** Any logon password associated with the data connection (connector encoded) */
75
- qPassword?: string;
76
- /** Indicates whether or not to create a credential-less connection */
77
- qSeparateCredentials?: boolean;
78
- /** Type of connection - indicates connection provider type */
79
- qType: string;
80
- /** Any logon username associated with the data connection */
81
- qUsername?: string;
82
- /** 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. */
83
- qriInRequest?: string;
84
- /** ID of the space to which the connection belongs */
85
- space?: string;
86
- /** List of tags attached to the connection (allow max 32 tags) */
38
+ /** ID of the datasource associated with this connection */datasourceID: string; /** App ID */
39
+ 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. */
40
+ qArchitecture?: 0 | 1; /** Connection string for the data connection */
41
+ qConnectStatement: string; /** String that contains connection specific secret (or password) that requires encryption before persist to database. This field is connection level secret */
42
+ qConnectionSecret?: string; /** ID of the credential associated with the connection */
43
+ qCredentialsID?: string; /** Name of the credential associated with the connection */
44
+ 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 */
45
+ qEngineObjectID?: string; /** Unique identifier (UUID) for the data connection. A UUID will be generated automatically if qID is not specified or empty */
46
+ qID?: string; /** Indicates the type of user associated with the data connection. */
47
+ qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER"; /** Descriptive name of the data connection */
48
+ qName: string; /** Any logon password associated with the data connection (connector encoded) */
49
+ qPassword?: string; /** Indicates whether or not to create a credential-less connection */
50
+ qSeparateCredentials?: boolean; /** Type of connection - indicates connection provider type */
51
+ qType: string; /** Any logon username associated with the data connection */
52
+ 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. */
53
+ qriInRequest?: string; /** ID of the space to which the connection belongs */
54
+ space?: string; /** List of tags attached to the connection (allow max 32 tags) */
87
55
  tags?: string[];
88
56
  };
89
57
  /**
90
58
  * Essential fields of a connection
91
59
  */
92
60
  type ConnectionCreateResponse = {
93
- /** Datetime when the connection was created */
94
- created?: string;
95
- links?: Link;
96
- /** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
97
- privileges: Privilege[];
98
- /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
99
- qArchitecture: 0 | 1;
100
- /** Connection string for the data connection */
101
- qConnectStatement: string;
102
- /** ID of the credential associated with the connection */
103
- qCredentialsID?: string;
104
- /** Name of the credential associated with the connection */
105
- qCredentialsName?: string;
106
- /** Unique identifier (UUID) for the data connection, must be same as qID */
107
- qEngineObjectID: string;
108
- /** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
109
- qID: string;
110
- /** Indicates the type of user associated with the data connection. */
111
- qLogOn: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
112
- /** Descriptive name of the data connection */
113
- qName: string;
114
- /** Reference key of credential in redis */
115
- qReferenceKey?: string;
116
- /** Indicates whether or not this is a credential-less connection */
117
- qSeparateCredentials: boolean;
118
- /** Type of connection - indicates connection provider type */
119
- qType: string;
120
- /** ID of the space to which the connection belongs */
121
- space?: string;
122
- /** Datetime when the connection was last updated */
123
- updated?: string;
124
- /** User ID of the connection's creator */
61
+ /** Datetime when the connection was created */created?: string;
62
+ links?: Link; /** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
63
+ 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. */
64
+ qArchitecture: 0 | 1; /** Connection string for the data connection */
65
+ qConnectStatement: string; /** ID of the credential associated with the connection */
66
+ qCredentialsID?: string; /** Name of the credential associated with the connection */
67
+ qCredentialsName?: string; /** Unique identifier (UUID) for the data connection, must be same as qID */
68
+ qEngineObjectID: string; /** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
69
+ qID: string; /** Indicates the type of user associated with the data connection. */
70
+ qLogOn: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER"; /** Descriptive name of the data connection */
71
+ qName: string; /** Reference key of credential in redis */
72
+ qReferenceKey?: string; /** Indicates whether or not this is a credential-less connection */
73
+ qSeparateCredentials: boolean; /** Type of connection - indicates connection provider type */
74
+ qType: string; /** ID of the space to which the connection belongs */
75
+ space?: string; /** Datetime when the connection was last updated */
76
+ updated?: string; /** User ID of the connection's creator */
125
77
  user?: string;
126
78
  };
127
79
  /**
128
80
  * Essential fields of a connection
129
81
  */
130
82
  type ConnectionGet = {
131
- /** List of connection parsed from connection string (only available when query parseConnection=true is set) */
132
- connectionProperties?: unknown;
133
- /** Datetime when the connection was created */
134
- created?: string;
135
- /** Data source ID */
83
+ /** List of connection parsed from connection string (only available when query parseConnection=true is set) */connectionProperties?: unknown; /** Datetime when the connection was created */
84
+ created?: string; /** Data source ID */
136
85
  datasourceID?: string;
137
- links: Link;
138
- /** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
139
- privileges: Privilege[];
140
- /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
141
- qArchitecture: 0 | 1;
142
- /** Connection string for the data connection */
143
- qConnectStatement: string;
144
- /** 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} */
145
- qConnectionSecret?: string;
146
- /** ID of the credential associated with the connection */
147
- qCredentialsID?: string;
148
- /** Unique identifier (UUID) for the data connection, must be same as qID */
149
- qEngineObjectID: string;
150
- /** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
151
- qID: string;
152
- /** Indicates the type of user associated with the data connection */
153
- qLogOn: 0 | 1;
154
- /** Descriptive name of the data connection */
155
- qName: string;
156
- /** Indicates whether or not this is a credential-less connection */
157
- qSeparateCredentials?: boolean;
158
- /** Type of connection, i.e. provider type of underlying connector */
159
- qType: string;
160
- /** Encrypted base Qri string (filterable using SCIM filter, e.g. filter='qri co "snowflake"') */
161
- qri?: string;
162
- /** ID of the space to which the connection belongs */
163
- space?: string;
164
- /** List of tags attached to the connection */
165
- tags?: string[];
166
- /** Tenant ID of the connection's creator */
167
- tenant: string;
168
- /** Datetime when the connection was last updated */
169
- updated?: string;
170
- /** User ID of the connection's creator */
86
+ links: Link; /** Array of string (i.e. update, delete, read) indicating the user's privileges on the associated connection */
87
+ 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. */
88
+ qArchitecture: 0 | 1; /** Connection string for the data connection */
89
+ 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} */
90
+ qConnectionSecret?: string; /** ID of the credential associated with the connection */
91
+ qCredentialsID?: string; /** Unique identifier (UUID) for the data connection, must be same as qID */
92
+ qEngineObjectID: string; /** Unique identifier (UUID) for the data connection, must be same as qEngineObjectID */
93
+ qID: string; /** Indicates the type of user associated with the data connection */
94
+ qLogOn: 0 | 1; /** Descriptive name of the data connection */
95
+ qName: string; /** Indicates whether or not this is a credential-less connection */
96
+ qSeparateCredentials?: boolean; /** Type of connection, i.e. provider type of underlying connector */
97
+ qType: string; /** Encrypted base Qri string (filterable using SCIM filter, e.g. filter='qri co "snowflake"') */
98
+ qri?: string; /** ID of the space to which the connection belongs */
99
+ space?: string; /** List of tags attached to the connection */
100
+ tags?: string[]; /** Tenant ID of the connection's creator */
101
+ tenant: string; /** Datetime when the connection was last updated */
102
+ updated?: string; /** User ID of the connection's creator */
171
103
  user?: string;
172
104
  };
173
105
  type ConnectionUpdate = {
174
- /** ID of the datasource associated with this connection */
175
- datasourceID?: string;
176
- /** 0 or 1 value indicating whether the data connector is 64-bit (0) or 32-bit (1). Defaults to 0 if not specified. */
177
- qArchitecture?: 0 | 1;
178
- /** Connection string for the data connection */
179
- qConnectStatement: string;
180
- /** 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. */
181
- qConnectionSecret?: string;
182
- /** ID of the credential associated with the connection */
183
- qCredentialsID?: string;
184
- /** Name of the credential associated with the connection */
185
- qCredentialsName?: string;
186
- /** Unique identifier for the data connection as specified by the Sense engine */
187
- qEngineObjectID: string;
188
- /** Unique identifier for the data connection */
189
- qID: string;
190
- /** Indicates the type of user associated with the data connection. */
191
- qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER";
192
- /** Descriptive name of the data connection */
193
- qName: string;
194
- /** Any logon password associated with the data connection */
195
- qPassword?: string;
196
- /** Indicates whether or not this is a credential-less connection */
197
- qSeparateCredentials?: boolean;
198
- /** Type of connection - indicates connection provider type */
199
- qType: string;
200
- /** Any logon username associated with the data connection */
201
- qUsername?: string;
202
- /** ID of the space to which the connection belongs */
106
+ /** 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. */
107
+ qArchitecture?: 0 | 1; /** Connection string for the data connection */
108
+ 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. */
109
+ qConnectionSecret?: string; /** ID of the credential associated with the connection */
110
+ qCredentialsID?: string; /** Name of the credential associated with the connection */
111
+ qCredentialsName?: string; /** Unique identifier for the data connection as specified by the Sense engine */
112
+ qEngineObjectID: string; /** Unique identifier for the data connection */
113
+ qID: string; /** Indicates the type of user associated with the data connection. */
114
+ qLogOn?: "0" | "1" | "LOG_ON_SERVICE_USER" | "LOG_ON_CURRENT_USER"; /** Descriptive name of the data connection */
115
+ qName: string; /** Any logon password associated with the data connection */
116
+ qPassword?: string; /** Indicates whether or not this is a credential-less connection */
117
+ qSeparateCredentials?: boolean; /** Type of connection - indicates connection provider type */
118
+ qType: string; /** Any logon username associated with the data connection */
119
+ qUsername?: string; /** ID of the space to which the connection belongs */
203
120
  space?: string;
204
121
  };
205
122
  type Connections = {
@@ -212,54 +129,37 @@ type Connections = {
212
129
  * Schema used to create a connection using a list of connection properties for given datasource
213
130
  */
214
131
  type DcaasConnectionCreate = {
215
- /** 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 */
216
- authUrlOnly?: boolean;
217
- /** Connection properties required to create dataconnection for the given datasource, which is defined by the response of 'GET /v1/data-sources/:{datasourceId}/api-specs' */
218
- connectionProperties: unknown;
219
- /** ID of the datasource of the connection */
220
- datasourceID: string;
221
- /** Descriptive name of the data connection */
222
- qName: string;
223
- /** ID of the space in which the connection shall be created. Connection will be created in user's personal space if undefined */
224
- space?: string;
225
- /** List of tags attached to the connection (allow max 31 tags) */
132
+ /** 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' */
133
+ connectionProperties: unknown; /** ID of the datasource of the connection */
134
+ datasourceID: string; /** Descriptive name of the data connection */
135
+ qName: string; /** ID of the space in which the connection shall be created. Connection will be created in user's personal space if undefined */
136
+ space?: string; /** List of tags attached to the connection (allow max 31 tags) */
226
137
  tags?: string[];
227
138
  };
228
139
  /**
229
140
  * Authentication URL response for OAuth datasources (when authUrlOnly is set to true in request)
230
141
  */
231
142
  type DcaasConnectionCreateAuthResponse = {
232
- /** Authentication URL used to generate authentication code for datasources supporting OAuth */
233
- authUrl: string;
143
+ /** Authentication URL used to generate authentication code for datasources supporting OAuth */authUrl: string;
234
144
  };
235
145
  type Error = {
236
- /** Unique internal error code */
237
- code?: string;
238
- /** More concrete details */
239
- detail?: string;
240
- /** HTTP status code */
241
- status?: number;
242
- /** A summary in english explaining what went wrong */
146
+ /** Unique internal error code */code?: string; /** More concrete details */
147
+ detail?: string; /** HTTP status code */
148
+ status?: number; /** A summary in english explaining what went wrong */
243
149
  title?: string;
244
150
  };
245
151
  type Errors = Error[];
246
152
  type Link = {
247
- /** Link to current query */
248
- self: {
249
- /** URL pointing to the resource */
250
- href: string;
153
+ /** Link to current query */self: {
154
+ /** URL pointing to the resource */href: string;
251
155
  };
252
156
  };
253
157
  type Meta = {
254
- /** Total count of resources being requested. */
255
- count?: number;
158
+ /** Total count of resources being requested. */count?: number;
256
159
  };
257
160
  type PatchRequest = {
258
- /** Operation type */
259
- op: "add" | "replace" | "remove";
260
- /** Path to the target field to be patched */
261
- path: string;
262
- /** Value used for the patch. Required only for `add` or `replace` operations. The value type should match the type of the target field. */
161
+ /** Operation type */op: "add" | "replace" | "remove"; /** Path to the target field to be patched */
162
+ path: string; /** Value used for the patch. Required only for `add` or `replace` operations. The value type should match the type of the target field. */
263
163
  value?: string | boolean | number | unknown[];
264
164
  }[];
265
165
  /**
@@ -272,20 +172,14 @@ type ResponseErrors = {
272
172
  errors?: Errors;
273
173
  };
274
174
  type TopLevelLink = {
275
- /** URL link to next page of requested resources (available to paged request only) */
276
- next?: {
277
- /** URL pointing to the next page of resources */
278
- href: string;
279
- };
280
- /** URL link to previous page of requested resources (available to paged request only) */
175
+ /** URL link to next page of requested resources (available to paged request only) */next?: {
176
+ /** URL pointing to the next page of resources */href: string;
177
+ }; /** URL link to previous page of requested resources (available to paged request only) */
281
178
  prev?: {
282
- /** URL pointing to the previous page of resources */
283
- href: string;
284
- };
285
- /** Link to current query */
179
+ /** URL pointing to the previous page of resources */href: string;
180
+ }; /** Link to current query */
286
181
  self: {
287
- /** URL pointing to the resource */
288
- href: string;
182
+ /** URL pointing to the resource */href: string;
289
183
  };
290
184
  };
291
185
  /**
@@ -315,37 +209,21 @@ type TopLevelLink = {
315
209
  * @throws GetDataConnectionsHttpError
316
210
  */
317
211
  declare function getDataConnections(query: {
318
- /** Sort results will be returned in case insensitive order if set to true (Only used along with sort query) */
319
- caseinsensitive?: boolean;
320
- /** Provides an alternate name to be used for data[] element in GET response. */
321
- dataName?: string;
322
- /** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
323
- extended?: boolean;
324
- /** 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. */
325
- filter?: string;
326
- /** Includes connections that uses disabled datasources */
327
- includeDisabled?: boolean;
328
- /** Base Qri (encrypted) will be returned when the query is set to true, default is false */
329
- includeQris?: boolean;
330
- /** Number of resources to be returned (between 1 and 100) */
331
- limit?: number;
332
- /** ICU locale ID, used only when caseinsensitive is set to true, default to 'en' if undefined */
333
- locale?: string;
334
- /** Datafiles connections will not be returned if set to true */
335
- noDatafiles?: boolean;
336
- /** Filtering on connections, return connections owned by the caller if set to true (doesn't apply to datafiles connections) */
337
- ownedByMe?: boolean;
338
- /** Filtering on datafile connections by owner (i.e. app) ID. */
339
- owner?: string;
340
- /** Pagination cursor string, which is generated automatically in previous pagination query. */
341
- page?: string;
342
- /** Filtering on personal connections, ignored if spaceId is defined in same request */
343
- personal?: boolean;
344
- /** 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. */
345
- sort?: string;
346
- /** Filtering on connections by space ID */
347
- spaceId?: string;
348
- /** Filtering on userId. Requires admin role if specified userId doesn't match that is defined in JWT. */
212
+ /** 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. */
213
+ dataName?: string; /** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
214
+ 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. */
215
+ filter?: string; /** Includes connections that uses disabled datasources */
216
+ includeDisabled?: boolean; /** Base Qri (encrypted) will be returned when the query is set to true, default is false */
217
+ includeQris?: boolean; /** Number of resources to be returned (between 1 and 100) */
218
+ limit?: number; /** ICU locale ID, used only when caseinsensitive is set to true, default to 'en' if undefined */
219
+ locale?: string; /** Datafiles connections will not be returned if set to true */
220
+ noDatafiles?: boolean; /** Filtering on connections, return connections owned by the caller if set to true (doesn't apply to datafiles connections) */
221
+ ownedByMe?: boolean; /** Filtering on datafile connections by owner (i.e. app) ID. */
222
+ owner?: string; /** Pagination cursor string, which is generated automatically in previous pagination query. */
223
+ page?: string; /** Filtering on personal connections, ignored if spaceId is defined in same request */
224
+ 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. */
225
+ sort?: string; /** Filtering on connections by space ID */
226
+ spaceId?: string; /** Filtering on userId. Requires admin role if specified userId doesn't match that is defined in JWT. */
349
227
  userId?: string;
350
228
  }, options?: ApiCallOptions): Promise<GetDataConnectionsHttpResponse>;
351
229
  type GetDataConnectionsHttpResponse = {
@@ -444,9 +322,7 @@ type UpdateDataConnectionsHttpError = {
444
322
  * @throws DeleteDataConnectionHttpError
445
323
  */
446
324
  declare function deleteDataConnection(qID: string, query: {
447
- /** Filtering on connections by space ID */
448
- spaceId?: string;
449
- /** The connection ID in the path becomes a connection name when this query parameter is set. */
325
+ /** Filtering on connections by space ID */spaceId?: string; /** The connection ID in the path becomes a connection name when this query parameter is set. */
450
326
  type?: "connectionname";
451
327
  }, options?: ApiCallOptions): Promise<DeleteDataConnectionHttpResponse>;
452
328
  type DeleteDataConnectionHttpResponse = {
@@ -480,19 +356,12 @@ type DeleteDataConnectionHttpError = {
480
356
  * @throws GetDataConnectionHttpError
481
357
  */
482
358
  declare function getDataConnection(qID: string, query: {
483
- /** If set to true, credentialId in the query will be interpreted as credential's name */
484
- byCredentialName?: boolean;
485
- /** Credential ID */
486
- credentialId?: string;
487
- /** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
488
- extended?: boolean;
489
- /** 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 */
490
- noCache?: boolean;
491
- /** List of connection properties shall be returned when the query is set to true, default is false */
492
- parseConnection?: boolean;
493
- /** Filtering on connections by space ID */
494
- spaceId?: string;
495
- /** The connection ID in the path becomes a connection name when this query parameter is set. */
359
+ /** If set to true, credentialId in the query will be interpreted as credential's name */byCredentialName?: boolean; /** Credential ID */
360
+ credentialId?: string; /** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
361
+ 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 */
362
+ noCache?: boolean; /** List of connection properties shall be returned when the query is set to true, default is false */
363
+ parseConnection?: boolean; /** Filtering on connections by space ID */
364
+ spaceId?: string; /** The connection ID in the path becomes a connection name when this query parameter is set. */
496
365
  type?: "connectionname";
497
366
  }, options?: ApiCallOptions): Promise<GetDataConnectionHttpResponse>;
498
367
  type GetDataConnectionHttpResponse = {
@@ -514,8 +383,7 @@ type GetDataConnectionHttpError = {
514
383
  * @throws PatchDataConnectionHttpError
515
384
  */
516
385
  declare function patchDataConnection(qID: string, query: {
517
- /** The connection ID in the path becomes a connection name when this query parameter is set. */
518
- type?: "connectionname";
386
+ /** The connection ID in the path becomes a connection name when this query parameter is set. */type?: "connectionname";
519
387
  }, body: PatchRequest, options?: ApiCallOptions): Promise<PatchDataConnectionHttpResponse>;
520
388
  type PatchDataConnectionHttpResponse = {
521
389
  data: void;
@@ -536,9 +404,7 @@ type PatchDataConnectionHttpError = {
536
404
  * @throws UpdateDataConnectionHttpError
537
405
  */
538
406
  declare function updateDataConnection(qID: string, query: {
539
- /** Filtering on connections by space ID */
540
- spaceId?: string;
541
- /** The connection ID in the path becomes a connection name when this query parameter is set. */
407
+ /** Filtering on connections by space ID */spaceId?: string; /** The connection ID in the path becomes a connection name when this query parameter is set. */
542
408
  type?: "connectionname";
543
409
  }, body: ConnectionUpdate, options?: ApiCallOptions): Promise<UpdateDataConnectionHttpResponse>;
544
410
  type UpdateDataConnectionHttpResponse = {