@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,50 +1,33 @@
1
- import { S as DownloadableBlob, y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
2
- import "./chunks/invoke-fetch-C1Z0RJYU.js";
1
+ import { ApiCallOptions, DownloadableBlob } from "./invoke-fetch-types.js";
2
+ import "./chunks/invoke-fetch-DFc3yzaj.js";
3
3
 
4
4
  //#region src/public/rest/sharing-tasks.d.ts
5
5
  type APISettingsUpload = {
6
- /** Whether API endpoints for sharing are enabled */
7
- "enable-sharing": boolean;
8
- /** Maximum number of recipients when creating a sharing task */
6
+ /** Whether API endpoints for sharing are enabled */"enable-sharing": boolean; /** Maximum number of recipients when creating a sharing task */
9
7
  readonly maxRecipients?: number;
10
8
  };
11
9
  type AlertingTaskGroupRecipientError = {
12
- /** Timestamp for the creation of the error */
13
- added?: string;
14
- /** Identifier for type of error occurring on alerting task */
10
+ /** Timestamp for the creation of the error */added?: string; /** Identifier for type of error occurring on alerting task */
15
11
  value?: "GROUP_IS_DISABLED" | "MAX_ALERTS_LIMIT_REACHED" | "GROUP_WITH_NO_APP_ACCESS" | "GROUP_IS_DELETED";
16
12
  };
17
13
  type AlertingTaskRecipientError = {
18
- /** Timestamp for the creation of the error */
19
- added?: string;
20
- /** Identifier for type of error occurring on alerting task */
14
+ /** Timestamp for the creation of the error */added?: string; /** Identifier for type of error occurring on alerting task */
21
15
  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";
22
16
  };
23
17
  /**
24
18
  * 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
25
19
  */
26
20
  type ChartTemplate = {
27
- /** ID of app */
28
- appId?: string;
29
- /** heightPx of chart */
30
- heightPx?: number;
31
- /** Visualization state from client as a string json value. Can include language, theme, viewState etc. */
32
- jsOpts?: unknown;
33
- /** Session chart object definition */
34
- objectDef?: unknown;
35
- /** ID of object */
36
- objectId?: string;
37
- /** outDpi of chart */
38
- outDpi?: number;
39
- /** outZoom of chart */
40
- outZoom?: number;
41
- /** Soft property changes on chart */
42
- patches?: unknown[];
43
- /** Flag to configure the persistent bookmark to use variables. */
44
- persistentBookmarkIncludeVariables?: boolean;
45
- /** sheetId of app */
46
- sheetId?: string;
47
- /** widthPx of chart */
21
+ /** ID of app */appId?: string; /** heightPx of chart */
22
+ heightPx?: number; /** Visualization state from client as a string json value. Can include language, theme, viewState etc. */
23
+ jsOpts?: unknown; /** Session chart object definition */
24
+ objectDef?: unknown; /** ID of object */
25
+ objectId?: string; /** outDpi of chart */
26
+ outDpi?: number; /** outZoom of chart */
27
+ outZoom?: number; /** Soft property changes on chart */
28
+ patches?: unknown[]; /** Flag to configure the persistent bookmark to use variables. */
29
+ persistentBookmarkIncludeVariables?: boolean; /** sheetId of app */
30
+ sheetId?: string; /** widthPx of chart */
48
31
  widthPx?: number;
49
32
  };
50
33
  /**
@@ -55,10 +38,8 @@ type CleanupStrategy = "noCleanup" | "removeOldBookmarks";
55
38
  * recipient object model that is directly persisted in the DB
56
39
  */
57
40
  type EmailAddressRecipientPersist = {
58
- /** Whether this recipient can receive alerts. */
59
- enabled?: boolean;
60
- taskRecipientErrors?: TaskRecipientError[];
61
- /** Email of recipient (external user). */
41
+ /** Whether this recipient can receive alerts. */enabled?: boolean;
42
+ taskRecipientErrors?: TaskRecipientError[]; /** Email of recipient (external user). */
62
43
  value?: string;
63
44
  };
64
45
  type EmailComposition = {
@@ -73,17 +54,13 @@ type EncryptedProperty = {
73
54
  value?: unknown;
74
55
  };
75
56
  type Error = {
76
- /** Error code specific to sharing service. */
77
- readonly code?: string;
78
- /** Error cause. */
57
+ /** Error code specific to sharing service. */readonly code?: string; /** Error cause. */
79
58
  readonly detail?: string;
80
- meta?: ErrorMeta;
81
- /** Error title. */
59
+ meta?: ErrorMeta; /** Error title. */
82
60
  readonly title?: string;
83
61
  };
84
62
  type ErrorMeta = {
85
- /** HTTP error code. */
86
- readonly httpCode?: number;
63
+ /** HTTP error code. */readonly httpCode?: number;
87
64
  };
88
65
  /**
89
66
  * @example
@@ -105,13 +82,10 @@ type Errors = {
105
82
  * recipient object model that is directly persisted in the DB
106
83
  */
107
84
  type GroupIDRecipientPersist = {
108
- alertingTaskGroupRecipientErrors?: AlertingTaskGroupRecipientError[];
109
- /** Whether this recipient can receive alerts, set by external settings. */
110
- enabledBySystem?: boolean;
111
- /** Whether this recipient can receive alerts, set by api calls. */
85
+ alertingTaskGroupRecipientErrors?: AlertingTaskGroupRecipientError[]; /** Whether this recipient can receive alerts, set by external settings. */
86
+ enabledBySystem?: boolean; /** Whether this recipient can receive alerts, set by api calls. */
112
87
  enabledByUser?: boolean;
113
- taskGroupRecipientErrors?: TaskGroupRecipientError[];
114
- /** Group ID of recipient. */
88
+ taskGroupRecipientErrors?: TaskGroupRecipientError[]; /** Group ID of recipient. */
115
89
  value?: string;
116
90
  };
117
91
  /**
@@ -120,37 +94,28 @@ type GroupIDRecipientPersist = {
120
94
  type InsightURL = {
121
95
  directURL?: string;
122
96
  fallbackURL?: string;
123
- insightID?: string;
124
- /** an identifier for the object within the template that this insight link points to */
125
- resourceID?: string;
126
- /** the status of the creation for this insight URL */
97
+ insightID?: string; /** an identifier for the object within the template that this insight link points to */
98
+ resourceID?: string; /** the status of the creation for this insight URL */
127
99
  status?: "successful" | "failed";
128
100
  /** @deprecated
129
101
  * an identifier for the template that this insight link points to */
130
102
  templateID?: string;
131
103
  };
132
104
  type Links = {
133
- /** Object with Href to a particular element or set of elements */
134
- self?: Self;
105
+ /** Object with Href to a particular element or set of elements */self?: Self;
135
106
  };
136
107
  type ListLinks = {
137
108
  next?: Page;
138
- prev?: Page;
139
- /** Object with Href to a particular element or set of elements */
109
+ prev?: Page; /** Object with Href to a particular element or set of elements */
140
110
  self?: Self;
141
111
  };
142
112
  type MultiSheetTemplate = {
143
- /** ID of app */
144
- appId?: string;
145
- /** heightPx of chart, must be 0 or omitted for autofit. */
146
- heightPx?: number;
147
- /** optional value to indicate that this sheet is private */
148
- isPrivate?: boolean;
149
- /** Sheet state from client as a string json value. Can include language, theme, viewState etc. */
113
+ /** ID of app */appId?: string; /** heightPx of chart, must be 0 or omitted for autofit. */
114
+ heightPx?: number; /** optional value to indicate that this sheet is private */
115
+ isPrivate?: boolean; /** Sheet state from client as a string json value. Can include language, theme, viewState etc. */
150
116
  jsOpts?: unknown;
151
117
  jsOptsById?: Record<string, unknown>;
152
- patchesById?: Record<string, unknown[]>;
153
- /** Flag to configure the persistent bookmark to use variables */
118
+ patchesById?: Record<string, unknown[]>; /** Flag to configure the persistent bookmark to use variables */
154
119
  persistentBookmarkIncludeVariables?: boolean;
155
120
  /** Currently only autofit is supported.
156
121
  * If omitted, autofit is the default.
@@ -158,20 +123,14 @@ type MultiSheetTemplate = {
158
123
  * - none is used to export a visualization, sheet as is (e.g. normal size), regardless its size. This may result in cropping.
159
124
  * - 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.
160
125
  * - fit fits the visualization, sheet into the area specified in resizeData. The content will be rescaled to fit in that area. */
161
- resizeType?: "none" | "fit" | "autofit";
162
- /** ID of sheet */
163
- sheetId?: string;
164
- /** an optional name for the sheet */
165
- sheetName?: string;
166
- /** widthPx of chart, must be 0 or omitted for autofit. */
126
+ resizeType?: "none" | "fit" | "autofit"; /** ID of sheet */
127
+ sheetId?: string; /** an optional name for the sheet */
128
+ sheetName?: string; /** widthPx of chart, must be 0 or omitted for autofit. */
167
129
  widthPx?: number;
168
130
  };
169
131
  type Page = {
170
- /** URL to particular set of elements */
171
- href?: string;
172
- /** Page unique token */
173
- token?: string;
174
- /** Page type, can be next or prev */
132
+ /** URL to particular set of elements */href?: string; /** Page unique token */
133
+ token?: string; /** Page type, can be next or prev */
175
134
  type?: "prev" | "next";
176
135
  };
177
136
  /**
@@ -181,31 +140,21 @@ type RecipientsPersist = {
181
140
  DLGroups?: unknown[];
182
141
  DLUsers?: unknown[];
183
142
  emailAddresses?: EmailAddressRecipientPersist[];
184
- groupIds?: GroupIDRecipientPersist[];
185
- /** Net count of recipients in DLGroups and DLUsers. */
143
+ groupIds?: GroupIDRecipientPersist[]; /** Net count of recipients in DLGroups and DLUsers. */
186
144
  netRecipientCount?: number;
187
145
  userIds?: UserIDRecipientPersist[];
188
146
  };
189
147
  type RetentionPolicy = {
190
- /** Number indicating the size of the window which stores the history. For Chart monitoring, the size should be 10. */
191
- historySize?: number;
192
- /** 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 */
148
+ /** Number indicating the size of the window which stores the history. For Chart monitoring, the size should be 10. */historySize?: number; /** 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 */
193
149
  overrideInterval?: string;
194
150
  };
195
151
  type ScheduleOptions = {
196
- /** The chronos job identifier. It is set once the related chronos job is created. */
197
- readonly chronosJobID?: string;
198
- /** 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. */
199
- endDateTime?: string;
200
- /** 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. */
201
- readonly lastExecutionTime?: string;
202
- /** 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. */
203
- readonly nextExecutionTime?: string;
204
- /** 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. */
205
- recurrence?: string[];
206
- /** 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. */
207
- startDateTime?: string;
208
- /** The timezone for time calculations in SCHEDULED triggers, optional. */
152
+ /** The chronos job identifier. It is set once the related chronos job is created. */readonly chronosJobID?: string; /** 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. */
153
+ endDateTime?: string; /** 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. */
154
+ readonly lastExecutionTime?: string; /** 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. */
155
+ readonly nextExecutionTime?: string; /** 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. */
156
+ recurrence?: string[]; /** 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. */
157
+ startDateTime?: string; /** The timezone for time calculations in SCHEDULED triggers, optional. */
209
158
  timezone?: string;
210
159
  };
211
160
  type Selection = {
@@ -226,81 +175,52 @@ type SharingActionsTriggerCreateRequest = {
226
175
  sharingTaskID: string;
227
176
  };
228
177
  type SharingExecutionError = {
229
- /** Error code specific to sharing service. */
230
- readonly code?: string;
231
- /** Error cause. */
232
- readonly detail?: string;
233
- /** Error title. */
178
+ /** Error code specific to sharing service. */readonly code?: string; /** Error cause. */
179
+ readonly detail?: string; /** Error title. */
234
180
  readonly title?: string;
235
181
  };
236
182
  type SharingExecutionErrors = SharingExecutionError[];
237
183
  type SharingExecutionFile = {
238
184
  fileAlias?: string;
239
185
  fileID?: string;
240
- tempContentsLocation?: string;
241
- /** identify the source task template */
186
+ tempContentsLocation?: string; /** identify the source task template */
242
187
  readonly templateId?: string;
243
- type?: "image" | "pdf" | "pptx" | "xlsx" | "html" | "docx";
244
- /** userId associated with the file */
188
+ type?: "image" | "pdf" | "pptx" | "xlsx" | "html" | "docx"; /** userId associated with the file */
245
189
  readonly userId?: string;
246
190
  };
247
191
  type SharingExecutionListResponse = StandardListResponseProps & {
248
- /** Gets a list of sharing-executions. */
249
- executions?: SharingExecutionResponse[];
192
+ /** Gets a list of sharing-executions. */executions?: SharingExecutionResponse[];
250
193
  links?: ListLinks;
251
194
  };
252
195
  type SharingExecutionPersist = {
253
- /** appId associated to sharing task execution */
254
- readonly appId?: string;
196
+ /** appId associated to sharing task execution */readonly appId?: string;
255
197
  /** @deprecated
256
198
  * The ID of a filter in a reporting request */
257
199
  readonly bookmarkId?: string;
258
- readonly bookmarkIds?: string[];
259
- /** Total count of cancelled reports in this execution */
260
- readonly cancelledCount?: number;
261
- /** Timestamp of execution cancel */
262
- readonly cancelledTime?: string;
263
- /** Timestamp of execution successful stop */
200
+ readonly bookmarkIds?: string[]; /** Total count of cancelled reports in this execution */
201
+ readonly cancelledCount?: number; /** Timestamp of execution cancel */
202
+ readonly cancelledTime?: string; /** Timestamp of execution successful stop */
264
203
  readonly endTime?: string;
265
- errors?: SharingExecutionErrors;
266
- /** eventID of the trigger NATS event */
267
- readonly eventID?: string;
268
- /** eventTime of the trigger NATS event */
269
- readonly eventTime?: string;
270
- /** Total count of failed reports in this execution */
271
- readonly failedCount?: number;
272
- /** Timestamp of execution stop */
273
- readonly failedTime?: string;
274
- /** Total count of failed uploaded reports in this execution */
204
+ errors?: SharingExecutionErrors; /** eventID of the trigger NATS event */
205
+ readonly eventID?: string; /** eventTime of the trigger NATS event */
206
+ readonly eventTime?: string; /** Total count of failed reports in this execution */
207
+ readonly failedCount?: number; /** Timestamp of execution stop */
208
+ readonly failedTime?: string; /** Total count of failed uploaded reports in this execution */
275
209
  readonly failedUploadCount?: number;
276
- readonly files?: SharingExecutionFile[];
277
- /** Gets the execution identifier. */
278
- readonly id?: string;
279
- /** Owner of the execution */
280
- readonly ownerId?: string;
281
- /** If this execution was triggered by an app reload. This will contain the reloadId from reloads service. Otherwise it is empty or omitted. */
282
- readonly reloadId?: string;
283
- /** 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. */
284
- readonly reloadTime?: string;
285
- /** ID for the sharing task that this execution references */
286
- readonly sharingTaskID?: string;
287
- /** Timestamp of execution start */
288
- readonly startTime?: string;
289
- /** Status of the task execution */
290
- readonly status?: "initialized" | "in-progress" | "successful" | "failed" | "cancelled" | "invalid" | "presuccessful" | "cancelling";
291
- /** Total count of successfully generated reports in this execution */
292
- readonly successCount?: number;
293
- /** Total count of successfully uploaded reports in this execution */
294
- readonly successUploadCount?: number;
295
- /** User that this execution is targeting as a recipient */
296
- targetUser?: TargetUser;
297
- /** The tenant that this execution belongs to */
298
- readonly tenantId?: string;
299
- /** Total count of reports in this execution */
300
- readonly totalCount?: number;
301
- /** Total count of reports to be uploaded in this execution */
302
- readonly totalUploadCount?: number;
303
- /** 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. */
210
+ readonly files?: SharingExecutionFile[]; /** Gets the execution identifier. */
211
+ readonly id?: string; /** Owner of the execution */
212
+ readonly ownerId?: string; /** If this execution was triggered by an app reload. This will contain the reloadId from reloads service. Otherwise it is empty or omitted. */
213
+ readonly reloadId?: string; /** 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. */
214
+ readonly reloadTime?: string; /** ID for the sharing task that this execution references */
215
+ readonly sharingTaskID?: string; /** Timestamp of execution start */
216
+ readonly startTime?: string; /** Status of the task execution */
217
+ readonly status?: "initialized" | "in-progress" | "successful" | "failed" | "cancelled" | "invalid" | "presuccessful" | "cancelling"; /** Total count of successfully generated reports in this execution */
218
+ readonly successCount?: number; /** Total count of successfully uploaded reports in this execution */
219
+ readonly successUploadCount?: number; /** User that this execution is targeting as a recipient */
220
+ targetUser?: TargetUser; /** The tenant that this execution belongs to */
221
+ readonly tenantId?: string; /** Total count of reports in this execution */
222
+ readonly totalCount?: number; /** Total count of reports to be uploaded in this execution */
223
+ readonly totalUploadCount?: number; /** 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. */
304
224
  readonly workflowID?: string;
305
225
  };
306
226
  type SharingExecutionResponse = SharingExecutionPersist & {
@@ -308,35 +228,21 @@ type SharingExecutionResponse = SharingExecutionPersist & {
308
228
  links?: Links;
309
229
  };
310
230
  type SharingSettings = {
311
- /** true if report-subscription feature is enabled for this tenant */
312
- "enable-report-subscription": boolean;
313
- /** true if reporting-template-subscription feature is enabled for this tenant */
314
- "enable-reporting-template-subscription": boolean;
315
- /** Whether API endpoints for sharing are enabled */
316
- "enable-sharing": boolean;
317
- /** Maximum number of recipients when creating a sharing task */
318
- readonly maxRecipients?: number;
319
- /** Max Recipients accepted when creating a new subscription (excluding the owner) */
320
- readonly maxSubscriptionRecipients?: number;
321
- /** 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 */
322
- readonly reportSubscriptionStatus?: "none" | "enabling" | "disabling";
323
- /** 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. */
324
- readonly reportSubscriptionStatusChangeTime?: string;
325
- /** Whether the license for the tenant has the reportingService feature enabled. */
326
- "reporting-service-license-status"?: "enabled" | "disabled";
327
- /** 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 */
328
- readonly reportingTemplateSubscriptionStatus?: "none" | "enabling" | "disabling";
329
- /** 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. */
330
- readonly reportingTemplateSubscriptionStatusChangeTime?: string;
331
- /** These persisted sharing settings are only available for this tenant. Extracted from request JWT. */
231
+ /** true if report-subscription feature is enabled for this tenant */"enable-report-subscription": boolean; /** true if reporting-template-subscription feature is enabled for this tenant */
232
+ "enable-reporting-template-subscription": boolean; /** Whether API endpoints for sharing are enabled */
233
+ "enable-sharing": boolean; /** Maximum number of recipients when creating a sharing task */
234
+ readonly maxRecipients?: number; /** Max Recipients accepted when creating a new subscription (excluding the owner) */
235
+ readonly maxSubscriptionRecipients?: number; /** 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 */
236
+ readonly reportSubscriptionStatus?: "none" | "enabling" | "disabling"; /** 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. */
237
+ readonly reportSubscriptionStatusChangeTime?: string; /** Whether the license for the tenant has the reportingService feature enabled. */
238
+ "reporting-service-license-status"?: "enabled" | "disabled"; /** 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 */
239
+ readonly reportingTemplateSubscriptionStatus?: "none" | "enabling" | "disabling"; /** 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. */
240
+ readonly reportingTemplateSubscriptionStatusChangeTime?: string; /** These persisted sharing settings are only available for this tenant. Extracted from request JWT. */
332
241
  readonly tenantId?: string;
333
242
  };
334
243
  type SharingSettingsPatchCompliant = {
335
- /** The operation to be performed. */
336
- op: "replace";
337
- /** The path for the given resource field to patch. */
338
- path: "/enable-sharing" | "/enable-report-subscription" | "/enable-reporting-template-subscription";
339
- /** The value to be used for this operation. */
244
+ /** The operation to be performed. */op: "replace"; /** The path for the given resource field to patch. */
245
+ path: "/enable-sharing" | "/enable-report-subscription" | "/enable-reporting-template-subscription"; /** The value to be used for this operation. */
340
246
  value?: unknown;
341
247
  };
342
248
  /**
@@ -418,157 +324,94 @@ type SharingTaskPatchRequestCompliantList = SharingTaskRecurringPatchRequestComp
418
324
  type SharingTaskRecurringCreateRequest = {
419
325
  /** @deprecated
420
326
  * Name of the app associated (through the templates) with this sharing task */
421
- appName?: string;
422
- /** A bookmark is considered old if its modification date is older than the app creation date. */
423
- cleanupStrategy?: CleanupStrategy;
424
- /** the id of the data connection */
425
- dataConnectionID?: string;
426
- /** Description of the sharing task */
427
- description?: string;
428
- /** the id of the distribution list associated to the app */
327
+ appName?: string; /** A bookmark is considered old if its modification date is older than the app creation date. */
328
+ cleanupStrategy?: CleanupStrategy; /** the id of the data connection */
329
+ dataConnectionID?: string; /** Description of the sharing task */
330
+ description?: string; /** the id of the distribution list associated to the app */
429
331
  distributionListId?: string;
430
- emailContent?: EmailComposition;
431
- /** Toggle for enabling sharing task. */
432
- enabled?: boolean;
433
- /** making this true will execute the sharing task upon creation regardless of next trigger */
434
- executeOnCreation?: boolean;
435
- /** Timestamp for the termination of the task */
436
- expiration?: string;
437
- /** Message along with sharing task */
438
- message?: string;
439
- /** Name of this sharing task */
440
- name: string;
441
- /** List of recipients. An internal recipient is represented by their user id. */
332
+ emailContent?: EmailComposition; /** Toggle for enabling sharing task. */
333
+ enabled?: boolean; /** making this true will execute the sharing task upon creation regardless of next trigger */
334
+ executeOnCreation?: boolean; /** Timestamp for the termination of the task */
335
+ expiration?: string; /** Message along with sharing task */
336
+ message?: string; /** Name of this sharing task */
337
+ name: string; /** List of recipients. An internal recipient is represented by their user id. */
442
338
  recipients?: SharingTaskRecurringRecipients;
443
339
  retentionPolicy?: RetentionPolicy;
444
- scheduleOptions?: ScheduleOptions;
445
- /** the SharePoint folder to upload the report to */
446
- sharePointFolder?: string;
447
- /** Space ID of the sharing task */
448
- spaceId?: string;
449
- /** Time to start capturing the history */
450
- startTime?: string;
451
- /** State of the selections and jsOpts */
340
+ scheduleOptions?: ScheduleOptions; /** the SharePoint folder to upload the report to */
341
+ sharePointFolder?: string; /** Space ID of the sharing task */
342
+ spaceId?: string; /** Time to start capturing the history */
343
+ startTime?: string; /** State of the selections and jsOpts */
452
344
  state: State;
453
345
  /** @deprecated
454
346
  * the sharing task resource mashup sub type. */
455
- subType?: "pdf" | "pptx" | "xlsx" | "html" | "docx";
456
- /** used to assign sharing task to a collection bucket (tags) */
347
+ subType?: "pdf" | "pptx" | "xlsx" | "html" | "docx"; /** used to assign sharing task to a collection bucket (tags) */
457
348
  tags?: string[];
458
- templates: TemplateResult[];
459
- /** the transport type for the report */
349
+ templates: TemplateResult[]; /** the transport type for the report */
460
350
  transportChannels?: ("email" | "sharepoint")[];
461
- trigger?: Trigger;
462
- /** the sharing task resource type. */
351
+ trigger?: Trigger; /** the sharing task resource type. */
463
352
  type: "chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing";
464
353
  };
465
354
  type SharingTaskRecurringListResponse = StandardListResponseProps & {
466
- links?: ListLinks;
467
- /** List of recipients. An internal recipient is represented by their user id. */
468
- recipients?: SharingTaskRecurringRecipients;
469
- /** Gets a list of recurring sharing tasks. */
355
+ links?: ListLinks; /** List of recipients. An internal recipient is represented by their user id. */
356
+ recipients?: SharingTaskRecurringRecipients; /** Gets a list of recurring sharing tasks. */
470
357
  sharingTasks?: SharingTaskRecurringResponse[];
471
358
  };
472
359
  type SharingTaskRecurringPatchRequestCompliant = {
473
- /** The operation to be performed */
474
- op: "replace" | "remove";
475
- /** A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902 */
476
- path: "/name" | "/tags" | "/ownerId" | "/enabled" | "/description" | "/scheduleOptions" | "/templates" | "/recipients" | "/recipient" | "/sharePointFolder" | "/dataConnectionID" | "/transportChannels" | "/bookmarkId";
477
- /** The value to be used for this operation. */
360
+ /** The operation to be performed */op: "replace" | "remove"; /** A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902 */
361
+ path: "/name" | "/tags" | "/ownerId" | "/enabled" | "/description" | "/scheduleOptions" | "/templates" | "/recipients" | "/recipient" | "/sharePointFolder" | "/dataConnectionID" | "/transportChannels" | "/bookmarkId"; /** The value to be used for this operation. */
478
362
  value?: unknown;
479
363
  };
480
364
  /**
481
365
  * Type of object stored in the database. Required fields mean that property cannot be null
482
366
  */
483
367
  type SharingTaskRecurringPersist = {
484
- /** ID of the app associated (through the templates) with this sharing task */
485
- appId?: string;
486
- /** Name of the app associated (through the templates) with this sharing task */
487
- appName?: string;
488
- /** internal identifier used when migrating keys */
489
- byokMigrationId?: string;
490
- /** ID of creator */
491
- createdBy?: string;
492
- /** the id of the data connection */
493
- dataConnectionID?: string;
494
- /** Timestamp for the creation of the task */
495
- dateCreated?: string;
496
- /** A description of this sharing task */
497
- description?: string;
498
- /** the id of the distribution list associated to the app */
368
+ /** ID of the app associated (through the templates) with this sharing task */appId?: string; /** Name of the app associated (through the templates) with this sharing task */
369
+ appName?: string; /** internal identifier used when migrating keys */
370
+ byokMigrationId?: string; /** ID of creator */
371
+ createdBy?: string; /** the id of the data connection */
372
+ dataConnectionID?: string; /** Timestamp for the creation of the task */
373
+ dateCreated?: string; /** A description of this sharing task */
374
+ description?: string; /** the id of the distribution list associated to the app */
499
375
  distributionListId?: string;
500
- emailContent?: EmailComposition;
501
- /** Toggle for enabling sharing task (system level). Example: when task owner gets enabled/ disabled. */
502
- enabledBySystem?: boolean;
503
- /** Toggle for enabling sharing task (user level). Example: user chooses to enable/ disable task. */
504
- enabledByUser?: boolean;
505
- /** the subject and body content for the email to send on report subscriptions */
506
- encryptedEmailContent?: SharingTaskRecurringPersistEncryptedEmailContent;
507
- /** Encrypted property in DB */
508
- encryptedState?: EncryptedProperty;
509
- /** Encrypted property in DB */
510
- encryptedTemplates?: EncryptedProperty;
511
- /** making this true will execute the sharing task upon creation regardless of next trigger */
512
- executeOnCreation?: boolean;
513
- /** Time for the termination of the task */
514
- expiration?: string;
515
- /** the number of consecutive failed executions for all recipeints. This is reset on a successful execution for at least one recipient */
516
- failedExecutionsCount?: number;
517
- /** the number of failed verifications. This is reset on a successful verification */
518
- failedVerificationsCount?: number;
519
- /** true if the associated app has section access enabled */
520
- hasSectionAccess?: boolean;
521
- /** Gets the sharing task resource identifier. */
522
- id?: string;
523
- /** The direct insights URL for the first template of this sharing task. (currently not used in multi-sheet scenarios) */
524
- insightDirectURL?: string;
525
- /** The insights fallback URL for the first template of this sharing task. (currently not used in multi-sheet scenarios) */
526
- insightFallbackURL?: string;
527
- /** 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) */
528
- insightID?: string;
529
- /** true if the sharing task is a candidate for verification */
530
- isCandidateForVerification?: boolean;
531
- /** The last execution end date time timestamp of the task */
532
- readonly lastExecutionDate?: string;
533
- /** The last execution start date time timestamp of the task */
534
- lastRun?: string;
535
- /** Timestamp of the most recent update. */
536
- lastUpdated?: string;
537
- /** Timestamp of the most recent view by the user. */
538
- lastViewed?: string;
539
- /** Message along with sharing task */
540
- message?: string;
541
- /** 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. */
542
- multiInsightURLs?: InsightURL[];
543
- /** Name of this sharing task */
544
- name?: string;
545
- /** Time for the next scheduled run */
546
- nextScheduledRun?: string;
547
- /** User id of owner of the sharing task */
548
- owner?: string;
549
- /** User name of owner of the sharing task */
376
+ emailContent?: EmailComposition; /** Toggle for enabling sharing task (system level). Example: when task owner gets enabled/ disabled. */
377
+ enabledBySystem?: boolean; /** Toggle for enabling sharing task (user level). Example: user chooses to enable/ disable task. */
378
+ enabledByUser?: boolean; /** the subject and body content for the email to send on report subscriptions */
379
+ encryptedEmailContent?: SharingTaskRecurringPersistEncryptedEmailContent; /** Encrypted property in DB */
380
+ encryptedState?: EncryptedProperty; /** Encrypted property in DB */
381
+ encryptedTemplates?: EncryptedProperty; /** making this true will execute the sharing task upon creation regardless of next trigger */
382
+ executeOnCreation?: boolean; /** Time for the termination of the task */
383
+ expiration?: string; /** the number of consecutive failed executions for all recipeints. This is reset on a successful execution for at least one recipient */
384
+ failedExecutionsCount?: number; /** the number of failed verifications. This is reset on a successful verification */
385
+ failedVerificationsCount?: number; /** true if the associated app has section access enabled */
386
+ hasSectionAccess?: boolean; /** Gets the sharing task resource identifier. */
387
+ id?: string; /** The direct insights URL for the first template of this sharing task. (currently not used in multi-sheet scenarios) */
388
+ insightDirectURL?: string; /** The insights fallback URL for the first template of this sharing task. (currently not used in multi-sheet scenarios) */
389
+ insightFallbackURL?: string; /** 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) */
390
+ insightID?: string; /** true if the sharing task is a candidate for verification */
391
+ isCandidateForVerification?: boolean; /** The last execution end date time timestamp of the task */
392
+ readonly lastExecutionDate?: string; /** The last execution start date time timestamp of the task */
393
+ lastRun?: string; /** Timestamp of the most recent update. */
394
+ lastUpdated?: string; /** Timestamp of the most recent view by the user. */
395
+ lastViewed?: string; /** Message along with sharing task */
396
+ message?: string; /** 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. */
397
+ multiInsightURLs?: InsightURL[]; /** Name of this sharing task */
398
+ name?: string; /** Time for the next scheduled run */
399
+ nextScheduledRun?: string; /** User id of owner of the sharing task */
400
+ owner?: string; /** User name of owner of the sharing task */
550
401
  ownerName?: string;
551
402
  /** @deprecated
552
403
  * 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. */
553
- persistentBookmarkIncludeVariables?: boolean;
554
- /** List of persisted recipients. */
404
+ persistentBookmarkIncludeVariables?: boolean; /** List of persisted recipients. */
555
405
  recipients?: RecipientsPersist;
556
406
  reportProperties?: unknown;
557
407
  retentionPolicy?: RetentionPolicy;
558
- scheduleOptions?: ScheduleOptions;
559
- /** reporting service returns rendering errors for missing selections */
560
- selectionErrors?: unknown;
561
- /** the SharePoint folder to upload the report to */
562
- sharePointFolder?: string;
563
- /** spaceId of the app associated to this task definition */
564
- spaceId?: string;
565
- /** Time to start capturing the history */
566
- startTime?: string;
567
- /** State of the selections and jsOpts */
568
- state?: State;
569
- /** the status of this recurring sharing task */
570
- 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";
571
- /** error message indicating the underlying failure */
408
+ scheduleOptions?: ScheduleOptions; /** reporting service returns rendering errors for missing selections */
409
+ selectionErrors?: unknown; /** the SharePoint folder to upload the report to */
410
+ sharePointFolder?: string; /** spaceId of the app associated to this task definition */
411
+ spaceId?: string; /** Time to start capturing the history */
412
+ startTime?: string; /** State of the selections and jsOpts */
413
+ state?: State; /** the status of this recurring sharing task */
414
+ 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"; /** error message indicating the underlying failure */
572
415
  readonly statusLabel?: string;
573
416
  /** @deprecated
574
417
  * Mashup subType of sharing task */
@@ -578,25 +421,19 @@ type SharingTaskRecurringPersist = {
578
421
  /** @deprecated
579
422
  * ID of unique template */
580
423
  readonly templateId?: string;
581
- templates?: TemplateResult[];
582
- /** Tenant of the sharing task */
424
+ templates?: TemplateResult[]; /** Tenant of the sharing task */
583
425
  tenant?: string;
584
- thumbnail?: string;
585
- /** the transport type for the report */
426
+ thumbnail?: string; /** the transport type for the report */
586
427
  transportChannels?: ("email" | "sharepoint")[];
587
- trigger?: Trigger;
588
- /** The sharing task resource type */
589
- type?: "chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing";
590
- /** ID of a user that updated this task last */
428
+ trigger?: Trigger; /** The sharing task resource type */
429
+ type?: "chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing"; /** ID of a user that updated this task last */
591
430
  updatedBy?: string;
592
431
  };
593
432
  /**
594
433
  * the subject and body content for the email to send on report subscriptions
595
434
  */
596
435
  type SharingTaskRecurringPersistEncryptedEmailContent = {
597
- /** Encrypted property in DB */
598
- body?: EncryptedProperty;
599
- /** Encrypted property in DB */
436
+ /** Encrypted property in DB */body?: EncryptedProperty; /** Encrypted property in DB */
600
437
  subject?: EncryptedProperty;
601
438
  };
602
439
  /**
@@ -612,11 +449,8 @@ type SharingTaskRecurringRecipients = {
612
449
  * Whatever is persisted in the db + links
613
450
  */
614
451
  type SharingTaskRecurringResponse = SharingTaskRecurringPersist & {
615
- /** true if the sharing task is enabled */
616
- enabled?: boolean;
617
- /** URL to querying the files of the latest execution tied to this sharing task */
618
- latestExecutionFilesURL?: string[];
619
- /** URL to querying the latest execution tied to this sharing task */
452
+ /** true if the sharing task is enabled */enabled?: boolean; /** URL to querying the files of the latest execution tied to this sharing task */
453
+ latestExecutionFilesURL?: string[]; /** URL to querying the latest execution tied to this sharing task */
620
454
  latestExecutionURL?: string;
621
455
  links?: Links;
622
456
  };
@@ -624,97 +458,70 @@ type SharingTaskRecurringResponse = SharingTaskRecurringPersist & {
624
458
  * @deprecated
625
459
  */
626
460
  type SheetTemplate = {
627
- /** ID of app */
628
- appId?: string;
629
- /** heightPx of chart */
461
+ /** ID of app */appId?: string; /** heightPx of chart */
630
462
  heightPx?: number;
631
463
  /** @deprecated
632
464
  * optional value to indicate that this sheet is private (used in multi-sheet sharing) */
633
- isPrivate?: boolean;
634
- /** Sheet state from client as a string json value. Can include language, theme, viewState etc. */
465
+ isPrivate?: boolean; /** Sheet state from client as a string json value. Can include language, theme, viewState etc. */
635
466
  jsOpts?: unknown;
636
467
  jsOptsById?: Record<string, unknown>;
637
- patchesById?: Record<string, unknown[]>;
638
- /** ID of sheet */
468
+ patchesById?: Record<string, unknown[]>; /** ID of sheet */
639
469
  sheetId?: string;
640
470
  /** @deprecated
641
471
  * an optional name for the sheet (used in multi-sheet sharing) */
642
- sheetName?: string;
643
- /** widthPx of chart */
472
+ sheetName?: string; /** widthPx of chart */
644
473
  widthPx?: number;
645
474
  };
646
475
  /**
647
476
  * properties that should be added to every list response
648
477
  */
649
478
  type StandardListResponseProps = {
650
- /** count of entries on the currently shown page */
651
- currentPageCount: number;
652
- /** total count of entries in the collection as a whole */
479
+ /** count of entries on the currently shown page */currentPageCount: number; /** total count of entries in the collection as a whole */
653
480
  totalCount: number;
654
481
  };
655
482
  /**
656
483
  * State of the selections and jsOpts
657
484
  */
658
485
  type State = {
659
- /** Selected fields that led to discovery of monitored Insight Advisor chart */
660
- fields?: unknown[];
661
- /** Query that led to discovery of monitored Insight Advisor chart */
486
+ /** Selected fields that led to discovery of monitored Insight Advisor chart */fields?: unknown[]; /** Query that led to discovery of monitored Insight Advisor chart */
662
487
  queryItems?: unknown[];
663
488
  selections?: Selection[];
664
489
  };
665
490
  type StoryTemplate = {
666
- /** ID of app */
667
- appId?: string;
668
- /** ID of story */
491
+ /** ID of app */appId?: string; /** ID of story */
669
492
  storyId?: string;
670
493
  };
671
494
  /**
672
495
  * User that this execution is targeting as a recipient
673
496
  */
674
497
  type TargetUser = {
675
- /** @deprecated */
676
- filterName?: string;
677
- filterNames?: string[];
678
- /** timezone for the timestamp on the attached file name */
679
- timezone?: string;
680
- /** type of user eg email, userId, groupId */
681
- type?: string;
682
- /** contains the value of user type e.g. abc@xyz.com, 213efewr3 */
498
+ /** @deprecated */filterName?: string;
499
+ filterNames?: string[]; /** timezone for the timestamp on the attached file name */
500
+ timezone?: string; /** type of user eg email, userId, groupId */
501
+ type?: string; /** contains the value of user type e.g. abc@xyz.com, 213efewr3 */
683
502
  value?: string;
684
503
  };
685
504
  type TaskError = {
686
- /** Timestamp for the creation of the error */
687
- timestamp?: string;
688
- /** Identifier for type of error occurring on sharing task */
505
+ /** Timestamp for the creation of the error */timestamp?: string; /** Identifier for type of error occurring on sharing task */
689
506
  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";
690
507
  };
691
508
  type TaskGroupRecipientError = {
692
- /** Timestamp for the creation of the error */
693
- timestamp?: string;
694
- /** Identifier for type of error occurring on sharing task specific for group recipient */
509
+ /** Timestamp for the creation of the error */timestamp?: string; /** Identifier for type of error occurring on sharing task specific for group recipient */
695
510
  value?: "GROUP_IS_DISABLED" | "MAX_ALERTS_LIMIT_REACHED" | "GROUP_WITH_NO_APP_ACCESS" | "GROUP_IS_DELETED" | "GROUP_NOT_FOUND_DL" | "GROUP_DISABLED_IN_DL";
696
511
  };
697
512
  type TaskRecipientError = {
698
- /** Timestamp for the creation of the error */
699
- timestamp?: string;
700
- /** Identifier for type of error occurring on sharing task specific for recipient */
513
+ /** Timestamp for the creation of the error */timestamp?: string; /** Identifier for type of error occurring on sharing task specific for recipient */
701
514
  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";
702
515
  };
703
516
  /**
704
517
  * 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.
705
518
  */
706
519
  type TemplatePersist = {
707
- /** 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 */
708
- chartData?: ChartTemplate;
709
- /** fileAlias provide an opaqueId for the client which can be used to filter and select the report generated */
710
- fileAlias?: string;
711
- /** fileName to be used when generating the report */
712
- fileName?: string;
713
- /** file name timestamp to be used when generating the report */
714
- fileTimeStamp?: "yyyy-MM-dd" | "yyyy-MM-dd_HH-mm" | "yyyyMMdd" | "yyyyMMdd_HH-mm";
715
- /** array of sheet data for multi-sheet type template */
716
- multiSheetData?: MultiSheetTemplate[];
717
- /** @deprecated */
520
+ /** 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 */chartData?: ChartTemplate; /** fileAlias provide an opaqueId for the client which can be used to filter and select the report generated */
521
+ fileAlias?: string; /** fileName to be used when generating the report */
522
+ fileName?: string; /** file name timestamp to be used when generating the report */
523
+ fileTimeStamp?: "yyyy-MM-dd" | "yyyy-MM-dd_HH-mm" | "yyyyMMdd" | "yyyyMMdd_HH-mm"; /** array of sheet data for multi-sheet type template */
524
+ multiSheetData?: MultiSheetTemplate[]; /** @deprecated */
718
525
  sheetData?: SheetTemplate;
719
526
  storyData?: StoryTemplate;
720
527
  subType?: "image" | "snapshot" | "pdf" | "pptx" | "xlsx" | "qpxp" | "qhtml" | "docx";
@@ -725,45 +532,32 @@ type TemplatePersist = {
725
532
  };
726
533
  type TemplateResult = TemplatePersist & unknown;
727
534
  type Trigger = {
728
- /** The chronosJobId which triggers the sharing task */
729
- readonly chronosJobID?: string;
730
- /** Toggle for executing sharing task on app reload. */
731
- executeOnAppReload?: boolean;
732
- /** 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. */
733
- executionHistoryInterval?: "minutely" | "hourly" | "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
734
- /** 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. */
535
+ /** The chronosJobId which triggers the sharing task */readonly chronosJobID?: string; /** Toggle for executing sharing task on app reload. */
536
+ executeOnAppReload?: boolean; /** 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. */
537
+ executionHistoryInterval?: "minutely" | "hourly" | "daily" | "weekly" | "monthly" | "quarterly" | "yearly"; /** 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. */
735
538
  recurrence: string[];
736
539
  };
737
540
  /**
738
541
  * an internal recipient based on its user id.
739
542
  */
740
543
  type UserIDRecipient = {
741
- alertingTaskRecipientErrors?: AlertingTaskRecipientError[];
742
- /** Whether this recipient can receive alerts. */
743
- enabled?: boolean;
744
- /** A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included */
745
- groups?: string[];
746
- /** Whether this recipient is subscribed to alerts of a task */
544
+ alertingTaskRecipientErrors?: AlertingTaskRecipientError[]; /** Whether this recipient can receive alerts. */
545
+ enabled?: boolean; /** A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included */
546
+ groups?: string[]; /** Whether this recipient is subscribed to alerts of a task */
747
547
  subscribed?: boolean;
748
- taskRecipientErrors?: TaskRecipientError[];
749
- /** User ID of recipient (internal user). */
548
+ taskRecipientErrors?: TaskRecipientError[]; /** User ID of recipient (internal user). */
750
549
  value?: string;
751
550
  };
752
551
  /**
753
552
  * recipient object model that is directly persisted in the DB
754
553
  */
755
554
  type UserIDRecipientPersist = {
756
- alertingTaskRecipientErrors?: AlertingTaskRecipientError[];
757
- /** Whether this recipient can receive alerts, set by external settings. */
758
- enabledBySystem?: boolean;
759
- /** Whether this recipient can receive alerts, set by api calls. */
760
- enabledByUser?: boolean;
761
- /** A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included */
762
- groups?: string[];
763
- /** Whether this user is subscribed to alerts in this task */
555
+ alertingTaskRecipientErrors?: AlertingTaskRecipientError[]; /** Whether this recipient can receive alerts, set by external settings. */
556
+ enabledBySystem?: boolean; /** Whether this recipient can receive alerts, set by api calls. */
557
+ enabledByUser?: boolean; /** A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included */
558
+ groups?: string[]; /** Whether this user is subscribed to alerts in this task */
764
559
  subscribed?: boolean;
765
- taskRecipientErrors?: TaskRecipientError[];
766
- /** User ID of recipient (internal user). */
560
+ taskRecipientErrors?: TaskRecipientError[]; /** User ID of recipient (internal user). */
767
561
  value?: string;
768
562
  };
769
563
  /**
@@ -773,33 +567,22 @@ type UserIDRecipientPersist = {
773
567
  * @throws GetSharingTasksHttpError
774
568
  */
775
569
  declare function getSharingTasks(query: {
776
- /** the filter by sharing task resource app id. TenantAdmin users may omit this parameter to list all sharing-tasks in the tenant. */
777
- appid?: string;
778
- /** Indicates if task with the status DELETING should be excluded from the list */
779
- excludeDeleting?: boolean;
780
- /** Limit the returned result set */
570
+ /** the filter by sharing task resource app id. TenantAdmin users may omit this parameter to list all sharing-tasks in the tenant. */appid?: string; /** Indicates if task with the status DELETING should be excluded from the list */
571
+ excludeDeleting?: boolean; /** Limit the returned result set */
781
572
  limit?: number;
782
573
  /** @deprecated
783
574
  * The cursor to the next page of data. Only one of next or previous may be specified. */
784
- next?: string;
785
- /** Offset for finding a list of entities - used for pagination */
786
- offset?: number;
787
- /** the filter by sharing task resource owner id. */
788
- owner?: string;
789
- /** the filter by sharing task resource owner name. */
790
- ownername?: string;
791
- /** The cursor to the page of data. */
575
+ next?: string; /** Offset for finding a list of entities - used for pagination */
576
+ offset?: number; /** the filter by sharing task resource owner id. */
577
+ owner?: string; /** the filter by sharing task resource owner name. */
578
+ ownername?: string; /** The cursor to the page of data. */
792
579
  page?: string;
793
580
  /** @deprecated
794
581
  * The cursor to the previous page of data. Only one of next or previous may be specified. */
795
- prev?: string;
796
- /** the filter by sharing task resource role. */
797
- role?: ("owner" | "recipient")[];
798
- /** Sort the returned result set by the specified field */
799
- 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")[];
800
- /** array of template ids to filter by */
801
- templateId?: string[];
802
- /** the filter by sharing task resource type. If type is template-sharing only and user is not tenant admin, appid is also required. */
582
+ prev?: string; /** the filter by sharing task resource role. */
583
+ role?: ("owner" | "recipient")[]; /** Sort the returned result set by the specified field */
584
+ 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")[]; /** array of template ids to filter by */
585
+ templateId?: string[]; /** the filter by sharing task resource type. If type is template-sharing only and user is not tenant admin, appid is also required. */
803
586
  type?: ("chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing")[];
804
587
  }, options?: ApiCallOptions): Promise<GetSharingTasksHttpResponse>;
805
588
  type GetSharingTasksHttpResponse = {
@@ -923,8 +706,7 @@ type DeleteSharingTaskHttpError = {
923
706
  * @throws GetSharingTaskHttpError
924
707
  */
925
708
  declare function getSharingTask(taskId: string, query: {
926
- /** 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. */
927
- isViewChart?: boolean;
709
+ /** 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. */isViewChart?: boolean;
928
710
  }, options?: ApiCallOptions): Promise<GetSharingTaskHttpResponse>;
929
711
  type GetSharingTaskHttpResponse = {
930
712
  data: SharingTaskRecurringResponse;
@@ -979,17 +761,11 @@ type CancelSharingTaskHttpError = {
979
761
  * @throws GetSharingTaskExecutionsHttpError
980
762
  */
981
763
  declare function getSharingTaskExecutions(taskId: string, query: {
982
- /** Limit the returned result set */
983
- limit?: number;
984
- /** The cursor to the next page of data. Only one of next or previous may be specified. */
985
- next?: string;
986
- /** Offset for pagination - how many elements to skip */
987
- offset?: number;
988
- /** The cursor to the previous page of data. Only one of next or previous may be specified. */
989
- prev?: string;
990
- /** Sort the returned result set by the specified field */
991
- sort?: ("starttime" | "-starttime" | "+starttime")[];
992
- /** Specifies a filter for a particular field and value of an execution */
764
+ /** Limit the returned result set */limit?: number; /** The cursor to the next page of data. Only one of next or previous may be specified. */
765
+ next?: string; /** Offset for pagination - how many elements to skip */
766
+ offset?: number; /** The cursor to the previous page of data. Only one of next or previous may be specified. */
767
+ prev?: string; /** Sort the returned result set by the specified field */
768
+ sort?: ("starttime" | "-starttime" | "+starttime")[]; /** Specifies a filter for a particular field and value of an execution */
993
769
  status?: "successful" | "failed";
994
770
  }, options?: ApiCallOptions): Promise<GetSharingTaskExecutionsHttpResponse>;
995
771
  type GetSharingTaskExecutionsHttpResponse = {
@@ -1013,8 +789,7 @@ type GetSharingTaskExecutionsHttpError = {
1013
789
  * @throws GetSharingTaskExecutionHttpError
1014
790
  */
1015
791
  declare function getSharingTaskExecution(taskId: string, executionId: string, query: {
1016
- /** Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution. */
1017
- status?: "successful" | "failed" | "cancelled";
792
+ /** Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution. */status?: "successful" | "failed" | "cancelled";
1018
793
  }, options?: ApiCallOptions): Promise<GetSharingTaskExecutionHttpResponse>;
1019
794
  type GetSharingTaskExecutionHttpResponse = {
1020
795
  data: SharingExecutionResponse;
@@ -1036,8 +811,7 @@ type GetSharingTaskExecutionHttpError = {
1036
811
  * @throws GetSharingTaskExecutionFileHttpError
1037
812
  */
1038
813
  declare function getSharingTaskExecutionFile(taskId: string, executionId: string, fileAlias: string, query: {
1039
- /** Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution. */
1040
- status?: "successful" | "failed" | "cancelled";
814
+ /** Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution. */status?: "successful" | "failed" | "cancelled";
1041
815
  }, options?: ApiCallOptions): Promise<GetSharingTaskExecutionFileHttpResponse>;
1042
816
  type GetSharingTaskExecutionFileHttpResponse = {
1043
817
  data: DownloadableBlob;