Integration Installs hooks

React hooks for Aeontel integration installs.

Hooks

useDeleteIntegrationInstall mutation

Uninstall — soft-delete the install; its members + grouping solution are torn down by the cascade handler.

useDeleteIntegrationInstall(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useListIntegrationInstalls query

List integration installs, optionally filtered by workspace or integration.

useListIntegrationInstalls(params?: Omit<ListIntegrationInstallsParams, | > & { filter?: IntegrationInstallFilter; orderBy?: IntegrationInstallOrderBy[]; } & IntegrationInstallShorthands, options?: QueryOpts<Page<IntegrationInstall>>)

Types: ListIntegrationInstallsParams · IntegrationInstallFilter · IntegrationInstallOrderBy · IntegrationInstallShorthands · Page · IntegrationInstall

usePurgeIntegrationInstall composite

Permanently delete a soft-deleted install.

usePurgeIntegrationInstall(options?: MutationOpts<SuccessResponse, PurgeIntegrationInstallParams>)

Types: SuccessResponse · PurgeIntegrationInstallParams

useRestoreIntegrationInstall composite

Restore a soft-deleted install (re-enables members + solution).

useRestoreIntegrationInstall(options?: MutationOpts<IntegrationInstall, string>)

Types: IntegrationInstall

useRetrieveIntegrationInstall query

Get an integration install by ID.

useRetrieveIntegrationInstall(id: string, options?: QueryOpts<IntegrationInstall>)

Types: IntegrationInstall