@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/ml.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/ml.ts
5
5
  /**
@@ -815,7 +815,6 @@ const mlExport = {
815
815
  getMlProfileInsight,
816
816
  clearCache
817
817
  };
818
- var ml_default = mlExport;
819
818
 
820
819
  //#endregion
821
- export { activateModelsMlDeployment, addMlDeploymentModels, cancelMlJob, clearCache, createMlDeployment, createMlDeploymentAliase, createMlDeploymentBatchPrediction, createMlExperiment, createMlExperimentVersion, createMlProfileInsight, deactivateModelsMlDeployment, ml_default as default, deleteMlDeployment, deleteMlDeploymentAliase, deleteMlDeploymentBatchPrediction, deleteMlDeploymentBatchPredictionSchedule, deleteMlExperiment, deleteMlExperimentVersion, getMlDeployment, getMlDeploymentAliase, getMlDeploymentAliases, getMlDeploymentBatchPrediction, getMlDeploymentBatchPredictionSchedule, getMlDeploymentBatchPredictions, getMlDeployments, getMlExperiment, getMlExperimentModel, getMlExperimentModels, getMlExperimentVersion, getMlExperimentVersions, getMlExperiments, getMlProfileInsight, getMlProfileInsightWithQuery, patchMlDeployment, patchMlDeploymentAliase, patchMlDeploymentBatchPrediction, patchMlExperiment, patchMlExperimentVersion, predictMlDeploymentBatchPrediction, recommendModelsMlExperiment, removeMlDeploymentModels, runMlDeploymentAliaseRealtimePredictions, runMlDeploymentRealtimePredictions, setMlDeploymentBatchPredictionSchedule, updateMlDeploymentBatchPredictionSchedule };
820
+ export { activateModelsMlDeployment, addMlDeploymentModels, cancelMlJob, clearCache, createMlDeployment, createMlDeploymentAliase, createMlDeploymentBatchPrediction, createMlExperiment, createMlExperimentVersion, createMlProfileInsight, deactivateModelsMlDeployment, mlExport as default, deleteMlDeployment, deleteMlDeploymentAliase, deleteMlDeploymentBatchPrediction, deleteMlDeploymentBatchPredictionSchedule, deleteMlExperiment, deleteMlExperimentVersion, getMlDeployment, getMlDeploymentAliase, getMlDeploymentAliases, getMlDeploymentBatchPrediction, getMlDeploymentBatchPredictionSchedule, getMlDeploymentBatchPredictions, getMlDeployments, getMlExperiment, getMlExperimentModel, getMlExperimentModels, getMlExperimentVersion, getMlExperimentVersions, getMlExperiments, getMlProfileInsight, getMlProfileInsightWithQuery, patchMlDeployment, patchMlDeploymentAliase, patchMlDeploymentBatchPrediction, patchMlExperiment, patchMlExperimentVersion, predictMlDeploymentBatchPrediction, recommendModelsMlExperiment, removeMlDeploymentModels, runMlDeploymentAliaseRealtimePredictions, runMlDeploymentRealtimePredictions, setMlDeploymentBatchPredictionSchedule, updateMlDeploymentBatchPredictionSchedule };
package/notes.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/notes.d.ts
5
5
  /**
@@ -7,11 +7,8 @@ import "./chunks/invoke-fetch-C1Z0RJYU.js";
7
7
  */
8
8
  type ConfigReasonCode = "deployment" | "toggle" | "license";
9
9
  type Error = {
10
- /** Error code specific to notes broker service. */
11
- readonly code?: string;
12
- /** Error cause. */
13
- readonly detail?: string;
14
- /** Error title. */
10
+ /** Error code specific to notes broker service. */readonly code?: string; /** Error cause. */
11
+ readonly detail?: string; /** Error title. */
15
12
  readonly title?: string;
16
13
  };
17
14
  /**
@@ -27,24 +24,18 @@ type Error = {
27
24
  * }
28
25
  */
29
26
  type Errors = {
30
- errors?: Error[];
31
- /** An optional traceId */
27
+ errors?: Error[]; /** An optional traceId */
32
28
  traceId?: string;
33
29
  };
34
30
  type NoteSettingsPutPayload = {
35
- /** pass 'true' to enable the note toggle for the tenant, 'false' to disable the toggle (other values are ignore). */
36
- toggledOn?: boolean;
31
+ /** pass 'true' to enable the note toggle for the tenant, 'false' to disable the toggle (other values are ignore). */toggledOn?: boolean;
37
32
  };
38
33
  type NoteSettingsPutResponse = {
39
- /** 'true' if the note feature is enabled for this tenant and user otherwise 'false'. */
40
- toggleOn?: boolean;
34
+ /** 'true' if the note feature is enabled for this tenant and user otherwise 'false'. */toggleOn?: boolean;
41
35
  };
42
36
  type NotesUserSettings = {
43
- /** 'true' if the note feature is enabled for this tenant and user otherwise 'false'. */
44
- available: boolean;
45
- /** The timestamp for the last time this users notes settings were fetched from downstream services. */
46
- lastFetch?: string;
47
- /** The possible states for the status of notes configuration GET or POST operation */
37
+ /** 'true' if the note feature is enabled for this tenant and user otherwise 'false'. */available: boolean; /** The timestamp for the last time this users notes settings were fetched from downstream services. */
38
+ lastFetch?: string; /** The possible states for the status of notes configuration GET or POST operation */
48
39
  reason?: ConfigReasonCode;
49
40
  };
50
41
  /**
package/notes.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/notes.ts
5
5
  /**
@@ -43,7 +43,6 @@ const notesExport = {
43
43
  setNotesSettings,
44
44
  clearCache
45
45
  };
46
- var notes_default = notesExport;
47
46
 
48
47
  //#endregion
49
- export { clearCache, notes_default as default, getNotesSettings, setNotesSettings };
48
+ export { clearCache, notesExport as default, getNotesSettings, setNotesSettings };
@@ -1,54 +1,41 @@
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/notifications.d.ts
5
5
  /**
6
6
  * An error object.
7
7
  */
8
8
  type Error = {
9
- /** The error code. */
10
- code: string;
11
- /** A human-readable explanation specific to this occurrence of the problem. */
12
- detail?: string;
13
- /** Summary of the problem. */
9
+ /** The error code. */code: string; /** A human-readable explanation specific to this occurrence of the problem. */
10
+ detail?: string; /** Summary of the problem. */
14
11
  title: string;
15
12
  };
16
13
  /**
17
14
  * Notification result item
18
15
  */
19
16
  type NotificationItem = {
20
- /** Indicates if the notification can be managed in the hub. If true, the object will also contain 'subscriptionInfo' object and a 'presentationInfo' object with a non-empty scopes array. */
21
- isManageableInHub?: boolean;
22
- /** Indicates if the notification can be subscribed to by users. If true, the object will also contain 'subscriptionInfo' object */
23
- isSubscribable: boolean;
24
- /** Notification name pattern that will trigger this notification e.g resource.action */
25
- notificationNamePattern: string;
26
- /** Object containing information pertaining to the presentaion of a notification in the UI */
17
+ /** Indicates if the notification can be managed in the hub. If true, the object will also contain 'subscriptionInfo' object and a 'presentationInfo' object with a non-empty scopes array. */isManageableInHub?: boolean; /** Indicates if the notification can be subscribed to by users. If true, the object will also contain 'subscriptionInfo' object */
18
+ isSubscribable: boolean; /** Notification name pattern that will trigger this notification e.g resource.action */
19
+ notificationNamePattern: string; /** Object containing information pertaining to the presentaion of a notification in the UI */
27
20
  presentationInfo?: {
28
- /** Localized, human-readable string representing the name of the notification suitable to use in a UI */
29
- friendlyName?: string;
30
- /** Friendly name to be displayed for each scope. */
31
- scopeFriendlyNames?: Record<string, string>;
32
- /** Information about the scopes to which this notification applies. Helps determine the placement of the notification in the UI */
21
+ /** Localized, human-readable string representing the name of the notification suitable to use in a UI */friendlyName?: string; /** Friendly name to be displayed for each scope. */
22
+ scopeFriendlyNames?: Record<string, string>; /** Information about the scopes to which this notification applies. Helps determine the placement of the notification in the UI */
33
23
  scopes?: string[];
34
- };
35
- /** Object indicating what properties to use to subscribe to this notification via the 'Subscriptions' service. For info about its properties, refer to the Subscription sevice's API doc. */
24
+ }; /** Object indicating what properties to use to subscribe to this notification via the 'Subscriptions' service. For info about its properties, refer to the Subscription sevice's API doc. */
36
25
  subscriptionInfo?: {
37
26
  action: string;
38
27
  resourceId?: string;
39
28
  resourceSubType?: string;
40
29
  resourceType: string;
41
30
  target?: string;
42
- };
43
- /** Type of Transport e.g. Email, Notification, Slack message etc... */
31
+ }; /** Type of Transport e.g. Email, Notification, Slack message etc... */
44
32
  transports: string[];
45
33
  };
46
34
  /**
47
35
  * Object containing array representing list of supported notifications
48
36
  */
49
37
  type NotificationsObject = {
50
- /** list of notifications */
51
- notifications: NotificationItem[];
38
+ /** list of notifications */notifications: NotificationItem[];
52
39
  };
53
40
  /**
54
41
  * List all supported notifications
@@ -57,11 +44,8 @@ type NotificationsObject = {
57
44
  * @throws GetNotificationsHttpError
58
45
  */
59
46
  declare function getNotifications(query: {
60
- /** If present, idenfies the language of the returned 'friendlyName' property. */
61
- locale?: string;
62
- /** If present, represents the 'manageableInHub' value to filter by. */
63
- manageableInHub?: true | false;
64
- /** If present, represents the 'subscribable' value to filter by. */
47
+ /** If present, idenfies the language of the returned 'friendlyName' property. */locale?: string; /** If present, represents the 'manageableInHub' value to filter by. */
48
+ manageableInHub?: true | false; /** If present, represents the 'subscribable' value to filter by. */
65
49
  subscribable?: true | false;
66
50
  }, options?: ApiCallOptions): Promise<GetNotificationsHttpResponse>;
67
51
  type GetNotificationsHttpResponse = {
package/notifications.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/notifications.ts
5
5
  /**
@@ -29,7 +29,6 @@ const notificationsExport = {
29
29
  getNotifications,
30
30
  clearCache
31
31
  };
32
- var notifications_default = notificationsExport;
33
32
 
34
33
  //#endregion
35
- export { clearCache, notifications_default as default, getNotifications };
34
+ export { clearCache, notificationsExport as default, getNotifications };
@@ -1,35 +1,26 @@
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/oauth-clients.d.ts
5
5
  /**
6
6
  * Hints of any client application secrets
7
7
  */
8
8
  type ClientSecrets = {
9
- /** The timestamp for when the client-secret record was created. */
10
- createdAt?: string;
11
- /** The identifier for the user that created the client-secret record. */
12
- createdBy?: string;
13
- /** Hint of a client application secret */
9
+ /** The timestamp for when the client-secret record was created. */createdAt?: string; /** The identifier for the user that created the client-secret record. */
10
+ createdBy?: string; /** Hint of a client application secret */
14
11
  hint: string;
15
12
  }[];
16
13
  /**
17
14
  * Response schema for reading a connection config
18
15
  */
19
16
  type ConnectionConfigReadResponse = {
20
- /** Consent method */
21
- readonly consentMethod: string;
22
- /** OAuth client has been deleted by owning tenant, only applies for published clients. */
23
- readonly deletedByOwner?: boolean;
24
- /** Status */
17
+ /** Consent method */readonly consentMethod: string; /** OAuth client has been deleted by owning tenant, only applies for published clients. */
18
+ readonly deletedByOwner?: boolean; /** Status */
25
19
  readonly status?: string;
26
20
  };
27
21
  type Error = {
28
- /** The unique code for the error */
29
- code: string;
30
- /** Additional details about the error */
31
- detail?: string;
32
- /** A summary of the error */
22
+ /** The unique code for the error */code: string; /** Additional details about the error */
23
+ detail?: string; /** A summary of the error */
33
24
  title: string;
34
25
  };
35
26
  type ErrorResponse = {
@@ -39,28 +30,18 @@ type ErrorResponse = {
39
30
  * JSON Web Key (JWK) for the public key used to verify the signature of a client assertion JWT
40
31
  */
41
32
  type JWK = {
42
- /** Algorithm intended for use with the key */
43
- alg: "RS256" | "RS512" | "ES384";
44
- /** Curve for EC keys */
45
- crv?: string;
46
- /** Exponent for RSA keys */
47
- e?: string;
48
- /** Key ID */
49
- kid: string;
50
- /** Key type (e.g., RSA, EC) */
51
- kty: "RSA" | "EC";
52
- /** Modulus for RSA keys */
53
- n?: string;
54
- /** Intended use of the key (typically "sig" for signature) */
55
- use: "sig";
56
- /** X coordinate for EC keys */
57
- x?: string;
58
- /** Y coordinate for EC keys */
33
+ /** Algorithm intended for use with the key */alg: "RS256" | "RS512" | "ES384"; /** Curve for EC keys */
34
+ crv?: string; /** Exponent for RSA keys */
35
+ e?: string; /** Key ID */
36
+ kid: string; /** Key type (e.g., RSA, EC) */
37
+ kty: "RSA" | "EC"; /** Modulus for RSA keys */
38
+ n?: string; /** Intended use of the key (typically "sig" for signature) */
39
+ use: "sig"; /** X coordinate for EC keys */
40
+ x?: string; /** Y coordinate for EC keys */
59
41
  y?: string;
60
42
  };
61
43
  type Link = {
62
- /** URL that defines the resource */
63
- href: string;
44
+ /** URL that defines the resource */href: string;
64
45
  };
65
46
  type Links = {
66
47
  next?: Link;
@@ -71,19 +52,12 @@ type Links = {
71
52
  * Schema for a OAuth client when listing as an admin user
72
53
  */
73
54
  type OAuthClientAdminListItem = {
74
- /** List of allowed authentication methods for the client */
75
- allowedAuthMethods?: ("client_secret" | "private_key_jwt")[];
76
- /** List of allowed origins for client */
77
- allowedOrigins?: string[];
78
- /** Client application id */
79
- readonly clientId: string;
80
- /** Hints of any client application secrets */
81
- readonly clientSecrets?: ClientSecrets;
82
- /** Response schema for reading a connection config */
83
- connectionConfig?: ConnectionConfigReadResponse;
84
- /** List of public keys for JWT authentication */
85
- publicKeys?: JWK[];
86
- /** List of allowed redirect URIs for login */
55
+ /** List of allowed authentication methods for the client */allowedAuthMethods?: ("client_secret" | "private_key_jwt")[]; /** List of allowed origins for client */
56
+ allowedOrigins?: string[]; /** Client application id */
57
+ readonly clientId: string; /** Hints of any client application secrets */
58
+ readonly clientSecrets?: ClientSecrets; /** Response schema for reading a connection config */
59
+ connectionConfig?: ConnectionConfigReadResponse; /** List of public keys for JWT authentication */
60
+ publicKeys?: JWK[]; /** List of allowed redirect URIs for login */
87
61
  redirectUris?: string[];
88
62
  } & OAuthClientBase;
89
63
  /**
@@ -91,103 +65,75 @@ type OAuthClientAdminListItem = {
91
65
  */
92
66
  type OAuthClientAdminListResponse = {
93
67
  data: OAuthClientAdminListItem[];
94
- links: Links;
95
- /** Total number of oauth clients, included only if `totalResults` query parameter is set to true. */
68
+ links: Links; /** Total number of oauth clients, included only if `totalResults` query parameter is set to true. */
96
69
  totalResults?: number;
97
70
  };
98
71
  /**
99
72
  * Response schema for reading an OAuth client as an admin user
100
73
  */
101
74
  type OAuthClientAdminReadResponse = {
102
- /** List of allowed authentication methods for the client */
103
- allowedAuthMethods?: ("client_secret" | "private_key_jwt")[];
104
- /** List of allowed origins for client */
105
- allowedOrigins?: string[];
106
- /** Client application id */
107
- readonly clientId: string;
108
- /** Hints of any client application secrets */
109
- readonly clientSecrets?: ClientSecrets;
110
- /** List of public keys for JWT authentication */
111
- publicKeys?: JWK[];
112
- /** List of allowed redirect URIs for login */
75
+ /** List of allowed authentication methods for the client */allowedAuthMethods?: ("client_secret" | "private_key_jwt")[]; /** List of allowed origins for client */
76
+ allowedOrigins?: string[]; /** Client application id */
77
+ readonly clientId: string; /** Hints of any client application secrets */
78
+ readonly clientSecrets?: ClientSecrets; /** List of public keys for JWT authentication */
79
+ publicKeys?: JWK[]; /** List of allowed redirect URIs for login */
113
80
  redirectUris?: string[];
114
81
  } & OAuthClientBase;
115
82
  /**
116
83
  * Base schema for OAuth client requests and responses
117
84
  */
118
85
  type OAuthClientBase = {
119
- /** Allowed grant types, only for use with appType: 'web' */
120
- allowedGrantTypes?: ("client_credentials" | "urn:qlik:oauth:user-impersonation")[];
121
- /** List of allowed scopes for this client. For a full list of scopes see [qlik.dev/authenticate/oauth/scopes/](https://qlik.dev/authenticate/oauth/scopes/). */
122
- allowedScopes?: string[];
123
- /** Application type */
124
- appType: "web" | "native" | "spa" | "anonymous-embed";
125
- /** Client application name */
126
- clientName: string;
127
- /** URI for homepage of client */
128
- clientUri?: string;
129
- /** The timestamp for when the oauth-clients record was created. */
130
- createdAt: string;
131
- /** The timestamp for when the oauth-clients record was deleted. */
132
- deletedAt?: string;
133
- /** Client description */
134
- description?: string;
135
- /** Is set if client disabled */
136
- readonly disableTag?: string;
137
- /** URI for logo of client */
138
- logoUri?: string;
139
- /** The timestamp which is set, if the client is published. */
140
- publishedAt?: string;
141
- /** The timestamp for when the oauth-clients record was updated. */
86
+ /** List of allowed authentication methods for the client */allowedAuthMethods?: ("client_secret" | "private_key_jwt")[]; /** Allowed grant types, only for use with appType: 'web' */
87
+ allowedGrantTypes?: ("client_credentials" | "urn:qlik:oauth:user-impersonation")[]; /** List of allowed scopes for this client. For a full list of scopes see [qlik.dev/authenticate/oauth/scopes/](https://qlik.dev/authenticate/oauth/scopes/). */
88
+ allowedScopes?: string[]; /** Application type */
89
+ appType: "web" | "native" | "spa" | "anonymous-embed"; /** Client application name */
90
+ clientName: string; /** Hints of any client application secrets */
91
+ readonly clientSecrets?: {
92
+ /** The timestamp for when the client-secret record was created. */createdAt?: string; /** The identifier for the user that created the client-secret record. */
93
+ createdBy?: string; /** Hint of a client application secret */
94
+ hint: string;
95
+ }[]; /** URI for homepage of client */
96
+ clientUri?: string; /** Optional settings for configuring the client connection. */
97
+ connectionConfig?: {
98
+ /** Specifies the consent method for the connection. */consentMethod?: "required" | "trusted";
99
+ }; /** The timestamp for when the oauth-clients record was created. */
100
+ createdAt: string; /** The timestamp for when the oauth-clients record was deleted. */
101
+ deletedAt?: string; /** Client description */
102
+ description?: string; /** Is set if client disabled */
103
+ readonly disableTag?: string; /** URI for logo of client */
104
+ logoUri?: string; /** List of public keys for JWT authentication */
105
+ publicKeys?: JWK[]; /** The timestamp which is set, if the client is published. */
106
+ publishedAt?: string; /** The timestamp for when the oauth-clients record was updated. */
142
107
  updatedAt?: string;
143
108
  };
144
109
  /**
145
110
  * Request schema for OAuth client creation
146
111
  */
147
112
  type OAuthClientCreateRequest = {
148
- /** List of allowed authentication methods for the client */
149
- allowedAuthMethods?: ("client_secret" | "private_key_jwt")[];
150
- /** Allowed grant types, only for use with appType: 'web' */
151
- allowedGrantTypes?: ("client_credentials" | "urn:qlik:oauth:user-impersonation")[];
152
- /** List of allowed origins for this client, only available with SPA application type */
153
- allowedOrigins?: string[];
154
- /** List of allowed scopes for this client. For a full list of scopes see [qlik.dev/authenticate/oauth/scopes/](https://qlik.dev/authenticate/oauth/scopes/). */
155
- allowedScopes?: string[];
156
- /** Application type */
157
- appType: "web" | "native" | "spa" | "anonymous-embed";
158
- /** Client application name */
159
- clientName: string;
160
- /** URI for homepage of client */
161
- clientUri?: string;
162
- /** Optional settings for configuring the client connection. */
113
+ /** List of allowed authentication methods for the client */allowedAuthMethods?: ("client_secret" | "private_key_jwt")[]; /** Allowed grant types, only for use with appType: 'web' */
114
+ allowedGrantTypes?: ("client_credentials" | "urn:qlik:oauth:user-impersonation")[]; /** List of allowed origins for this client, only available with SPA application type */
115
+ allowedOrigins?: string[]; /** List of allowed scopes for this client. For a full list of scopes see [qlik.dev/authenticate/oauth/scopes/](https://qlik.dev/authenticate/oauth/scopes/). */
116
+ allowedScopes?: string[]; /** Application type */
117
+ appType: "web" | "native" | "spa" | "anonymous-embed"; /** Client application name */
118
+ clientName: string; /** URI for homepage of client */
119
+ clientUri?: string; /** Optional settings for configuring the client connection. */
163
120
  connectionConfig?: {
164
- /** Specifies the consent method for the connection. The only allowed value is "trusted." */
165
- consentMethod?: "trusted";
166
- };
167
- /** Client description */
168
- description?: string;
169
- /** URI for logo of client */
170
- logoUri?: string;
171
- /** List of public keys for JWT authentication (required when using private_key_jwt) */
172
- publicKeys?: JWK[];
173
- /** List of allowed redirect URIs for login */
121
+ /** Specifies the consent method for the connection. The only allowed value is "trusted." */consentMethod?: "trusted";
122
+ }; /** Client description */
123
+ description?: string; /** URI for logo of client */
124
+ logoUri?: string; /** List of public keys for JWT authentication (required when using private_key_jwt) */
125
+ publicKeys?: JWK[]; /** List of allowed redirect URIs for login */
174
126
  redirectUris?: string[];
175
127
  };
176
128
  /**
177
129
  * Response schema for OAuth client creation
178
130
  */
179
131
  type OAuthClientCreateResponse = {
180
- /** List of allowed authentication methods for the client */
181
- allowedAuthMethods?: ("client_secret" | "private_key_jwt")[];
182
- /** List of allowed redirect URIs for login */
183
- allowedOrigins?: string[];
184
- /** Client application id */
185
- readonly clientId: string;
186
- /** Client application secret */
187
- readonly clientSecret: string;
188
- /** List of public keys for JWT authentication */
189
- publicKeys?: JWK[];
190
- /** List of allowed redirect URIs for login */
132
+ /** List of allowed authentication methods for the client */allowedAuthMethods?: ("client_secret" | "private_key_jwt")[]; /** List of allowed redirect URIs for login */
133
+ allowedOrigins?: string[]; /** Client application id */
134
+ readonly clientId: string; /** Client application secret */
135
+ readonly clientSecret: string; /** List of public keys for JWT authentication */
136
+ publicKeys?: JWK[]; /** List of allowed redirect URIs for login */
191
137
  redirectUris?: string[];
192
138
  } & OAuthClientBase;
193
139
  /**
@@ -197,55 +143,48 @@ type OAuthClientListResponse = {
197
143
  data: OAuthClientReadResponse[];
198
144
  links: Links;
199
145
  };
146
+ /**
147
+ * Response schema for PATCH /oauth-clients when a client secret is generated
148
+ */
149
+ type OAuthClientPatchResponse = {
150
+ /** The generated client application secret */readonly clientSecret: string;
151
+ };
200
152
  /**
201
153
  * Response schema for successfully publishing an OAuth client
202
154
  */
203
155
  type OAuthClientPublishResponse = {
204
- /** The timestamp which is set, if the client is published. */
205
- publishedAt: string;
156
+ /** The timestamp which is set, if the client is published. */publishedAt: string;
206
157
  };
207
158
  /**
208
159
  * Response schema for reading an OAuth client
209
160
  */
210
161
  type OAuthClientReadResponse = {
211
- /** Client application id */
212
- readonly clientId: string;
162
+ /** Client application id */readonly clientId: string;
213
163
  } & OAuthClientBase;
214
164
  /**
215
165
  * Response schema for creating an OAuth client application secret
216
166
  */
217
167
  type OAuthClientSecretResponse = {
218
- /** Client application id */
219
- readonly clientId: string;
220
- /** Client application secret */
221
- readonly clientSecret: string;
222
- /** The timestamp for when the client-secret record was created. */
223
- createdAt?: string;
224
- /** The identifier for the user that created the client-secret record. */
225
- createdBy?: string;
226
- /** Client application hint */
168
+ /** Client application id */readonly clientId: string; /** Client application secret */
169
+ readonly clientSecret: string; /** The timestamp for when the client-secret record was created. */
170
+ createdAt?: string; /** The identifier for the user that created the client-secret record. */
171
+ createdBy?: string; /** Client application hint */
227
172
  readonly hint: string;
228
173
  };
229
174
  /**
230
175
  * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902
231
176
  */
232
177
  type OAuthClientUpdate = {
233
- /** The operation to be performed */
234
- op: "add" | "remove" | "replace";
235
- /** The path for the given resource field to patch */
236
- path: "/allowedOrigins" | "/clientName" | "/clientUri" | "/description" | "/logoUri" | "/redirectUris" | "/allowedScopes" | "/allowedGrantTypes";
237
- /** The value to be used for this operation. */
178
+ /** The operation to be performed */op: "add" | "remove" | "replace"; /** The path for the given resource field to patch */
179
+ path: "/allowedOrigins" | "/clientName" | "/clientUri" | "/description" | "/logoUri" | "/redirectUris" | "/allowedScopes" | "/allowedGrantTypes" | "/publicKeys" | "/allowedAuthMethods"; /** The value to be used for this operation. */
238
180
  value?: string | string[];
239
181
  };
240
182
  /**
241
183
  * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902
242
184
  */
243
185
  type OAuthConnectionConfigUpdate = {
244
- /** The operation to be performed */
245
- op: "replace";
246
- /** The path for the given resource field to patch */
247
- path: "/consentMethod";
248
- /** The value to be used for this operation. */
186
+ /** The operation to be performed */op: "replace"; /** The path for the given resource field to patch */
187
+ path: "/consentMethod"; /** The value to be used for this operation. */
249
188
  value: "required" | "trusted";
250
189
  };
251
190
  /**
@@ -262,17 +201,11 @@ type OAuthConnectionConfigUpdate = {
262
201
  * @throws GetOAuthClientsHttpError
263
202
  */
264
203
  declare function getOAuthClients(query: {
265
- /** The filter query that should be used to filter the list of oauth clients. The filter syntax is defined in RFC 7644. Valid attributes for filtering are `clientId`, `clientName`, `appType`, and `tenantId`. */
266
- filter?: string;
267
- /** The number of OAuth client entries to retrieve. */
268
- limit?: number;
269
- /** The next page cursor */
270
- next?: string;
271
- /** The previous page cursor */
272
- prev?: string;
273
- /** The attribute to sort by, beginning with + for ascending and - for descending. Valid attributes for sorting are clientId, clientName, appType, tenantId, createdAt, updatedAt. */
274
- sort?: string;
275
- /** Boolean query parameter that determines if the total count of results should be included in the response. If true, the response includes the total number of results in the `totalResults` field. If false or not included in the query, `totalResults` will be excluded from the response. */
204
+ /** The filter query that should be used to filter the list of oauth clients. The filter syntax is defined in RFC 7644. Valid attributes for filtering are `clientId`, `clientName`, `appType`, and `tenantId`. */filter?: string; /** The number of OAuth client entries to retrieve. */
205
+ limit?: number; /** The next page cursor */
206
+ next?: string; /** The previous page cursor */
207
+ prev?: string; /** The attribute to sort by, beginning with + for ascending and - for descending. Valid attributes for sorting are clientId, clientName, appType, tenantId, createdAt, updatedAt. */
208
+ sort?: string; /** Boolean query parameter that determines if the total count of results should be included in the response. If true, the response includes the total number of results in the `totalResults` field. If false or not included in the query, `totalResults` will be excluded from the response. */
276
209
  totalResults?: boolean;
277
210
  }, options?: ApiCallOptions): Promise<GetOAuthClientsHttpResponse>;
278
211
  type GetOAuthClientsHttpResponse = {
@@ -337,14 +270,20 @@ type GetOAuthClientHttpError = {
337
270
  status: 400 | 401 | 403 | 404 | 500 | 503;
338
271
  };
339
272
  /**
340
- * Updates the specified OAuth client.
273
+ * Updates the specified OAuth client. Returns 202 Accepted with a client secret in the response body if a client secret is generated during the update (e.g., when adding client_secret to allowedAuthMethods). Otherwise returns 204 No Content.
341
274
  *
342
275
  * @param id The unique identifier for the OAuth client
343
276
  * @param body an object with the body content
344
277
  * @throws PatchOAuthClientHttpError
345
278
  */
346
279
  declare function patchOAuthClient(id: string, body: OAuthClientUpdate[], options?: ApiCallOptions): Promise<PatchOAuthClientHttpResponse>;
347
- type PatchOAuthClientHttpResponse = {
280
+ type PatchOAuthClientHttpResponse = PatchOAuthClient202HttpResponse | PatchOAuthClient204HttpResponse;
281
+ type PatchOAuthClient202HttpResponse = {
282
+ data: OAuthClientPatchResponse;
283
+ headers: Headers;
284
+ status: 202;
285
+ };
286
+ type PatchOAuthClient204HttpResponse = {
348
287
  data: void;
349
288
  headers: Headers;
350
289
  status: 204;
@@ -499,7 +438,7 @@ type OauthClientsAPI = {
499
438
  */
500
439
  getOAuthClient: typeof getOAuthClient;
501
440
  /**
502
- * Updates the specified OAuth client.
441
+ * Updates the specified OAuth client. Returns 202 Accepted with a client secret in the response body if a client secret is generated during the update (e.g., when adding client_secret to allowedAuthMethods). Otherwise returns 204 No Content.
503
442
  *
504
443
  * @param id The unique identifier for the OAuth client
505
444
  * @param body an object with the body content
@@ -560,4 +499,4 @@ type OauthClientsAPI = {
560
499
  */
561
500
  declare const oauthClientsExport: OauthClientsAPI;
562
501
  //#endregion
563
- export { ClientSecrets, ConnectionConfigReadResponse, CreateOAuthClientHttpError, CreateOAuthClientHttpResponse, CreateOAuthClientSecretHttpError, CreateOAuthClientSecretHttpResponse, DeleteOAuthClientConnectionConfigHttpError, DeleteOAuthClientConnectionConfigHttpResponse, DeleteOAuthClientHttpError, DeleteOAuthClientHttpResponse, DeleteOAuthClientSecretHttpError, DeleteOAuthClientSecretHttpResponse, Error, ErrorResponse, GetOAuthClientConnectionConfigHttpError, GetOAuthClientConnectionConfigHttpResponse, GetOAuthClientHttpError, GetOAuthClientHttpResponse, GetOAuthClientsHttpError, GetOAuthClientsHttpResponse, JWK, Link, Links, OAuthClientAdminListItem, OAuthClientAdminListResponse, OAuthClientAdminReadResponse, OAuthClientBase, OAuthClientCreateRequest, OAuthClientCreateResponse, OAuthClientListResponse, OAuthClientPublishResponse, OAuthClientReadResponse, OAuthClientSecretResponse, OAuthClientUpdate, OAuthConnectionConfigUpdate, OauthClientsAPI, PatchOAuthClientConnectionConfigHttpError, PatchOAuthClientConnectionConfigHttpResponse, PatchOAuthClientHttpError, PatchOAuthClientHttpResponse, PublishOAuthClientHttpError, PublishOAuthClientHttpResponse, clearCache, createOAuthClient, createOAuthClientSecret, oauthClientsExport as default, deleteOAuthClient, deleteOAuthClientConnectionConfig, deleteOAuthClientSecret, getOAuthClient, getOAuthClientConnectionConfig, getOAuthClients, patchOAuthClient, patchOAuthClientConnectionConfig, publishOAuthClient };
502
+ export { ClientSecrets, ConnectionConfigReadResponse, CreateOAuthClientHttpError, CreateOAuthClientHttpResponse, CreateOAuthClientSecretHttpError, CreateOAuthClientSecretHttpResponse, DeleteOAuthClientConnectionConfigHttpError, DeleteOAuthClientConnectionConfigHttpResponse, DeleteOAuthClientHttpError, DeleteOAuthClientHttpResponse, DeleteOAuthClientSecretHttpError, DeleteOAuthClientSecretHttpResponse, Error, ErrorResponse, GetOAuthClientConnectionConfigHttpError, GetOAuthClientConnectionConfigHttpResponse, GetOAuthClientHttpError, GetOAuthClientHttpResponse, GetOAuthClientsHttpError, GetOAuthClientsHttpResponse, JWK, Link, Links, OAuthClientAdminListItem, OAuthClientAdminListResponse, OAuthClientAdminReadResponse, OAuthClientBase, OAuthClientCreateRequest, OAuthClientCreateResponse, OAuthClientListResponse, OAuthClientPatchResponse, OAuthClientPublishResponse, OAuthClientReadResponse, OAuthClientSecretResponse, OAuthClientUpdate, OAuthConnectionConfigUpdate, OauthClientsAPI, PatchOAuthClient202HttpResponse, PatchOAuthClient204HttpResponse, PatchOAuthClientConnectionConfigHttpError, PatchOAuthClientConnectionConfigHttpResponse, PatchOAuthClientHttpError, PatchOAuthClientHttpResponse, PublishOAuthClientHttpError, PublishOAuthClientHttpResponse, clearCache, createOAuthClient, createOAuthClientSecret, oauthClientsExport as default, deleteOAuthClient, deleteOAuthClientConnectionConfig, deleteOAuthClientSecret, getOAuthClient, getOAuthClientConnectionConfig, getOAuthClients, patchOAuthClient, patchOAuthClientConnectionConfig, publishOAuthClient };
package/oauth-clients.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/oauth-clients.ts
5
5
  /**
@@ -67,7 +67,7 @@ async function getOAuthClient(id, options) {
67
67
  });
68
68
  }
69
69
  /**
70
- * Updates the specified OAuth client.
70
+ * Updates the specified OAuth client. Returns 202 Accepted with a client secret in the response body if a client secret is generated during the update (e.g., when adding client_secret to allowedAuthMethods). Otherwise returns 204 No Content.
71
71
  *
72
72
  * @param id The unique identifier for the OAuth client
73
73
  * @param body an object with the body content
@@ -197,7 +197,6 @@ const oauthClientsExport = {
197
197
  patchOAuthClientConnectionConfig,
198
198
  clearCache
199
199
  };
200
- var oauth_clients_default = oauthClientsExport;
201
200
 
202
201
  //#endregion
203
- export { clearCache, createOAuthClient, createOAuthClientSecret, oauth_clients_default as default, deleteOAuthClient, deleteOAuthClientConnectionConfig, deleteOAuthClientSecret, getOAuthClient, getOAuthClientConnectionConfig, getOAuthClients, patchOAuthClient, patchOAuthClientConnectionConfig, publishOAuthClient };
202
+ export { clearCache, createOAuthClient, createOAuthClientSecret, oauthClientsExport as default, deleteOAuthClient, deleteOAuthClientConnectionConfig, deleteOAuthClientSecret, getOAuthClient, getOAuthClientConnectionConfig, getOAuthClients, patchOAuthClient, patchOAuthClientConnectionConfig, publishOAuthClient };