@qlik/api 2.3.0 → 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-DipDBQQ5.js → boot-interceptors-DqRxTczb.js} +296 -248
  33. package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
  34. package/chunks/{invoke-fetch-B7lGscuQ.js → invoke-fetch-DMAi6Fg3.js} +3 -3
  35. package/chunks/{invoke-fetch-DhdyFZ0F.js → invoke-fetch-pMN6iqup.js} +2 -3
  36. package/chunks/platform-types-CECrZkOF.d.ts +29 -0
  37. package/chunks/{public-runtime-modules-QhLPeQr5.js → public-runtime-modules-2KfyI2qM.js} +5 -5
  38. package/chunks/{qix-RCUslia8.js → qix-BdNrIA4s.js} +19 -20
  39. package/chunks/{qix-chunk-entrypoint-WAS4NVTf.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 -4
  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-BowS4SUR.js +0 -28
  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
@@ -1,18 +1,14 @@
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/web-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
- message?: string;
13
- /** The HTTP status code. */
14
- status?: number;
15
- /** Summary of the problem. */
9
+ /** The error code. */code: string; /** A human-readable explanation specific to this occurrence of the problem. */
10
+ message?: string; /** The HTTP status code. */
11
+ status?: number; /** Summary of the problem. */
16
12
  title: string;
17
13
  };
18
14
  /**
@@ -39,8 +35,7 @@ type Links = {
39
35
  * Notifications meta data
40
36
  */
41
37
  type Meta = {
42
- /** The total number of unread notification. */
43
- unreadCount?: number;
38
+ /** The total number of unread notification. */unreadCount?: number;
44
39
  };
45
40
  type Notification = {
46
41
  readonly action?: string;
@@ -62,11 +57,8 @@ type Notification = {
62
57
  * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
63
58
  */
64
59
  type NotificationPatch = {
65
- /** The operation to be performed. */
66
- op: "replace";
67
- /** The path for the given resource field to patch. */
68
- path: "/read";
69
- /** The value to be used for this operation. */
60
+ /** The operation to be performed. */op: "replace"; /** The path for the given resource field to patch. */
61
+ path: "/read"; /** The value to be used for this operation. */
70
62
  value: string;
71
63
  };
72
64
  /**
@@ -81,10 +73,8 @@ type NotificationPatch = {
81
73
  */
82
74
  type NotificationPatchSchema = NotificationPatch[];
83
75
  type Notifications = {
84
- data?: Notification[];
85
- /** Notifications links */
86
- links?: Links;
87
- /** Notifications meta data */
76
+ data?: Notification[]; /** Notifications links */
77
+ links?: Links; /** Notifications meta data */
88
78
  meta?: Meta;
89
79
  };
90
80
  /**
@@ -100,15 +90,10 @@ type Notifications = {
100
90
  * @throws GetNotificationsHttpError
101
91
  */
102
92
  declare function getNotifications(query: {
103
- /** The number of notification entries to retrieved. */
104
- limit?: number;
105
- /** Page number */
106
- page?: number;
107
- /** Read status of the notification */
108
- read?: boolean;
109
- /** Filter by resource types. If passing more than 1 resource type, use comma seperated string. */
110
- resourceType?: string;
111
- /** The field to sort by, with +/- prefix indicating sort order */
93
+ /** The number of notification entries to retrieved. */limit?: number; /** Page number */
94
+ page?: number; /** Read status of the notification */
95
+ read?: boolean; /** Filter by resource types. If passing more than 1 resource type, use comma seperated string. */
96
+ resourceType?: string; /** The field to sort by, with +/- prefix indicating sort order */
112
97
  sort?: "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt";
113
98
  }, options?: ApiCallOptions): Promise<GetNotificationsHttpResponse>;
114
99
  type GetNotificationsHttpResponse = {
@@ -1,5 +1,5 @@
1
- import "./chunks/public-runtime-modules-QhLPeQr5.js";
2
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.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/web-notifications.ts
5
5
  /**
@@ -112,7 +112,6 @@ const webNotificationsExport = {
112
112
  patchNotification,
113
113
  clearCache
114
114
  };
115
- var web_notifications_default = webNotificationsExport;
116
115
 
117
116
  //#endregion
118
- export { clearCache, web_notifications_default as default, deleteNotification, deleteNotifications, getNotification, getNotifications, patchNotification, patchNotifications };
117
+ export { clearCache, webNotificationsExport as default, deleteNotification, deleteNotifications, getNotification, getNotifications, patchNotification, patchNotifications };
package/webhooks.d.ts CHANGED
@@ -1,37 +1,23 @@
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/webhooks.d.ts
5
5
  type Delivery = {
6
- /** The name of the triggering event-type. */
7
- eventType: string;
8
- /** The delivery's unique identifier. */
9
- id: string;
10
- /** Request details for the delivery. */
6
+ /** The name of the triggering event-type. */eventType: string; /** The delivery's unique identifier. */
7
+ id: string; /** Request details for the delivery. */
11
8
  request?: {
12
- /** The sent body/payload of the delivery. */
13
- body?: unknown;
14
- /** Headers sent for this delivery, values of encryptedHeaders are omitted as such "**OMITTED**". */
15
- headers?: Record<string, string>;
16
- /** URL used for this delivery. */
9
+ /** The sent body/payload of the delivery. */body?: unknown; /** Headers sent for this delivery, values of encryptedHeaders are omitted as such "**OMITTED**". */
10
+ headers?: Record<string, string>; /** URL used for this delivery. */
17
11
  url?: string;
18
- };
19
- /** Response details for the delivery. */
12
+ }; /** Response details for the delivery. */
20
13
  response?: {
21
- /** The received body of the delivery. */
22
- body?: string;
23
- /** Headers received for this delivery, values of encryptedHeaders are omitted as such "**OMITTED**". */
24
- headers?: Record<string, string>;
25
- /** The HTTP status code of the response. */
14
+ /** The received body of the delivery. */body?: string; /** Headers received for this delivery, values of encryptedHeaders are omitted as such "**OMITTED**". */
15
+ headers?: Record<string, string>; /** The HTTP status code of the response. */
26
16
  statusCode?: number;
27
- };
28
- /** The status of delivery. */
29
- status: "success" | "fail";
30
- /** The status message of the delivery. */
31
- statusMessage?: string;
32
- /** The UTC timestamp when the delivery was triggered. */
33
- triggeredAt: string;
34
- /** The unique webhook identifier that the delivery is for. */
17
+ }; /** The status of delivery. */
18
+ status: "success" | "fail"; /** The status message of the delivery. */
19
+ statusMessage?: string; /** The UTC timestamp when the delivery was triggered. */
20
+ triggeredAt: string; /** The unique webhook identifier that the delivery is for. */
35
21
  webhookId: string;
36
22
  };
37
23
  type DeliveryList = {
@@ -43,55 +29,36 @@ type DeliveryList = {
43
29
  };
44
30
  };
45
31
  type Error = {
46
- /** The unique code for the error. */
47
- code: string;
48
- /** May be used to provide additional details. */
49
- detail?: string;
50
- /** A summary of what went wrong. */
32
+ /** The unique code for the error. */code: string; /** May be used to provide additional details. */
33
+ detail?: string; /** A summary of what went wrong. */
51
34
  title: string;
52
35
  };
53
36
  type ErrorResponse = {
54
- errors?: Error[];
55
- /** A way to trace the source of the error. */
37
+ errors?: Error[]; /** A way to trace the source of the error. */
56
38
  traceId?: string;
57
39
  };
58
40
  type EventType = {
59
- /** Description of the event type. */
60
- description?: string;
61
- /** Specifies which levels that are supported for this event type. */
62
- levels?: string[];
63
- /** Name of the event type. */
64
- name?: string;
65
- /** Title of the event type. */
41
+ /** Description of the event type. */description?: string; /** Specifies which levels that are supported for this event type. */
42
+ levels?: string[]; /** Name of the event type. */
43
+ name?: string; /** Title of the event type. */
66
44
  title?: string;
67
45
  };
68
46
  type EventTypes = {
69
47
  data?: EventType[];
70
48
  };
71
49
  type Link = {
72
- /** URL to a resource request. */
73
- href: string;
50
+ /** URL to a resource request. */href: string;
74
51
  };
75
52
  type WebhookBase = {
76
- /** If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook. */
77
- checkCertificateRevocation?: boolean;
78
- /** The UTC timestamp when the webhook was created. */
79
- readonly createdAt?: string;
80
- /** The id of the user that created the webhook. */
81
- readonly createdByUserId?: string;
82
- /** The reason for creating the webhook. */
83
- description?: string;
84
- /** The reason for the webhook to be disabled. */
85
- readonly disabledReason?: string;
86
- /** The unique code for the reason. */
87
- readonly disabledReasonCode?: string;
88
- /** If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled. */
89
- enableCloudEventDelivery?: boolean;
90
- /** Whether the webhook is active and sending requests. */
91
- enabled?: boolean;
92
- /** These headers are persisted encrypted and decrypted to be sent as normal headers in post request (webhook delivery), in case of URL change these headers will need to be re-entered. Note: duplicate headers are not allowed and are case-insensitive. */
93
- encryptedHeaders?: Record<string, string>;
94
- /** Types of events for which the webhook should trigger. Retrieve available types from `/v1/webhooks/event-types`. */
53
+ /** If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook. */checkCertificateRevocation?: boolean; /** The UTC timestamp when the webhook was created. */
54
+ readonly createdAt?: string; /** The id of the user that created the webhook. */
55
+ readonly createdByUserId?: string; /** The reason for creating the webhook. */
56
+ description?: string; /** The reason for the webhook to be disabled. */
57
+ readonly disabledReason?: string; /** The unique code for the reason. */
58
+ readonly disabledReasonCode?: string; /** If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled. */
59
+ enableCloudEventDelivery?: boolean; /** Whether the webhook is active and sending requests. */
60
+ enabled?: boolean; /** These headers are persisted encrypted and decrypted to be sent as normal headers in post request (webhook delivery), in case of URL change these headers will need to be re-entered. Note: duplicate headers are not allowed and are case-insensitive. */
61
+ encryptedHeaders?: Record<string, string>; /** Types of events for which the webhook should trigger. Retrieve available types from `/v1/webhooks/event-types`. */
95
62
  eventTypes?: string[];
96
63
  /** Filter that should match for a webhook to be triggered.
97
64
  * Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId', beside the common attributes the "com.qlik.v1.app.reload.finished" event also supports "data.status" that could be either "ok" or "error" but can't be used together with other event types.
@@ -99,24 +66,15 @@ type WebhookBase = {
99
66
  * Supported logical operators are 'and' and 'or'.
100
67
  * Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes.
101
68
  * For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation. */
102
- filter?: string;
103
- /** Additional headers in the post request (webhook delivery). Note: duplicate headers are not allowed and are case-insensitive. */
104
- headers?: Record<string, string>;
105
- /** The webhook's unique identifier. */
106
- readonly id?: string;
107
- /** Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator. */
108
- level?: "tenant" | "user";
109
- /** The name for the webhook. */
110
- name: string;
111
- /** The id of the user that owns the webhook, only applicable for user level webhooks. */
112
- ownerId?: string;
113
- /** String used as secret for calculating HMAC hash sent as header. */
114
- secret?: string;
115
- /** The UTC timestamp when the webhook was last updated. */
116
- readonly updatedAt?: string;
117
- /** The id of the user that last updated the webhook. */
118
- readonly updatedByUserId?: string;
119
- /** Target URL for webhook HTTPS requests. */
69
+ filter?: string; /** Additional headers in the post request (webhook delivery). Note: duplicate headers are not allowed and are case-insensitive. */
70
+ headers?: Record<string, string>; /** The webhook's unique identifier. */
71
+ readonly id?: string; /** Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator. */
72
+ level?: "tenant" | "user"; /** The name for the webhook. */
73
+ name: string; /** The id of the user that owns the webhook, only applicable for user level webhooks. */
74
+ ownerId?: string; /** String used as secret for calculating HMAC hash sent as header. */
75
+ secret?: string; /** The UTC timestamp when the webhook was last updated. */
76
+ readonly updatedAt?: string; /** The id of the user that last updated the webhook. */
77
+ readonly updatedByUserId?: string; /** Target URL for webhook HTTPS requests. */
120
78
  url: string;
121
79
  };
122
80
  type WebhookList = {
@@ -131,41 +89,26 @@ type WebhookList = {
131
89
  * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902
132
90
  */
133
91
  type WebhookPatch = {
134
- /** The operation to be performed. */
135
- op: "add" | "remove" | "replace";
136
- /** The path for the given resource field to patch. */
137
- path: "/name" | "/description" | "/url" | "/eventTypes" | "/headers" | "/enabled" | "/secret" | "/encryptedHeaders" | "/enableCloudEventDelivery";
138
- /** The value to be used for this operation. */
92
+ /** The operation to be performed. */op: "add" | "remove" | "replace"; /** The path for the given resource field to patch. */
93
+ path: "/name" | "/description" | "/url" | "/eventTypes" | "/headers" | "/enabled" | "/secret" | "/encryptedHeaders" | "/enableCloudEventDelivery"; /** The value to be used for this operation. */
139
94
  value?: boolean | number | unknown | string;
140
95
  };
141
96
  type WebhookPost = WebhookBase & {
142
- /** Indicates from where the webhook was created and its purpose. */
143
- origin?: "api" | "automations" | "management-console";
97
+ /** Indicates from where the webhook was created and its purpose. */origin?: "api" | "automations" | "management-console";
144
98
  };
145
99
  type WebhookResponse = WebhookResponseBase & {
146
- /** Indicates from where the webhook was created and its purpose. */
147
- readonly origin?: "api" | "automations" | "management-console";
100
+ /** Indicates from where the webhook was created and its purpose. */readonly origin?: "api" | "automations" | "management-console";
148
101
  };
149
102
  type WebhookResponseBase = {
150
- /** If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook. */
151
- checkCertificateRevocation?: boolean;
152
- /** The UTC timestamp when the webhook was created. */
153
- readonly createdAt?: string;
154
- /** The id of the user that created the webhook. */
155
- readonly createdByUserId?: string;
156
- /** The reason for creating the webhook. */
157
- description?: string;
158
- /** The reason for the webhook to be disabled. */
159
- readonly disabledReason?: string;
160
- /** The unique code for the reason. */
161
- readonly disabledReasonCode?: string;
162
- /** If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled. */
163
- enableCloudEventDelivery?: boolean;
164
- /** Whether the webhook is active and sending requests. */
165
- enabled?: boolean;
166
- /** Additional encrypted headers in the post request. */
167
- encryptedHeaders?: string[];
168
- /** Types of events for which the webhook should trigger. Retrieve available types from `/v1/webhooks/event-types`. */
103
+ /** If enabled the certificate chain of the configured URL will be checked for revocation before sending the webhook. */checkCertificateRevocation?: boolean; /** The UTC timestamp when the webhook was created. */
104
+ readonly createdAt?: string; /** The id of the user that created the webhook. */
105
+ readonly createdByUserId?: string; /** The reason for creating the webhook. */
106
+ description?: string; /** The reason for the webhook to be disabled. */
107
+ readonly disabledReason?: string; /** The unique code for the reason. */
108
+ readonly disabledReasonCode?: string; /** If enabled the webhook will be sent as a CloudEvent, once enabled for a webhook it cannot be disabled. */
109
+ enableCloudEventDelivery?: boolean; /** Whether the webhook is active and sending requests. */
110
+ enabled?: boolean; /** Additional encrypted headers in the post request. */
111
+ encryptedHeaders?: string[]; /** Types of events for which the webhook should trigger. Retrieve available types from `/v1/webhooks/event-types`. */
169
112
  eventTypes?: string[];
170
113
  /** Filter that should match for a webhook to be triggered.
171
114
  * Supported common attribute names are 'id', 'spaceId' and 'topLevelResourceId', beside the common attributes the "com.qlik.v1.app.reload.finished" event also supports "data.status" that could be either "ok" or "error" but can't be used together with other event types.
@@ -173,27 +116,18 @@ type WebhookResponseBase = {
173
116
  * Supported logical operators are 'and' and 'or'.
174
117
  * Note that attribute values must be valid JSON strings, hence they're enclosed with double quotes.
175
118
  * For more detailed information regarding the SCIM filter syntax (RFC7644) used please follow the link to external documentation. */
176
- filter?: string;
177
- /** Additional headers in the post request. */
178
- headers?: Record<string, string>;
179
- /** The webhook's unique identifier. */
180
- readonly id?: string;
181
- /** Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator. */
182
- level?: "tenant" | "user";
183
- /** The name for the webhook. */
184
- name: string;
185
- /** The id of the user that owns the webhook, only applicable for user level webhooks. */
119
+ filter?: string; /** Additional headers in the post request. */
120
+ headers?: Record<string, string>; /** The webhook's unique identifier. */
121
+ readonly id?: string; /** Defines at what level the webhook should operate: for all resources belonging to a tenant or restricted to only those accessible by the webhook-creator. */
122
+ level?: "tenant" | "user"; /** The name for the webhook. */
123
+ name: string; /** The id of the user that owns the webhook, only applicable for user level webhooks. */
186
124
  ownerId?: string;
187
125
  /** @deprecated
188
126
  * String used as secret for calculating HMAC hash sent as header. */
189
- secret?: string;
190
- /** Provides status of the string used as secret for calculating HMAC hash sent as header is already added or not. */
191
- secretKeyAdded?: boolean;
192
- /** The UTC timestamp when the webhook was last updated. */
193
- readonly updatedAt?: string;
194
- /** The id of the user that last updated the webhook. */
195
- readonly updatedByUserId?: string;
196
- /** Target URL for webhook HTTPS requests. */
127
+ secret?: string; /** Provides status of the string used as secret for calculating HMAC hash sent as header is already added or not. */
128
+ secretKeyAdded?: boolean; /** The UTC timestamp when the webhook was last updated. */
129
+ readonly updatedAt?: string; /** The id of the user that last updated the webhook. */
130
+ readonly updatedByUserId?: string; /** Target URL for webhook HTTPS requests. */
197
131
  url: string;
198
132
  };
199
133
  /**
@@ -203,31 +137,18 @@ type WebhookResponseBase = {
203
137
  * @throws GetWebhooksHttpError
204
138
  */
205
139
  declare function getWebhooks(query: {
206
- /** Filter resources by user that created it. */
207
- createdByUserId?: string;
208
- /** Filter resources by enabled true/false. */
209
- enabled?: boolean;
210
- /** Filter resources by event-type/types, a single webhook item can have multiple event-types. */
211
- eventTypes?: string;
212
- /** Filter resources by level that user has access to (either user or level). */
213
- level?: string;
214
- /** Maximum number of webhooks to retrieve. */
215
- limit?: number;
216
- /** Filter resources by name (wildcard and case insensitive). */
217
- name?: string;
218
- /** Cursor to the next page. */
219
- next?: string;
220
- /** Filter resources by origins, supports multiorigin. */
221
- origins?: "api" | "automations" | "management-console";
222
- /** Filter resources by user that owns it, only applicable for user level webhooks. */
223
- ownerId?: string;
224
- /** Cursor to the previous page. */
225
- prev?: string;
226
- /** Field to sort by, prefix with -/+ to indicate order. */
227
- sort?: "name" | "+name" | "-name" | "url" | "+url" | "-url" | "createdAt" | "+createdAt" | "-createdAt" | "updatedAt" | "+updatedAt" | "-updatedAt";
228
- /** Filter resources by user that last updated the webhook. */
229
- updatedByUserId?: string;
230
- /** Filter resources by URL (wildcard and case insensitive). */
140
+ /** Filter resources by user that created it. */createdByUserId?: string; /** Filter resources by enabled true/false. */
141
+ enabled?: boolean; /** Filter resources by event-type/types, a single webhook item can have multiple event-types. */
142
+ eventTypes?: string; /** Filter resources by level that user has access to (either user or level). */
143
+ level?: string; /** Maximum number of webhooks to retrieve. */
144
+ limit?: number; /** Filter resources by name (wildcard and case insensitive). */
145
+ name?: string; /** Cursor to the next page. */
146
+ next?: string; /** Filter resources by origins, supports multiorigin. */
147
+ origins?: "api" | "automations" | "management-console"; /** Filter resources by user that owns it, only applicable for user level webhooks. */
148
+ ownerId?: string; /** Cursor to the previous page. */
149
+ prev?: string; /** Field to sort by, prefix with -/+ to indicate order. */
150
+ sort?: "name" | "+name" | "-name" | "url" | "+url" | "-url" | "createdAt" | "+createdAt" | "-createdAt" | "updatedAt" | "+updatedAt" | "-updatedAt"; /** Filter resources by user that last updated the webhook. */
151
+ updatedByUserId?: string; /** Filter resources by URL (wildcard and case insensitive). */
231
152
  url?: string;
232
153
  }, options?: ApiCallOptions): Promise<GetWebhooksHttpResponse>;
233
154
  type GetWebhooksHttpResponse = {
@@ -353,17 +274,11 @@ type UpdateWebhookHttpError = {
353
274
  * @throws GetWebhookDeliveriesHttpError
354
275
  */
355
276
  declare function getWebhookDeliveries(id: string, query: {
356
- /** Filter resources by event-type. */
357
- eventType?: string;
358
- /** Maximum number of deliveries to retrieve. */
359
- limit?: number;
360
- /** Cursor to the next page. */
361
- next?: string;
362
- /** Cursor to the previous page. */
363
- prev?: string;
364
- /** Field to sort by, prefix with -/+ to indicate order. */
365
- sort?: "status" | "+status" | "-status" | "triggeredAt" | "+triggeredAt" | "-triggeredAt";
366
- /** Filter resources by status (success or fail). */
277
+ /** Filter resources by event-type. */eventType?: string; /** Maximum number of deliveries to retrieve. */
278
+ limit?: number; /** Cursor to the next page. */
279
+ next?: string; /** Cursor to the previous page. */
280
+ prev?: string; /** Field to sort by, prefix with -/+ to indicate order. */
281
+ sort?: "status" | "+status" | "-status" | "triggeredAt" | "+triggeredAt" | "-triggeredAt"; /** Filter resources by status (success or fail). */
367
282
  status?: "success" | "fail";
368
283
  }, options?: ApiCallOptions): Promise<GetWebhookDeliveriesHttpResponse>;
369
284
  type GetWebhookDeliveriesHttpResponse = {
package/webhooks.js CHANGED
@@ -1,5 +1,5 @@
1
- import "./chunks/public-runtime-modules-QhLPeQr5.js";
2
- import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.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/webhooks.ts
5
5
  /**
@@ -179,7 +179,6 @@ const webhooksExport = {
179
179
  resendWebhookDelivery,
180
180
  clearCache
181
181
  };
182
- var webhooks_default = webhooksExport;
183
182
 
184
183
  //#endregion
185
- export { clearCache, createWebhook, webhooks_default as default, deleteWebhook, getWebhook, getWebhookDeliveries, getWebhookDelivery, getWebhookEventTypes, getWebhooks, patchWebhook, resendWebhookDelivery, updateWebhook };
184
+ export { clearCache, createWebhook, webhooksExport as default, deleteWebhook, getWebhook, getWebhookDeliveries, getWebhookDelivery, getWebhookEventTypes, getWebhooks, patchWebhook, resendWebhookDelivery, updateWebhook };
@@ -1,28 +0,0 @@
1
- import { C as unregisterHostConfig, D as UnexpectedAuthTypeError, E as InvalidHostConfigError, S as toValidWebsocketLocationUrl, T as InvalidAuthTypeError, _ as registerAuthModule, b as setDefaultHostConfig, c as getAccessToken, d as getWebResourceAuthParams, f as getWebSocketAuthParams, g as logout, h as isWindows, l as getDefaultHostConfig, m as isHostCrossOrigin, p as handleAuthenticationError, s as determineAuthType, u as getRestCallAuthParams, v as registerHostConfig, w as AuthorizationError, x as toValidLocationUrl, y as serializeHostConfig } from "./interceptors-DipDBQQ5.js";
2
-
3
- //#region src/auth/auth.ts
4
- /**
5
- * Provides functionalities for authentication with Qlik backends.
6
- */
7
- const auth = {
8
- determineAuthType,
9
- getDefaultHostConfig,
10
- getRestCallAuthParams,
11
- getWebResourceAuthParams,
12
- getWebSocketAuthParams,
13
- handleAuthenticationError,
14
- isHostCrossOrigin,
15
- isWindows,
16
- logout,
17
- registerAuthModule,
18
- registerHostConfig,
19
- serializeHostConfig,
20
- setDefaultHostConfig,
21
- toValidLocationUrl,
22
- toValidWebsocketLocationUrl,
23
- unregisterHostConfig
24
- };
25
- var auth_default = auth;
26
-
27
- //#endregion
28
- export { AuthorizationError, InvalidAuthTypeError, InvalidHostConfigError, UnexpectedAuthTypeError, auth_default as default, determineAuthType, getAccessToken, getDefaultHostConfig, getRestCallAuthParams, getWebResourceAuthParams, getWebSocketAuthParams, handleAuthenticationError, isHostCrossOrigin, isWindows, logout, registerAuthModule, registerHostConfig, serializeHostConfig, setDefaultHostConfig, toValidLocationUrl, toValidWebsocketLocationUrl, unregisterHostConfig };