@qlik/api 1.41.0 → 1.43.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.d.ts +2 -2
- package/api-keys.js +3 -3
- package/apps.d.ts +2 -2
- package/apps.js +3 -3
- package/assistants.d.ts +2 -2
- package/assistants.js +3 -3
- package/audits.d.ts +3 -3
- package/audits.js +17 -4
- package/auth-types.d.ts +1 -1
- package/auth-types.js +1 -1
- package/auth.d.ts +2 -2
- package/auth.js +2 -2
- package/automation-connections.d.ts +2 -2
- package/automation-connections.js +3 -3
- package/automations.d.ts +3 -3
- package/automations.js +3 -3
- package/automl-deployments.d.ts +2 -2
- package/automl-deployments.js +5 -3
- package/automl-predictions.d.ts +2 -2
- package/automl-predictions.js +15 -3
- package/brands.d.ts +2 -2
- package/brands.js +3 -3
- package/chunks/{api-keys-CI44OuNR.d.ts → api-keys-C-ZqA-wl.d.ts} +1 -1
- package/chunks/{apps-BiGof9WJ.d.ts → apps-CJH5JjKB.d.ts} +1 -1
- package/chunks/{assistants-CDtI99Yr.d.ts → assistants-BsDbpzl4.d.ts} +7 -1
- package/chunks/{audits-C-UDFprK.d.ts → audits-5CBpwcdx.d.ts} +24 -2
- package/chunks/{auth-DhI7LQIw.js → auth-CCj082fh.js} +4 -4
- package/chunks/{auth-B5Hx9GeQ.d.ts → auth-DFOXWfqh.d.ts} +3 -3
- package/chunks/{auth-DBrXfv7D.js → auth-IDN6Z4Nr.js} +2 -2
- package/chunks/{auth-functions-DHRxWU6t.js → auth-functions-CZbgZARw.js} +72 -24
- package/chunks/{auth-types-BlCWK0FP.d.ts → auth-types-B1c_1Nca.d.ts} +4 -1
- package/chunks/{automation-connections-keN9CuNO.d.ts → automation-connections-DRQDgw7Q.d.ts} +1 -1
- package/chunks/{automations-CFRnQ8sX.d.ts → automations-arVbySrW.d.ts} +13 -4
- package/chunks/{automl-deployments-D05clUGa.d.ts → automl-deployments-B-WuR_zE.d.ts} +5 -1
- package/chunks/{automl-predictions-Ddp6PdpE.d.ts → automl-predictions-CewW0eZn.d.ts} +25 -1
- package/chunks/{brands-hEcnkdfg.d.ts → brands-C4eALPrs.d.ts} +1 -1
- package/chunks/{collections-CuX8Cp8Z.d.ts → collections-Djmd9gof.d.ts} +1 -1
- package/chunks/{conditions-DUmPB4Ej.d.ts → conditions-BRDxUbgu.d.ts} +1 -1
- package/chunks/{consumption-CSptDhk9.d.ts → consumption-UNw8R7jN.d.ts} +1 -1
- package/chunks/{csp-origins-v_UyOSK9.d.ts → csp-origins-_4HBSdgU.d.ts} +1 -1
- package/chunks/{csrf-token-DZK6GX6Z.d.ts → csrf-token-CsvbqXyY.d.ts} +1 -1
- package/chunks/{data-alerts-DwPcCvHP.d.ts → data-alerts-DSV3VOnW.d.ts} +1 -1
- package/chunks/{data-assets-BPMOGSO7.d.ts → data-assets-C3U3T_lj.d.ts} +1 -1
- package/chunks/{data-connections-DK1AhSi4.d.ts → data-connections-BYNfX1Fl.d.ts} +1 -1
- package/chunks/{data-credentials-BDCHbRwM.d.ts → data-credentials-CgCjw_Cn.d.ts} +1 -1
- package/chunks/{data-files-D7mlQnrw.d.ts → data-files-DH19MfYE.d.ts} +1 -1
- package/chunks/{data-qualities-Z554f_p6.d.ts → data-qualities-BogHQw4I.d.ts} +1 -1
- package/chunks/{data-sets-AcCLu1zw.d.ts → data-sets-B27GmshO.d.ts} +1 -1
- package/chunks/{data-sources-DNnmr1Qi.d.ts → data-sources-D_TRdWV-.d.ts} +5 -1
- package/chunks/{data-stores-Bofu7fl5.d.ts → data-stores-BjfzMp9W.d.ts} +1 -1
- package/chunks/{dcaas-DK4f7Rrs.d.ts → dcaas-A7hfpAI5.d.ts} +1 -1
- package/chunks/{di-projects-uem8xKkX.d.ts → di-projects-mdshgyFv.d.ts} +70 -13
- package/chunks/{direct-access-agents-BbSiWlMD.d.ts → direct-access-agents-CfUpbi73.d.ts} +74 -5
- package/chunks/{dist-CjqdvDf3.js → dist-UZqmL_Q6.js} +15 -10
- package/chunks/{encryption-CMJWtMcm.d.ts → encryption-CjBmNQDZ.d.ts} +1 -1
- package/chunks/{extensions-Ct2JAsbk.d.ts → extensions-D05y2FWk.d.ts} +1 -1
- package/chunks/global-types-BGMD2sDY.js +1 -0
- package/chunks/{glossaries-Drx-EwiU.d.ts → glossaries-vYbykU3r.d.ts} +1 -1
- package/chunks/{groups-C-R5oUEa.d.ts → groups-BapgngJf.d.ts} +1 -1
- package/chunks/{identity-providers-Bj88evsO.d.ts → identity-providers-CAxsp9hP.d.ts} +1 -1
- package/chunks/{interceptors-e6hoYE8W.d.ts → interceptors-BF556LaK.d.ts} +1 -1
- package/chunks/{interceptors-DD0vKL8_.js → interceptors-DBoV6UkN.js} +1 -1
- package/chunks/{invoke-fetch-B-ZucHu9.js → invoke-fetch-09EW5w1d.js} +3 -3
- package/chunks/{invoke-fetch-NdtGGVxy.js → invoke-fetch-fXOUPARi.js} +4 -4
- package/chunks/{items-BnN6gI0J.d.ts → items-CjVrNg57.d.ts} +1 -1
- package/chunks/{knowledgebases-tmPZVD6i.d.ts → knowledgebases-BFiV7Fwh.d.ts} +1 -1
- package/chunks/{licenses-DAPVQuFJ.d.ts → licenses-yZKgQ2k6.d.ts} +1 -1
- package/chunks/{lineage-graphs-Q4LiGGtL.d.ts → lineage-graphs-Bkc04N-t.d.ts} +1 -1
- package/chunks/{ml-C80TkK1J.d.ts → ml-CABYvU_L.d.ts} +8 -14
- package/chunks/{notes-CHvadRai.d.ts → notes-C5HjmBeI.d.ts} +1 -1
- package/chunks/{notifications-BhS8s4Eo.d.ts → notifications-DfP7aWPH.d.ts} +1 -1
- package/chunks/{oauth-clients-D1f8xiFC.d.ts → oauth-clients-BmMEDuET.d.ts} +1 -1
- package/chunks/{oauth-tokens-DteoDifd.d.ts → oauth-tokens-Dimf19DE.d.ts} +1 -1
- package/chunks/{public-runtime-modules-lsJEDVxt.js → public-runtime-modules-P9LEbn8i.js} +3 -3
- package/chunks/{qix-J4MO8SAa.d.ts → qix-C1WaB-67.d.ts} +3 -18
- package/chunks/{qix-CwYrlHFT.js → qix-C86sBDw3.js} +1 -1
- package/chunks/{qix-bnv1_Kxc.js → qix-Ds6X5svJ.js} +6 -6
- package/chunks/{qix-chunk-entrypoint-ByJzCY0D.js → qix-chunk-entrypoint-CpkRq84_.js} +427 -90
- package/chunks/{questions-BiR5-mZ4.d.ts → questions-CFN7BgWt.d.ts} +1 -1
- package/chunks/{quotas-GTQL9uPt.d.ts → quotas-BUH2e2K_.d.ts} +1 -1
- package/chunks/{reload-tasks-CmXJp5va.d.ts → reload-tasks-DN3X2-30.d.ts} +1 -1
- package/chunks/{reloads-3XgvVnbq.d.ts → reloads-ClLQO7Vt.d.ts} +1 -1
- package/chunks/{report-templates-BowaTti4.d.ts → report-templates-D5KOFkRi.d.ts} +1 -1
- package/chunks/{reports-oosnUaFo.d.ts → reports-CRwCogRL.d.ts} +94 -3
- package/chunks/{roles-D93ENaRt.d.ts → roles-DCzyiLdU.d.ts} +1 -1
- package/chunks/{sharing-tasks-BMDAjWTj.d.ts → sharing-tasks-DsxFrADQ.d.ts} +1 -1
- package/chunks/{spaces-DZI6zKZi.d.ts → spaces-B0cx23Nc.d.ts} +4 -4
- package/chunks/{tasks-BWmS6L8Y.d.ts → tasks-DWfE5JM_.d.ts} +1 -1
- package/chunks/{temp-contents-CZVb5P0V.d.ts → temp-contents-CU94UTZU.d.ts} +1 -1
- package/chunks/{tenants-BDH4DmcO.d.ts → tenants-DvtbiwAP.d.ts} +1 -1
- package/chunks/{themes-BkubWfOE.d.ts → themes-BPkyCLWS.d.ts} +1 -1
- package/chunks/{transports-CO9kRJg5.d.ts → transports-DlRmSWLj.d.ts} +1 -1
- package/chunks/{ui-config-DIOnLEV9.d.ts → ui-config-BqX-bPjf.d.ts} +1 -1
- package/chunks/{users-DM-ZfzQB.d.ts → users-CuQ0nboa.d.ts} +1 -1
- package/chunks/{utils-qEQ6sEXX.js → utils-CAGXTaqJ.js} +14 -1
- package/chunks/{web-integrations-BjVMC88M.d.ts → web-integrations-D54LCd0Z.d.ts} +1 -1
- package/chunks/{web-notifications-D-eA8h1I.d.ts → web-notifications-sUlHGnmy.d.ts} +1 -1
- package/chunks/{webhooks-Dytyr5nk.d.ts → webhooks-Dw0FIeFq.d.ts} +1 -1
- package/collections.d.ts +2 -2
- package/collections.js +3 -3
- package/conditions.d.ts +2 -2
- package/conditions.js +3 -3
- package/consumption.d.ts +2 -2
- package/consumption.js +3 -3
- package/csp-origins.d.ts +2 -2
- package/csp-origins.js +3 -3
- package/csrf-token.d.ts +2 -2
- package/csrf-token.js +3 -3
- package/data-alerts.d.ts +2 -2
- package/data-alerts.js +3 -3
- package/data-assets.d.ts +2 -2
- package/data-assets.js +3 -3
- package/data-connections.d.ts +2 -2
- package/data-connections.js +3 -3
- package/data-credentials.d.ts +2 -2
- package/data-credentials.js +3 -3
- package/data-files.d.ts +2 -2
- package/data-files.js +3 -3
- package/data-qualities.d.ts +2 -2
- package/data-qualities.js +3 -3
- package/data-sets.d.ts +2 -2
- package/data-sets.js +3 -3
- package/data-sources.d.ts +2 -2
- package/data-sources.js +4 -3
- package/data-stores.d.ts +2 -2
- package/data-stores.js +3 -3
- package/dcaas.d.ts +2 -2
- package/dcaas.js +3 -3
- package/di-projects.d.ts +3 -3
- package/di-projects.js +4 -4
- package/direct-access-agents.d.ts +3 -3
- package/direct-access-agents.js +46 -5
- package/docs/authentication.md +65 -1
- package/docs/rest.md +1 -1
- package/encryption.d.ts +2 -2
- package/encryption.js +3 -3
- package/extensions.d.ts +2 -2
- package/extensions.js +3 -3
- package/global-types.d.ts +1 -1
- package/global-types.js +3 -1
- package/glossaries.d.ts +2 -2
- package/glossaries.js +3 -3
- package/groups.d.ts +2 -2
- package/groups.js +3 -3
- package/identity-providers.d.ts +2 -2
- package/identity-providers.js +3 -3
- package/index.d.ts +63 -63
- package/index.js +74 -69
- package/interceptors.d.ts +2 -2
- package/interceptors.js +2 -2
- package/invoke-fetch-types.d.ts +1 -1
- package/items.d.ts +2 -2
- package/items.js +3 -3
- package/knowledgebases.d.ts +2 -2
- package/knowledgebases.js +3 -3
- package/licenses.d.ts +2 -2
- package/licenses.js +3 -3
- package/lineage-graphs.d.ts +2 -2
- package/lineage-graphs.js +3 -3
- package/ml.d.ts +3 -3
- package/ml.js +4 -4
- package/notes.d.ts +2 -2
- package/notes.js +3 -3
- package/notifications.d.ts +2 -2
- package/notifications.js +3 -3
- package/oauth-clients.d.ts +2 -2
- package/oauth-clients.js +3 -3
- package/oauth-tokens.d.ts +2 -2
- package/oauth-tokens.js +3 -3
- package/package.json +2 -2
- package/qix.d.ts +4 -4
- package/qix.js +2 -2
- package/questions.d.ts +2 -2
- package/questions.js +3 -3
- package/quotas.d.ts +2 -2
- package/quotas.js +3 -3
- package/reload-tasks.d.ts +2 -2
- package/reload-tasks.js +3 -3
- package/reloads.d.ts +2 -2
- package/reloads.js +3 -3
- package/report-templates.d.ts +2 -2
- package/report-templates.js +3 -3
- package/reports.d.ts +3 -3
- package/reports.js +22 -4
- package/roles.d.ts +2 -2
- package/roles.js +3 -3
- package/sharing-tasks.d.ts +2 -2
- package/sharing-tasks.js +3 -3
- package/spaces.d.ts +2 -2
- package/spaces.js +3 -3
- package/tasks.d.ts +2 -2
- package/tasks.js +3 -3
- package/temp-contents.d.ts +2 -2
- package/temp-contents.js +3 -3
- package/tenants.d.ts +2 -2
- package/tenants.js +3 -3
- package/themes.d.ts +2 -2
- package/themes.js +3 -3
- package/transports.d.ts +2 -2
- package/transports.js +3 -3
- package/ui-config.d.ts +2 -2
- package/ui-config.js +3 -3
- package/users.d.ts +2 -2
- package/users.js +3 -3
- package/web-integrations.d.ts +2 -2
- package/web-integrations.js +3 -3
- package/web-notifications.d.ts +2 -2
- package/web-notifications.js +3 -3
- package/webhooks.d.ts +2 -2
- package/webhooks.js +3 -3
- package/website/assets/navigation.js +1 -1
- package/website/assets/search.js +1 -1
- package/website/functions/audits.fetchConsumptionAppAudits.html +3 -0
- package/website/functions/auth.setDefaultHostConfig.html +1 -1
- package/website/functions/automations.getAutomationsUsageMetrics.html +5 -1
- package/website/functions/automations.updateAutomation.html +2 -2
- package/website/functions/automl-deployments.createAutomlDeploymentRealtimePrediction.html +3 -3
- package/website/functions/automl-predictions.createAutomlPredictionJob.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionCoordinateShap.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionNotPredictedReasons.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionPredictions.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionShap.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionSource.html +3 -3
- package/website/functions/data-sources.getDataSources.html +4 -3
- package/website/functions/di-projects.getDiProjectDiTaskRuntimeState.html +1 -1
- package/website/functions/direct-access-agents.getDirectAccessAgentConnectorCustomDataTypeMappings.html +1 -1
- package/website/functions/direct-access-agents.getDirectAccessAgentConnectorFilesAllowedPaths.html +5 -0
- package/website/functions/direct-access-agents.putDirectAccessAgentConnectorFilesAllowedPaths.html +6 -0
- package/website/functions/ml.getMlDeploymentAliases.html +2 -1
- package/website/functions/reports.getReportOutputs.html +13 -0
- package/website/interfaces/api-keys.ApiKeysAPI.html +8 -8
- package/website/interfaces/apps.AppsAPI.html +45 -45
- package/website/interfaces/assistants.AssistantsAPI.html +29 -29
- package/website/interfaces/audits.AuditsAPI.html +27 -22
- package/website/interfaces/auth.AuthAPI.html +7 -7
- package/website/interfaces/automation-connections.AutomationConnectionsAPI.html +9 -9
- package/website/interfaces/automations.AutomationsAPI.html +29 -25
- package/website/interfaces/automl-deployments.AutomlDeploymentsAPI.html +7 -7
- package/website/interfaces/automl-predictions.AutomlPredictionsAPI.html +37 -37
- package/website/interfaces/brands.BrandsAPI.html +13 -13
- package/website/interfaces/collections.CollectionsAPI.html +12 -12
- package/website/interfaces/conditions.ConditionsAPI.html +12 -12
- package/website/interfaces/consumption.ConsumptionAPI.html +2 -2
- package/website/interfaces/csp-origins.CspOriginsAPI.html +7 -7
- package/website/interfaces/csrf-token.CsrfTokenAPI.html +2 -2
- package/website/interfaces/data-alerts.DataAlertsAPI.html +17 -17
- package/website/interfaces/data-assets.DataAssetsAPI.html +6 -6
- package/website/interfaces/data-connections.DataConnectionsAPI.html +10 -10
- package/website/interfaces/data-credentials.DataCredentialsAPI.html +6 -6
- package/website/interfaces/data-files.DataFilesAPI.html +13 -13
- package/website/interfaces/data-qualities.DataQualitiesAPI.html +4 -4
- package/website/interfaces/data-sets.DataSetsAPI.html +7 -7
- package/website/interfaces/data-sources.DataSourcesAPI.html +10 -9
- package/website/interfaces/data-stores.DataStoresAPI.html +11 -11
- package/website/interfaces/dcaas.DcaasAPI.html +4 -4
- package/website/interfaces/di-projects.DiProjectsAPI.html +18 -18
- package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +58 -38
- package/website/interfaces/encryption.EncryptionAPI.html +11 -11
- package/website/interfaces/extensions.ExtensionsAPI.html +8 -8
- package/website/interfaces/glossaries.GlossariesAPI.html +25 -25
- package/website/interfaces/groups.GroupsAPI.html +9 -9
- package/website/interfaces/identity-providers.IdentityProvidersAPI.html +9 -9
- package/website/interfaces/interceptors.InterceptorsAPI.html +3 -3
- package/website/interfaces/items.ItemsAPI.html +9 -9
- package/website/interfaces/knowledgebases.KnowledgebasesAPI.html +18 -18
- package/website/interfaces/licenses.LicensesAPI.html +10 -10
- package/website/interfaces/lineage-graphs.LineageGraphsAPI.html +9 -9
- package/website/interfaces/ml.MlAPI.html +48 -46
- package/website/interfaces/notes.NotesAPI.html +3 -3
- package/website/interfaces/notifications.NotificationsAPI.html +2 -2
- package/website/interfaces/oauth-clients.OauthClientsAPI.html +12 -12
- package/website/interfaces/oauth-tokens.OauthTokensAPI.html +3 -3
- package/website/interfaces/qix.GenericObject.html +1 -1
- package/website/interfaces/questions.QuestionsAPI.html +3 -3
- package/website/interfaces/quotas.QuotasAPI.html +3 -3
- package/website/interfaces/reload-tasks.ReloadTasksAPI.html +6 -6
- package/website/interfaces/reloads.ReloadsAPI.html +5 -5
- package/website/interfaces/report-templates.ReportTemplatesAPI.html +8 -8
- package/website/interfaces/reports.ReportsAPI.html +26 -8
- package/website/interfaces/roles.RolesAPI.html +6 -6
- package/website/interfaces/sharing-tasks.SharingTasksAPI.html +14 -14
- package/website/interfaces/spaces.SpacesAPI.html +18 -18
- package/website/interfaces/tasks.TasksAPI.html +11 -11
- package/website/interfaces/temp-contents.TempContentsAPI.html +4 -4
- package/website/interfaces/tenants.TenantsAPI.html +7 -7
- package/website/interfaces/themes.ThemesAPI.html +8 -8
- package/website/interfaces/transports.TransportsAPI.html +7 -7
- package/website/interfaces/ui-config.UiConfigAPI.html +8 -8
- package/website/interfaces/users.UsersAPI.html +10 -10
- package/website/interfaces/web-integrations.WebIntegrationsAPI.html +6 -6
- package/website/interfaces/web-notifications.WebNotificationsAPI.html +7 -7
- package/website/interfaces/webhooks.WebhooksAPI.html +11 -11
- package/website/modules/audits.html +1 -1
- package/website/modules/auth.html +1 -1
- package/website/modules/automations.html +1 -1
- package/website/modules/automl-deployments.html +1 -1
- package/website/modules/automl-predictions.html +1 -1
- package/website/modules/di-projects.html +1 -1
- package/website/modules/direct-access-agents.html +1 -1
- package/website/modules/ml.html +1 -1
- package/website/modules/qix.html +1 -1
- package/website/modules/reports.html +1 -1
- package/website/types/api-keys.Error.html +1 -1
- package/website/types/apps.Error.html +1 -1
- package/website/types/apps.Evaluation.html +1 -1
- package/website/types/apps.RecommendItems.html +1 -1
- package/website/types/apps.RecommendedAnalysis.html +1 -1
- package/website/types/assistants.Assistant.html +4 -2
- package/website/types/assistants.CreateAssistant.html +4 -2
- package/website/types/assistants.CreateAssistantWithAvatar.html +4 -2
- package/website/types/assistants.PromptInput.html +1 -1
- package/website/types/audits.EventExtensions.html +1 -1
- package/website/types/audits.FetchConsumptionAppAuditsHttpError.html +4 -0
- package/website/types/audits.FetchConsumptionAppAuditsHttpResponse.html +4 -0
- package/website/types/audits.GetSettingsResult.html +1 -1
- package/website/types/automations.AutomationDetailUpdateRequestObject.html +6 -0
- package/website/types/automations.CopyAutomationHttpResponse.html +1 -1
- package/website/types/automations.RunDetailResponseObject.html +1 -1
- package/website/types/automl-deployments.Error.html +1 -1
- package/website/types/automl-predictions.Error.html +1 -1
- package/website/types/collections.CollectionByIdPatch.html +1 -1
- package/website/types/csp-origins.CSPEntry.html +1 -1
- package/website/types/data-alerts.AlertingExecutionListResponse.html +1 -1
- package/website/types/data-alerts.AlertingTaskListResponse.html +1 -1
- package/website/types/data-connections.ActionDeleteRequest.html +1 -1
- package/website/types/data-connections.ActionUpdateRequest.html +1 -1
- package/website/types/data-connections.BulkResponse.html +1 -1
- package/website/types/data-connections.Link.html +1 -1
- package/website/types/data-connections.PatchRequest.html +1 -1
- package/website/types/data-connections.TopLevelLink.html +3 -3
- package/website/types/data-credentials.Link.html +1 -1
- package/website/types/data-credentials.PatchRequest.html +1 -1
- package/website/types/data-qualities.DataQualityComputationRequest.html +1 -1
- package/website/types/data-sources.GetDataSourceGatewaysHttpResponse.html +1 -1
- package/website/types/data-sources.QriDefinition.html +2 -2
- package/website/types/di-projects.AsyncActionDetails.html +1 -1
- package/website/types/di-projects.DataTaskInstanceState.html +29 -2
- package/website/types/di-projects.DataTaskRuntimeState.html +6 -0
- package/website/types/di-projects.DataTaskType.html +1 -1
- package/website/types/di-projects.GetDiExportProjectVariablesRsp.html +3 -2
- package/website/types/di-projects.GetDiProjectDiTaskRuntimeStateHttpResponse.html +2 -2
- package/website/types/direct-access-agents.FileConnectorAllowedPath.html +5 -0
- package/website/types/direct-access-agents.FileConnectorAllowedPathsResponse.html +3 -0
- package/website/types/direct-access-agents.GetDirectAccessAgentConnectorFilesAllowedPathsHttpError.html +4 -0
- package/website/types/direct-access-agents.GetDirectAccessAgentConnectorFilesAllowedPathsHttpResponse.html +4 -0
- package/website/types/direct-access-agents.Operation.html +2 -2
- package/website/types/direct-access-agents.PutDirectAccessAgentConnectorFilesAllowedPathsHttpError.html +4 -0
- package/website/types/direct-access-agents.PutDirectAccessAgentConnectorFilesAllowedPathsHttpResponse.html +4 -0
- package/website/types/direct-access-agents.UpdateFileConnectorAllowedPathsRequest.html +3 -0
- package/website/types/direct-access-agents.UpdateOdbcCustomTypeMappingsRequest.html +2 -1
- package/website/types/encryption.KeyProvider.html +1 -1
- package/website/types/global-types.PerformInteractiveLoginFn.html +1 -1
- package/website/types/groups.AssignedRoles.html +1 -1
- package/website/types/groups.AssignedRolesRefIDs.html +1 -1
- package/website/types/groups.AssignedRolesRefNames.html +1 -1
- package/website/types/groups.Error.html +1 -1
- package/website/types/identity-providers.CreateJWTAuthPayload.html +1 -1
- package/website/types/identity-providers.CreateOIDCPayload.html +2 -2
- package/website/types/identity-providers.CreateSAMLPayload.html +2 -2
- package/website/types/identity-providers.Error.html +1 -1
- package/website/types/identity-providers.IDPOIDC.html +1 -1
- package/website/types/identity-providers.IDPSAML.html +1 -1
- package/website/types/identity-providers.IDPsStatus.html +1 -1
- package/website/types/identity-providers.Links.html +3 -3
- package/website/types/identity-providers.PendingResult.html +1 -1
- package/website/types/interceptors.RestInterceptor.html +1 -1
- package/website/types/invoke-fetch-types.DownloadableBlob.html +1 -1
- package/website/types/items.ItemsSettingsPatch.html +1 -1
- package/website/types/licenses.AssignmentsActionsAddRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsAddResponse.html +1 -1
- package/website/types/licenses.AssignmentsActionsDeleteRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsDeleteResponse.html +1 -1
- package/website/types/licenses.AssignmentsActionsUpdateRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsUpdateResponse.html +1 -1
- package/website/types/licenses.AssignmentsResponse.html +1 -1
- package/website/types/licenses.ConsumptionEventsResponse.html +1 -1
- package/website/types/licenses.ErrorResponse.html +1 -1
- package/website/types/licenses.LicenseOverview.html +2 -2
- package/website/types/lineage-graphs.ErrorResponse500.html +1 -1
- package/website/types/lineage-graphs.Graph.html +1 -1
- package/website/types/lineage-graphs.Node.html +1 -1
- package/website/types/ml.APIError.html +1 -1
- package/website/types/ml.AliasFindResponse.html +1 -1
- package/website/types/ml.AliasGetResponse.html +1 -1
- package/website/types/ml.AliasPostResponse.html +1 -1
- package/website/types/ml.BatchPredictionActionResponse.html +1 -1
- package/website/types/ml.BatchPredictionFindResponse.html +1 -1
- package/website/types/ml.BatchPredictionGetResponse.html +1 -1
- package/website/types/ml.BatchPredictionPatch.html +1 -1
- package/website/types/ml.BatchPredictionPostResponse.html +1 -1
- package/website/types/ml.BatchPredictionScheduleGetResponse.html +1 -1
- package/website/types/ml.BatchPredictionScheduleInput.html +1 -1
- package/website/types/ml.BatchPredictionSchedulePatch.html +1 -1
- package/website/types/ml.BatchPredictionSchedulePutResponse.html +1 -1
- package/website/types/ml.DeploymentFindResponse.html +1 -1
- package/website/types/ml.DeploymentGetResponse.html +1 -1
- package/website/types/ml.DeploymentPatch.html +1 -1
- package/website/types/ml.DeploymentPostResponse.html +1 -1
- package/website/types/ml.ExperimentFindResponse.html +1 -1
- package/website/types/ml.ExperimentGetResponse.html +1 -1
- package/website/types/ml.ExperimentInput.html +1 -1
- package/website/types/ml.ExperimentModelRecommendationPostResponse.html +1 -1
- package/website/types/ml.ExperimentPostResponse.html +1 -1
- package/website/types/ml.ExperimentType.html +1 -1
- package/website/types/ml.ExperimentVersionFindResponse.html +1 -1
- package/website/types/ml.ExperimentVersionGetResponse.html +1 -1
- package/website/types/ml.ExperimentVersionPatch.html +1 -1
- package/website/types/ml.ExperimentVersionPostResponse.html +1 -1
- package/website/types/ml.Insights.html +1 -1
- package/website/types/ml.ModelAlgorithm.html +1 -1
- package/website/types/ml.ModelAlgorithmAbbreviation.html +1 -1
- package/website/types/ml.ModelFindResponse.html +1 -1
- package/website/types/ml.ModelGetResponse.html +1 -1
- package/website/types/ml.Pipeline.html +2 -3
- package/website/types/ml.ProfileInsights.html +1 -1
- package/website/types/ml.ProfileInsightsGetResponse.html +1 -1
- package/website/types/ml.ProfileInsightsInput.html +1 -1
- package/website/types/ml.ResponseLinks.html +5 -5
- package/website/types/notifications.NotificationItem.html +1 -1
- package/website/types/oauth-clients.ClientSecrets.html +1 -1
- package/website/types/oauth-clients.OAuthClientAdminListItem.html +1 -1
- package/website/types/oauth-clients.OAuthClientAdminReadResponse.html +1 -1
- package/website/types/oauth-clients.OAuthClientCreateRequest.html +1 -1
- package/website/types/oauth-clients.OAuthClientCreateResponse.html +1 -1
- package/website/types/oauth-clients.OAuthClientReadResponse.html +1 -1
- package/website/types/qix.BookmarkList.html +3 -6
- package/website/types/qix.BookmarkListDef.html +2 -5
- package/website/types/qix.DocAction.html +1 -1
- package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
- package/website/types/qix.RpcObject.html +1 -1
- package/website/types/qix.UndoInfoObject.html +1 -1
- package/website/types/qix.UseAppHook.html +1 -1
- package/website/types/questions.Error.html +1 -1
- package/website/types/questions.NLMetricsResponse.html +1 -1
- package/website/types/quotas.Quota.html +1 -1
- package/website/types/reload-tasks.PostTaskBody.html +1 -1
- package/website/types/reload-tasks.PutTaskBody.html +1 -1
- package/website/types/reload-tasks.Task.html +1 -1
- package/website/types/reports.CreateReportHttpResponse.html +2 -2
- package/website/types/reports.GetReportOutputsHttpError.html +4 -0
- package/website/types/reports.GetReportOutputsHttpResponse.html +6 -0
- package/website/types/reports.LinkResponse.html +2 -0
- package/website/types/reports.LinksResponse.html +7 -0
- package/website/types/reports.OutputList.html +4 -0
- package/website/types/reports.OutputListItem.html +13 -0
- package/website/types/reports.PdfOutput.html +1 -1
- package/website/types/reports.PostReportsResponse.html +7 -0
- package/website/types/roles.Error.html +1 -1
- package/website/types/sharing-tasks.SharingExecutionListResponse.html +1 -1
- package/website/types/sharing-tasks.SharingTaskRecurringListResponse.html +1 -1
- package/website/types/sharing-tasks.SharingTaskRecurringResponse.html +1 -1
- package/website/types/spaces.Assignments.html +1 -1
- package/website/types/spaces.Error.html +1 -1
- package/website/types/spaces.Errors.html +1 -1
- package/website/types/spaces.SharePatch.html +1 -1
- package/website/types/spaces.ShareRoleType.html +2 -2
- package/website/types/spaces.Shares.html +1 -1
- package/website/types/spaces.Space.html +1 -1
- package/website/types/spaces.SpacePatch.html +1 -1
- package/website/types/spaces.Spaces.html +1 -1
- package/website/types/tasks.Action.html +1 -1
- package/website/types/tasks.Crondef.html +1 -1
- package/website/types/tasks.Eventstate.html +1 -1
- package/website/types/tasks.Functionref.html +1 -1
- package/website/types/tasks.GetTaskRunLogHttpResponse.html +1 -1
- package/website/types/tasks.Schedule.html +1 -1
- package/website/types/temp-contents.Error.html +1 -1
- package/website/types/tenants.Error.html +1 -1
- package/website/types/tenants.Tenant.html +1 -1
- package/website/types/tenants.TenantPatchErrors.html +1 -1
- package/website/types/tenants.TenantPatchSchema.html +1 -1
- package/website/types/transports.DeleteConfigNotFoundError.html +1 -1
- package/website/types/transports.SendTestMailConfigNotFoundError.html +1 -1
- package/website/types/transports.TenantAdminError.html +1 -1
- package/website/types/transports.UpdateEmailConfigError.html +1 -1
- package/website/types/transports.VerifyConnectionConfigNotFoundError.html +1 -1
- package/website/types/ui-config.JSONPatchPinnedLinkPayload.html +1 -1
- package/website/types/users.AssignedGroups.html +1 -1
- package/website/types/users.AssignedGroupsRefNames.html +1 -1
- package/website/types/users.AssignedRoles.html +1 -1
- package/website/types/users.Error.html +1 -1
- package/website/types/users.InviteErrorItem.html +1 -1
- package/website/types/users.RefIDs.html +1 -1
- package/website/types/users.RefNames.html +1 -1
- package/website/types/users.User.html +1 -1
- package/website/types/users.Users.html +1 -1
- package/website/types/web-integrations.Error.html +1 -1
- package/website/types/web-integrations.WebIntegrationPost.html +1 -1
- package/website/types/web-integrations.WebIntegrations.html +1 -1
- package/website/types/webhooks.Delivery.html +2 -2
- package/website/types/webhooks.WebhookPost.html +1 -1
- package/website/types/webhooks.WebhookResponse.html +1 -1
- package/website/variables/index.auth.html +1 -1
- package/website/variables/index.createQlikApi.html +1 -1
- package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
- package/chunks/global-types-CQrlc6w9.js +0 -0
- package/website/types/ml.ConfigurationKey.html +0 -1
- package/website/types/ml.DataSchemaConfiguration.html +0 -3
- package/website/types/qix.NxGroupMember.html +0 -2
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AutomationsAPI | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/automations.html">automations</a></li><li><a href="" aria-current="page">AutomationsAPI</a></li></ul><h1>Interface AutomationsAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AutomationsAPI</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#changeownerautomation">changeOwnerAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">userId</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-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/automations.ChangeOwnerAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ChangeOwnerAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#changespaceautomation">changeSpaceAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">spaceId</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-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/automations.ChangeSpaceAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ChangeSpaceAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#clearcache">clearCache</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#copyautomation">copyAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">name</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-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/automations.CopyAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CopyAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#createautomation">createAutomation</a><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/automations.AutomationDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">AutomationDetailRequestObject</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/automations.CreateAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#deleteautomation">deleteAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.DeleteAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disableautomation">disableAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.DisableAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DisableAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enableautomation">enableAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.EnableAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">EnableAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomation">getAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.GetAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationrun">getAutomationRun</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.GetAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationrundetails">getAutomationRunDetails</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.GetAutomationRunDetailsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunDetailsHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationruns">getAutomationRuns</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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><br/> <span class="tsd-kind-property">fields</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">filter</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">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">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">"id"</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">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"startTime"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-startTime"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+startTime"</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/automations.GetAutomationRunsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunsHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationrunwithquery">getAutomationRunWithQuery</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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">fields</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-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/automations.GetAutomationRunWithQueryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunWithQueryHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomations">getAutomations</a><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">fields</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">filter</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">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">listAll</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">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"id"</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">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"duration"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+duration"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-duration"</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/automations.GetAutomationsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationsHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationsusagemetrics">getAutomationsUsageMetrics</a><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> <span class="tsd-kind-property">breakdownBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">filter</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-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/automations.GetAutomationsUsageMetricsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationsUsageMetricsHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationwithquery">getAutomationWithQuery</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">fields</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-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/automations.GetAutomationWithQueryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationWithQueryHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#moveautomation">moveAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">userId</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-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/automations.MoveAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">MoveAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#queueautomationrun">queueAutomationRun</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.RunDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">RunDetailRequestObject</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/automations.QueueAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">QueueAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#retryautomationrun">retryAutomationRun</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.RetryAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">RetryAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stopautomationrun">stopAutomationRun</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.StopAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">StopAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updateautomation">updateAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.AutomationDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">AutomationDetailRequestObject</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/automations.UpdateAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#changeownerautomation" 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>change<wbr/>Owner<wbr/>Automation</span></a>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AutomationsAPI | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/automations.html">automations</a></li><li><a href="" aria-current="page">AutomationsAPI</a></li></ul><h1>Interface AutomationsAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AutomationsAPI</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#changeownerautomation">changeOwnerAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">userId</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-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/automations.ChangeOwnerAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ChangeOwnerAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#changespaceautomation">changeSpaceAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">spaceId</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-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/automations.ChangeSpaceAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ChangeSpaceAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#clearcache">clearCache</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#copyautomation">copyAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">name</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-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/automations.CopyAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CopyAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#createautomation">createAutomation</a><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/automations.AutomationDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">AutomationDetailRequestObject</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/automations.CreateAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#deleteautomation">deleteAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.DeleteAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disableautomation">disableAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.DisableAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DisableAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#enableautomation">enableAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.EnableAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">EnableAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomation">getAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.GetAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationrun">getAutomationRun</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.GetAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationrundetails">getAutomationRunDetails</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.GetAutomationRunDetailsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunDetailsHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationruns">getAutomationRuns</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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><br/> <span class="tsd-kind-property">fields</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">filter</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">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">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">"id"</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">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"startTime"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-startTime"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+startTime"</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/automations.GetAutomationRunsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunsHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationrunwithquery">getAutomationRunWithQuery</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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">fields</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-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/automations.GetAutomationRunWithQueryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunWithQueryHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomations">getAutomations</a><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">fields</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">filter</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">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">listAll</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">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"id"</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">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"duration"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+duration"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-duration"</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/automations.GetAutomationsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationsHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationsusagemetrics">getAutomationsUsageMetrics</a><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> <span class="tsd-kind-property">breakdownBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">filter</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-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/automations.GetAutomationsUsageMetricsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationsUsageMetricsHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getautomationwithquery">getAutomationWithQuery</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">fields</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-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/automations.GetAutomationWithQueryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationWithQueryHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#moveautomation">moveAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">userId</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-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/automations.MoveAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">MoveAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#queueautomationrun">queueAutomationRun</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.RunDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">RunDetailRequestObject</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/automations.QueueAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">QueueAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#retryautomationrun">retryAutomationRun</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.RetryAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">RetryAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stopautomationrun">stopAutomationRun</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.StopAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">StopAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updateautomation">updateAutomation</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.AutomationDetailUpdateRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">AutomationDetailUpdateRequestObject</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/automations.UpdateAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateAutomationHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#changeownerautomation" 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>change<wbr/>Owner<wbr/>Automation</span></a>
|
|
2
2
|
<a href="#changespaceautomation" 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>change<wbr/>Space<wbr/>Automation</span></a>
|
|
3
3
|
<a href="#clearcache" 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>clear<wbr/>Cache</span></a>
|
|
4
4
|
<a href="#copyautomation" 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>copy<wbr/>Automation</span></a>
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
<a href="#stopautomationrun" 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>stop<wbr/>Automation<wbr/>Run</span></a>
|
|
21
21
|
<a href="#updateautomation" 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/>Automation</span></a>
|
|
22
22
|
</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="changeownerautomation"><span>change<wbr/>Owner<wbr/>Automation</span><a href="#changeownerautomation" 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">changeOwnerAutomation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">userId</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-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/automations.ChangeOwnerAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ChangeOwnerAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner.</p>
|
|
23
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
23
|
+
</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">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">userId</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-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/automations.ChangeOwnerAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ChangeOwnerAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner.</p>
|
|
24
24
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
25
25
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">userId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
26
26
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">userId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The unique identifier of the new owner.</p>
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
</div><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>
|
|
30
30
|
</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>ChangeOwnerAutomationHttpError</p>
|
|
31
31
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="changespaceautomation"><span>change<wbr/>Space<wbr/>Automation</span><a href="#changespaceautomation" 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">changeSpaceAutomation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">spaceId</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-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/automations.ChangeSpaceAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ChangeSpaceAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Changes the space of an automation by specifying a new space.</p>
|
|
32
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
32
|
+
</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">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">spaceId</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-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/automations.ChangeSpaceAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">ChangeSpaceAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Changes the space of an automation by specifying a new space.</p>
|
|
33
33
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
34
34
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
35
35
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">spaceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The unique identifier of the new space.</p>
|
|
@@ -38,9 +38,9 @@
|
|
|
38
38
|
</div><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>
|
|
39
39
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-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>ChangeSpaceAutomationHttpError</p>
|
|
40
40
|
</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 automations api requests.</p>
|
|
41
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
41
|
+
</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 automations api requests.</p>
|
|
42
42
|
</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="copyautomation"><span>copy<wbr/>Automation</span><a href="#copyautomation" 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">copyAutomation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">name</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-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/automations.CopyAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CopyAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Duplicates an existing automation. The requesting user must be the owner of the automation.</p>
|
|
43
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
43
|
+
</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">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">name</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-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/automations.CopyAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CopyAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Duplicates an existing automation. The requesting user must be the owner of the automation.</p>
|
|
44
44
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
45
45
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
46
46
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Name of the new automation.</p>
|
|
@@ -49,37 +49,37 @@
|
|
|
49
49
|
</div><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>
|
|
50
50
|
</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>CopyAutomationHttpError</p>
|
|
51
51
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createautomation"><span>create<wbr/>Automation</span><a href="#createautomation" 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">createAutomation</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/automations.AutomationDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">AutomationDetailRequestObject</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/automations.CreateAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates a new automation. The requesting user must be assigned the <code>AutomationCreator</code> role.</p>
|
|
52
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
52
|
+
</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/automations.AutomationDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">AutomationDetailRequestObject</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/automations.CreateAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new automation. The requesting user must be assigned the <code>AutomationCreator</code> role.</p>
|
|
53
53
|
</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/automations.AutomationDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">AutomationDetailRequestObject</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
54
54
|
</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/automations.CreateAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAutomationHttpResponse</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>CreateAutomationHttpError</p>
|
|
55
55
|
</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-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>
|
|
56
56
|
</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>CreateAutomationHttpError</p>
|
|
57
57
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteautomation"><span>delete<wbr/>Automation</span><a href="#deleteautomation" 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">deleteAutomation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.DeleteAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes an automation. The requesting user must be the owner of the automation, or be assigned the <code>TenantAdmin</code> role.</p>
|
|
58
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
58
|
+
</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">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/automations.DeleteAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes an automation. The requesting user must be the owner of the automation, or be assigned the <code>TenantAdmin</code> role.</p>
|
|
59
59
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
60
60
|
</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/automations.DeleteAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAutomationHttpResponse</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>DeleteAutomationHttpError</p>
|
|
61
61
|
</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-id-3">Param: id<a href="#param-id-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 unique identifier for the automation.</p>
|
|
62
62
|
</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>DeleteAutomationHttpError</p>
|
|
63
63
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="disableautomation"><span>disable<wbr/>Automation</span><a href="#disableautomation" 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">disableAutomation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.DisableAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DisableAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Disables an automation so that it cannot be run. The requesting user must be the owner of the automation, or be assigned the <code>TenantAdmin</code> role.</p>
|
|
64
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
64
|
+
</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">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/automations.DisableAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DisableAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Disables an automation so that it cannot be run. The requesting user must be the owner of the automation, or be assigned the <code>TenantAdmin</code> role.</p>
|
|
65
65
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
66
66
|
</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/automations.DisableAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DisableAutomationHttpResponse</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>DisableAutomationHttpError</p>
|
|
67
67
|
</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-id-4">Param: id<a href="#param-id-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>The unique identifier for the automation.</p>
|
|
68
68
|
</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>DisableAutomationHttpError</p>
|
|
69
69
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enableautomation"><span>enable<wbr/>Automation</span><a href="#enableautomation" 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">enableAutomation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.EnableAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">EnableAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Enables an automation so that it can be run. The requesting user must be the owner of the automation, or be assigned the <code>TenantAdmin</code> role.</p>
|
|
70
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
70
|
+
</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">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/automations.EnableAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">EnableAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Enables an automation so that it can be run. The requesting user must be the owner of the automation, or be assigned the <code>TenantAdmin</code> role.</p>
|
|
71
71
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
72
72
|
</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/automations.EnableAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">EnableAutomationHttpResponse</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>EnableAutomationHttpError</p>
|
|
73
73
|
</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-id-5">Param: id<a href="#param-id-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>The unique identifier for the automation.</p>
|
|
74
74
|
</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>EnableAutomationHttpError</p>
|
|
75
75
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getautomation"><span>get<wbr/>Automation</span><a href="#getautomation" 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">getAutomation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.GetAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the full definition of an automation. The requesting user must be the owner of the automation.</p>
|
|
76
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
76
|
+
</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">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/automations.GetAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the full definition of an automation. The requesting user must be the owner of the automation.</p>
|
|
77
77
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
78
78
|
</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/automations.GetAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationHttpResponse</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>GetAutomationHttpError</p>
|
|
79
79
|
</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-id-6">Param: id<a href="#param-id-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>The unique identifier for the automation.</p>
|
|
80
80
|
</div><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>GetAutomationHttpError</p>
|
|
81
81
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getautomationrun"><span>get<wbr/>Automation<wbr/>Run</span><a href="#getautomationrun" 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">getAutomationRun</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.GetAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a specific run for an automation. The requesting user must be the owner of the automation.</p>
|
|
82
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
82
|
+
</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">id</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">runId</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/automations.GetAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a specific run for an automation. The requesting user must be the owner of the automation.</p>
|
|
83
83
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
84
84
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">runId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the run.</p>
|
|
85
85
|
</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/automations.GetAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunHttpResponse</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>GetAutomationRunHttpError</p>
|
|
@@ -87,7 +87,7 @@
|
|
|
87
87
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-runid">Param: runId<a href="#param-runid" 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 unique identifier for the run.</p>
|
|
88
88
|
</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>GetAutomationRunHttpError</p>
|
|
89
89
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getautomationrundetails"><span>get<wbr/>Automation<wbr/>Run<wbr/>Details</span><a href="#getautomationrundetails" 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">getAutomationRunDetails</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.GetAutomationRunDetailsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunDetailsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the URL for the debug log of a specific automation run. The requesting user must be the owner of the automation.</p>
|
|
90
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
90
|
+
</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">id</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">runId</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/automations.GetAutomationRunDetailsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunDetailsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the URL for the debug log of a specific automation run. The requesting user must be the owner of the automation.</p>
|
|
91
91
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
92
92
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">runId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the run.</p>
|
|
93
93
|
</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/automations.GetAutomationRunDetailsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunDetailsHttpResponse</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>GetAutomationRunDetailsHttpError</p>
|
|
@@ -95,7 +95,7 @@
|
|
|
95
95
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-runid-1">Param: runId<a href="#param-runid-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 unique identifier for the run.</p>
|
|
96
96
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-19">Throws<a href="#throws-19" 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>GetAutomationRunDetailsHttpError</p>
|
|
97
97
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getautomationruns"><span>get<wbr/>Automation<wbr/>Runs</span><a href="#getautomationruns" 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">getAutomationRuns</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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><br/> <span class="tsd-kind-property">fields</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">filter</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">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">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">"id"</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">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"startTime"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-startTime"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+startTime"</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/automations.GetAutomationRunsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the <code>TenantAdmin</code> role.</p>
|
|
98
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
98
|
+
</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">id</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><br/> <span class="tsd-kind-property">fields</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">filter</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">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">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">"id"</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">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"startTime"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-startTime"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+startTime"</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/automations.GetAutomationRunsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the <code>TenantAdmin</code> role.</p>
|
|
99
99
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
100
100
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">fields</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">filter</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">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">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">"id"</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">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"startTime"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-startTime"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+startTime"</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>
|
|
101
101
|
</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">fields</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Allows to select the actual fields to be returned. Where the default is all fields</p>
|
|
@@ -107,7 +107,7 @@
|
|
|
107
107
|
</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>
|
|
108
108
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-21">Throws<a href="#throws-21" 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>GetAutomationRunsHttpError</p>
|
|
109
109
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getautomationrunwithquery"><span>get<wbr/>Automation<wbr/>Run<wbr/>With<wbr/>Query</span><a href="#getautomationrunwithquery" 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">getAutomationRunWithQuery</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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">fields</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-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/automations.GetAutomationRunWithQueryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunWithQueryHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a specific run for an automation. The requesting user must be the owner of the automation.</p>
|
|
110
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
110
|
+
</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">id</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">runId</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">fields</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-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/automations.GetAutomationRunWithQueryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationRunWithQueryHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a specific run for an automation. The requesting user must be the owner of the automation.</p>
|
|
111
111
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
112
112
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">runId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the run.</p>
|
|
113
113
|
</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">fields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
@@ -118,7 +118,7 @@
|
|
|
118
118
|
</div><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>
|
|
119
119
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-23">Throws<a href="#throws-23" 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>GetAutomationRunWithQueryHttpError</p>
|
|
120
120
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getautomations"><span>get<wbr/>Automations</span><a href="#getautomations" 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">getAutomations</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">fields</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">filter</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">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">listAll</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">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"id"</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">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"duration"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+duration"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-duration"</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/automations.GetAutomationsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a list of the automations that the requesting user has access to.</p>
|
|
121
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
121
|
+
</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">fields</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">filter</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">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">listAll</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">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"id"</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">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"duration"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+duration"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-duration"</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/automations.GetAutomationsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a list of the automations that the requesting user has access to.</p>
|
|
122
122
|
</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">fields</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">filter</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">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">listAll</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">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"id"</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">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"duration"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-runMode"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-state"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-lastRunAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-lastRunStatus"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+duration"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-duration"</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>
|
|
123
123
|
</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">fields</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Allows to select the actual fields to be returned. When no fields are defined, all are returned.</p>
|
|
124
124
|
</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">filter</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Allowed filters: name, runMode, lastRunStatus, ownerId, spaceId</p>
|
|
@@ -135,15 +135,19 @@
|
|
|
135
135
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-2">Param: query<a href="#param-query-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 query parameters</p>
|
|
136
136
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-25">Throws<a href="#throws-25" 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>GetAutomationsHttpError</p>
|
|
137
137
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getautomationsusagemetrics"><span>get<wbr/>Automations<wbr/>Usage<wbr/>Metrics</span><a href="#getautomationsusagemetrics" 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">getAutomationsUsageMetrics</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> <span class="tsd-kind-property">breakdownBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">filter</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-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/automations.GetAutomationsUsageMetricsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationsUsageMetricsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves paginated usage metrics for automations. The requesting user must be assigned the <code>TenantAdmin</code> role.</p>
|
|
138
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
138
|
+
</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> <span class="tsd-kind-property">breakdownBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">filter</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-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/automations.GetAutomationsUsageMetricsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationsUsageMetricsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves paginated usage metrics for automations. The requesting user must be assigned the <code>TenantAdmin</code> role.</p>
|
|
139
139
|
</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> <span class="tsd-kind-property">breakdownBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
140
140
|
</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">breakdownBy</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>If specified, result will be broken apart for each automation</p>
|
|
141
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Indicates how the metrics should be filtered
|
|
141
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Indicates how the metrics should be filtered using a SCIM-style expression. Available parameters:</p>
|
|
142
|
+
<ul>
|
|
143
|
+
<li>name (runs, scheduledRun, triggeredRun, webhookRuns, duration, bandwidthIn, bandwidthOut)</li>
|
|
144
|
+
<li>date</li>
|
|
145
|
+
</ul>
|
|
142
146
|
</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/automations.GetAutomationsUsageMetricsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationsUsageMetricsHttpResponse</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-26">Throws<a href="#throws-26" 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>GetAutomationsUsageMetricsHttpError</p>
|
|
143
147
|
</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-3">Param: query<a href="#param-query-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 query parameters</p>
|
|
144
148
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-27">Throws<a href="#throws-27" 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>GetAutomationsUsageMetricsHttpError</p>
|
|
145
149
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getautomationwithquery"><span>get<wbr/>Automation<wbr/>With<wbr/>Query</span><a href="#getautomationwithquery" 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">getAutomationWithQuery</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">fields</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-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/automations.GetAutomationWithQueryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationWithQueryHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the full definition of an automation. The requesting user must be the owner of the automation.</p>
|
|
146
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
150
|
+
</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">id</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">fields</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-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/automations.GetAutomationWithQueryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAutomationWithQueryHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the full definition of an automation. The requesting user must be the owner of the automation.</p>
|
|
147
151
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
148
152
|
</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">fields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
149
153
|
</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">fields</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Allows to select the actual fields to be returned. Where the default is all fields</p>
|
|
@@ -152,7 +156,7 @@
|
|
|
152
156
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-4">Param: query<a href="#param-query-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 query parameters</p>
|
|
153
157
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-29">Throws<a href="#throws-29" 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>GetAutomationWithQueryHttpError</p>
|
|
154
158
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="moveautomation"><span>move<wbr/>Automation</span><a href="#moveautomation" 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">moveAutomation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">userId</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-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/automations.MoveAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">MoveAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner.</p>
|
|
155
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
159
|
+
</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">id</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> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">userId</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-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/automations.MoveAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">MoveAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner.</p>
|
|
156
160
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
157
161
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">userId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
158
162
|
</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/automations.MoveAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">MoveAutomationHttpResponse</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-30">Throws<a href="#throws-30" 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>MoveAutomationHttpError</p>
|
|
@@ -160,7 +164,7 @@
|
|
|
160
164
|
</div><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>
|
|
161
165
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-31">Throws<a href="#throws-31" 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>MoveAutomationHttpError</p>
|
|
162
166
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="queueautomationrun"><span>queue<wbr/>Automation<wbr/>Run</span><a href="#queueautomationrun" 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">queueAutomationRun</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.RunDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">RunDetailRequestObject</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/automations.QueueAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">QueueAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates a runs for a specific automation. The requesting user must be the owner of the automation.</p>
|
|
163
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
167
|
+
</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">id</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/automations.RunDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">RunDetailRequestObject</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/automations.QueueAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">QueueAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a runs for a specific automation. The requesting user must be the owner of the automation.</p>
|
|
164
168
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
165
169
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/automations.RunDetailRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">RunDetailRequestObject</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
166
170
|
</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/automations.QueueAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">QueueAutomationRunHttpResponse</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-32">Throws<a href="#throws-32" 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>QueueAutomationRunHttpError</p>
|
|
@@ -168,7 +172,7 @@
|
|
|
168
172
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-5">Param: body<a href="#param-body-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>an object with the body content</p>
|
|
169
173
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-33">Throws<a href="#throws-33" 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>QueueAutomationRunHttpError</p>
|
|
170
174
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="retryautomationrun"><span>retry<wbr/>Automation<wbr/>Run</span><a href="#retryautomationrun" 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">retryAutomationRun</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.RetryAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">RetryAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retries a specific run by creating a new run using the same inputs. The requesting user must be the owner of the automation.</p>
|
|
171
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
175
|
+
</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">id</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">runId</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/automations.RetryAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">RetryAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retries a specific run by creating a new run using the same inputs. The requesting user must be the owner of the automation.</p>
|
|
172
176
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
173
177
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">runId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the run.</p>
|
|
174
178
|
</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/automations.RetryAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">RetryAutomationRunHttpResponse</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-34">Throws<a href="#throws-34" 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>RetryAutomationRunHttpError</p>
|
|
@@ -176,17 +180,17 @@
|
|
|
176
180
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-runid-3">Param: runId<a href="#param-runid-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 unique identifier for the run.</p>
|
|
177
181
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-35">Throws<a href="#throws-35" 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>RetryAutomationRunHttpError</p>
|
|
178
182
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stopautomationrun"><span>stop<wbr/>Automation<wbr/>Run</span><a href="#stopautomationrun" 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">stopAutomationRun</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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">runId</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/automations.StopAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">StopAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Forcefully stops an automation run immediately. The requesting user must be the owner of the automation.</p>
|
|
179
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
183
|
+
</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">id</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">runId</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/automations.StopAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">StopAutomationRunHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Forcefully stops an automation run immediately. The requesting user must be the owner of the automation.</p>
|
|
180
184
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
181
185
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">runId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the run.</p>
|
|
182
186
|
</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/automations.StopAutomationRunHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">StopAutomationRunHttpResponse</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-36">Throws<a href="#throws-36" 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>StopAutomationRunHttpError</p>
|
|
183
187
|
</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-id-15">Param: id<a href="#param-id-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>The unique identifier for the automation.</p>
|
|
184
188
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-runid-4">Param: runId<a href="#param-runid-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>The unique identifier for the run.</p>
|
|
185
189
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-37">Throws<a href="#throws-37" 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>StopAutomationRunHttpError</p>
|
|
186
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updateautomation"><span>update<wbr/>Automation</span><a href="#updateautomation" 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">updateAutomation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.
|
|
187
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
190
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updateautomation"><span>update<wbr/>Automation</span><a href="#updateautomation" 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">updateAutomation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</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/automations.AutomationDetailUpdateRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">AutomationDetailUpdateRequestObject</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/automations.UpdateAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates the full definition of an automation. The requesting user must be the owner of the automation.</p>
|
|
191
|
+
</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">id</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/automations.AutomationDetailUpdateRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">AutomationDetailUpdateRequestObject</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/automations.UpdateAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateAutomationHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the full definition of an automation. The requesting user must be the owner of the automation.</p>
|
|
188
192
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The unique identifier for the automation.</p>
|
|
189
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/automations.
|
|
193
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/automations.AutomationDetailUpdateRequestObject.html" class="tsd-signature-type tsd-kind-type-alias">AutomationDetailUpdateRequestObject</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
190
194
|
</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/automations.UpdateAutomationHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateAutomationHttpResponse</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-38">Throws<a href="#throws-38" 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>UpdateAutomationHttpError</p>
|
|
191
195
|
</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-id-16">Param: id<a href="#param-id-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>The unique identifier for the automation.</p>
|
|
192
196
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-6">Param: body<a href="#param-body-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>an object with the body content</p>
|