@qlik/api 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (231) hide show
  1. package/analytics/change-stores.d.ts +386 -0
  2. package/analytics/change-stores.js +123 -0
  3. package/analytics.d.ts +14 -0
  4. package/analytics.js +13 -0
  5. package/api-keys.d.ts +362 -3
  6. package/api-keys.js +2 -3
  7. package/apps.d.ts +2673 -3
  8. package/apps.js +2 -3
  9. package/assistants.d.ts +1370 -3
  10. package/assistants.js +2 -3
  11. package/audits.d.ts +318 -3
  12. package/audits.js +4 -4
  13. package/auth-types.d.ts +1 -1
  14. package/auth-types.js +1 -2
  15. package/auth.d.ts +94 -2
  16. package/auth.js +63 -3
  17. package/automation-connections.d.ts +366 -3
  18. package/automation-connections.js +2 -3
  19. package/automation-connectors.d.ts +84 -3
  20. package/automation-connectors.js +2 -3
  21. package/automations.d.ts +805 -3
  22. package/automations.js +2 -3
  23. package/automl-deployments.d.ts +101 -3
  24. package/automl-deployments.js +2 -3
  25. package/automl-predictions.d.ts +238 -3
  26. package/automl-predictions.js +2 -3
  27. package/banners.d.ts +184 -3
  28. package/banners.js +2 -3
  29. package/brands.d.ts +670 -3
  30. package/brands.js +2 -3
  31. package/chunks/{auth-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
  32. package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
  33. package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
  34. package/chunks/{auth-functions-BmZgZYSs.js → interceptors-DipDBQQ5.js} +258 -54
  35. package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
  36. package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
  37. package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
  38. package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
  39. package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
  40. package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.js} +48 -50
  41. package/collections.d.ts +582 -3
  42. package/collections.js +2 -3
  43. package/conditions.d.ts +662 -3
  44. package/conditions.js +2 -3
  45. package/consumption.d.ts +182 -3
  46. package/consumption.js +2 -3
  47. package/core/ip-policies.d.ts +328 -4
  48. package/core/ip-policies.js +108 -5
  49. package/core.d.ts +13 -4
  50. package/core.js +3 -4
  51. package/csp-origins.d.ts +273 -3
  52. package/csp-origins.js +2 -3
  53. package/csrf-token.d.ts +62 -3
  54. package/csrf-token.js +2 -3
  55. package/data-alerts.d.ts +1004 -3
  56. package/data-alerts.js +2 -3
  57. package/data-assets.d.ts +207 -3
  58. package/data-assets.js +2 -3
  59. package/data-connections.d.ts +678 -3
  60. package/data-connections.js +2 -3
  61. package/data-credentials.d.ts +292 -3
  62. package/data-credentials.js +2 -3
  63. package/data-files.d.ts +860 -3
  64. package/data-files.js +2 -3
  65. package/data-qualities.d.ts +175 -3
  66. package/data-qualities.js +2 -3
  67. package/data-sets.d.ts +424 -3
  68. package/data-sets.js +2 -3
  69. package/data-sources.d.ts +348 -3
  70. package/data-sources.js +2 -3
  71. package/data-stores.d.ts +537 -3
  72. package/data-stores.js +2 -3
  73. package/dcaas.d.ts +192 -3
  74. package/dcaas.js +2 -3
  75. package/di-projects.d.ts +812 -4
  76. package/di-projects.js +25 -4
  77. package/direct-access-agents.d.ts +710 -4
  78. package/direct-access-agents.js +37 -5
  79. package/docs/authentication.md +1 -1
  80. package/encryption.d.ts +372 -3
  81. package/encryption.js +2 -3
  82. package/extensions.d.ts +295 -3
  83. package/extensions.js +2 -3
  84. package/global-types.d.ts +1 -1
  85. package/global-types.js +0 -2
  86. package/glossaries.d.ts +1223 -3
  87. package/glossaries.js +2 -3
  88. package/groups.d.ts +510 -3
  89. package/groups.js +2 -3
  90. package/identity-providers.d.ts +711 -3
  91. package/identity-providers.js +2 -3
  92. package/index.d.ts +78 -69
  93. package/index.js +28 -10
  94. package/interceptors.d.ts +52 -3
  95. package/interceptors.js +1 -2
  96. package/invoke-fetch-types.d.ts +1 -1
  97. package/items.d.ts +536 -3
  98. package/items.js +2 -3
  99. package/knowledgebases.d.ts +976 -3
  100. package/knowledgebases.js +2 -3
  101. package/licenses.d.ts +663 -3
  102. package/licenses.js +2 -3
  103. package/lineage-graphs.d.ts +704 -3
  104. package/lineage-graphs.js +2 -3
  105. package/ml.d.ts +2808 -3
  106. package/ml.js +2 -3
  107. package/notes.d.ts +110 -3
  108. package/notes.js +2 -3
  109. package/notifications.d.ts +98 -3
  110. package/notifications.js +2 -3
  111. package/oauth-callback.iife.js +1151 -0
  112. package/oauth-clients.d.ts +562 -3
  113. package/oauth-clients.js +2 -3
  114. package/oauth-tokens.d.ts +126 -3
  115. package/oauth-tokens.js +2 -3
  116. package/package.json +6 -4
  117. package/qix.d.ts +3 -3
  118. package/qix.js +38 -3
  119. package/questions.d.ts +364 -3
  120. package/questions.js +2 -3
  121. package/quotas.d.ts +112 -3
  122. package/quotas.js +2 -3
  123. package/reload-tasks.d.ts +249 -3
  124. package/reload-tasks.js +2 -3
  125. package/reloads.d.ts +260 -3
  126. package/reloads.js +2 -3
  127. package/report-templates.d.ts +287 -3
  128. package/report-templates.js +2 -3
  129. package/reports.d.ts +863 -3
  130. package/reports.js +2 -3
  131. package/roles.d.ts +312 -3
  132. package/roles.js +2 -3
  133. package/sharing-tasks.d.ts +1164 -3
  134. package/sharing-tasks.js +2 -3
  135. package/spaces.d.ts +779 -3
  136. package/spaces.js +2 -3
  137. package/tasks.d.ts +564 -3
  138. package/tasks.js +2 -3
  139. package/temp-contents.d.ts +167 -3
  140. package/temp-contents.js +2 -3
  141. package/tenants.d.ts +360 -3
  142. package/tenants.js +2 -3
  143. package/themes.d.ts +270 -3
  144. package/themes.js +2 -3
  145. package/transports.d.ts +435 -4
  146. package/transports.js +20 -5
  147. package/ui-config.d.ts +274 -3
  148. package/ui-config.js +2 -3
  149. package/users.d.ts +674 -3
  150. package/users.js +2 -3
  151. package/web-integrations.d.ts +294 -3
  152. package/web-integrations.js +2 -3
  153. package/web-notifications.d.ts +273 -3
  154. package/web-notifications.js +2 -3
  155. package/webhooks.d.ts +505 -3
  156. package/webhooks.js +2 -3
  157. package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
  158. package/chunks/apps-BwpXUGDb.d.ts +0 -2673
  159. package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
  160. package/chunks/audits-DakwzT97.d.ts +0 -316
  161. package/chunks/auth-6mptVm5Q.d.ts +0 -95
  162. package/chunks/auth-D11iO7ZV.js +0 -65
  163. package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
  164. package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
  165. package/chunks/automations-BGy83EBO.d.ts +0 -797
  166. package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
  167. package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
  168. package/chunks/banners-CgBRnZGv.d.ts +0 -184
  169. package/chunks/brands-DCgk6Gqx.d.ts +0 -671
  170. package/chunks/collections-BpYjcpIY.d.ts +0 -582
  171. package/chunks/conditions-CJJG7Uph.d.ts +0 -662
  172. package/chunks/consumption-DerFk437.d.ts +0 -182
  173. package/chunks/core-DQXNZdnf.d.ts +0 -12
  174. package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
  175. package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
  176. package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
  177. package/chunks/data-assets-CJDcssoX.d.ts +0 -207
  178. package/chunks/data-connections-VSB13K6g.d.ts +0 -678
  179. package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
  180. package/chunks/data-files-CVzn9M6V.d.ts +0 -860
  181. package/chunks/data-qualities-DBrot957.d.ts +0 -176
  182. package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
  183. package/chunks/data-sources-IsAaof_C.d.ts +0 -346
  184. package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
  185. package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
  186. package/chunks/di-projects-DVQTxASr.d.ts +0 -777
  187. package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
  188. package/chunks/encryption-BjA6xbCO.d.ts +0 -372
  189. package/chunks/extensions-OO0WtInj.d.ts +0 -294
  190. package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
  191. package/chunks/groups-C86-UG7S.d.ts +0 -511
  192. package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
  193. package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
  194. package/chunks/interceptors-DTYm37AU.js +0 -104
  195. package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
  196. package/chunks/ip-policies-DXlf172B.js +0 -108
  197. package/chunks/items-C-jzqvFW.d.ts +0 -536
  198. package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
  199. package/chunks/licenses-xzjnkitW.d.ts +0 -663
  200. package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
  201. package/chunks/ml-Abt2MUva.d.ts +0 -2809
  202. package/chunks/notes-BZxuyDgt.d.ts +0 -111
  203. package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
  204. package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
  205. package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
  206. package/chunks/qix-CYQsLyGQ.js +0 -40
  207. package/chunks/questions-BVp0tvNs.d.ts +0 -364
  208. package/chunks/quotas-CfAebRJd.d.ts +0 -113
  209. package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
  210. package/chunks/reloads-CwmagnFx.d.ts +0 -260
  211. package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
  212. package/chunks/reports-DzNC6Uq3.d.ts +0 -861
  213. package/chunks/roles-BYFIY6E7.d.ts +0 -312
  214. package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
  215. package/chunks/spaces-BK823t-b.d.ts +0 -780
  216. package/chunks/tasks-COKDfShO.d.ts +0 -564
  217. package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
  218. package/chunks/tenants-Bhn86519.d.ts +0 -361
  219. package/chunks/themes-v9NbhiBo.d.ts +0 -269
  220. package/chunks/transports-CqEiFxD3.d.ts +0 -362
  221. package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
  222. package/chunks/users-BSOBU_fg.d.ts +0 -675
  223. package/chunks/web-integrations-MisPAHod.d.ts +0 -295
  224. package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
  225. package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
  226. /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
  227. /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
  228. /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
  229. /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
  230. /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
  231. /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
@@ -1,1164 +0,0 @@
1
- import { S as DownloadableBlob, y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
2
-
3
- //#region src/public/rest/sharing-tasks.d.ts
4
- type APISettingsUpload = {
5
- /** Whether API endpoints for sharing are enabled */
6
- "enable-sharing": boolean;
7
- /** Maximum number of recipients when creating a sharing task */
8
- readonly maxRecipients?: number;
9
- };
10
- type AlertingTaskGroupRecipientError = {
11
- /** Timestamp for the creation of the error */
12
- added?: string;
13
- /** Identifier for type of error occurring on alerting task */
14
- value?: "GROUP_IS_DISABLED" | "MAX_ALERTS_LIMIT_REACHED" | "GROUP_WITH_NO_APP_ACCESS" | "GROUP_IS_DELETED";
15
- };
16
- type AlertingTaskRecipientError = {
17
- /** Timestamp for the creation of the error */
18
- added?: string;
19
- /** Identifier for type of error occurring on alerting task */
20
- value?: "USER_IS_DELETED" | "USER_DISABLED_IN_QCS" | "NO_ACCESS_TO_APP" | "UNSUBSCRIBED_FROM_ALERT" | "CONDITION_EVAL_ERROR" | "USER_DISABLED_IN_ALERT_BY_OWNER" | "MAX_ALERTS_LIMIT_REACHED";
21
- };
22
- /**
23
- * If the template type is not "chart", this can be null. Otherwise, the following properties are required: appId, sheetId, objectId, widthPx, heightPx, language. The following properties are optional: outZoom, outDpi
24
- */
25
- type ChartTemplate = {
26
- /** ID of app */
27
- appId?: string;
28
- /** heightPx of chart */
29
- heightPx?: number;
30
- /** Visualization state from client as a string json value. Can include language, theme, viewState etc. */
31
- jsOpts?: unknown;
32
- /** Session chart object definition */
33
- objectDef?: unknown;
34
- /** ID of object */
35
- objectId?: string;
36
- /** outDpi of chart */
37
- outDpi?: number;
38
- /** outZoom of chart */
39
- outZoom?: number;
40
- /** Soft property changes on chart */
41
- patches?: unknown[];
42
- /** Flag to configure the persistent bookmark to use variables. */
43
- persistentBookmarkIncludeVariables?: boolean;
44
- /** sheetId of app */
45
- sheetId?: string;
46
- /** widthPx of chart */
47
- widthPx?: number;
48
- };
49
- /**
50
- * A bookmark is considered old if its modification date is older than the app creation date.
51
- */
52
- type CleanupStrategy = "noCleanup" | "removeOldBookmarks";
53
- /**
54
- * recipient object model that is directly persisted in the DB
55
- */
56
- type EmailAddressRecipientPersist = {
57
- /** Whether this recipient can receive alerts. */
58
- enabled?: boolean;
59
- taskRecipientErrors?: TaskRecipientError[];
60
- /** Email of recipient (external user). */
61
- value?: string;
62
- };
63
- type EmailComposition = {
64
- body?: string;
65
- subject?: string;
66
- };
67
- /**
68
- * Encrypted property in DB
69
- */
70
- type EncryptedProperty = {
71
- cipher?: string;
72
- value?: unknown;
73
- };
74
- type Error = {
75
- /** Error code specific to sharing service. */
76
- readonly code?: string;
77
- /** Error cause. */
78
- readonly detail?: string;
79
- meta?: ErrorMeta;
80
- /** Error title. */
81
- readonly title?: string;
82
- };
83
- type ErrorMeta = {
84
- /** HTTP error code. */
85
- readonly httpCode?: number;
86
- };
87
- /**
88
- * @example
89
- * {
90
- * errors: [
91
- * {
92
- * code: "HTTP-123",
93
- * title: "short error message"
94
- * }
95
- * ],
96
- * traceId: "7975401f3954aa47"
97
- * }
98
- */
99
- type Errors = {
100
- errors?: Error[];
101
- traceId?: string;
102
- };
103
- /**
104
- * recipient object model that is directly persisted in the DB
105
- */
106
- type GroupIDRecipientPersist = {
107
- alertingTaskGroupRecipientErrors?: AlertingTaskGroupRecipientError[];
108
- /** Whether this recipient can receive alerts, set by external settings. */
109
- enabledBySystem?: boolean;
110
- /** Whether this recipient can receive alerts, set by api calls. */
111
- enabledByUser?: boolean;
112
- taskGroupRecipientErrors?: TaskGroupRecipientError[];
113
- /** Group ID of recipient. */
114
- value?: string;
115
- };
116
- /**
117
- * In case of multiple insight urls for multi-sheet sharing (or subsequent multi types) this defines those URLs and a mapping to the correct object.
118
- */
119
- type InsightURL = {
120
- directURL?: string;
121
- fallbackURL?: string;
122
- insightID?: string;
123
- /** an identifier for the object within the template that this insight link points to */
124
- resourceID?: string;
125
- /** the status of the creation for this insight URL */
126
- status?: "successful" | "failed";
127
- /** @deprecated
128
- * an identifier for the template that this insight link points to */
129
- templateID?: string;
130
- };
131
- type Links = {
132
- /** Object with Href to a particular element or set of elements */
133
- self?: Self;
134
- };
135
- type ListLinks = {
136
- next?: Page;
137
- prev?: Page;
138
- /** Object with Href to a particular element or set of elements */
139
- self?: Self;
140
- };
141
- type MultiSheetTemplate = {
142
- /** ID of app */
143
- appId?: string;
144
- /** heightPx of chart, must be 0 or omitted for autofit. */
145
- heightPx?: number;
146
- /** optional value to indicate that this sheet is private */
147
- isPrivate?: boolean;
148
- /** Sheet state from client as a string json value. Can include language, theme, viewState etc. */
149
- jsOpts?: unknown;
150
- jsOptsById?: Record<string, unknown>;
151
- patchesById?: Record<string, unknown[]>;
152
- /** Flag to configure the persistent bookmark to use variables */
153
- persistentBookmarkIncludeVariables?: boolean;
154
- /** Currently only autofit is supported.
155
- * If omitted, autofit is the default.
156
- * The type of resize to be performed:
157
- * - none is used to export a visualization, sheet as is (e.g. normal size), regardless its size. This may result in cropping.
158
- * - autofit automatically fits the visualization, sheet into the output size (i.e. A4, A3 etc.). Any provided resizeData parameter will be ignored for this configuration.
159
- * - fit fits the visualization, sheet into the area specified in resizeData. The content will be rescaled to fit in that area. */
160
- resizeType?: "none" | "fit" | "autofit";
161
- /** ID of sheet */
162
- sheetId?: string;
163
- /** an optional name for the sheet */
164
- sheetName?: string;
165
- /** widthPx of chart, must be 0 or omitted for autofit. */
166
- widthPx?: number;
167
- };
168
- type Page = {
169
- /** URL to particular set of elements */
170
- href?: string;
171
- /** Page unique token */
172
- token?: string;
173
- /** Page type, can be next or prev */
174
- type?: "prev" | "next";
175
- };
176
- /**
177
- * List of persisted recipients.
178
- */
179
- type RecipientsPersist = {
180
- DLGroups?: unknown[];
181
- DLUsers?: unknown[];
182
- emailAddresses?: EmailAddressRecipientPersist[];
183
- groupIds?: GroupIDRecipientPersist[];
184
- /** Net count of recipients in DLGroups and DLUsers. */
185
- netRecipientCount?: number;
186
- userIds?: UserIDRecipientPersist[];
187
- };
188
- type RetentionPolicy = {
189
- /** Number indicating the size of the window which stores the history. For Chart monitoring, the size should be 10. */
190
- historySize?: number;
191
- /** Using RFC-5545 provide the time interval in which the previous generated can be overridden with the newly generated report. For Chart monitoring, interval should be FREQ=DAILY;INTERVAL=1 */
192
- overrideInterval?: string;
193
- };
194
- type ScheduleOptions = {
195
- /** The chronos job identifier. It is set once the related chronos job is created. */
196
- readonly chronosJobID?: string;
197
- /** EndDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. EndDateTime is an optional parameter, when not set or when it's an empty string, the recurrence is intended to be never ending. */
198
- endDateTime?: string;
199
- /** lastExecutionTime is the time of the chronos job last execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if job has not run yet. */
200
- readonly lastExecutionTime?: string;
201
- /** nextExecutionTime is the time of the chronos job next execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if the job is completed. */
202
- readonly nextExecutionTime?: string;
203
- /** List of RRULEs for SCHEDULED triggers, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. It is mandatory if the trigger type is SCHEDULED. At least 1 rule must be set and maximum 5 rules are allowed. */
204
- recurrence?: string[];
205
- /** StartDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. StartDateTime should not be older than 1 year from current date. StartDateTime is an optional parameter, when not set or when it's an empty string, its value is set to the current local date time. */
206
- startDateTime?: string;
207
- /** The timezone for time calculations in SCHEDULED triggers, optional. */
208
- timezone?: string;
209
- };
210
- type Selection = {
211
- displayName?: string;
212
- displayValues?: string[];
213
- isNumeric: boolean;
214
- name: string;
215
- stateName: string;
216
- values: string[];
217
- };
218
- /**
219
- * Object with Href to a particular element or set of elements
220
- */
221
- type Self = {
222
- href?: string;
223
- };
224
- type SharingActionsTriggerCreateRequest = {
225
- sharingTaskID: string;
226
- };
227
- type SharingExecutionError = {
228
- /** Error code specific to sharing service. */
229
- readonly code?: string;
230
- /** Error cause. */
231
- readonly detail?: string;
232
- /** Error title. */
233
- readonly title?: string;
234
- };
235
- type SharingExecutionErrors = SharingExecutionError[];
236
- type SharingExecutionFile = {
237
- fileAlias?: string;
238
- fileID?: string;
239
- tempContentsLocation?: string;
240
- /** identify the source task template */
241
- readonly templateId?: string;
242
- type?: "image" | "pdf" | "pptx" | "xlsx" | "html" | "docx";
243
- /** userId associated with the file */
244
- readonly userId?: string;
245
- };
246
- type SharingExecutionListResponse = StandardListResponseProps & {
247
- /** Gets a list of sharing-executions. */
248
- executions?: SharingExecutionResponse[];
249
- links?: ListLinks;
250
- };
251
- type SharingExecutionPersist = {
252
- /** appId associated to sharing task execution */
253
- readonly appId?: string;
254
- /** @deprecated
255
- * The ID of a filter in a reporting request */
256
- readonly bookmarkId?: string;
257
- readonly bookmarkIds?: string[];
258
- /** Total count of cancelled reports in this execution */
259
- readonly cancelledCount?: number;
260
- /** Timestamp of execution cancel */
261
- readonly cancelledTime?: string;
262
- /** Timestamp of execution successful stop */
263
- readonly endTime?: string;
264
- errors?: SharingExecutionErrors;
265
- /** eventID of the trigger NATS event */
266
- readonly eventID?: string;
267
- /** eventTime of the trigger NATS event */
268
- readonly eventTime?: string;
269
- /** Total count of failed reports in this execution */
270
- readonly failedCount?: number;
271
- /** Timestamp of execution stop */
272
- readonly failedTime?: string;
273
- /** Total count of failed uploaded reports in this execution */
274
- readonly failedUploadCount?: number;
275
- readonly files?: SharingExecutionFile[];
276
- /** Gets the execution identifier. */
277
- readonly id?: string;
278
- /** Owner of the execution */
279
- readonly ownerId?: string;
280
- /** If this execution was triggered by an app reload. This will contain the reloadId from reloads service. Otherwise it is empty or omitted. */
281
- readonly reloadId?: string;
282
- /** If this execution was triggered by an app reload. This will contain the reload time to compare with reporting service when the report is requested. */
283
- readonly reloadTime?: string;
284
- /** ID for the sharing task that this execution references */
285
- readonly sharingTaskID?: string;
286
- /** Timestamp of execution start */
287
- readonly startTime?: string;
288
- /** Status of the task execution */
289
- readonly status?: "initialized" | "in-progress" | "successful" | "failed" | "cancelled" | "invalid" | "presuccessful" | "cancelling";
290
- /** Total count of successfully generated reports in this execution */
291
- readonly successCount?: number;
292
- /** Total count of successfully uploaded reports in this execution */
293
- readonly successUploadCount?: number;
294
- /** User that this execution is targeting as a recipient */
295
- targetUser?: TargetUser;
296
- /** The tenant that this execution belongs to */
297
- readonly tenantId?: string;
298
- /** Total count of reports in this execution */
299
- readonly totalCount?: number;
300
- /** Total count of reports to be uploaded in this execution */
301
- readonly totalUploadCount?: number;
302
- /** Workflow that the execution belongs to. Note that in a multi-recipient context we can have multiple executions (one per recipient) that share the same unique workflow. */
303
- readonly workflowID?: string;
304
- };
305
- type SharingExecutionResponse = SharingExecutionPersist & {
306
- fileLocations?: string[];
307
- links?: Links;
308
- };
309
- type SharingSettings = {
310
- /** true if report-subscription feature is enabled for this tenant */
311
- "enable-report-subscription": boolean;
312
- /** true if reporting-template-subscription feature is enabled for this tenant */
313
- "enable-reporting-template-subscription": boolean;
314
- /** Whether API endpoints for sharing are enabled */
315
- "enable-sharing": boolean;
316
- /** Maximum number of recipients when creating a sharing task */
317
- readonly maxRecipients?: number;
318
- /** Max Recipients accepted when creating a new subscription (excluding the owner) */
319
- readonly maxSubscriptionRecipients?: number;
320
- /** This indicates that there is an ongoing operation to either disable or enable the report subscription feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature */
321
- readonly reportSubscriptionStatus?: "none" | "enabling" | "disabling";
322
- /** UTC timestamp of the most recent change of reportSubscriptionStatus. If there has not been any such change, this is the timestamp of the initial creation of the record. */
323
- readonly reportSubscriptionStatusChangeTime?: string;
324
- /** Whether the license for the tenant has the reportingService feature enabled. */
325
- "reporting-service-license-status"?: "enabled" | "disabled";
326
- /** This indicates that there is an ongoing operation to either disable or enable the reporting template subscription feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature */
327
- readonly reportingTemplateSubscriptionStatus?: "none" | "enabling" | "disabling";
328
- /** UTC timestamp of the most recent change of reportSubscriptionStatus. If there has not been any such change, this is the timestamp of the initial creation of the record. */
329
- readonly reportingTemplateSubscriptionStatusChangeTime?: string;
330
- /** These persisted sharing settings are only available for this tenant. Extracted from request JWT. */
331
- readonly tenantId?: string;
332
- };
333
- type SharingSettingsPatchCompliant = {
334
- /** The operation to be performed. */
335
- op: "replace";
336
- /** The path for the given resource field to patch. */
337
- path: "/enable-sharing" | "/enable-report-subscription" | "/enable-reporting-template-subscription";
338
- /** The value to be used for this operation. */
339
- value?: unknown;
340
- };
341
- /**
342
- * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
343
- * @example
344
- * [
345
- * {
346
- * op: "replace",
347
- * path: "/enable-sharing",
348
- * value: true
349
- * },
350
- * {
351
- * op: "replace",
352
- * path: "/enable-sharing",
353
- * value: false
354
- * },
355
- * {
356
- * op: "replace",
357
- * path: "/enable-report-subscription",
358
- * value: true
359
- * },
360
- * {
361
- * op: "replace",
362
- * path: "/enable-report-subscription",
363
- * value: false
364
- * },
365
- * {
366
- * op: "replace",
367
- * path: "/enable-reporting-template-subscription",
368
- * value: true
369
- * },
370
- * {
371
- * op: "replace",
372
- * path: "/enable-reporting-template-subscription",
373
- * value: false
374
- * }
375
- * ]
376
- */
377
- type SharingSettingsPatchCompliantList = SharingSettingsPatchCompliant[];
378
- /**
379
- * @example
380
- * [
381
- * {
382
- * op: "replace",
383
- * path: "/name"
384
- * },
385
- * {
386
- * op: "replace",
387
- * path: "/tags",
388
- * value: [
389
- * "tag1",
390
- * "tag2"
391
- * ]
392
- * },
393
- * {
394
- * op: "replace",
395
- * path: "/tags"
396
- * },
397
- * {
398
- * op: "replace",
399
- * path: "/tags"
400
- * },
401
- * {
402
- * op: "replace",
403
- * path: "/ownerId"
404
- * },
405
- * {
406
- * op: "replace",
407
- * path: "/enabled",
408
- * value: true
409
- * },
410
- * {
411
- * op: "replace",
412
- * path: "/description"
413
- * }
414
- * ]
415
- */
416
- type SharingTaskPatchRequestCompliantList = SharingTaskRecurringPatchRequestCompliant[];
417
- type SharingTaskRecurringCreateRequest = {
418
- /** @deprecated
419
- * Name of the app associated (through the templates) with this sharing task */
420
- appName?: string;
421
- /** A bookmark is considered old if its modification date is older than the app creation date. */
422
- cleanupStrategy?: CleanupStrategy;
423
- /** the id of the data connection */
424
- dataConnectionID?: string;
425
- /** Description of the sharing task */
426
- description?: string;
427
- /** the id of the distribution list associated to the app */
428
- distributionListId?: string;
429
- emailContent?: EmailComposition;
430
- /** Toggle for enabling sharing task. */
431
- enabled?: boolean;
432
- /** making this true will execute the sharing task upon creation regardless of next trigger */
433
- executeOnCreation?: boolean;
434
- /** Timestamp for the termination of the task */
435
- expiration?: string;
436
- /** Message along with sharing task */
437
- message?: string;
438
- /** Name of this sharing task */
439
- name: string;
440
- /** List of recipients. An internal recipient is represented by their user id. */
441
- recipients?: SharingTaskRecurringRecipients;
442
- retentionPolicy?: RetentionPolicy;
443
- scheduleOptions?: ScheduleOptions;
444
- /** the SharePoint folder to upload the report to */
445
- sharePointFolder?: string;
446
- /** Space ID of the sharing task */
447
- spaceId?: string;
448
- /** Time to start capturing the history */
449
- startTime?: string;
450
- /** State of the selections and jsOpts */
451
- state: State;
452
- /** @deprecated
453
- * the sharing task resource mashup sub type. */
454
- subType?: "pdf" | "pptx" | "xlsx" | "html" | "docx";
455
- /** used to assign sharing task to a collection bucket (tags) */
456
- tags?: string[];
457
- templates: TemplateResult[];
458
- /** the transport type for the report */
459
- transportChannels?: ("email" | "sharepoint")[];
460
- trigger?: Trigger;
461
- /** the sharing task resource type. */
462
- type: "chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing";
463
- };
464
- type SharingTaskRecurringListResponse = StandardListResponseProps & {
465
- links?: ListLinks;
466
- /** List of recipients. An internal recipient is represented by their user id. */
467
- recipients?: SharingTaskRecurringRecipients;
468
- /** Gets a list of recurring sharing tasks. */
469
- sharingTasks?: SharingTaskRecurringResponse[];
470
- };
471
- type SharingTaskRecurringPatchRequestCompliant = {
472
- /** The operation to be performed */
473
- op: "replace" | "remove";
474
- /** A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902 */
475
- path: "/name" | "/tags" | "/ownerId" | "/enabled" | "/description" | "/scheduleOptions" | "/templates" | "/recipients" | "/recipient" | "/sharePointFolder" | "/dataConnectionID" | "/transportChannels" | "/bookmarkId";
476
- /** The value to be used for this operation. */
477
- value?: unknown;
478
- };
479
- /**
480
- * Type of object stored in the database. Required fields mean that property cannot be null
481
- */
482
- type SharingTaskRecurringPersist = {
483
- /** ID of the app associated (through the templates) with this sharing task */
484
- appId?: string;
485
- /** Name of the app associated (through the templates) with this sharing task */
486
- appName?: string;
487
- /** internal identifier used when migrating keys */
488
- byokMigrationId?: string;
489
- /** ID of creator */
490
- createdBy?: string;
491
- /** the id of the data connection */
492
- dataConnectionID?: string;
493
- /** Timestamp for the creation of the task */
494
- dateCreated?: string;
495
- /** A description of this sharing task */
496
- description?: string;
497
- /** the id of the distribution list associated to the app */
498
- distributionListId?: string;
499
- emailContent?: EmailComposition;
500
- /** Toggle for enabling sharing task (system level). Example: when task owner gets enabled/ disabled. */
501
- enabledBySystem?: boolean;
502
- /** Toggle for enabling sharing task (user level). Example: user chooses to enable/ disable task. */
503
- enabledByUser?: boolean;
504
- /** the subject and body content for the email to send on report subscriptions */
505
- encryptedEmailContent?: SharingTaskRecurringPersistEncryptedEmailContent;
506
- /** Encrypted property in DB */
507
- encryptedState?: EncryptedProperty;
508
- /** Encrypted property in DB */
509
- encryptedTemplates?: EncryptedProperty;
510
- /** making this true will execute the sharing task upon creation regardless of next trigger */
511
- executeOnCreation?: boolean;
512
- /** Time for the termination of the task */
513
- expiration?: string;
514
- /** the number of consecutive failed executions for all recipeints. This is reset on a successful execution for at least one recipient */
515
- failedExecutionsCount?: number;
516
- /** the number of failed verifications. This is reset on a successful verification */
517
- failedVerificationsCount?: number;
518
- /** true if the associated app has section access enabled */
519
- hasSectionAccess?: boolean;
520
- /** Gets the sharing task resource identifier. */
521
- id?: string;
522
- /** The direct insights URL for the first template of this sharing task. (currently not used in multi-sheet scenarios) */
523
- insightDirectURL?: string;
524
- /** The insights fallback URL for the first template of this sharing task. (currently not used in multi-sheet scenarios) */
525
- insightFallbackURL?: string;
526
- /** The identifier for the insight URLs in this sharing task. Needed to remove the permanent insight upon task deletion. (currently not used in multi-sheet scenarios) */
527
- insightID?: string;
528
- /** true if the sharing task is a candidate for verification */
529
- isCandidateForVerification?: boolean;
530
- /** The last execution end date time timestamp of the task */
531
- readonly lastExecutionDate?: string;
532
- /** The last execution start date time timestamp of the task */
533
- lastRun?: string;
534
- /** Timestamp of the most recent update. */
535
- lastUpdated?: string;
536
- /** Timestamp of the most recent view by the user. */
537
- lastViewed?: string;
538
- /** Message along with sharing task */
539
- message?: string;
540
- /** Contains one or more insight links. Currently only used in multi sheet scenarios. Sharing will ensure that the persisted sort order is aligned to the order of sheets provided. */
541
- multiInsightURLs?: InsightURL[];
542
- /** Name of this sharing task */
543
- name?: string;
544
- /** Time for the next scheduled run */
545
- nextScheduledRun?: string;
546
- /** User id of owner of the sharing task */
547
- owner?: string;
548
- /** User name of owner of the sharing task */
549
- ownerName?: string;
550
- /** @deprecated
551
- * Flag to configure the persistent bookmark to use variables. it is valid for subscriptions with type chart-sharing or sheet-sharing. Deprecated: please use the same field defined in the template instead. */
552
- persistentBookmarkIncludeVariables?: boolean;
553
- /** List of persisted recipients. */
554
- recipients?: RecipientsPersist;
555
- reportProperties?: unknown;
556
- retentionPolicy?: RetentionPolicy;
557
- scheduleOptions?: ScheduleOptions;
558
- /** reporting service returns rendering errors for missing selections */
559
- selectionErrors?: unknown;
560
- /** the SharePoint folder to upload the report to */
561
- sharePointFolder?: string;
562
- /** spaceId of the app associated to this task definition */
563
- spaceId?: string;
564
- /** Time to start capturing the history */
565
- startTime?: string;
566
- /** State of the selections and jsOpts */
567
- state?: State;
568
- /** the status of this recurring sharing task */
569
- readonly statusCode?: "CHART_NOT_FOUND" | "APP_NOT_FOUND" | "STORY_NOT_FOUND" | "SHEET_NOT_FOUND" | "ENGINE_POD_NOT_AVAILABLE" | "APP_FORBIDDEN" | "CHART_TYPE_NOT_ALLOWED" | "FAILED" | "DELETING" | "IN_PROGRESS" | "VALID" | "MAX_FAILURES_REACHED" | "BOOKMARK_NOT_FOUND" | "CANCELLING" | "CANCELLED" | "REPORTING_CONSUMPTION_EXCEEDED" | "REPORTING_CAPABILITY_NOT_FOUND";
570
- /** error message indicating the underlying failure */
571
- readonly statusLabel?: string;
572
- /** @deprecated
573
- * Mashup subType of sharing task */
574
- readonly subType?: "pdf" | "pptx" | "xlsx" | "html" | "docx";
575
- tags?: string[];
576
- taskErrors?: TaskError[];
577
- /** @deprecated
578
- * ID of unique template */
579
- readonly templateId?: string;
580
- templates?: TemplateResult[];
581
- /** Tenant of the sharing task */
582
- tenant?: string;
583
- thumbnail?: string;
584
- /** the transport type for the report */
585
- transportChannels?: ("email" | "sharepoint")[];
586
- trigger?: Trigger;
587
- /** The sharing task resource type */
588
- type?: "chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing";
589
- /** ID of a user that updated this task last */
590
- updatedBy?: string;
591
- };
592
- /**
593
- * the subject and body content for the email to send on report subscriptions
594
- */
595
- type SharingTaskRecurringPersistEncryptedEmailContent = {
596
- /** Encrypted property in DB */
597
- body?: EncryptedProperty;
598
- /** Encrypted property in DB */
599
- subject?: EncryptedProperty;
600
- };
601
- /**
602
- * List of recipients. An internal recipient is represented by their user id.
603
- */
604
- type SharingTaskRecurringRecipients = {
605
- DLGroups?: unknown[];
606
- DLUsers?: unknown[];
607
- emailAddresses?: string[];
608
- userIds?: UserIDRecipient[];
609
- };
610
- /**
611
- * Whatever is persisted in the db + links
612
- */
613
- type SharingTaskRecurringResponse = SharingTaskRecurringPersist & {
614
- /** true if the sharing task is enabled */
615
- enabled?: boolean;
616
- /** URL to querying the files of the latest execution tied to this sharing task */
617
- latestExecutionFilesURL?: string[];
618
- /** URL to querying the latest execution tied to this sharing task */
619
- latestExecutionURL?: string;
620
- links?: Links;
621
- };
622
- /**
623
- * @deprecated
624
- */
625
- type SheetTemplate = {
626
- /** ID of app */
627
- appId?: string;
628
- /** heightPx of chart */
629
- heightPx?: number;
630
- /** @deprecated
631
- * optional value to indicate that this sheet is private (used in multi-sheet sharing) */
632
- isPrivate?: boolean;
633
- /** Sheet state from client as a string json value. Can include language, theme, viewState etc. */
634
- jsOpts?: unknown;
635
- jsOptsById?: Record<string, unknown>;
636
- patchesById?: Record<string, unknown[]>;
637
- /** ID of sheet */
638
- sheetId?: string;
639
- /** @deprecated
640
- * an optional name for the sheet (used in multi-sheet sharing) */
641
- sheetName?: string;
642
- /** widthPx of chart */
643
- widthPx?: number;
644
- };
645
- /**
646
- * properties that should be added to every list response
647
- */
648
- type StandardListResponseProps = {
649
- /** count of entries on the currently shown page */
650
- currentPageCount: number;
651
- /** total count of entries in the collection as a whole */
652
- totalCount: number;
653
- };
654
- /**
655
- * State of the selections and jsOpts
656
- */
657
- type State = {
658
- /** Selected fields that led to discovery of monitored Insight Advisor chart */
659
- fields?: unknown[];
660
- /** Query that led to discovery of monitored Insight Advisor chart */
661
- queryItems?: unknown[];
662
- selections?: Selection[];
663
- };
664
- type StoryTemplate = {
665
- /** ID of app */
666
- appId?: string;
667
- /** ID of story */
668
- storyId?: string;
669
- };
670
- /**
671
- * User that this execution is targeting as a recipient
672
- */
673
- type TargetUser = {
674
- /** @deprecated */
675
- filterName?: string;
676
- filterNames?: string[];
677
- /** timezone for the timestamp on the attached file name */
678
- timezone?: string;
679
- /** type of user eg email, userId, groupId */
680
- type?: string;
681
- /** contains the value of user type e.g. abc@xyz.com, 213efewr3 */
682
- value?: string;
683
- };
684
- type TaskError = {
685
- /** Timestamp for the creation of the error */
686
- timestamp?: string;
687
- /** Identifier for type of error occurring on sharing task */
688
- value?: "OWNER_DISABLED" | "OWNER_ACCESS" | "OWNER_LICENSE" | "APP_DELETED" | "NO_RECIPIENTS" | "PARTIAL_ACCESS" | "ORPHAN" | "PARTIAL_SENT" | "FATAL_SENT_ERROR" | "SECTION_ACCESS_MODIFIED" | "INVALID_DISTRIBUTION_LIST" | "MAX_DL_RECIPIENTS_LIMIT_REACHED" | "TEMPLATE_NOT_FOUND" | "REPORTING_BOOKMARK_NOT_FOUND" | "DATA_CONNECTION_NOT_FOUND" | "INVALID_SHAREPOINT_DIRECTORY" | "GENERIC_FILE_UPLOAD_ERROR" | "DISABLED_DUE_TO_OWNERSHIP_CHANGE" | "REPORTING_CONSUMPTION_EXCEEDED" | "REPORTING_CAPABILITY_NOT_FOUND" | "EXECUTION_TIME_OUT" | "OWNER_INSUFFICIENT_PERMISSIONS" | "MAX_UNIQUE_REPORTS_LIMIT_REACHED" | "MISSING_DISTRIBUTION_LIST" | "SECTION_ACCESS_NOT_SUPPORTED";
689
- };
690
- type TaskGroupRecipientError = {
691
- /** Timestamp for the creation of the error */
692
- timestamp?: string;
693
- /** Identifier for type of error occurring on sharing task specific for group recipient */
694
- value?: "GROUP_IS_DISABLED" | "MAX_ALERTS_LIMIT_REACHED" | "GROUP_WITH_NO_APP_ACCESS" | "GROUP_IS_DELETED" | "GROUP_NOT_FOUND_DL" | "GROUP_DISABLED_IN_DL";
695
- };
696
- type TaskRecipientError = {
697
- /** Timestamp for the creation of the error */
698
- timestamp?: string;
699
- /** Identifier for type of error occurring on sharing task specific for recipient */
700
- value?: "USER_IS_DELETED" | "USER_DISABLED_IN_QCS" | "NO_ACCESS_TO_APP" | "UNSUBSCRIBED_FROM_SHARING" | "USER_DISABLED_IN_SHARING_BY_OWNER" | "CHART_NOT_FOUND" | "APP_NOT_FOUND" | "SHEET_NOT_FOUND" | "ENGINE_POD_NOT_AVAILABLE" | "CHART_TYPE_NOT_ALLOWED" | "GENERIC_EXECUTION_FAILURE" | "USER_NOT_FOUND_DL" | "USER_DISABLED_IN_DL" | "FILTER_NOT_FOUND" | "BOOKMARK_NOT_FOUND";
701
- };
702
- /**
703
- * Depending on the value of type, sharing service will internally validate a specific property regarding its data. Type "file" validates property "fileData", type "chart" validates property "chartData", type "story" validates property "storyData". Check description of each of the models for their required properties.
704
- */
705
- type TemplatePersist = {
706
- /** If the template type is not "chart", this can be null. Otherwise, the following properties are required: appId, sheetId, objectId, widthPx, heightPx, language. The following properties are optional: outZoom, outDpi */
707
- chartData?: ChartTemplate;
708
- /** fileAlias provide an opaqueId for the client which can be used to filter and select the report generated */
709
- fileAlias?: string;
710
- /** fileName to be used when generating the report */
711
- fileName?: string;
712
- /** file name timestamp to be used when generating the report */
713
- fileTimeStamp?: "yyyy-MM-dd" | "yyyy-MM-dd_HH-mm" | "yyyyMMdd" | "yyyyMMdd_HH-mm";
714
- /** array of sheet data for multi-sheet type template */
715
- multiSheetData?: MultiSheetTemplate[];
716
- /** @deprecated */
717
- sheetData?: SheetTemplate;
718
- storyData?: StoryTemplate;
719
- subType?: "image" | "snapshot" | "pdf" | "pptx" | "xlsx" | "qpxp" | "qhtml" | "docx";
720
- /** @deprecated
721
- * ID of unique template */
722
- readonly templateId?: string;
723
- type: "file" | "chart" | "story" | "sheet" | "multi-sheet" | "excel" | "pixel-perfect" | "html" | "powerpoint" | "word";
724
- };
725
- type TemplateResult = TemplatePersist & unknown;
726
- type Trigger = {
727
- /** The chronosJobId which triggers the sharing task */
728
- readonly chronosJobID?: string;
729
- /** Toggle for executing sharing task on app reload. */
730
- executeOnAppReload?: boolean;
731
- /** To prevent overflow in the history, setting this to daily store the chart of a previous day in the history and maintain the live version with the tag latest. */
732
- executionHistoryInterval?: "minutely" | "hourly" | "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
733
- /** List of RRULE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; event start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. This field is omitted for single events. */
734
- recurrence: string[];
735
- };
736
- /**
737
- * an internal recipient based on its user id.
738
- */
739
- type UserIDRecipient = {
740
- alertingTaskRecipientErrors?: AlertingTaskRecipientError[];
741
- /** Whether this recipient can receive alerts. */
742
- enabled?: boolean;
743
- /** A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included */
744
- groups?: string[];
745
- /** Whether this recipient is subscribed to alerts of a task */
746
- subscribed?: boolean;
747
- taskRecipientErrors?: TaskRecipientError[];
748
- /** User ID of recipient (internal user). */
749
- value?: string;
750
- };
751
- /**
752
- * recipient object model that is directly persisted in the DB
753
- */
754
- type UserIDRecipientPersist = {
755
- alertingTaskRecipientErrors?: AlertingTaskRecipientError[];
756
- /** Whether this recipient can receive alerts, set by external settings. */
757
- enabledBySystem?: boolean;
758
- /** Whether this recipient can receive alerts, set by api calls. */
759
- enabledByUser?: boolean;
760
- /** A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included */
761
- groups?: string[];
762
- /** Whether this user is subscribed to alerts in this task */
763
- subscribed?: boolean;
764
- taskRecipientErrors?: TaskRecipientError[];
765
- /** User ID of recipient (internal user). */
766
- value?: string;
767
- };
768
- /**
769
- * Retrieves all sharing tasks accessible to the user. Users assigned the `TenantAdmin` or `AnalyticsAdmin` role can view all tasks.
770
- *
771
- * @param query an object with query parameters
772
- * @throws GetSharingTasksHttpError
773
- */
774
- declare function getSharingTasks(query: {
775
- /** the filter by sharing task resource app id. TenantAdmin users may omit this parameter to list all sharing-tasks in the tenant. */
776
- appid?: string;
777
- /** Indicates if task with the status DELETING should be excluded from the list */
778
- excludeDeleting?: boolean;
779
- /** Limit the returned result set */
780
- limit?: number;
781
- /** @deprecated
782
- * The cursor to the next page of data. Only one of next or previous may be specified. */
783
- next?: string;
784
- /** Offset for finding a list of entities - used for pagination */
785
- offset?: number;
786
- /** the filter by sharing task resource owner id. */
787
- owner?: string;
788
- /** the filter by sharing task resource owner name. */
789
- ownername?: string;
790
- /** The cursor to the page of data. */
791
- page?: string;
792
- /** @deprecated
793
- * The cursor to the previous page of data. Only one of next or previous may be specified. */
794
- prev?: string;
795
- /** the filter by sharing task resource role. */
796
- role?: ("owner" | "recipient")[];
797
- /** Sort the returned result set by the specified field */
798
- sort?: ("-datecreated" | "datecreated" | "+datecreated" | "-name" | "name" | "+name" | "-ownername" | "ownername" | "+ownername" | "-enabled" | "enabled" | "+enabled" | "-status" | "status" | "+status" | "-type" | "type" | "+type" | "-sent" | "sent" | "+sent" | "-scheduled" | "scheduled" | "+scheduled" | "-appname" | "appname" | "+appname" | "-appid" | "appid" | "+appid")[];
799
- /** array of template ids to filter by */
800
- templateId?: string[];
801
- /** the filter by sharing task resource type. If type is template-sharing only and user is not tenant admin, appid is also required. */
802
- type?: ("chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing")[];
803
- }, options?: ApiCallOptions): Promise<GetSharingTasksHttpResponse>;
804
- type GetSharingTasksHttpResponse = {
805
- data: SharingTaskRecurringListResponse;
806
- headers: Headers;
807
- status: 200;
808
- prev?: (options?: ApiCallOptions) => Promise<GetSharingTasksHttpResponse>;
809
- next?: (options?: ApiCallOptions) => Promise<GetSharingTasksHttpResponse>;
810
- };
811
- type GetSharingTasksHttpError = {
812
- data: Errors;
813
- headers: Headers;
814
- status: number;
815
- };
816
- /**
817
- * Creates a new recurring sharing task.
818
- *
819
- * @param body an object with the body content
820
- * @throws CreateSharingTaskHttpError
821
- */
822
- declare function createSharingTask(body: SharingTaskRecurringCreateRequest, options?: ApiCallOptions): Promise<CreateSharingTaskHttpResponse>;
823
- type CreateSharingTaskHttpResponse = {
824
- data: SharingTaskRecurringResponse;
825
- headers: Headers;
826
- status: 201;
827
- };
828
- type CreateSharingTaskHttpError = {
829
- data: Errors;
830
- headers: Headers;
831
- status: number;
832
- };
833
- /**
834
- * Requests execution of the specified recurring sharing task.
835
- *
836
- * @param body an object with the body content
837
- * @throws ExecuteSharingTasksHttpError
838
- */
839
- declare function executeSharingTasks(body: SharingActionsTriggerCreateRequest, options?: ApiCallOptions): Promise<ExecuteSharingTasksHttpResponse>;
840
- type ExecuteSharingTasksHttpResponse = {
841
- data: void;
842
- headers: Headers;
843
- status: 204;
844
- };
845
- type ExecuteSharingTasksHttpError = {
846
- data: Errors;
847
- headers: Headers;
848
- status: number;
849
- };
850
- /**
851
- * Retrieves the current settings for sharing tasks, reports, and other related configuration.
852
- *
853
- * @throws GetSharingTasksSettingsHttpError
854
- */
855
- declare function getSharingTasksSettings(options?: ApiCallOptions): Promise<GetSharingTasksSettingsHttpResponse>;
856
- type GetSharingTasksSettingsHttpResponse = {
857
- data: SharingSettings;
858
- headers: Headers;
859
- status: 200;
860
- };
861
- type GetSharingTasksSettingsHttpError = {
862
- data: Errors;
863
- headers: Headers;
864
- status: number;
865
- };
866
- /**
867
- * Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the `TenantAdmin` role.
868
- *
869
- * @param body an object with the body content
870
- * @throws UpdateSharingTasksSettingsHttpError
871
- */
872
- declare function updateSharingTasksSettings(body: SharingSettingsPatchCompliantList, options?: ApiCallOptions): Promise<UpdateSharingTasksSettingsHttpResponse>;
873
- type UpdateSharingTasksSettingsHttpResponse = {
874
- data: void;
875
- headers: Headers;
876
- status: 204;
877
- };
878
- type UpdateSharingTasksSettingsHttpError = {
879
- data: Errors;
880
- headers: Headers;
881
- status: number;
882
- };
883
- /**
884
- * Updates the settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the `TenantAdmin` role.
885
- *
886
- * @param body an object with the body content
887
- * @throws ConfigureSharingTasksSettingsHttpError
888
- */
889
- declare function configureSharingTasksSettings(body: APISettingsUpload, options?: ApiCallOptions): Promise<ConfigureSharingTasksSettingsHttpResponse>;
890
- type ConfigureSharingTasksSettingsHttpResponse = {
891
- data: void;
892
- headers: Headers;
893
- status: 204;
894
- };
895
- type ConfigureSharingTasksSettingsHttpError = {
896
- data: Errors;
897
- headers: Headers;
898
- status: number;
899
- };
900
- /**
901
- * Deletes a specific sharing task.
902
- *
903
- * @param taskId The sharing task identifier.
904
- * @throws DeleteSharingTaskHttpError
905
- */
906
- declare function deleteSharingTask(taskId: string, options?: ApiCallOptions): Promise<DeleteSharingTaskHttpResponse>;
907
- type DeleteSharingTaskHttpResponse = {
908
- data: void;
909
- headers: Headers;
910
- status: 204;
911
- };
912
- type DeleteSharingTaskHttpError = {
913
- data: Errors;
914
- headers: Headers;
915
- status: number;
916
- };
917
- /**
918
- * Returns the details of a specific sharing task.
919
- *
920
- * @param taskId The sharing task identifier.
921
- * @param query an object with query parameters
922
- * @throws GetSharingTaskHttpError
923
- */
924
- declare function getSharingTask(taskId: string, query: {
925
- /** Determines whether to update the `lastViewed` property for the sharing task, which is used to determine whether the sharing task is still in use. If set to `true`, this will be updated to current time. */
926
- isViewChart?: boolean;
927
- }, options?: ApiCallOptions): Promise<GetSharingTaskHttpResponse>;
928
- type GetSharingTaskHttpResponse = {
929
- data: SharingTaskRecurringResponse;
930
- headers: Headers;
931
- status: 200;
932
- };
933
- type GetSharingTaskHttpError = {
934
- data: Errors;
935
- headers: Headers;
936
- status: number;
937
- };
938
- /**
939
- * Updates one or more properties of a specific sharing task.
940
- *
941
- * @param taskId The sharing task identifier.
942
- * @param body an object with the body content
943
- * @throws PatchSharingTaskHttpError
944
- */
945
- declare function patchSharingTask(taskId: string, body: SharingTaskPatchRequestCompliantList, options?: ApiCallOptions): Promise<PatchSharingTaskHttpResponse>;
946
- type PatchSharingTaskHttpResponse = {
947
- data: void;
948
- headers: Headers;
949
- status: 204;
950
- };
951
- type PatchSharingTaskHttpError = {
952
- data: Errors;
953
- headers: Headers;
954
- status: number;
955
- };
956
- /**
957
- * Requests cancellation of an execution of the specified recurring sharing task.
958
- *
959
- * @param taskId The sharing task identifier.
960
- * @throws CancelSharingTaskHttpError
961
- */
962
- declare function cancelSharingTask(taskId: string, options?: ApiCallOptions): Promise<CancelSharingTaskHttpResponse>;
963
- type CancelSharingTaskHttpResponse = {
964
- data: void;
965
- headers: Headers;
966
- status: 204;
967
- };
968
- type CancelSharingTaskHttpError = {
969
- data: Errors;
970
- headers: Headers;
971
- status: number;
972
- };
973
- /**
974
- * Lists executions for the specified sharing task.
975
- *
976
- * @param taskId The sharing task identifier.
977
- * @param query an object with query parameters
978
- * @throws GetSharingTaskExecutionsHttpError
979
- */
980
- declare function getSharingTaskExecutions(taskId: string, query: {
981
- /** Limit the returned result set */
982
- limit?: number;
983
- /** The cursor to the next page of data. Only one of next or previous may be specified. */
984
- next?: string;
985
- /** Offset for pagination - how many elements to skip */
986
- offset?: number;
987
- /** The cursor to the previous page of data. Only one of next or previous may be specified. */
988
- prev?: string;
989
- /** Sort the returned result set by the specified field */
990
- sort?: ("starttime" | "-starttime" | "+starttime")[];
991
- /** Specifies a filter for a particular field and value of an execution */
992
- status?: "successful" | "failed";
993
- }, options?: ApiCallOptions): Promise<GetSharingTaskExecutionsHttpResponse>;
994
- type GetSharingTaskExecutionsHttpResponse = {
995
- data: SharingExecutionListResponse;
996
- headers: Headers;
997
- status: 200;
998
- prev?: (options?: ApiCallOptions) => Promise<GetSharingTaskExecutionsHttpResponse>;
999
- next?: (options?: ApiCallOptions) => Promise<GetSharingTaskExecutionsHttpResponse>;
1000
- };
1001
- type GetSharingTaskExecutionsHttpError = {
1002
- data: Errors;
1003
- headers: Headers;
1004
- status: number;
1005
- };
1006
- /**
1007
- * Retrieves a specific sharing task execution.
1008
- *
1009
- * @param taskId The sharing task identifier.
1010
- * @param executionId The execution identifier. If value is "latest", the latest execution will be returned
1011
- * @param query an object with query parameters
1012
- * @throws GetSharingTaskExecutionHttpError
1013
- */
1014
- declare function getSharingTaskExecution(taskId: string, executionId: string, query: {
1015
- /** Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution. */
1016
- status?: "successful" | "failed" | "cancelled";
1017
- }, options?: ApiCallOptions): Promise<GetSharingTaskExecutionHttpResponse>;
1018
- type GetSharingTaskExecutionHttpResponse = {
1019
- data: SharingExecutionResponse;
1020
- headers: Headers;
1021
- status: 200;
1022
- };
1023
- type GetSharingTaskExecutionHttpError = {
1024
- data: Errors;
1025
- headers: Headers;
1026
- status: number;
1027
- };
1028
- /**
1029
- * Retrieves the file content for the requested execution and file type.
1030
- *
1031
- * @param taskId The sharing task identifier.
1032
- * @param executionId The execution identifier.
1033
- * @param fileAlias The execution identifier. If value is "latest", the latest execution will be returned
1034
- * @param query an object with query parameters
1035
- * @throws GetSharingTaskExecutionFileHttpError
1036
- */
1037
- declare function getSharingTaskExecutionFile(taskId: string, executionId: string, fileAlias: string, query: {
1038
- /** Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution. */
1039
- status?: "successful" | "failed" | "cancelled";
1040
- }, options?: ApiCallOptions): Promise<GetSharingTaskExecutionFileHttpResponse>;
1041
- type GetSharingTaskExecutionFileHttpResponse = {
1042
- data: DownloadableBlob;
1043
- headers: Headers;
1044
- status: 200;
1045
- };
1046
- type GetSharingTaskExecutionFileHttpError = {
1047
- data: Errors;
1048
- headers: Headers;
1049
- status: number;
1050
- };
1051
- /**
1052
- * Clears the cache for sharing-tasks api requests.
1053
- */
1054
- declare function clearCache(): void;
1055
- type SharingTasksAPI = {
1056
- /**
1057
- * Retrieves all sharing tasks accessible to the user. Users assigned the `TenantAdmin` or `AnalyticsAdmin` role can view all tasks.
1058
- *
1059
- * @param query an object with query parameters
1060
- * @throws GetSharingTasksHttpError
1061
- */
1062
- getSharingTasks: typeof getSharingTasks;
1063
- /**
1064
- * Creates a new recurring sharing task.
1065
- *
1066
- * @param body an object with the body content
1067
- * @throws CreateSharingTaskHttpError
1068
- */
1069
- createSharingTask: typeof createSharingTask;
1070
- /**
1071
- * Requests execution of the specified recurring sharing task.
1072
- *
1073
- * @param body an object with the body content
1074
- * @throws ExecuteSharingTasksHttpError
1075
- */
1076
- executeSharingTasks: typeof executeSharingTasks;
1077
- /**
1078
- * Retrieves the current settings for sharing tasks, reports, and other related configuration.
1079
- *
1080
- * @throws GetSharingTasksSettingsHttpError
1081
- */
1082
- getSharingTasksSettings: typeof getSharingTasksSettings;
1083
- /**
1084
- * Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the `TenantAdmin` role.
1085
- *
1086
- * @param body an object with the body content
1087
- * @throws UpdateSharingTasksSettingsHttpError
1088
- */
1089
- updateSharingTasksSettings: typeof updateSharingTasksSettings;
1090
- /**
1091
- * Updates the settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the `TenantAdmin` role.
1092
- *
1093
- * @param body an object with the body content
1094
- * @throws ConfigureSharingTasksSettingsHttpError
1095
- */
1096
- configureSharingTasksSettings: typeof configureSharingTasksSettings;
1097
- /**
1098
- * Deletes a specific sharing task.
1099
- *
1100
- * @param taskId The sharing task identifier.
1101
- * @throws DeleteSharingTaskHttpError
1102
- */
1103
- deleteSharingTask: typeof deleteSharingTask;
1104
- /**
1105
- * Returns the details of a specific sharing task.
1106
- *
1107
- * @param taskId The sharing task identifier.
1108
- * @param query an object with query parameters
1109
- * @throws GetSharingTaskHttpError
1110
- */
1111
- getSharingTask: typeof getSharingTask;
1112
- /**
1113
- * Updates one or more properties of a specific sharing task.
1114
- *
1115
- * @param taskId The sharing task identifier.
1116
- * @param body an object with the body content
1117
- * @throws PatchSharingTaskHttpError
1118
- */
1119
- patchSharingTask: typeof patchSharingTask;
1120
- /**
1121
- * Requests cancellation of an execution of the specified recurring sharing task.
1122
- *
1123
- * @param taskId The sharing task identifier.
1124
- * @throws CancelSharingTaskHttpError
1125
- */
1126
- cancelSharingTask: typeof cancelSharingTask;
1127
- /**
1128
- * Lists executions for the specified sharing task.
1129
- *
1130
- * @param taskId The sharing task identifier.
1131
- * @param query an object with query parameters
1132
- * @throws GetSharingTaskExecutionsHttpError
1133
- */
1134
- getSharingTaskExecutions: typeof getSharingTaskExecutions;
1135
- /**
1136
- * Retrieves a specific sharing task execution.
1137
- *
1138
- * @param taskId The sharing task identifier.
1139
- * @param executionId The execution identifier. If value is "latest", the latest execution will be returned
1140
- * @param query an object with query parameters
1141
- * @throws GetSharingTaskExecutionHttpError
1142
- */
1143
- getSharingTaskExecution: typeof getSharingTaskExecution;
1144
- /**
1145
- * Retrieves the file content for the requested execution and file type.
1146
- *
1147
- * @param taskId The sharing task identifier.
1148
- * @param executionId The execution identifier.
1149
- * @param fileAlias The execution identifier. If value is "latest", the latest execution will be returned
1150
- * @param query an object with query parameters
1151
- * @throws GetSharingTaskExecutionFileHttpError
1152
- */
1153
- getSharingTaskExecutionFile: typeof getSharingTaskExecutionFile;
1154
- /**
1155
- * Clears the cache for sharing-tasks api requests.
1156
- */
1157
- clearCache: typeof clearCache;
1158
- };
1159
- /**
1160
- * Functions for the sharing-tasks api
1161
- */
1162
- declare const sharingTasksExport: SharingTasksAPI;
1163
- //#endregion
1164
- export { SharingExecutionResponse as $, GetSharingTasksHttpError as A, createSharingTask as At, PatchSharingTaskHttpError as B, sharingTasksExport as Bt, GetSharingTaskExecutionFileHttpResponse as C, UpdateSharingTasksSettingsHttpError as Ct, GetSharingTaskExecutionsHttpResponse as D, cancelSharingTask as Dt, GetSharingTaskExecutionsHttpError as E, UserIDRecipientPersist as Et, InsightURL as F, getSharingTaskExecutionFile as Ft, Selection as G, RecipientsPersist as H, Links as I, getSharingTaskExecutions as It, SharingExecutionError as J, Self as K, ListLinks as L, getSharingTasks as Lt, GetSharingTasksSettingsHttpError as M, executeSharingTasks as Mt, GetSharingTasksSettingsHttpResponse as N, getSharingTask as Nt, GetSharingTaskHttpError as O, clearCache as Ot, GroupIDRecipientPersist as P, getSharingTaskExecution as Pt, SharingExecutionPersist as Q, MultiSheetTemplate as R, getSharingTasksSettings as Rt, GetSharingTaskExecutionFileHttpError as S, Trigger as St, GetSharingTaskExecutionHttpResponse as T, UserIDRecipient as Tt, RetentionPolicy as U, PatchSharingTaskHttpResponse as V, updateSharingTasksSettings as Vt, ScheduleOptions as W, SharingExecutionFile as X, SharingExecutionErrors as Y, SharingExecutionListResponse as Z, Error as _, TaskError as _t, CancelSharingTaskHttpResponse as a, SharingTaskRecurringListResponse as at, ExecuteSharingTasksHttpError as b, TemplatePersist as bt, ConfigureSharingTasksSettingsHttpError as c, SharingTaskRecurringPersistEncryptedEmailContent as ct, CreateSharingTaskHttpResponse as d, SharingTasksAPI as dt, SharingSettings as et, DeleteSharingTaskHttpError as f, SheetTemplate as ft, EncryptedProperty as g, TargetUser as gt, EmailComposition as h, StoryTemplate as ht, CancelSharingTaskHttpError as i, SharingTaskRecurringCreateRequest as it, GetSharingTasksHttpResponse as j, deleteSharingTask as jt, GetSharingTaskHttpResponse as k, configureSharingTasksSettings as kt, ConfigureSharingTasksSettingsHttpResponse as l, SharingTaskRecurringRecipients as lt, EmailAddressRecipientPersist as m, State as mt, AlertingTaskGroupRecipientError as n, SharingSettingsPatchCompliantList as nt, ChartTemplate as o, SharingTaskRecurringPatchRequestCompliant as ot, DeleteSharingTaskHttpResponse as p, StandardListResponseProps as pt, SharingActionsTriggerCreateRequest as q, AlertingTaskRecipientError as r, SharingTaskPatchRequestCompliantList as rt, CleanupStrategy as s, SharingTaskRecurringPersist as st, APISettingsUpload as t, SharingSettingsPatchCompliant as tt, CreateSharingTaskHttpError as u, SharingTaskRecurringResponse as ut, ErrorMeta as v, TaskGroupRecipientError as vt, GetSharingTaskExecutionHttpError as w, UpdateSharingTasksSettingsHttpResponse as wt, ExecuteSharingTasksHttpResponse as x, TemplateResult as xt, Errors as y, TaskRecipientError as yt, Page as z, patchSharingTask as zt };