@qlik/api 1.38.0 → 1.39.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.
- package/api-keys.js +2 -2
- package/apps.js +2 -2
- package/assistants.d.ts +1 -1
- package/assistants.js +2 -2
- package/audits.js +2 -2
- package/auth.js +2 -2
- package/automation-connections.js +2 -2
- package/automations.js +2 -2
- package/automl-deployments.js +2 -2
- package/automl-predictions.js +2 -2
- package/brands.js +2 -2
- package/chunks/{assistants-CDtI99Yr.d.ts → assistants-2UX0GzZ7.d.ts} +33 -33
- package/chunks/{auth-BzhoWKwN.js → auth-DBrXfv7D.js} +1 -1
- package/chunks/{data-alerts-Bx5sDVGI.d.ts → data-alerts-DwPcCvHP.d.ts} +32 -32
- package/chunks/{dist-P1twboQp.js → dist-CjqdvDf3.js} +1 -1
- package/chunks/{invoke-fetch-DJFDz11x.js → invoke-fetch-B-ZucHu9.js} +2 -2
- package/chunks/{public-runtime-modules-Bfh2smA7.js → public-runtime-modules-lsJEDVxt.js} +3 -3
- package/chunks/{qix-f5SasQCg.js → qix-CwYrlHFT.js} +1 -1
- package/chunks/{qix-DggPusot.d.ts → qix-x9gZqE4P.d.ts} +1 -1
- package/chunks/{reloads-CA7KjqJO.d.ts → reloads-B_U6GYDf.d.ts} +9 -1
- package/chunks/{sharing-tasks-QKSzROsB.d.ts → sharing-tasks-BiTNvcFe.d.ts} +19 -19
- package/collections.js +2 -2
- package/conditions.js +2 -2
- package/consumption.js +2 -2
- package/csp-origins.js +2 -2
- package/csrf-token.js +2 -2
- package/data-alerts.d.ts +1 -1
- package/data-alerts.js +18 -18
- package/data-assets.js +2 -2
- package/data-connections.js +2 -2
- package/data-credentials.js +2 -2
- package/data-files.js +2 -2
- package/data-qualities.js +2 -2
- package/data-sets.js +2 -2
- package/data-sources.js +2 -2
- package/data-stores.js +2 -2
- package/dcaas.js +2 -2
- package/di-projects.js +2 -2
- package/direct-access-agents.js +2 -2
- package/encryption.js +2 -2
- package/extensions.js +2 -2
- package/glossaries.js +2 -2
- package/groups.js +2 -2
- package/identity-providers.js +2 -2
- package/index.d.ts +5 -5
- package/index.js +4 -4
- package/items.js +2 -2
- package/knowledgebases.js +2 -2
- package/licenses.js +2 -2
- package/lineage-graphs.js +2 -2
- package/ml.js +2 -2
- package/notes.js +2 -2
- package/notifications.js +2 -2
- package/oauth-clients.js +2 -2
- package/oauth-tokens.js +2 -2
- package/package.json +1 -1
- package/qix.d.ts +1 -1
- package/qix.js +2 -2
- package/questions.js +2 -2
- package/quotas.js +2 -2
- package/reload-tasks.js +2 -2
- package/reloads.d.ts +2 -2
- package/reloads.js +2 -2
- package/report-templates.js +2 -2
- package/reports.js +2 -2
- package/roles.js +2 -2
- package/sharing-tasks.d.ts +1 -1
- package/sharing-tasks.js +11 -11
- package/spaces.js +2 -2
- package/tasks.js +2 -2
- package/temp-contents.js +2 -2
- package/tenants.js +2 -2
- package/themes.js +2 -2
- package/transports.js +2 -2
- package/ui-config.js +2 -2
- package/users.js +2 -2
- package/web-integrations.js +2 -2
- package/web-notifications.js +2 -2
- package/webhooks.js +2 -2
- package/website/assets/navigation.js +1 -1
- package/website/assets/search.js +1 -1
- package/website/functions/data-alerts.createDataAlert.html +1 -1
- package/website/functions/data-alerts.deleteDataAlert.html +1 -1
- package/website/functions/data-alerts.deleteDataAlertExecution.html +1 -1
- package/website/functions/data-alerts.getDataAlert.html +1 -1
- package/website/functions/data-alerts.getDataAlertCondition.html +1 -1
- package/website/functions/data-alerts.getDataAlertExecution.html +1 -1
- package/website/functions/data-alerts.getDataAlertExecutionEvaluations.html +1 -1
- package/website/functions/data-alerts.getDataAlertExecutions.html +1 -1
- package/website/functions/data-alerts.getDataAlertExecutionsStats.html +1 -1
- package/website/functions/data-alerts.getDataAlertRecipientStats.html +1 -1
- package/website/functions/data-alerts.getDataAlerts.html +1 -1
- package/website/functions/data-alerts.getDataAlertsSettings.html +1 -1
- package/website/functions/data-alerts.patchDataAlert.html +1 -1
- package/website/functions/data-alerts.setDataAlertsSettings.html +1 -1
- package/website/functions/data-alerts.triggerDataAlerts.html +1 -1
- package/website/functions/data-alerts.validateDataAlerts.html +1 -1
- package/website/functions/sharing-tasks.cancelSharingTask.html +1 -1
- package/website/functions/sharing-tasks.configureSharingTasksSettings.html +1 -1
- package/website/functions/sharing-tasks.deleteSharingTask.html +1 -1
- package/website/functions/sharing-tasks.executeSharingTasks.html +1 -1
- package/website/functions/sharing-tasks.getSharingTask.html +2 -2
- package/website/functions/sharing-tasks.getSharingTasks.html +1 -1
- package/website/functions/sharing-tasks.getSharingTasksSettings.html +1 -1
- package/website/functions/sharing-tasks.patchSharingTask.html +1 -1
- package/website/functions/sharing-tasks.updateSharingTasksSettings.html +1 -1
- package/website/interfaces/data-alerts.DataAlertsAPI.html +32 -32
- package/website/interfaces/sharing-tasks.SharingTasksAPI.html +19 -19
- package/website/modules/reloads.html +1 -1
- package/website/types/assistants.CreateAssistantHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantStarterHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadInteractionFeedbackHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadInteractionHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadInteractionReviewHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantStarterFollowupHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantStarterHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantThreadInteractionHttpError.html +2 -2
- package/website/types/assistants.ErrorResponseCode.html +1 -11
- package/website/types/assistants.ErrorResponseCodeCopy.html +11 -1
- package/website/types/assistants.GetAssistantFeedbackHttpError.html +2 -2
- package/website/types/assistants.GetAssistantHttpError.html +2 -2
- package/website/types/assistants.GetAssistantSourcesHttpError.html +2 -2
- package/website/types/assistants.GetAssistantStarterHttpError.html +2 -2
- package/website/types/assistants.GetAssistantStartersHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadInteractionHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadInteractionsHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadsHttpError.html +2 -2
- package/website/types/assistants.GetAssistantsHttpError.html +2 -2
- package/website/types/assistants.InvokeAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.PatchAssistantHttpError.html +2 -2
- package/website/types/assistants.PatchAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.PatchAssistantThreadInteractionFeedbackHttpError.html +2 -2
- package/website/types/assistants.StreamAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.UpdateAssistantStarterFollowupHttpError.html +2 -2
- package/website/types/assistants.UpdateAssistantStarterHttpError.html +2 -2
- package/website/types/reloads.Reload.html +4 -2
- package/website/types/reloads.ReloadRequest.html +4 -2
- package/website/types/reloads.Weight.html +2 -0
- package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
|
@@ -9,16 +9,16 @@
|
|
|
9
9
|
<a href="#getsharingtaskssettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Sharing<wbr/>Tasks<wbr/>Settings</span></a>
|
|
10
10
|
<a href="#patchsharingtask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Sharing<wbr/>Task</span></a>
|
|
11
11
|
<a href="#updatesharingtaskssettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Sharing<wbr/>Tasks<wbr/>Settings</span></a>
|
|
12
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cancelsharingtask"><span>cancel<wbr/>Sharing<wbr/>Task</span><a href="#cancelsharingtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cancelSharingTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.CancelSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>
|
|
13
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.CancelSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>
|
|
12
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cancelsharingtask"><span>cancel<wbr/>Sharing<wbr/>Task</span><a href="#cancelsharingtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cancelSharingTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.CancelSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Requests cancellation of an execution of the specified recurring sharing task.</p>
|
|
13
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.CancelSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests cancellation of an execution of the specified recurring sharing task.</p>
|
|
14
14
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">taskId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The sharing task identifier.</p>
|
|
15
15
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.CancelSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CancelSharingTaskHttpError</p>
|
|
16
16
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-taskid">Param: taskId<a href="#param-taskid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The sharing task identifier.</p>
|
|
17
17
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CancelSharingTaskHttpError</p>
|
|
18
18
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears the cache for sharing-tasks api requests.</p>
|
|
19
19
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the cache for sharing-tasks api requests.</p>
|
|
20
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="configuresharingtaskssettings"><span>configure<wbr/>Sharing<wbr/>Tasks<wbr/>Settings</span><a href="#configuresharingtaskssettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configureSharingTasksSettings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.APISettingsUpload.html" class="tsd-signature-type tsd-kind-type-alias">APISettingsUpload</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.ConfigureSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ConfigureSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates
|
|
21
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.APISettingsUpload.html" class="tsd-signature-type tsd-kind-type-alias">APISettingsUpload</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.ConfigureSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ConfigureSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates
|
|
20
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="configuresharingtaskssettings"><span>configure<wbr/>Sharing<wbr/>Tasks<wbr/>Settings</span><a href="#configuresharingtaskssettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">configureSharingTasksSettings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.APISettingsUpload.html" class="tsd-signature-type tsd-kind-type-alias">APISettingsUpload</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.ConfigureSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ConfigureSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates the settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the <code>TenantAdmin</code> role.</p>
|
|
21
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.APISettingsUpload.html" class="tsd-signature-type tsd-kind-type-alias">APISettingsUpload</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.ConfigureSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ConfigureSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the <code>TenantAdmin</code> role.</p>
|
|
22
22
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/sharing-tasks.APISettingsUpload.html" class="tsd-signature-type tsd-kind-type-alias">APISettingsUpload</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
23
23
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.ConfigureSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ConfigureSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ConfigureSharingTasksSettingsHttpError</p>
|
|
24
24
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
@@ -29,29 +29,29 @@
|
|
|
29
29
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.CreateSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateSharingTaskHttpError</p>
|
|
30
30
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-1">Param: body<a href="#param-body-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
31
31
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateSharingTaskHttpError</p>
|
|
32
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletesharingtask"><span>delete<wbr/>Sharing<wbr/>Task</span><a href="#deletesharingtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteSharingTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.DeleteSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes a sharing task.</p>
|
|
33
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.DeleteSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes a sharing task.</p>
|
|
32
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletesharingtask"><span>delete<wbr/>Sharing<wbr/>Task</span><a href="#deletesharingtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteSharingTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.DeleteSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes a specific sharing task.</p>
|
|
33
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.DeleteSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes a specific sharing task.</p>
|
|
34
34
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">taskId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The sharing task identifier.</p>
|
|
35
35
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.DeleteSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-6">Throws<a href="#throws-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteSharingTaskHttpError</p>
|
|
36
36
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-taskid-1">Param: taskId<a href="#param-taskid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The sharing task identifier.</p>
|
|
37
37
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteSharingTaskHttpError</p>
|
|
38
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="executesharingtasks"><span>execute<wbr/>Sharing<wbr/>Tasks</span><a href="#executesharingtasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">executeSharingTasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingActionsTriggerCreateRequest.html" class="tsd-signature-type tsd-kind-type-alias">SharingActionsTriggerCreateRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.ExecuteSharingTasksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ExecuteSharingTasksHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>
|
|
39
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingActionsTriggerCreateRequest.html" class="tsd-signature-type tsd-kind-type-alias">SharingActionsTriggerCreateRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.ExecuteSharingTasksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ExecuteSharingTasksHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>
|
|
38
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="executesharingtasks"><span>execute<wbr/>Sharing<wbr/>Tasks</span><a href="#executesharingtasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">executeSharingTasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingActionsTriggerCreateRequest.html" class="tsd-signature-type tsd-kind-type-alias">SharingActionsTriggerCreateRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.ExecuteSharingTasksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ExecuteSharingTasksHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Requests execution of the specified recurring sharing task.</p>
|
|
39
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingActionsTriggerCreateRequest.html" class="tsd-signature-type tsd-kind-type-alias">SharingActionsTriggerCreateRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.ExecuteSharingTasksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ExecuteSharingTasksHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests execution of the specified recurring sharing task.</p>
|
|
40
40
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/sharing-tasks.SharingActionsTriggerCreateRequest.html" class="tsd-signature-type tsd-kind-type-alias">SharingActionsTriggerCreateRequest</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
41
41
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.ExecuteSharingTasksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ExecuteSharingTasksHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-8">Throws<a href="#throws-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ExecuteSharingTasksHttpError</p>
|
|
42
42
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-2">Param: body<a href="#param-body-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
43
43
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-9">Throws<a href="#throws-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>ExecuteSharingTasksHttpError</p>
|
|
44
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getsharingtask"><span>get<wbr/>Sharing<wbr/>Task</span><a href="#getsharingtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getSharingTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">isViewChart</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>
|
|
45
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">isViewChart</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>
|
|
44
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getsharingtask"><span>get<wbr/>Sharing<wbr/>Task</span><a href="#getsharingtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getSharingTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">isViewChart</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Returns the details of a specific sharing task.</p>
|
|
45
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">isViewChart</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the details of a specific sharing task.</p>
|
|
46
46
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">taskId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The sharing task identifier.</p>
|
|
47
47
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">isViewChart</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
48
|
-
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">isViewChart</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>
|
|
48
|
+
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">isViewChart</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Determines whether to update the <code>lastViewed</code> property for the sharing task, which is used to determine whether the sharing task is still in use. If set to <code>true</code>, this will be updated to current time.</p>
|
|
49
49
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-10">Throws<a href="#throws-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetSharingTaskHttpError</p>
|
|
50
50
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-taskid-2">Param: taskId<a href="#param-taskid-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The sharing task identifier.</p>
|
|
51
51
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query">Param: query<a href="#param-query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
|
|
52
52
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-11">Throws<a href="#throws-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetSharingTaskHttpError</p>
|
|
53
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getsharingtasks"><span>get<wbr/>Sharing<wbr/>Tasks</span><a href="#getsharingtasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getSharingTasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">appid</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">excludeDeleting</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownername</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-type">"owner"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"recipient"</span>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-appid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"appid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+appid"</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">templateId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart-monitoring"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart-sharing"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sheet-sharing"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"template-sharing"</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTasksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTasksHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>
|
|
54
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">appid</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">excludeDeleting</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownername</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-type">"owner"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"recipient"</span>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-appid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"appid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+appid"</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">templateId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart-monitoring"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart-sharing"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sheet-sharing"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"template-sharing"</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTasksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTasksHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>
|
|
53
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getsharingtasks"><span>get<wbr/>Sharing<wbr/>Tasks</span><a href="#getsharingtasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getSharingTasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">appid</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">excludeDeleting</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownername</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-type">"owner"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"recipient"</span>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-appid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"appid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+appid"</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">templateId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart-monitoring"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart-sharing"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sheet-sharing"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"template-sharing"</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTasksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTasksHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves all sharing tasks accessible to the user. Users assigned the <code>TenantAdmin</code> or <code>AnalyticsAdmin</code> role can view all tasks.</p>
|
|
54
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">appid</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">excludeDeleting</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownername</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-type">"owner"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"recipient"</span>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-appid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"appid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+appid"</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">templateId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart-monitoring"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart-sharing"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sheet-sharing"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"template-sharing"</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTasksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTasksHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves all sharing tasks accessible to the user. Users assigned the <code>TenantAdmin</code> or <code>AnalyticsAdmin</code> role can view all tasks.</p>
|
|
55
55
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">appid</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">excludeDeleting</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownername</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-type">"owner"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"recipient"</span>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+datecreated"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+ownername"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+enabled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-type"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+sent"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+scheduled"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+appname"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-appid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"appid"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+appid"</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">templateId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> (<br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart-monitoring"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"chart-sharing"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"sheet-sharing"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"template-sharing"</span><br/> )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
56
56
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">appid</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the filter by sharing task resource app id. TenantAdmin users may omit this parameter to list all sharing-tasks in the tenant.</p>
|
|
57
57
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">excludeDeleting</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Indicates if task with the status DELETING should be excluded from the list</p>
|
|
@@ -69,20 +69,20 @@
|
|
|
69
69
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTasksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTasksHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-12">Throws<a href="#throws-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetSharingTasksHttpError</p>
|
|
70
70
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-1">Param: query<a href="#param-query-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
|
|
71
71
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-13">Throws<a href="#throws-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetSharingTasksHttpError</p>
|
|
72
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getsharingtaskssettings"><span>get<wbr/>Sharing<wbr/>Tasks<wbr/>Settings</span><a href="#getsharingtaskssettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getSharingTasksSettings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>
|
|
73
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>
|
|
72
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getsharingtaskssettings"><span>get<wbr/>Sharing<wbr/>Tasks<wbr/>Settings</span><a href="#getsharingtaskssettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getSharingTasksSettings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the current settings for sharing tasks, reports, and other related configuration.</p>
|
|
73
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the current settings for sharing tasks, reports, and other related configuration.</p>
|
|
74
74
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.GetSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-14">Throws<a href="#throws-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetSharingTasksSettingsHttpError</p>
|
|
75
75
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-15">Throws<a href="#throws-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetSharingTasksSettingsHttpError</p>
|
|
76
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchsharingtask"><span>patch<wbr/>Sharing<wbr/>Task</span><a href="#patchsharingtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">patchSharingTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingTaskPatchRequestCompliantList.html" class="tsd-signature-type tsd-kind-type-alias">SharingTaskPatchRequestCompliantList</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.PatchSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates
|
|
77
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingTaskPatchRequestCompliantList.html" class="tsd-signature-type tsd-kind-type-alias">SharingTaskPatchRequestCompliantList</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.PatchSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates
|
|
76
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchsharingtask"><span>patch<wbr/>Sharing<wbr/>Task</span><a href="#patchsharingtask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">patchSharingTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingTaskPatchRequestCompliantList.html" class="tsd-signature-type tsd-kind-type-alias">SharingTaskPatchRequestCompliantList</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.PatchSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates one or more properties of a specific sharing task.</p>
|
|
77
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">taskId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingTaskPatchRequestCompliantList.html" class="tsd-signature-type tsd-kind-type-alias">SharingTaskPatchRequestCompliantList</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.PatchSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates one or more properties of a specific sharing task.</p>
|
|
78
78
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">taskId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The sharing task identifier.</p>
|
|
79
79
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/sharing-tasks.SharingTaskPatchRequestCompliantList.html" class="tsd-signature-type tsd-kind-type-alias">SharingTaskPatchRequestCompliantList</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
80
80
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.PatchSharingTaskHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchSharingTaskHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-16">Throws<a href="#throws-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchSharingTaskHttpError</p>
|
|
81
81
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-taskid-3">Param: taskId<a href="#param-taskid-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The sharing task identifier.</p>
|
|
82
82
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-3">Param: body<a href="#param-body-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
83
83
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-17">Throws<a href="#throws-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchSharingTaskHttpError</p>
|
|
84
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatesharingtaskssettings"><span>update<wbr/>Sharing<wbr/>Tasks<wbr/>Settings</span><a href="#updatesharingtaskssettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">updateSharingTasksSettings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingSettingsPatchCompliantList.html" class="tsd-signature-type tsd-kind-type-alias">SharingSettingsPatchCompliantList</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.UpdateSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Patches sharing
|
|
85
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingSettingsPatchCompliantList.html" class="tsd-signature-type tsd-kind-type-alias">SharingSettingsPatchCompliantList</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.UpdateSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Patches sharing
|
|
84
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatesharingtaskssettings"><span>update<wbr/>Sharing<wbr/>Tasks<wbr/>Settings</span><a href="#updatesharingtaskssettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">updateSharingTasksSettings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingSettingsPatchCompliantList.html" class="tsd-signature-type tsd-kind-type-alias">SharingSettingsPatchCompliantList</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.UpdateSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the <code>TenantAdmin</code> role.</p>
|
|
85
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/sharing-tasks.SharingSettingsPatchCompliantList.html" class="tsd-signature-type tsd-kind-type-alias">SharingSettingsPatchCompliantList</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.UpdateSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the <code>TenantAdmin</code> role.</p>
|
|
86
86
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/sharing-tasks.SharingSettingsPatchCompliantList.html" class="tsd-signature-type tsd-kind-type-alias">SharingSettingsPatchCompliantList</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
87
87
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/sharing-tasks.UpdateSharingTasksSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateSharingTasksSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-18">Throws<a href="#throws-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>UpdateSharingTasksSettingsHttpError</p>
|
|
88
88
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-4">Param: body<a href="#param-body-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|