@qlik/api 1.42.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.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-Cl-o3AnG.js → auth-CCj082fh.js} +3 -3
- package/chunks/{auth-B5Hx9GeQ.d.ts → auth-DFOXWfqh.d.ts} +3 -3
- package/chunks/{auth-DD2ENDUe.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-hfHV7WaV.d.ts → data-sources-D_TRdWV-.d.ts} +1 -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-DYJgDVfh.d.ts → di-projects-mdshgyFv.d.ts} +69 -13
- package/chunks/{direct-access-agents-Pmhjq2z5.d.ts → direct-access-agents-CfUpbi73.d.ts} +1 -1
- 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/{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-DbVuX5mE.js → invoke-fetch-09EW5w1d.js} +3 -3
- package/chunks/{invoke-fetch-BIh4VnG4.js → invoke-fetch-fXOUPARi.js} +3 -3
- 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-CNGnt1rU.js → public-runtime-modules-P9LEbn8i.js} +3 -3
- package/chunks/{qix-T3MHM_Lb.d.ts → qix-C1WaB-67.d.ts} +2 -2
- package/chunks/{qix-3nXOY2qw.js → qix-C86sBDw3.js} +1 -1
- package/chunks/{qix-DbtKisCn.js → qix-Ds6X5svJ.js} +5 -5
- package/chunks/{qix-chunk-entrypoint-xeI9UjuJ.js → qix-chunk-entrypoint-CpkRq84_.js} +426 -89
- 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-D-sRL947.d.ts → reports-CRwCogRL.d.ts} +85 -2
- 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-DFQCYg41.d.ts → spaces-B0cx23Nc.d.ts} +1 -1
- 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 +3 -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 +2 -2
- package/direct-access-agents.js +3 -3
- 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/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 +73 -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 +3 -3
- 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/di-projects.getDiProjectDiTaskRuntimeState.html +1 -1
- 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 +4 -4
- 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 +13 -13
- 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/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/ml.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 +30 -0
- package/website/types/di-projects.DataTaskRuntimeState.html +6 -0
- package/website/types/di-projects.GetDiProjectDiTaskRuntimeStateHttpResponse.html +2 -2
- 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.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.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/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.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/website/types/di-projects.DataTaskInstanceStateOld.html +0 -3
- package/website/types/ml.ConfigurationKey.html +0 -1
- package/website/types/ml.DataSchemaConfiguration.html +0 -3
|
@@ -7,41 +7,41 @@
|
|
|
7
7
|
<a href="#getuiconfigpinnedlinks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span></a>
|
|
8
8
|
<a href="#patchuiconfigpinnedlink" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span></a>
|
|
9
9
|
</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="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 ui-config api requests.</p>
|
|
10
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
10
|
+
</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 ui-config api requests.</p>
|
|
11
11
|
</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="createuiconfigpinnedlink"><span>create<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span><a href="#createuiconfigpinnedlink" 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">createUiConfigPinnedLink</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/ui-config.CreatePinnedLinkPayload.html" class="tsd-signature-type tsd-kind-type-alias">CreatePinnedLinkPayload</a> <span class="tsd-signature-symbol">&</span> <a href="../types/ui-config.CreatePinnedLinkConfigPayload.html" class="tsd-signature-type tsd-kind-type-alias">CreatePinnedLinkConfigPayload</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/ui-config.CreateUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateUiConfigPinnedLinkHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates a pinned link, which will appear below any existing pinned links in the tenant. Requires calling user to be assigned the <code>TenantAdmin</code> role. A tenant can have a maximum of 50 pinned links.</p>
|
|
12
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
12
|
+
</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/ui-config.CreatePinnedLinkPayload.html" class="tsd-signature-type tsd-kind-type-alias">CreatePinnedLinkPayload</a> <span class="tsd-signature-symbol">&</span> <a href="../types/ui-config.CreatePinnedLinkConfigPayload.html" class="tsd-signature-type tsd-kind-type-alias">CreatePinnedLinkConfigPayload</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/ui-config.CreateUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateUiConfigPinnedLinkHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a pinned link, which will appear below any existing pinned links in the tenant. Requires calling user to be assigned the <code>TenantAdmin</code> role. A tenant can have a maximum of 50 pinned links.</p>
|
|
13
13
|
</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/ui-config.CreatePinnedLinkPayload.html" class="tsd-signature-type tsd-kind-type-alias">CreatePinnedLinkPayload</a> <span class="tsd-signature-symbol">&</span> <a href="../types/ui-config.CreatePinnedLinkConfigPayload.html" class="tsd-signature-type tsd-kind-type-alias">CreatePinnedLinkConfigPayload</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
14
14
|
</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/ui-config.CreateUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateUiConfigPinnedLinkHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateUiConfigPinnedLinkHttpError</p>
|
|
15
15
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
16
16
|
</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>CreateUiConfigPinnedLinkHttpError</p>
|
|
17
17
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createuiconfigpinnedlinks"><span>create<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span><a href="#createuiconfigpinnedlinks" 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">createUiConfigPinnedLinks</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/ui-config.BulkCreatePinnedLinkItemPayload.html" class="tsd-signature-type tsd-kind-type-alias">BulkCreatePinnedLinkItemPayload</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/ui-config.CreateUiConfigPinnedLinksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateUiConfigPinnedLinksHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates one or more pinned links for navigation, an alternative method to multiple calls to <code>/ui-config/pinned-links</code>. Links are displayed below any existing pinned links, and will be added in the order sent in the request. Requires calling user to be assigned the <code>TenantAdmin</code> role. A tenant can have a maximum of 50 pinned links.</p>
|
|
18
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
18
|
+
</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/ui-config.BulkCreatePinnedLinkItemPayload.html" class="tsd-signature-type tsd-kind-type-alias">BulkCreatePinnedLinkItemPayload</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/ui-config.CreateUiConfigPinnedLinksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateUiConfigPinnedLinksHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates one or more pinned links for navigation, an alternative method to multiple calls to <code>/ui-config/pinned-links</code>. Links are displayed below any existing pinned links, and will be added in the order sent in the request. Requires calling user to be assigned the <code>TenantAdmin</code> role. A tenant can have a maximum of 50 pinned links.</p>
|
|
19
19
|
</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/ui-config.BulkCreatePinnedLinkItemPayload.html" class="tsd-signature-type tsd-kind-type-alias">BulkCreatePinnedLinkItemPayload</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
20
20
|
</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/ui-config.CreateUiConfigPinnedLinksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateUiConfigPinnedLinksHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateUiConfigPinnedLinksHttpError</p>
|
|
21
21
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-1">Param: body<a href="#param-body-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
22
22
|
</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>CreateUiConfigPinnedLinksHttpError</p>
|
|
23
23
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletealluiconfigpinnedlinks"><span>delete<wbr/>All<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span><a href="#deletealluiconfigpinnedlinks" 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">deleteAllUiConfigPinnedLinks</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/ui-config.DeleteAllUiConfigPinnedLinksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAllUiConfigPinnedLinksHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes all pinned links in the tenant. Requires calling user to be assigned the <code>TenantAdmin</code> role.</p>
|
|
24
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
24
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ui-config.DeleteAllUiConfigPinnedLinksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAllUiConfigPinnedLinksHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes all pinned links in the tenant. Requires calling user to be assigned the <code>TenantAdmin</code> role.</p>
|
|
25
25
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ui-config.DeleteAllUiConfigPinnedLinksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAllUiConfigPinnedLinksHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteAllUiConfigPinnedLinksHttpError</p>
|
|
26
26
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-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>DeleteAllUiConfigPinnedLinksHttpError</p>
|
|
27
27
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteuiconfigpinnedlink"><span>delete<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span><a href="#deleteuiconfigpinnedlink" 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">deleteUiConfigPinnedLink</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/ui-config.DeleteUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteUiConfigPinnedLinkHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes a specific pinned link. Requires calling user to be assigned the <code>TenantAdmin</code> role.</p>
|
|
28
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
28
|
+
</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">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/ui-config.DeleteUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteUiConfigPinnedLinkHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes a specific pinned link. Requires calling user to be assigned the <code>TenantAdmin</code> role.</p>
|
|
29
29
|
</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 pinned link identifier.</p>
|
|
30
30
|
</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/ui-config.DeleteUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteUiConfigPinnedLinkHttpResponse</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>DeleteUiConfigPinnedLinkHttpError</p>
|
|
31
31
|
</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">Param: id<a href="#param-id" 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 pinned link identifier.</p>
|
|
32
32
|
</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>DeleteUiConfigPinnedLinkHttpError</p>
|
|
33
33
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getuiconfigpinnedlink"><span>get<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span><a href="#getuiconfigpinnedlink" 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">getUiConfigPinnedLink</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/ui-config.GetUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUiConfigPinnedLinkHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a specific pinned link.</p>
|
|
34
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
34
|
+
</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">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/ui-config.GetUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUiConfigPinnedLinkHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a specific pinned link.</p>
|
|
35
35
|
</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 pinned link identifier.</p>
|
|
36
36
|
</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/ui-config.GetUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUiConfigPinnedLinkHttpResponse</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>GetUiConfigPinnedLinkHttpError</p>
|
|
37
37
|
</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-1">Param: id<a href="#param-id-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 pinned link identifier.</p>
|
|
38
38
|
</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>GetUiConfigPinnedLinkHttpError</p>
|
|
39
39
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getuiconfigpinnedlinks"><span>get<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Links</span><a href="#getuiconfigpinnedlinks" 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">getUiConfigPinnedLinks</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/ui-config.GetUiConfigPinnedLinksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUiConfigPinnedLinksHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a list of all pinned links. All users can list pinned links. This endpoint does not support pagination as a tenant can have a maximum of 50 pinned links at one time.</p>
|
|
40
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
40
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ui-config.GetUiConfigPinnedLinksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUiConfigPinnedLinksHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a list of all pinned links. All users can list pinned links. This endpoint does not support pagination as a tenant can have a maximum of 50 pinned links at one time.</p>
|
|
41
41
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ui-config.GetUiConfigPinnedLinksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUiConfigPinnedLinksHttpResponse</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>GetUiConfigPinnedLinksHttpError</p>
|
|
42
42
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-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>GetUiConfigPinnedLinksHttpError</p>
|
|
43
43
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchuiconfigpinnedlink"><span>patch<wbr/>Ui<wbr/>Config<wbr/>Pinned<wbr/>Link</span><a href="#patchuiconfigpinnedlink" 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">patchUiConfigPinnedLink</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/ui-config.JSONPatchPinnedLinkPayload.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchPinnedLinkPayload</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/ui-config.PatchUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchUiConfigPinnedLinkHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates a specific pinned link with an array of JSON patches. Requires calling user to be assigned the <code>TenantAdmin</code> role.</p>
|
|
44
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
44
|
+
</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/ui-config.JSONPatchPinnedLinkPayload.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchPinnedLinkPayload</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/ui-config.PatchUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchUiConfigPinnedLinkHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates a specific pinned link with an array of JSON patches. Requires calling user to be assigned the <code>TenantAdmin</code> role.</p>
|
|
45
45
|
</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 pinned link identifier.</p>
|
|
46
46
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/ui-config.JSONPatchPinnedLinkPayload.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchPinnedLinkPayload</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
47
47
|
</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/ui-config.PatchUiConfigPinnedLinkHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchUiConfigPinnedLinkHttpResponse</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>PatchUiConfigPinnedLinkHttpError</p>
|
|
@@ -9,28 +9,28 @@
|
|
|
9
9
|
<a href="#inviteusers" 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>invite<wbr/>Users</span></a>
|
|
10
10
|
<a href="#patchuser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>User</span></a>
|
|
11
11
|
</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="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 users api requests.</p>
|
|
12
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
12
|
+
</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 users api requests.</p>
|
|
13
13
|
</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="countusers"><span>count<wbr/>Users</span><a href="#countusers" 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">countUsers</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">tenantId</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/users.CountUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CountUsersHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Returns the number of users in a given tenant</p>
|
|
14
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
14
|
+
</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">tenantId</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/users.CountUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CountUsersHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the number of users in a given tenant</p>
|
|
15
15
|
</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">tenantId</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>
|
|
16
16
|
</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">tenantId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" 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 tenant ID to filter by.</p>
|
|
17
17
|
</div></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/users.CountUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CountUsersHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CountUsersHttpError</p>
|
|
18
18
|
</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">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>
|
|
19
19
|
</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>CountUsersHttpError</p>
|
|
20
20
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createuser"><span>create<wbr/>User</span><a href="#createuser" 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">createUser</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/users.UserPostSchema.html" class="tsd-signature-type tsd-kind-type-alias">UserPostSchema</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/users.CreateUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateUserHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates an invited user.</p>
|
|
21
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
21
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/users.UserPostSchema.html" class="tsd-signature-type tsd-kind-type-alias">UserPostSchema</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/users.CreateUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateUserHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates an invited user.</p>
|
|
22
22
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/users.UserPostSchema.html" class="tsd-signature-type tsd-kind-type-alias">UserPostSchema</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
23
23
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/users.CreateUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateUserHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateUserHttpError</p>
|
|
24
24
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
25
25
|
</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>CreateUserHttpError</p>
|
|
26
26
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteuser"><span>delete<wbr/>User</span><a href="#deleteuser" 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">deleteUser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">userId</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/users.DeleteUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteUserHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes the requested user.</p>
|
|
27
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
27
|
+
</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">userId</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/users.DeleteUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteUserHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes the requested user.</p>
|
|
28
28
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">userId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the user to delete.</p>
|
|
29
29
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/users.DeleteUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteUserHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteUserHttpError</p>
|
|
30
30
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-userid">Param: userId<a href="#param-userid" 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 ID of the user to delete.</p>
|
|
31
31
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteUserHttpError</p>
|
|
32
32
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filterusers"><span>filter<wbr/>Users</span><a href="#filterusers" 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">filterUsers</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">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</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">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/users.Filter.html" class="tsd-signature-type tsd-kind-type-alias">Filter</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/users.FilterUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">FilterUsersHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a list of users matching the filter using an advanced query string.</p>
|
|
33
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
33
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">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">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</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">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/users.Filter.html" class="tsd-signature-type tsd-kind-type-alias">Filter</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/users.FilterUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">FilterUsersHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a list of users matching the filter using an advanced query string.</p>
|
|
34
34
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">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">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</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>
|
|
35
35
|
</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>A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted.</p>
|
|
36
36
|
</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">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The number of user entries to retrieve.</p>
|
|
@@ -43,11 +43,11 @@
|
|
|
43
43
|
</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>
|
|
44
44
|
</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>FilterUsersHttpError</p>
|
|
45
45
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getmyuser"><span>get<wbr/>My<wbr/>User</span><a href="#getmyuser" 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">getMyUser</span><span class="tsd-signature-symbol">:</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/users.GetMyUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetMyUserHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Redirects to retrieve the user resource associated with the JWT claims.</p>
|
|
46
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
46
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/users.GetMyUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetMyUserHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Redirects to retrieve the user resource associated with the JWT claims.</p>
|
|
47
47
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/users.GetMyUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetMyUserHttpResponse</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>GetMyUserHttpError</p>
|
|
48
48
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-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>GetMyUserHttpError</p>
|
|
49
49
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getuser"><span>get<wbr/>User</span><a href="#getuser" 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">getUser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">userId</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/users.GetUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUserHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Returns the requested user.</p>
|
|
50
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
50
|
+
</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">userId</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/users.GetUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUserHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the requested user.</p>
|
|
51
51
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">userId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The user's unique identifier</p>
|
|
52
52
|
</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>
|
|
53
53
|
</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>A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted.</p>
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
</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>
|
|
57
57
|
</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>GetUserHttpError</p>
|
|
58
58
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getusers"><span>get<wbr/>Users</span><a href="#getusers" 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">getUsers</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">email</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">endingBefore</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">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">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</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">"subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"clientId"</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">"name"</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">"email"</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">"createdAt"</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">"_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">"-_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-inviteExpiry"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sortBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sortOrder</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"asc"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"desc"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">startingAfter</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">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"active"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"disabled"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"deleted"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"invited"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"provisioned"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">subject</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">tenantId</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">totalResults</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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/users.GetUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUsersHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Returns a list of users using cursor-based pagination.</p>
|
|
59
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
59
|
+
</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">email</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">endingBefore</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">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">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</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">"subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"clientId"</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">"name"</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">"email"</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">"createdAt"</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">"_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">"-_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-inviteExpiry"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sortBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sortOrder</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"asc"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"desc"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">startingAfter</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">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"active"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"disabled"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"deleted"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"invited"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"provisioned"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">subject</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">tenantId</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">totalResults</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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/users.GetUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUsersHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a list of users using cursor-based pagination.</p>
|
|
60
60
|
</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">email</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">endingBefore</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">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">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</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">"subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"clientId"</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">"name"</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">"email"</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">"createdAt"</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">"_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">"-_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-inviteExpiry"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sortBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sortOrder</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"asc"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"desc"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">startingAfter</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">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"active"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"disabled"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"deleted"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"invited"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"provisioned"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">subject</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">tenantId</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">totalResults</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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>
|
|
61
61
|
</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">email</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-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 email to filter by. Deprecated. Use the new <code>filter</code> parameter to provide an advanced query filter.</p>
|
|
62
62
|
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">endingBefore</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-2">Deprecated<a href="#deprecated-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>Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with startingAfter. Deprecated. Use <code>prev</code> instead.</p>
|
|
@@ -96,13 +96,13 @@
|
|
|
96
96
|
</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>
|
|
97
97
|
</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>GetUsersHttpError</p>
|
|
98
98
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="inviteusers"><span>invite<wbr/>Users</span><a href="#inviteusers" 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">inviteUsers</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/users.InviteRequestData.html" class="tsd-signature-type tsd-kind-type-alias">InviteRequestData</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/users.InviteUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">InviteUsersHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Invite one or more users by email address.</p>
|
|
99
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
99
|
+
</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/users.InviteRequestData.html" class="tsd-signature-type tsd-kind-type-alias">InviteRequestData</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/users.InviteUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">InviteUsersHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invite one or more users by email address.</p>
|
|
100
100
|
</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/users.InviteRequestData.html" class="tsd-signature-type tsd-kind-type-alias">InviteRequestData</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
101
101
|
</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/users.InviteUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">InviteUsersHttpResponse</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>InviteUsersHttpError</p>
|
|
102
102
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-2">Param: body<a href="#param-body-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
103
103
|
</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>InviteUsersHttpError</p>
|
|
104
104
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchuser"><span>patch<wbr/>User</span><a href="#patchuser" 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">patchUser</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">userId</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/users.JSONPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchArray</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/users.PatchUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchUserHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates fields for a user resource</p>
|
|
105
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
105
|
+
</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">userId</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/users.JSONPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchArray</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/users.PatchUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchUserHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates fields for a user resource</p>
|
|
106
106
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">userId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the user to update.</p>
|
|
107
107
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/users.JSONPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchArray</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
108
108
|
</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/users.PatchUserHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchUserHttpResponse</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>PatchUserHttpError</p>
|