@dx-do/client 6.4.0 → 7.0.1
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/dist/index.cjs.js +4594 -3406
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +4497 -3399
- package/dist/index.esm.js.map +1 -1
- package/dist/src/index.d.ts +5 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/lib/model/acc/acc-package.d.ts +9 -7
- package/dist/src/lib/model/acc/acc-package.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/client/client.gen.d.ts +1 -2
- package/dist/src/lib/model/asm/client/client/client.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/client/index.d.ts +10 -8
- package/dist/src/lib/model/asm/client/client/index.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/client/types.gen.d.ts +13 -14
- package/dist/src/lib/model/asm/client/client/types.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/client/utils.gen.d.ts +6 -6
- package/dist/src/lib/model/asm/client/client/utils.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/client.gen.d.ts +3 -3
- package/dist/src/lib/model/asm/client/client.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/core/auth.gen.d.ts +10 -3
- package/dist/src/lib/model/asm/client/core/auth.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/core/bodySerializer.gen.d.ts +5 -5
- package/dist/src/lib/model/asm/client/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/core/params.gen.d.ts +5 -5
- package/dist/src/lib/model/asm/client/core/params.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/core/pathSerializer.gen.d.ts +5 -5
- package/dist/src/lib/model/asm/client/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/core/queryKeySerializer.gen.d.ts +1 -1
- package/dist/src/lib/model/asm/client/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/core/serverSentEvents.gen.d.ts +4 -4
- package/dist/src/lib/model/asm/client/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/core/types.gen.d.ts +10 -5
- package/dist/src/lib/model/asm/client/core/types.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/core/utils.gen.d.ts +1 -1
- package/dist/src/lib/model/asm/client/core/utils.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/index.d.ts +2 -2
- package/dist/src/lib/model/asm/client/index.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/schemas.gen.d.ts +31 -55
- package/dist/src/lib/model/asm/client/schemas.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/sdk.gen.d.ts +112 -130
- package/dist/src/lib/model/asm/client/sdk.gen.d.ts.map +1 -1
- package/dist/src/lib/model/asm/client/types.gen.d.ts +186 -243
- package/dist/src/lib/model/asm/client/types.gen.d.ts.map +1 -1
- package/dist/src/lib/model/channel/PolicyResponse.d.ts +8 -0
- package/dist/src/lib/model/channel/PolicyResponse.d.ts.map +1 -1
- package/dist/src/lib/model/config/DXSaaSConfiguration.d.ts +9 -0
- package/dist/src/lib/model/config/DXSaaSConfiguration.d.ts.map +1 -1
- package/dist/src/lib/model/datastore/index.d.ts +1 -0
- package/dist/src/lib/model/datastore/index.d.ts.map +1 -1
- package/dist/src/lib/model/datastore/views/index.d.ts +1 -0
- package/dist/src/lib/model/datastore/views/index.d.ts.map +1 -1
- package/dist/src/lib/model/datastore/views/query.d.ts +3 -3
- package/dist/src/lib/model/datastore/views/response.d.ts +3 -3
- package/dist/src/lib/model/datastore/views/service-universe.d.ts +294 -0
- package/dist/src/lib/model/datastore/views/service-universe.d.ts.map +1 -0
- package/dist/src/lib/model/experience/ApplicationExperienceRequest.d.ts +8 -6
- package/dist/src/lib/model/experience/ApplicationExperienceRequest.d.ts.map +1 -1
- package/dist/src/lib/model/experience/ExperienceSettingsResponse.d.ts +13 -12
- package/dist/src/lib/model/experience/ExperienceSettingsResponse.d.ts.map +1 -1
- package/dist/src/lib/model/maintenance/create.d.ts +1 -1
- package/dist/src/lib/model/maintenance/detail.d.ts +1 -1
- package/dist/src/lib/model/maintenance/member.d.ts +2 -2
- package/dist/src/lib/model/oi/services.export.d.ts +1 -1
- package/dist/src/lib/model/oi/services.export.d.ts.map +1 -1
- package/dist/src/lib/model/oi/services.transform.d.ts +2 -2
- package/dist/src/lib/model/oi/services.transform.d.ts.map +1 -1
- package/dist/src/lib/model/service/service-detail.d.ts +3 -2
- package/dist/src/lib/model/service/service-detail.d.ts.map +1 -1
- package/dist/src/lib/model/service/service-overview.d.ts +4 -3
- package/dist/src/lib/model/service/service-overview.d.ts.map +1 -1
- package/dist/src/lib/model/sli/definition.d.ts +532 -0
- package/dist/src/lib/model/sli/definition.d.ts.map +1 -0
- package/dist/src/lib/model/sli/group.d.ts +10 -8
- package/dist/src/lib/model/sli/group.d.ts.map +1 -1
- package/dist/src/lib/model/sli/metrics-preview.d.ts +86 -0
- package/dist/src/lib/model/sli/metrics-preview.d.ts.map +1 -0
- package/dist/src/lib/model/sli/save.d.ts +24 -14
- package/dist/src/lib/model/sli/save.d.ts.map +1 -1
- package/dist/src/lib/model/sli/search.d.ts +8 -8
- package/dist/src/lib/model/sli/search.d.ts.map +1 -1
- package/dist/src/lib/model/tas/TAS.d.ts +82 -81
- package/dist/src/lib/model/tas/TAS.d.ts.map +1 -1
- package/dist/src/lib/model/tenant/status-page.d.ts +77 -0
- package/dist/src/lib/model/tenant/status-page.d.ts.map +1 -0
- package/dist/src/lib/services/acc.service.d.ts +5 -4
- package/dist/src/lib/services/acc.service.d.ts.map +1 -1
- package/dist/src/lib/services/agent.service.d.ts +7 -7
- package/dist/src/lib/services/agent.service.d.ts.map +1 -1
- package/dist/src/lib/services/alarm.service.d.ts +1 -1
- package/dist/src/lib/services/alarm.service.d.ts.map +1 -1
- package/dist/src/lib/services/apm-universe.service.d.ts +3 -2
- package/dist/src/lib/services/apm-universe.service.d.ts.map +1 -1
- package/dist/src/lib/services/attribute.service.d.ts +3 -2
- package/dist/src/lib/services/attribute.service.d.ts.map +1 -1
- package/dist/src/lib/services/authorization.service.d.ts +12 -1
- package/dist/src/lib/services/authorization.service.d.ts.map +1 -1
- package/dist/src/lib/services/axa.service.d.ts +4 -3
- package/dist/src/lib/services/axa.service.d.ts.map +1 -1
- package/dist/src/lib/services/channel.service.d.ts +7 -6
- package/dist/src/lib/services/channel.service.d.ts.map +1 -1
- package/dist/src/lib/services/dashboard.service.d.ts +8 -7
- package/dist/src/lib/services/dashboard.service.d.ts.map +1 -1
- package/dist/src/lib/services/datastore/datastore-service-universe.service.d.ts +129 -0
- package/dist/src/lib/services/datastore/datastore-service-universe.service.d.ts.map +1 -0
- package/dist/src/lib/services/dx-saas.service.d.ts +18 -0
- package/dist/src/lib/services/dx-saas.service.d.ts.map +1 -1
- package/dist/src/lib/services/dxoi.service.d.ts +1 -1
- package/dist/src/lib/services/dxoi.service.d.ts.map +1 -1
- package/dist/src/lib/services/experience.service.d.ts +3 -2
- package/dist/src/lib/services/experience.service.d.ts.map +1 -1
- package/dist/src/lib/services/inventory.service.d.ts +4 -3
- package/dist/src/lib/services/inventory.service.d.ts.map +1 -1
- package/dist/src/lib/services/management-module.service.d.ts +7 -6
- package/dist/src/lib/services/management-module.service.d.ts.map +1 -1
- package/dist/src/lib/services/metric-batch.service.d.ts +6 -5
- package/dist/src/lib/services/metric-batch.service.d.ts.map +1 -1
- package/dist/src/lib/services/o2-universe.service.d.ts +7 -6
- package/dist/src/lib/services/o2-universe.service.d.ts.map +1 -1
- package/dist/src/lib/services/service-monolith.d.ts +4 -0
- package/dist/src/lib/services/service-monolith.d.ts.map +1 -1
- package/dist/src/lib/services/service.service.d.ts +14 -13
- package/dist/src/lib/services/service.service.d.ts.map +1 -1
- package/dist/src/lib/services/situation.service.d.ts +3 -2
- package/dist/src/lib/services/situation.service.d.ts.map +1 -1
- package/dist/src/lib/services/sli.service.d.ts +49 -13
- package/dist/src/lib/services/sli.service.d.ts.map +1 -1
- package/dist/src/lib/services/tas.service.d.ts +3 -2
- package/dist/src/lib/services/tas.service.d.ts.map +1 -1
- package/dist/src/lib/services/tenant.service.d.ts +60 -0
- package/dist/src/lib/services/tenant.service.d.ts.map +1 -0
- package/dist/src/lib/services/vertex.service.d.ts +9 -8
- package/dist/src/lib/services/vertex.service.d.ts.map +1 -1
- package/dist/src/lib/util/vertex/vertex-search.d.ts +1 -1
- package/dist/src/lib/util/vertex/vertex-search.d.ts.map +1 -1
- package/package.json +2 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { type Client, type Options as Options2, type TDataShape } from
|
|
2
|
-
import type { ApiTokenCreateData, ApiTokenCreateErrors, ApiTokenCreateResponses, ApiTokenDeleteData, ApiTokenDeleteErrors, ApiTokenDeleteResponses, ApiTokenGetData, ApiTokenGetErrors, ApiTokenGetResponses, ApiTokenListData, ApiTokenListErrors, ApiTokenListResponses, ApiTokenUpdateData, ApiTokenUpdateErrors, ApiTokenUpdateResponses, CheckGetData, CheckGetErrors, CheckGetResponses, ContactActivateData, ContactActivateErrors, ContactActivateResponses, ContactDeleteData, ContactDeleteErrors, ContactDeleteResponses, ContactsBlockDeleteData, ContactsBlockDeleteErrors, ContactsBlockDeleteResponses, ContactsBlockPutData, ContactsBlockPutErrors, ContactsBlockPutResponses, ContactsConfirmData, ContactsConfirmErrors, ContactsConfirmResponses, ContactsCreateData, ContactsCreateErrors, ContactsCreateResponses, ContactsGetData, ContactsGetDetailData, ContactsGetDetailErrors, ContactsGetDetailResponses, ContactsGetErrors, ContactsGetResponses, ContactsReplaceNotificationsWithData, ContactsReplaceNotificationsWithErrors, ContactsReplaceNotificationsWithResponses, ContactsRequestConfirmationCodeData, ContactsRequestConfirmationCodeErrors, ContactsRequestConfirmationCodeResponses, ContactsUpdateData, ContactsUpdateErrors, ContactsUpdateResponses, ContactTestSendData, ContactTestSendErrors, ContactTestSendResponses, FolderAccessGetData, FolderAccessGetErrors, FolderAccessGetResponses, FolderDeleteData, FolderDeleteErrors, FolderDeleteResponses, FolderGetData, FolderGetErrors, FolderGetResponses, FolderPostData, FolderPostErrors, FolderPostResponses, FoldersListData, FoldersListErrors, FoldersListResponses, FolderUpdateData, FolderUpdateErrors, FolderUpdateResponses, LocationsCreateData, LocationsCreateErrors, LocationsCreateResponses, LocationsDeleteData, LocationsDeleteErrors, LocationsDeleteResponses, LocationsGetAllData, LocationsGetAllErrors, LocationsGetAllResponses, LocationsGetByTypeData, LocationsGetByTypeErrors, LocationsGetByTypeResponses, LocationsGetData, LocationsGetErrors, LocationsGetResponses, LocationsLeafGetFilterData, LocationsLeafGetFilterErrors, LocationsLeafGetFilterResponses, LocationsPostData, LocationsPostErrors, LocationsPostResponses, LogGetData, LogGetErrors, LogGetEventData, LogGetEventErrors, LogGetEventResponses, LogGetResponses, MaintenanceDeleteData, MaintenanceDeleteErrors, MaintenanceDeleteResponses, MaintenanceDeleteWindowsData, MaintenanceDeleteWindowsErrors, MaintenanceDeleteWindowsResponses, MaintenanceGetData, MaintenanceGetDetailData, MaintenanceGetDetailErrors, MaintenanceGetDetailResponses, MaintenanceGetErrors, MaintenanceGetResponses, MaintenanceGetWindowsData, MaintenanceGetWindowsDetailData, MaintenanceGetWindowsDetailErrors, MaintenanceGetWindowsDetailResponses, MaintenanceGetWindowsErrors, MaintenanceGetWindowsResponses, MaintenancesCreateData, MaintenancesCreateErrors, MaintenancesCreateResponses, MaintenancesImmediateDeleteData, MaintenancesImmediateDeleteErrors, MaintenancesImmediateDeleteResponses, MaintenancesImmediatePutData, MaintenancesImmediatePutErrors, MaintenancesImmediatePutResponses, MaintenancesPostWindowsData, MaintenancesPostWindowsErrors, MaintenancesPostWindowsResponses, MaintenancesUpdateData, MaintenancesUpdateErrors, MaintenancesUpdateResponses, MaintenanceUpdateWindowsDetailData, MaintenanceUpdateWindowsDetailErrors, MaintenanceUpdateWindowsDetailResponses, MessageGetData, MessageGetErrors, MessageGetResponses, MessagesListData, MessagesListErrors, MessagesListResponses, MonitorActivateData, MonitorActivateErrors, MonitorActivateResponses, MonitorCreateData, MonitorCreateErrors, MonitorCreateResponses, MonitorDeactivateData, MonitorDeactivateErrors, MonitorDeactivateResponses, MonitorDeleteData, MonitorDeleteErrors, MonitorDeleteResponses, MonitorGetAllData, MonitorGetAllErrors, MonitorGetAllResponses, MonitorGetData, MonitorGetErrors, MonitorGetResponses, MonitorUpdateData, MonitorUpdateErrors, MonitorUpdateResponses, OauthClientTokensCreateData, OauthClientTokensCreateErrors, OauthClientTokensCreateResponses, OauthClientTokensDeleteData, OauthClientTokensDeleteErrors, OauthClientTokensDeleteResponses, OauthClientTokensGetData, OauthClientTokensGetErrors, OauthClientTokensGetResponses, OauthClientTokensListData, OauthClientTokensListErrors, OauthClientTokensListResponses, OauthClientTokensUpdateData, OauthClientTokensUpdateErrors, OauthClientTokensUpdateResponses, OauthCreateTokenData, OauthCreateTokenErrors, OauthCreateTokenResponses, OauthGetRefreshTokenListData, OauthGetRefreshTokenListErrors, OauthGetRefreshTokenListResponses, OauthGetTokenListData, OauthGetTokenListErrors, OauthGetTokenListResponses, OauthRefreshTokenDeleteIdData, OauthRefreshTokenDeleteIdErrors, OauthRefreshTokenDeleteIdResponses, OauthTokenCognateDeleteCurrentData, OauthTokenCognateDeleteCurrentErrors, OauthTokenCognateDeleteCurrentResponses, OauthTokenCognateDeleteData, OauthTokenCognateDeleteErrors, OauthTokenCognateDeleteResponses, OauthTokenDeleteCurrentData, OauthTokenDeleteCurrentErrors, OauthTokenDeleteCurrentResponses, OauthTokenDeleteData, OauthTokenDeleteErrors, OauthTokenDeleteResponses, SettingsGetData, SettingsGetDetailData, SettingsGetDetailErrors, SettingsGetDetailResponses, SettingsGetErrors, SettingsGetResponses, SettingsUpdateData, SettingsUpdateErrors, SettingsUpdateResponses, StationDeleteData, StationDeleteErrors, StationDeleteResponses, StationsAgentTypeData, StationsAgentTypeErrors, StationsAgentTypeResponses, StationsCreateData, StationsCreateErrors, StationsCreateResponses, StationsDeleteMaintenanceData, StationsDeleteMaintenanceErrors, StationsDeleteMaintenanceResponses, StationsGetAgentsData, StationsGetAgentsErrors, StationsGetAgentsResponses, StationsGetData, StationsGetErrors, StationsGetResponses, StationsLatestData, StationsLatestResponses, StationsListData, StationsListErrors, StationsListResponses, StationsOnpremiseConnectedAllData, StationsOnpremiseConnectedAllErrors, StationsOnpremiseConnectedAllResponses, StationsOnpremiseConnectedData, StationsOnpremiseConnectedErrors, StationsOnpremiseConnectedResponses, StationsOnpremiseListData, StationsOnpremiseListErrors, StationsOnpremiseListResponses, StationsPutMaintenanceData, StationsPutMaintenanceErrors, StationsPutMaintenanceResponses, StationsUpdateData, StationsUpdateErrors, StationsUpdateResponses, StatisticData, StatisticErrors, StatisticResponses, TagsGetAllData, TagsGetAllErrors, TagsGetAllResponses, TimezonesListData, TimezonesListErrors, TimezonesListResponses, UserBlockDeleteData, UserBlockDeleteErrors, UserBlockDeleteResponses, UserBlockPutData, UserBlockPutErrors, UserBlockPutResponses, UserDeleteData, UserDeleteErrors, UserDeleteResponses, UserGetData, UserGetErrors, UserGetResponses, UserLockDeleteData, UserLockDeleteErrors, UserLockDeleteResponses, UserPutData, UserPutErrors, UserPutResponses, UserSubaccountsGetData, UserSubaccountsGetErrors, UserSubaccountsGetResponses, UserSubaccountsPostData, UserSubaccountsPostErrors, UserSubaccountsPostResponses } from
|
|
3
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
1
|
+
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from './client/index.js';
|
|
2
|
+
import type { ApiTokenCreateData, ApiTokenCreateErrors, ApiTokenCreateResponses, ApiTokenDeleteData, ApiTokenDeleteErrors, ApiTokenDeleteResponses, ApiTokenGetData, ApiTokenGetErrors, ApiTokenGetResponses, ApiTokenListData, ApiTokenListErrors, ApiTokenListResponses, ApiTokenUpdateData, ApiTokenUpdateErrors, ApiTokenUpdateResponses, CheckGetData, CheckGetErrors, CheckGetResponses, ContactActivateData, ContactActivateErrors, ContactActivateResponses, ContactDeleteData, ContactDeleteErrors, ContactDeleteResponses, ContactsBlockDeleteData, ContactsBlockDeleteErrors, ContactsBlockDeleteResponses, ContactsBlockPutData, ContactsBlockPutErrors, ContactsBlockPutResponses, ContactsConfirmData, ContactsConfirmErrors, ContactsConfirmResponses, ContactsCreateData, ContactsCreateErrors, ContactsCreateResponses, ContactsGetData, ContactsGetDetailData, ContactsGetDetailErrors, ContactsGetDetailResponses, ContactsGetErrors, ContactsGetResponses, ContactsReplaceNotificationsWithData, ContactsReplaceNotificationsWithErrors, ContactsReplaceNotificationsWithResponses, ContactsRequestConfirmationCodeData, ContactsRequestConfirmationCodeErrors, ContactsRequestConfirmationCodeResponses, ContactsUpdateData, ContactsUpdateErrors, ContactsUpdateResponses, ContactTestSendData, ContactTestSendErrors, ContactTestSendResponses, FolderAccessGetData, FolderAccessGetErrors, FolderAccessGetResponses, FolderDeleteData, FolderDeleteErrors, FolderDeleteResponses, FolderGetData, FolderGetErrors, FolderGetResponses, FolderPostData, FolderPostErrors, FolderPostResponses, FoldersListData, FoldersListErrors, FoldersListResponses, FolderUpdateData, FolderUpdateErrors, FolderUpdateResponses, LocationsCreateData, LocationsCreateErrors, LocationsCreateResponses, LocationsDeleteData, LocationsDeleteErrors, LocationsDeleteResponses, LocationsGetAllData, LocationsGetAllErrors, LocationsGetAllResponses, LocationsGetByTypeData, LocationsGetByTypeErrors, LocationsGetByTypeResponses, LocationsGetData, LocationsGetErrors, LocationsGetResponses, LocationsLeafGetFilterData, LocationsLeafGetFilterErrors, LocationsLeafGetFilterResponses, LocationsPostData, LocationsPostErrors, LocationsPostResponses, LogGetData, LogGetErrors, LogGetEventData, LogGetEventErrors, LogGetEventResponses, LogGetResponses, MaintenanceDeleteData, MaintenanceDeleteErrors, MaintenanceDeleteResponses, MaintenanceDeleteWindowsData, MaintenanceDeleteWindowsErrors, MaintenanceDeleteWindowsResponses, MaintenanceGetData, MaintenanceGetDetailData, MaintenanceGetDetailErrors, MaintenanceGetDetailResponses, MaintenanceGetErrors, MaintenanceGetResponses, MaintenanceGetWindowsData, MaintenanceGetWindowsDetailData, MaintenanceGetWindowsDetailErrors, MaintenanceGetWindowsDetailResponses, MaintenanceGetWindowsErrors, MaintenanceGetWindowsResponses, MaintenancesCreateData, MaintenancesCreateErrors, MaintenancesCreateResponses, MaintenancesImmediateDeleteData, MaintenancesImmediateDeleteErrors, MaintenancesImmediateDeleteResponses, MaintenancesImmediatePutData, MaintenancesImmediatePutErrors, MaintenancesImmediatePutResponses, MaintenancesPostWindowsData, MaintenancesPostWindowsErrors, MaintenancesPostWindowsResponses, MaintenancesUpdateData, MaintenancesUpdateErrors, MaintenancesUpdateResponses, MaintenanceUpdateWindowsDetailData, MaintenanceUpdateWindowsDetailErrors, MaintenanceUpdateWindowsDetailResponses, MessageGetData, MessageGetErrors, MessageGetResponses, MessagesListData, MessagesListErrors, MessagesListResponses, MonitorActivateData, MonitorActivateErrors, MonitorActivateResponses, MonitorCreateData, MonitorCreateErrors, MonitorCreateResponses, MonitorDeactivateData, MonitorDeactivateErrors, MonitorDeactivateResponses, MonitorDeleteData, MonitorDeleteErrors, MonitorDeleteResponses, MonitorGetAllData, MonitorGetAllErrors, MonitorGetAllResponses, MonitorGetData, MonitorGetErrors, MonitorGetResponses, MonitorUpdateData, MonitorUpdateErrors, MonitorUpdateResponses, OauthClientTokensCreateData, OauthClientTokensCreateErrors, OauthClientTokensCreateResponses, OauthClientTokensDeleteData, OauthClientTokensDeleteErrors, OauthClientTokensDeleteResponses, OauthClientTokensGetData, OauthClientTokensGetErrors, OauthClientTokensGetResponses, OauthClientTokensListData, OauthClientTokensListErrors, OauthClientTokensListResponses, OauthClientTokensUpdateData, OauthClientTokensUpdateErrors, OauthClientTokensUpdateResponses, OauthCreateTokenData, OauthCreateTokenErrors, OauthCreateTokenResponses, OauthGetRefreshTokenListData, OauthGetRefreshTokenListErrors, OauthGetRefreshTokenListResponses, OauthGetTokenListData, OauthGetTokenListErrors, OauthGetTokenListResponses, OauthRefreshTokenDeleteIdData, OauthRefreshTokenDeleteIdErrors, OauthRefreshTokenDeleteIdResponses, OauthTokenCognateDeleteCurrentData, OauthTokenCognateDeleteCurrentErrors, OauthTokenCognateDeleteCurrentResponses, OauthTokenCognateDeleteData, OauthTokenCognateDeleteErrors, OauthTokenCognateDeleteResponses, OauthTokenDeleteCurrentData, OauthTokenDeleteCurrentErrors, OauthTokenDeleteCurrentResponses, OauthTokenDeleteData, OauthTokenDeleteErrors, OauthTokenDeleteResponses, SettingsGetData, SettingsGetDetailData, SettingsGetDetailErrors, SettingsGetDetailResponses, SettingsGetErrors, SettingsGetResponses, SettingsUpdateData, SettingsUpdateErrors, SettingsUpdateResponses, StationDeleteData, StationDeleteErrors, StationDeleteResponses, StationsAgentTypeData, StationsAgentTypeErrors, StationsAgentTypeResponses, StationsCreateData, StationsCreateErrors, StationsCreateResponses, StationsDeleteMaintenanceData, StationsDeleteMaintenanceErrors, StationsDeleteMaintenanceResponses, StationsGetAgentsData, StationsGetAgentsErrors, StationsGetAgentsResponses, StationsGetData, StationsGetErrors, StationsGetResponses, StationsLatestData, StationsLatestResponses, StationsListData, StationsListErrors, StationsListResponses, StationsOnpremiseConnectedAllData, StationsOnpremiseConnectedAllErrors, StationsOnpremiseConnectedAllResponses, StationsOnpremiseConnectedData, StationsOnpremiseConnectedErrors, StationsOnpremiseConnectedResponses, StationsOnpremiseListData, StationsOnpremiseListErrors, StationsOnpremiseListResponses, StationsPutMaintenanceData, StationsPutMaintenanceErrors, StationsPutMaintenanceResponses, StationsUpdateData, StationsUpdateErrors, StationsUpdateResponses, StatisticData, StatisticErrors, StatisticResponses, TagsGetAllData, TagsGetAllErrors, TagsGetAllResponses, TimezonesListData, TimezonesListErrors, TimezonesListResponses, UserBlockDeleteData, UserBlockDeleteErrors, UserBlockDeleteResponses, UserBlockPutData, UserBlockPutErrors, UserBlockPutResponses, UserDeleteData, UserDeleteErrors, UserDeleteResponses, UserGetData, UserGetErrors, UserGetResponses, UserLockDeleteData, UserLockDeleteErrors, UserLockDeleteResponses, UserPutData, UserPutErrors, UserPutResponses, UserSubaccountsGetData, UserSubaccountsGetErrors, UserSubaccountsGetResponses, UserSubaccountsPostData, UserSubaccountsPostErrors, UserSubaccountsPostResponses } from './types.gen.js';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
6
6
|
* individual options. This might be also useful if you want to implement a
|
|
@@ -11,593 +11,575 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
11
11
|
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
12
|
* used to access values that aren't defined as part of the SDK function.
|
|
13
13
|
*/
|
|
14
|
-
meta?: Record<string, unknown
|
|
14
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
15
15
|
};
|
|
16
16
|
/**
|
|
17
17
|
* Get list of all api tokens for current account
|
|
18
18
|
*
|
|
19
19
|
* Get list of all api tokens for current account
|
|
20
20
|
*/
|
|
21
|
-
export declare const apiTokenList: <ThrowOnError extends boolean = false>(options?: Options<ApiTokenListData, ThrowOnError>) =>
|
|
21
|
+
export declare const apiTokenList: <ThrowOnError extends boolean = false>(options?: Options<ApiTokenListData, ThrowOnError>) => RequestResult<ApiTokenListResponses, ApiTokenListErrors, ThrowOnError>;
|
|
22
22
|
/**
|
|
23
23
|
* Creates a new token
|
|
24
24
|
*
|
|
25
25
|
* Creates a new token
|
|
26
26
|
*/
|
|
27
|
-
export declare const apiTokenCreate: <ThrowOnError extends boolean = false>(options: Options<ApiTokenCreateData, ThrowOnError>) =>
|
|
27
|
+
export declare const apiTokenCreate: <ThrowOnError extends boolean = false>(options: Options<ApiTokenCreateData, ThrowOnError>) => RequestResult<ApiTokenCreateResponses, ApiTokenCreateErrors, ThrowOnError>;
|
|
28
28
|
/**
|
|
29
29
|
* Deletes token with given ID
|
|
30
30
|
*
|
|
31
31
|
* Deletes token with given ID
|
|
32
32
|
*/
|
|
33
|
-
export declare const apiTokenDelete: <ThrowOnError extends boolean = false>(options: Options<ApiTokenDeleteData, ThrowOnError>) =>
|
|
33
|
+
export declare const apiTokenDelete: <ThrowOnError extends boolean = false>(options: Options<ApiTokenDeleteData, ThrowOnError>) => RequestResult<ApiTokenDeleteResponses, ApiTokenDeleteErrors, ThrowOnError>;
|
|
34
34
|
/**
|
|
35
35
|
* Get details about individual token
|
|
36
36
|
*
|
|
37
37
|
* Get details about individual token
|
|
38
38
|
*/
|
|
39
|
-
export declare const apiTokenGet: <ThrowOnError extends boolean = false>(options: Options<ApiTokenGetData, ThrowOnError>) =>
|
|
39
|
+
export declare const apiTokenGet: <ThrowOnError extends boolean = false>(options: Options<ApiTokenGetData, ThrowOnError>) => RequestResult<ApiTokenGetResponses, ApiTokenGetErrors, ThrowOnError>;
|
|
40
40
|
/**
|
|
41
41
|
* Update token's name and/or validity by its ID
|
|
42
42
|
*
|
|
43
43
|
* The name parameter is required. If you don't supply the valid_until parameter it will be set to null (which means infinite)
|
|
44
44
|
*/
|
|
45
|
-
export declare const apiTokenUpdate: <ThrowOnError extends boolean = false>(options: Options<ApiTokenUpdateData, ThrowOnError>) =>
|
|
45
|
+
export declare const apiTokenUpdate: <ThrowOnError extends boolean = false>(options: Options<ApiTokenUpdateData, ThrowOnError>) => RequestResult<ApiTokenUpdateResponses, ApiTokenUpdateErrors, ThrowOnError>;
|
|
46
46
|
/**
|
|
47
47
|
* Run a check
|
|
48
48
|
*
|
|
49
49
|
* Return a check result
|
|
50
50
|
*/
|
|
51
|
-
export declare const checkGet: <ThrowOnError extends boolean = false>(options: Options<CheckGetData, ThrowOnError>) =>
|
|
51
|
+
export declare const checkGet: <ThrowOnError extends boolean = false>(options: Options<CheckGetData, ThrowOnError>) => RequestResult<CheckGetResponses, CheckGetErrors, ThrowOnError>;
|
|
52
52
|
/**
|
|
53
53
|
* Get contacts user is permitted to view
|
|
54
54
|
*
|
|
55
55
|
* Get contacts
|
|
56
56
|
*/
|
|
57
|
-
export declare const contactsGet: <ThrowOnError extends boolean = false>(options?: Options<ContactsGetData, ThrowOnError>) =>
|
|
57
|
+
export declare const contactsGet: <ThrowOnError extends boolean = false>(options?: Options<ContactsGetData, ThrowOnError>) => RequestResult<ContactsGetResponses, ContactsGetErrors, ThrowOnError>;
|
|
58
58
|
/**
|
|
59
59
|
* Create a contact
|
|
60
60
|
*
|
|
61
61
|
* Create a contact. The contact will be inactive before you activate it (if applicable)
|
|
62
62
|
*/
|
|
63
|
-
export declare const contactsCreate: <ThrowOnError extends boolean = false>(options?: Options<ContactsCreateData, ThrowOnError>) =>
|
|
63
|
+
export declare const contactsCreate: <ThrowOnError extends boolean = false>(options?: Options<ContactsCreateData, ThrowOnError>) => RequestResult<ContactsCreateResponses, ContactsCreateErrors, ThrowOnError>;
|
|
64
64
|
/**
|
|
65
65
|
* Delete contact
|
|
66
66
|
*
|
|
67
67
|
* Delete contact and set up another as default if necessary
|
|
68
68
|
*/
|
|
69
|
-
export declare const contactDelete: <ThrowOnError extends boolean = false>(options: Options<ContactDeleteData, ThrowOnError>) =>
|
|
69
|
+
export declare const contactDelete: <ThrowOnError extends boolean = false>(options: Options<ContactDeleteData, ThrowOnError>) => RequestResult<ContactDeleteResponses, ContactDeleteErrors, ThrowOnError>;
|
|
70
70
|
/**
|
|
71
71
|
* Get details of a contact
|
|
72
72
|
*
|
|
73
73
|
* Get details of a contact
|
|
74
74
|
*/
|
|
75
|
-
export declare const contactsGetDetail: <ThrowOnError extends boolean = false>(options: Options<ContactsGetDetailData, ThrowOnError>) =>
|
|
75
|
+
export declare const contactsGetDetail: <ThrowOnError extends boolean = false>(options: Options<ContactsGetDetailData, ThrowOnError>) => RequestResult<ContactsGetDetailResponses, ContactsGetDetailErrors, ThrowOnError>;
|
|
76
76
|
/**
|
|
77
77
|
* Update a contact
|
|
78
78
|
*
|
|
79
79
|
* Update an contact. The contact will be inactive before you activate it (if applicable)
|
|
80
80
|
*/
|
|
81
|
-
export declare const contactsUpdate: <ThrowOnError extends boolean = false>(options: Options<ContactsUpdateData, ThrowOnError>) =>
|
|
81
|
+
export declare const contactsUpdate: <ThrowOnError extends boolean = false>(options: Options<ContactsUpdateData, ThrowOnError>) => RequestResult<ContactsUpdateResponses, ContactsUpdateErrors, ThrowOnError>;
|
|
82
82
|
/**
|
|
83
83
|
* Test contact
|
|
84
84
|
*
|
|
85
85
|
* Send a test message to the contact
|
|
86
86
|
*/
|
|
87
|
-
export declare const contactTestSend: <ThrowOnError extends boolean = false>(options: Options<ContactTestSendData, ThrowOnError>) =>
|
|
87
|
+
export declare const contactTestSend: <ThrowOnError extends boolean = false>(options: Options<ContactTestSendData, ThrowOnError>) => RequestResult<ContactTestSendResponses, ContactTestSendErrors, ThrowOnError>;
|
|
88
88
|
/**
|
|
89
89
|
* Activate a contact
|
|
90
90
|
*
|
|
91
91
|
* Activate a contact - change the account status from INACTIVE to CONFIRMED.
|
|
92
92
|
*/
|
|
93
|
-
export declare const contactActivate: <ThrowOnError extends boolean = false>(options: Options<ContactActivateData, ThrowOnError>) =>
|
|
93
|
+
export declare const contactActivate: <ThrowOnError extends boolean = false>(options: Options<ContactActivateData, ThrowOnError>) => RequestResult<ContactActivateResponses, ContactActivateErrors, ThrowOnError>;
|
|
94
94
|
/**
|
|
95
95
|
* Confirms a contact using the confirmation code
|
|
96
96
|
*
|
|
97
97
|
* Confirms a contact that has an unconfirmed status using the confirmation code received
|
|
98
98
|
*/
|
|
99
|
-
export declare const contactsConfirm: <ThrowOnError extends boolean = false>(options: Options<ContactsConfirmData, ThrowOnError>) =>
|
|
99
|
+
export declare const contactsConfirm: <ThrowOnError extends boolean = false>(options: Options<ContactsConfirmData, ThrowOnError>) => RequestResult<ContactsConfirmResponses, ContactsConfirmErrors, ThrowOnError>;
|
|
100
100
|
/**
|
|
101
101
|
* Request a confirmation code for the contact
|
|
102
102
|
*
|
|
103
103
|
* Request a confirmation code for the contact. This endpoint is rate limited.
|
|
104
104
|
*/
|
|
105
|
-
export declare const contactsRequestConfirmationCode: <ThrowOnError extends boolean = false>(options: Options<ContactsRequestConfirmationCodeData, ThrowOnError>) =>
|
|
105
|
+
export declare const contactsRequestConfirmationCode: <ThrowOnError extends boolean = false>(options: Options<ContactsRequestConfirmationCodeData, ThrowOnError>) => RequestResult<ContactsRequestConfirmationCodeResponses, ContactsRequestConfirmationCodeErrors, ThrowOnError>;
|
|
106
106
|
/**
|
|
107
107
|
* Unblock an account
|
|
108
108
|
*
|
|
109
|
-
* Unblock a contact - change the account status from BLOCKED to CONFIRMED.
|
|
110
|
-
* Only owner of the contact or privileged accounts can perform the action.
|
|
109
|
+
* Unblock a contact - change the account status from BLOCKED to CONFIRMED. Only owner of the contact or privileged accounts can perform the action.
|
|
111
110
|
*/
|
|
112
|
-
export declare const contactsBlockDelete: <ThrowOnError extends boolean = false>(options: Options<ContactsBlockDeleteData, ThrowOnError>) =>
|
|
111
|
+
export declare const contactsBlockDelete: <ThrowOnError extends boolean = false>(options: Options<ContactsBlockDeleteData, ThrowOnError>) => RequestResult<ContactsBlockDeleteResponses, ContactsBlockDeleteErrors, ThrowOnError>;
|
|
113
112
|
/**
|
|
114
113
|
* Block a contact
|
|
115
114
|
*
|
|
116
|
-
* Block a channel - change the account status from CONFIRMED to BLOCKED.
|
|
117
|
-
* Only owner of the contact or privileged accounts can perform the action.
|
|
115
|
+
* Block a channel - change the account status from CONFIRMED to BLOCKED. Only owner of the contact or privileged accounts can perform the action.
|
|
118
116
|
*/
|
|
119
|
-
export declare const contactsBlockPut: <ThrowOnError extends boolean = false>(options: Options<ContactsBlockPutData, ThrowOnError>) =>
|
|
117
|
+
export declare const contactsBlockPut: <ThrowOnError extends boolean = false>(options: Options<ContactsBlockPutData, ThrowOnError>) => RequestResult<ContactsBlockPutResponses, ContactsBlockPutErrors, ThrowOnError>;
|
|
120
118
|
/**
|
|
121
119
|
* Replace all usage of contact `{id}` in monitor notifications with another contact `{to}`
|
|
122
120
|
*
|
|
123
|
-
* Replace contact with another contact in monitor notifications.
|
|
124
|
-
* This is necessary before you want to delete contact `{id}`. This
|
|
125
|
-
* call will replace contacts only in monitors where you have the update permission.
|
|
121
|
+
* Replace contact with another contact in monitor notifications. This is necessary before you want to delete contact `{id}`. This call will replace contacts only in monitors where you have the update permission.
|
|
126
122
|
*/
|
|
127
|
-
export declare const contactsReplaceNotificationsWith: <ThrowOnError extends boolean = false>(options: Options<ContactsReplaceNotificationsWithData, ThrowOnError>) =>
|
|
123
|
+
export declare const contactsReplaceNotificationsWith: <ThrowOnError extends boolean = false>(options: Options<ContactsReplaceNotificationsWithData, ThrowOnError>) => RequestResult<ContactsReplaceNotificationsWithResponses, ContactsReplaceNotificationsWithErrors, ThrowOnError>;
|
|
128
124
|
/**
|
|
129
125
|
* Get monitor folders user is permitted to view
|
|
130
126
|
*
|
|
131
127
|
* Get folders
|
|
132
128
|
*/
|
|
133
|
-
export declare const foldersList: <ThrowOnError extends boolean = false>(options?: Options<FoldersListData, ThrowOnError>) =>
|
|
129
|
+
export declare const foldersList: <ThrowOnError extends boolean = false>(options?: Options<FoldersListData, ThrowOnError>) => RequestResult<FoldersListResponses, FoldersListErrors, ThrowOnError>;
|
|
134
130
|
/**
|
|
135
131
|
* Create monitor folder
|
|
136
132
|
*
|
|
137
133
|
* Create monitor folder
|
|
138
134
|
*/
|
|
139
|
-
export declare const folderPost: <ThrowOnError extends boolean = false>(options: Options<FolderPostData, ThrowOnError>) =>
|
|
135
|
+
export declare const folderPost: <ThrowOnError extends boolean = false>(options: Options<FolderPostData, ThrowOnError>) => RequestResult<FolderPostResponses, FolderPostErrors, ThrowOnError>;
|
|
140
136
|
/**
|
|
141
137
|
* Delete monitor folder
|
|
142
138
|
*
|
|
143
139
|
* Delete folder
|
|
144
140
|
*/
|
|
145
|
-
export declare const folderDelete: <ThrowOnError extends boolean = false>(options: Options<FolderDeleteData, ThrowOnError>) =>
|
|
141
|
+
export declare const folderDelete: <ThrowOnError extends boolean = false>(options: Options<FolderDeleteData, ThrowOnError>) => RequestResult<FolderDeleteResponses, FolderDeleteErrors, ThrowOnError>;
|
|
146
142
|
/**
|
|
147
143
|
* Get monitor folder detail
|
|
148
144
|
*
|
|
149
145
|
* Get folder
|
|
150
146
|
*/
|
|
151
|
-
export declare const folderGet: <ThrowOnError extends boolean = false>(options: Options<FolderGetData, ThrowOnError>) =>
|
|
147
|
+
export declare const folderGet: <ThrowOnError extends boolean = false>(options: Options<FolderGetData, ThrowOnError>) => RequestResult<FolderGetResponses, FolderGetErrors, ThrowOnError>;
|
|
152
148
|
/**
|
|
153
149
|
* Update monitor folder
|
|
154
150
|
*
|
|
155
151
|
* Update monitor folder
|
|
156
152
|
*/
|
|
157
|
-
export declare const folderUpdate: <ThrowOnError extends boolean = false>(options: Options<FolderUpdateData, ThrowOnError>) =>
|
|
153
|
+
export declare const folderUpdate: <ThrowOnError extends boolean = false>(options: Options<FolderUpdateData, ThrowOnError>) => RequestResult<FolderUpdateResponses, FolderUpdateErrors, ThrowOnError>;
|
|
158
154
|
/**
|
|
159
155
|
* Get monitor folders owned by caller with permissions granted to user's default role
|
|
160
156
|
*
|
|
161
157
|
* Get folders with permissions
|
|
162
158
|
*/
|
|
163
|
-
export declare const folderAccessGet: <ThrowOnError extends boolean = false>(options: Options<FolderAccessGetData, ThrowOnError>) =>
|
|
159
|
+
export declare const folderAccessGet: <ThrowOnError extends boolean = false>(options: Options<FolderAccessGetData, ThrowOnError>) => RequestResult<FolderAccessGetResponses, FolderAccessGetErrors, ThrowOnError>;
|
|
164
160
|
/**
|
|
165
161
|
* Delete monitoring station location
|
|
166
162
|
*
|
|
167
163
|
* Delete monitoring station location. It must not be used for monitoring and must be empty.
|
|
168
164
|
*/
|
|
169
|
-
export declare const locationsDelete: <ThrowOnError extends boolean = false>(options: Options<LocationsDeleteData, ThrowOnError>) =>
|
|
165
|
+
export declare const locationsDelete: <ThrowOnError extends boolean = false>(options: Options<LocationsDeleteData, ThrowOnError>) => RequestResult<LocationsDeleteResponses, LocationsDeleteErrors, ThrowOnError>;
|
|
170
166
|
/**
|
|
171
167
|
* Get monitoring station location
|
|
172
168
|
*
|
|
173
169
|
* Get monitoring station locations detailed information
|
|
174
170
|
*/
|
|
175
|
-
export declare const locationsGet: <ThrowOnError extends boolean = false>(options: Options<LocationsGetData, ThrowOnError>) =>
|
|
171
|
+
export declare const locationsGet: <ThrowOnError extends boolean = false>(options: Options<LocationsGetData, ThrowOnError>) => RequestResult<LocationsGetResponses, LocationsGetErrors, ThrowOnError>;
|
|
176
172
|
/**
|
|
177
173
|
* Update location
|
|
178
174
|
*
|
|
179
|
-
* Update location. The new location can be moved as child of another sub-location -
|
|
180
|
-
* provide parent ID of the new parent location or country iso code of the new public parent location.
|
|
175
|
+
* Update location. The new location can be moved as child of another sub-location - provide parent ID of the new parent location or country iso code of the new public parent location.
|
|
181
176
|
*/
|
|
182
|
-
export declare const locationsPost: <ThrowOnError extends boolean = false>(options: Options<LocationsPostData, ThrowOnError>) =>
|
|
177
|
+
export declare const locationsPost: <ThrowOnError extends boolean = false>(options: Options<LocationsPostData, ThrowOnError>) => RequestResult<LocationsPostResponses, LocationsPostErrors, ThrowOnError>;
|
|
183
178
|
/**
|
|
184
179
|
* Get monitoring station locations filtered by public / private type
|
|
185
180
|
*
|
|
186
181
|
* Get monitoring stations' locations useable either as a container of monitoring stations or other locations
|
|
187
182
|
*/
|
|
188
|
-
export declare const locationsGetByType: <ThrowOnError extends boolean = false>(options: Options<LocationsGetByTypeData, ThrowOnError>) =>
|
|
183
|
+
export declare const locationsGetByType: <ThrowOnError extends boolean = false>(options: Options<LocationsGetByTypeData, ThrowOnError>) => RequestResult<LocationsGetByTypeResponses, LocationsGetByTypeErrors, ThrowOnError>;
|
|
189
184
|
/**
|
|
190
185
|
* Get all monitoring station locations
|
|
191
186
|
*
|
|
192
187
|
* Get monitoring stations' locations useable either as a container of monitoring stations or other locations
|
|
193
188
|
*/
|
|
194
|
-
export declare const locationsGetAll: <ThrowOnError extends boolean = false>(options?: Options<LocationsGetAllData, ThrowOnError>) =>
|
|
189
|
+
export declare const locationsGetAll: <ThrowOnError extends boolean = false>(options?: Options<LocationsGetAllData, ThrowOnError>) => RequestResult<LocationsGetAllResponses, LocationsGetAllErrors, ThrowOnError>;
|
|
195
190
|
/**
|
|
196
191
|
* Create new location
|
|
197
192
|
*
|
|
198
|
-
* Insert new location. The location can be placed as child sub-location of another location -
|
|
199
|
-
* provide parent as ID of the parent location or country iso code of the public location.
|
|
193
|
+
* Insert new location. The location can be placed as child sub-location of another location - provide parent as ID of the parent location or country iso code of the public location.
|
|
200
194
|
*/
|
|
201
|
-
export declare const locationsCreate: <ThrowOnError extends boolean = false>(options: Options<LocationsCreateData, ThrowOnError>) =>
|
|
195
|
+
export declare const locationsCreate: <ThrowOnError extends boolean = false>(options: Options<LocationsCreateData, ThrowOnError>) => RequestResult<LocationsCreateResponses, LocationsCreateErrors, ThrowOnError>;
|
|
202
196
|
/**
|
|
203
197
|
* Get monitoring stations' leaf-locations
|
|
204
198
|
*
|
|
205
199
|
* Get monitoring stations' leaf-locations - possible or real monitoring station containers
|
|
206
200
|
*/
|
|
207
|
-
export declare const locationsLeafGetFilter: <ThrowOnError extends boolean = false>(options: Options<LocationsLeafGetFilterData, ThrowOnError>) =>
|
|
201
|
+
export declare const locationsLeafGetFilter: <ThrowOnError extends boolean = false>(options: Options<LocationsLeafGetFilterData, ThrowOnError>) => RequestResult<LocationsLeafGetFilterResponses, LocationsLeafGetFilterErrors, ThrowOnError>;
|
|
208
202
|
/**
|
|
209
203
|
* Get monitor check results
|
|
210
204
|
*
|
|
211
205
|
* Get monitor check results
|
|
212
206
|
*/
|
|
213
|
-
export declare const logGet: <ThrowOnError extends boolean = false>(options?: Options<LogGetData, ThrowOnError>) =>
|
|
207
|
+
export declare const logGet: <ThrowOnError extends boolean = false>(options?: Options<LogGetData, ThrowOnError>) => RequestResult<LogGetResponses, LogGetErrors, ThrowOnError>;
|
|
214
208
|
/**
|
|
215
209
|
* Get a single event
|
|
216
210
|
*
|
|
217
211
|
* Get a single event
|
|
218
212
|
*/
|
|
219
|
-
export declare const logGetEvent: <ThrowOnError extends boolean = false>(options: Options<LogGetEventData, ThrowOnError>) =>
|
|
213
|
+
export declare const logGetEvent: <ThrowOnError extends boolean = false>(options: Options<LogGetEventData, ThrowOnError>) => RequestResult<LogGetEventResponses, LogGetEventErrors, ThrowOnError>;
|
|
220
214
|
/**
|
|
221
215
|
* Get maintenances user is permitted to view
|
|
222
216
|
*
|
|
223
217
|
* Get maintenances
|
|
224
218
|
*/
|
|
225
|
-
export declare const maintenanceGet: <ThrowOnError extends boolean = false>(options?: Options<MaintenanceGetData, ThrowOnError>) =>
|
|
219
|
+
export declare const maintenanceGet: <ThrowOnError extends boolean = false>(options?: Options<MaintenanceGetData, ThrowOnError>) => RequestResult<MaintenanceGetResponses, MaintenanceGetErrors, ThrowOnError>;
|
|
226
220
|
/**
|
|
227
221
|
* Create a new maintenance window
|
|
228
222
|
*
|
|
229
223
|
* Create a new maintenance window
|
|
230
224
|
*/
|
|
231
|
-
export declare const maintenancesCreate: <ThrowOnError extends boolean = false>(options: Options<MaintenancesCreateData, ThrowOnError>) =>
|
|
225
|
+
export declare const maintenancesCreate: <ThrowOnError extends boolean = false>(options: Options<MaintenancesCreateData, ThrowOnError>) => RequestResult<MaintenancesCreateResponses, MaintenancesCreateErrors, ThrowOnError>;
|
|
232
226
|
/**
|
|
233
227
|
* Delete maintenance
|
|
234
228
|
*
|
|
235
229
|
* Delete maintenance
|
|
236
230
|
*/
|
|
237
|
-
export declare const maintenanceDelete: <ThrowOnError extends boolean = false>(options: Options<MaintenanceDeleteData, ThrowOnError>) =>
|
|
231
|
+
export declare const maintenanceDelete: <ThrowOnError extends boolean = false>(options: Options<MaintenanceDeleteData, ThrowOnError>) => RequestResult<MaintenanceDeleteResponses, MaintenanceDeleteErrors, ThrowOnError>;
|
|
238
232
|
/**
|
|
239
233
|
* Get a maintenance window detail
|
|
240
234
|
*
|
|
241
235
|
* Get a single maintenance window detail
|
|
242
236
|
*/
|
|
243
|
-
export declare const maintenanceGetDetail: <ThrowOnError extends boolean = false>(options: Options<MaintenanceGetDetailData, ThrowOnError>) =>
|
|
237
|
+
export declare const maintenanceGetDetail: <ThrowOnError extends boolean = false>(options: Options<MaintenanceGetDetailData, ThrowOnError>) => RequestResult<MaintenanceGetDetailResponses, MaintenanceGetDetailErrors, ThrowOnError>;
|
|
244
238
|
/**
|
|
245
239
|
* Updates the maintenance window
|
|
246
240
|
*
|
|
247
241
|
* Updates the maintenance window. All values provided will be replaced with new values, values not provided in the schema will not be modified.
|
|
248
242
|
*/
|
|
249
|
-
export declare const maintenancesUpdate: <ThrowOnError extends boolean = false>(options: Options<MaintenancesUpdateData, ThrowOnError>) =>
|
|
243
|
+
export declare const maintenancesUpdate: <ThrowOnError extends boolean = false>(options: Options<MaintenancesUpdateData, ThrowOnError>) => RequestResult<MaintenancesUpdateResponses, MaintenancesUpdateErrors, ThrowOnError>;
|
|
250
244
|
/**
|
|
251
245
|
* List individual time windows from a maintenance window
|
|
252
246
|
*
|
|
253
247
|
* List individual time windows from a maintenance window
|
|
254
248
|
*/
|
|
255
|
-
export declare const maintenanceGetWindows: <ThrowOnError extends boolean = false>(options: Options<MaintenanceGetWindowsData, ThrowOnError>) =>
|
|
249
|
+
export declare const maintenanceGetWindows: <ThrowOnError extends boolean = false>(options: Options<MaintenanceGetWindowsData, ThrowOnError>) => RequestResult<MaintenanceGetWindowsResponses, MaintenanceGetWindowsErrors, ThrowOnError>;
|
|
256
250
|
/**
|
|
257
251
|
* Create a time window inside maintenance window
|
|
258
252
|
*
|
|
259
253
|
* Create a time window inside maintenance window.
|
|
260
254
|
*/
|
|
261
|
-
export declare const maintenancesPostWindows: <ThrowOnError extends boolean = false>(options: Options<MaintenancesPostWindowsData, ThrowOnError>) =>
|
|
255
|
+
export declare const maintenancesPostWindows: <ThrowOnError extends boolean = false>(options: Options<MaintenancesPostWindowsData, ThrowOnError>) => RequestResult<MaintenancesPostWindowsResponses, MaintenancesPostWindowsErrors, ThrowOnError>;
|
|
262
256
|
/**
|
|
263
257
|
* Delete a time window from maintenance window
|
|
264
258
|
*
|
|
265
259
|
* Delete a time window from maintenance window
|
|
266
260
|
*/
|
|
267
|
-
export declare const maintenanceDeleteWindows: <ThrowOnError extends boolean = false>(options: Options<MaintenanceDeleteWindowsData, ThrowOnError>) =>
|
|
261
|
+
export declare const maintenanceDeleteWindows: <ThrowOnError extends boolean = false>(options: Options<MaintenanceDeleteWindowsData, ThrowOnError>) => RequestResult<MaintenanceDeleteWindowsResponses, MaintenanceDeleteWindowsErrors, ThrowOnError>;
|
|
268
262
|
/**
|
|
269
263
|
* Get individual time window from maintenance window
|
|
270
264
|
*
|
|
271
265
|
* Get individual time window from maintenance window
|
|
272
266
|
*/
|
|
273
|
-
export declare const maintenanceGetWindowsDetail: <ThrowOnError extends boolean = false>(options: Options<MaintenanceGetWindowsDetailData, ThrowOnError>) =>
|
|
267
|
+
export declare const maintenanceGetWindowsDetail: <ThrowOnError extends boolean = false>(options: Options<MaintenanceGetWindowsDetailData, ThrowOnError>) => RequestResult<MaintenanceGetWindowsDetailResponses, MaintenanceGetWindowsDetailErrors, ThrowOnError>;
|
|
274
268
|
/**
|
|
275
269
|
* Update time window from maintenance window
|
|
276
270
|
*
|
|
277
271
|
* Update time window from maintenance window
|
|
278
272
|
*/
|
|
279
|
-
export declare const maintenanceUpdateWindowsDetail: <ThrowOnError extends boolean = false>(options: Options<MaintenanceUpdateWindowsDetailData, ThrowOnError>) =>
|
|
273
|
+
export declare const maintenanceUpdateWindowsDetail: <ThrowOnError extends boolean = false>(options: Options<MaintenanceUpdateWindowsDetailData, ThrowOnError>) => RequestResult<MaintenanceUpdateWindowsDetailResponses, MaintenanceUpdateWindowsDetailErrors, ThrowOnError>;
|
|
280
274
|
/**
|
|
281
275
|
* Finish the immediate maintenance
|
|
282
276
|
*
|
|
283
|
-
* Finish the immediate maintenance mode for selected monitors.
|
|
284
|
-
* This affects the special monitor specific immediate-maintenance only.
|
|
285
|
-
* You need monitor update permission for the selected monitors.
|
|
277
|
+
* Finish the immediate maintenance mode for selected monitors. This affects the special monitor specific immediate-maintenance only. You need monitor update permission for the selected monitors.
|
|
286
278
|
*/
|
|
287
|
-
export declare const maintenancesImmediateDelete: <ThrowOnError extends boolean = false>(options: Options<MaintenancesImmediateDeleteData, ThrowOnError>) =>
|
|
279
|
+
export declare const maintenancesImmediateDelete: <ThrowOnError extends boolean = false>(options: Options<MaintenancesImmediateDeleteData, ThrowOnError>) => RequestResult<MaintenancesImmediateDeleteResponses, MaintenancesImmediateDeleteErrors, ThrowOnError>;
|
|
288
280
|
/**
|
|
289
281
|
* Put monitors in immediate maintenance
|
|
290
282
|
*
|
|
291
|
-
* Put selected monitors to immediate maintenance. This creates or updates a
|
|
292
|
-
* special monitor specific immediate-maintenance window. You need monitor
|
|
293
|
-
* update permission for the selected monitors.
|
|
283
|
+
* Put selected monitors to immediate maintenance. This creates or updates a special monitor specific immediate-maintenance window. You need monitor update permission for the selected monitors.
|
|
294
284
|
*/
|
|
295
|
-
export declare const maintenancesImmediatePut: <ThrowOnError extends boolean = false>(options: Options<MaintenancesImmediatePutData, ThrowOnError>) =>
|
|
285
|
+
export declare const maintenancesImmediatePut: <ThrowOnError extends boolean = false>(options: Options<MaintenancesImmediatePutData, ThrowOnError>) => RequestResult<MaintenancesImmediatePutResponses, MaintenancesImmediatePutErrors, ThrowOnError>;
|
|
296
286
|
/**
|
|
297
287
|
* Get messages. If no filter is applied messages of the user are returned (by user ID).
|
|
298
288
|
*
|
|
299
289
|
* Get messages
|
|
300
290
|
*/
|
|
301
|
-
export declare const messagesList: <ThrowOnError extends boolean = false>(options?: Options<MessagesListData, ThrowOnError>) =>
|
|
291
|
+
export declare const messagesList: <ThrowOnError extends boolean = false>(options?: Options<MessagesListData, ThrowOnError>) => RequestResult<MessagesListResponses, MessagesListErrors, ThrowOnError>;
|
|
302
292
|
/**
|
|
303
293
|
* Get message by ID
|
|
304
294
|
*
|
|
305
295
|
* Get message
|
|
306
296
|
*/
|
|
307
|
-
export declare const messageGet: <ThrowOnError extends boolean = false>(options: Options<MessageGetData, ThrowOnError>) =>
|
|
297
|
+
export declare const messageGet: <ThrowOnError extends boolean = false>(options: Options<MessageGetData, ThrowOnError>) => RequestResult<MessageGetResponses, MessageGetErrors, ThrowOnError>;
|
|
308
298
|
/**
|
|
309
299
|
* Get all monitors details.
|
|
310
300
|
*
|
|
311
|
-
* Get list of monitors. Only the common monitor parameters are shown
|
|
312
|
-
* in the response schemas, for full individual monitor types see the corresponding schemas.
|
|
301
|
+
* Get list of monitors. Only the common monitor parameters are shown in the response schemas, for full individual monitor types see the corresponding schemas.
|
|
313
302
|
* The result returned depends on the framesOnly and pagination parameters.
|
|
314
303
|
* The content of the jmeter and webdriver scripts is not populated, get monitor by ID for full monitor details.
|
|
315
304
|
*/
|
|
316
|
-
export declare const monitorGetAll: <ThrowOnError extends boolean = false>(options?: Options<MonitorGetAllData, ThrowOnError>) =>
|
|
305
|
+
export declare const monitorGetAll: <ThrowOnError extends boolean = false>(options?: Options<MonitorGetAllData, ThrowOnError>) => RequestResult<MonitorGetAllResponses, MonitorGetAllErrors, ThrowOnError>;
|
|
317
306
|
/**
|
|
318
307
|
* Create a monitor
|
|
319
308
|
*
|
|
320
309
|
* Create a monitor
|
|
321
310
|
*/
|
|
322
|
-
export declare const monitorCreate: <ThrowOnError extends boolean = false>(options: Options<MonitorCreateData, ThrowOnError>) =>
|
|
311
|
+
export declare const monitorCreate: <ThrowOnError extends boolean = false>(options: Options<MonitorCreateData, ThrowOnError>) => RequestResult<MonitorCreateResponses, MonitorCreateErrors, ThrowOnError>;
|
|
323
312
|
/**
|
|
324
313
|
* Delete monitor
|
|
325
314
|
*
|
|
326
315
|
* Delete monitor
|
|
327
316
|
*/
|
|
328
|
-
export declare const monitorDelete: <ThrowOnError extends boolean = false>(options: Options<MonitorDeleteData, ThrowOnError>) =>
|
|
317
|
+
export declare const monitorDelete: <ThrowOnError extends boolean = false>(options: Options<MonitorDeleteData, ThrowOnError>) => RequestResult<MonitorDeleteResponses, MonitorDeleteErrors, ThrowOnError>;
|
|
329
318
|
/**
|
|
330
319
|
* Get monitor details
|
|
331
320
|
*
|
|
332
321
|
* Get detail of a monitor. Only the common parameters are shown, to see details of individual types see the Schemas.
|
|
333
322
|
*/
|
|
334
|
-
export declare const monitorGet: <ThrowOnError extends boolean = false>(options: Options<MonitorGetData, ThrowOnError>) =>
|
|
323
|
+
export declare const monitorGet: <ThrowOnError extends boolean = false>(options: Options<MonitorGetData, ThrowOnError>) => RequestResult<MonitorGetResponses, MonitorGetErrors, ThrowOnError>;
|
|
335
324
|
/**
|
|
336
325
|
* Update a monitor
|
|
337
326
|
*
|
|
338
327
|
* Update a monitor
|
|
339
328
|
*/
|
|
340
|
-
export declare const monitorUpdate: <ThrowOnError extends boolean = false>(options: Options<MonitorUpdateData, ThrowOnError>) =>
|
|
329
|
+
export declare const monitorUpdate: <ThrowOnError extends boolean = false>(options: Options<MonitorUpdateData, ThrowOnError>) => RequestResult<MonitorUpdateResponses, MonitorUpdateErrors, ThrowOnError>;
|
|
341
330
|
/**
|
|
342
331
|
* Activate monitors
|
|
343
332
|
*
|
|
344
333
|
* Activate monitors
|
|
345
334
|
*/
|
|
346
|
-
export declare const monitorActivate: <ThrowOnError extends boolean = false>(options: Options<MonitorActivateData, ThrowOnError>) =>
|
|
335
|
+
export declare const monitorActivate: <ThrowOnError extends boolean = false>(options: Options<MonitorActivateData, ThrowOnError>) => RequestResult<MonitorActivateResponses, MonitorActivateErrors, ThrowOnError>;
|
|
347
336
|
/**
|
|
348
337
|
* Deactivate monitors
|
|
349
338
|
*
|
|
350
339
|
* Deactivate monitors
|
|
351
340
|
*/
|
|
352
|
-
export declare const monitorDeactivate: <ThrowOnError extends boolean = false>(options: Options<MonitorDeactivateData, ThrowOnError>) =>
|
|
341
|
+
export declare const monitorDeactivate: <ThrowOnError extends boolean = false>(options: Options<MonitorDeactivateData, ThrowOnError>) => RequestResult<MonitorDeactivateResponses, MonitorDeactivateErrors, ThrowOnError>;
|
|
353
342
|
/**
|
|
354
343
|
* Returns list of oauth client credentials
|
|
355
344
|
*
|
|
356
345
|
* Returns list of oauth client credentials
|
|
357
346
|
*/
|
|
358
|
-
export declare const oauthClientTokensList: <ThrowOnError extends boolean = false>(options?: Options<OauthClientTokensListData, ThrowOnError>) =>
|
|
347
|
+
export declare const oauthClientTokensList: <ThrowOnError extends boolean = false>(options?: Options<OauthClientTokensListData, ThrowOnError>) => RequestResult<OauthClientTokensListResponses, OauthClientTokensListErrors, ThrowOnError>;
|
|
359
348
|
/**
|
|
360
349
|
* Creates new client credentials
|
|
361
350
|
*
|
|
362
351
|
* Creates new client credentials
|
|
363
352
|
*/
|
|
364
|
-
export declare const oauthClientTokensCreate: <ThrowOnError extends boolean = false>(options: Options<OauthClientTokensCreateData, ThrowOnError>) =>
|
|
353
|
+
export declare const oauthClientTokensCreate: <ThrowOnError extends boolean = false>(options: Options<OauthClientTokensCreateData, ThrowOnError>) => RequestResult<OauthClientTokensCreateResponses, OauthClientTokensCreateErrors, ThrowOnError>;
|
|
365
354
|
/**
|
|
366
355
|
* Deletes individual credentials
|
|
367
356
|
*
|
|
368
357
|
* Deletes individual credentials
|
|
369
358
|
*/
|
|
370
|
-
export declare const oauthClientTokensDelete: <ThrowOnError extends boolean = false>(options: Options<OauthClientTokensDeleteData, ThrowOnError>) =>
|
|
359
|
+
export declare const oauthClientTokensDelete: <ThrowOnError extends boolean = false>(options: Options<OauthClientTokensDeleteData, ThrowOnError>) => RequestResult<OauthClientTokensDeleteResponses, OauthClientTokensDeleteErrors, ThrowOnError>;
|
|
371
360
|
/**
|
|
372
361
|
* Returns individual client credentials
|
|
373
362
|
*
|
|
374
363
|
* Returns individual client credentials
|
|
375
364
|
*/
|
|
376
|
-
export declare const oauthClientTokensGet: <ThrowOnError extends boolean = false>(options: Options<OauthClientTokensGetData, ThrowOnError>) =>
|
|
365
|
+
export declare const oauthClientTokensGet: <ThrowOnError extends boolean = false>(options: Options<OauthClientTokensGetData, ThrowOnError>) => RequestResult<OauthClientTokensGetResponses, OauthClientTokensGetErrors, ThrowOnError>;
|
|
377
366
|
/**
|
|
378
367
|
* Updates client credentials
|
|
379
368
|
*
|
|
380
369
|
* Updates client credentials
|
|
381
370
|
*/
|
|
382
|
-
export declare const oauthClientTokensUpdate: <ThrowOnError extends boolean = false>(options: Options<OauthClientTokensUpdateData, ThrowOnError>) =>
|
|
371
|
+
export declare const oauthClientTokensUpdate: <ThrowOnError extends boolean = false>(options: Options<OauthClientTokensUpdateData, ThrowOnError>) => RequestResult<OauthClientTokensUpdateResponses, OauthClientTokensUpdateErrors, ThrowOnError>;
|
|
383
372
|
/**
|
|
384
373
|
* Invalidate current access token
|
|
385
374
|
*
|
|
386
375
|
* Invalidate access token used in this request
|
|
387
376
|
*/
|
|
388
|
-
export declare const oauthTokenDeleteCurrent: <ThrowOnError extends boolean = false>(options?: Options<OauthTokenDeleteCurrentData, ThrowOnError>) =>
|
|
377
|
+
export declare const oauthTokenDeleteCurrent: <ThrowOnError extends boolean = false>(options?: Options<OauthTokenDeleteCurrentData, ThrowOnError>) => RequestResult<OauthTokenDeleteCurrentResponses, OauthTokenDeleteCurrentErrors, ThrowOnError>;
|
|
389
378
|
/**
|
|
390
379
|
* Get list of OAuth access tokens.
|
|
391
380
|
*
|
|
392
381
|
* Get list of OAuth access tokens
|
|
393
382
|
*/
|
|
394
|
-
export declare const oauthGetTokenList: <ThrowOnError extends boolean = false>(options?: Options<OauthGetTokenListData, ThrowOnError>) =>
|
|
383
|
+
export declare const oauthGetTokenList: <ThrowOnError extends boolean = false>(options?: Options<OauthGetTokenListData, ThrowOnError>) => RequestResult<OauthGetTokenListResponses, OauthGetTokenListErrors, ThrowOnError>;
|
|
395
384
|
/**
|
|
396
385
|
* Obtain access token using one of the supported grants.
|
|
397
386
|
*
|
|
398
|
-
* Obtain access token using one of the supported grants. The authorization code
|
|
399
|
-
* grant must be sent using application/json; not standard application/x-www-form-urlencoded
|
|
387
|
+
* Obtain access token using one of the supported grants. The authorization code grant must be sent using application/json; not standard application/x-www-form-urlencoded
|
|
400
388
|
*/
|
|
401
|
-
export declare const oauthCreateToken: <ThrowOnError extends boolean = false>(options?: Options<OauthCreateTokenData, ThrowOnError>) =>
|
|
389
|
+
export declare const oauthCreateToken: <ThrowOnError extends boolean = false>(options?: Options<OauthCreateTokenData, ThrowOnError>) => RequestResult<OauthCreateTokenResponses, OauthCreateTokenErrors, ThrowOnError>;
|
|
402
390
|
/**
|
|
403
391
|
* Get list of OAuth refresh tokens.
|
|
404
392
|
*
|
|
405
393
|
* Get list of OAuth refresh tokens
|
|
406
394
|
*/
|
|
407
|
-
export declare const oauthGetRefreshTokenList: <ThrowOnError extends boolean = false>(options?: Options<OauthGetRefreshTokenListData, ThrowOnError>) =>
|
|
395
|
+
export declare const oauthGetRefreshTokenList: <ThrowOnError extends boolean = false>(options?: Options<OauthGetRefreshTokenListData, ThrowOnError>) => RequestResult<OauthGetRefreshTokenListResponses, OauthGetRefreshTokenListErrors, ThrowOnError>;
|
|
408
396
|
/**
|
|
409
397
|
* Invalidate access token
|
|
410
398
|
*
|
|
411
399
|
* Invalidate given access token or token given by ID
|
|
412
400
|
*/
|
|
413
|
-
export declare const oauthTokenDelete: <ThrowOnError extends boolean = false>(options: Options<OauthTokenDeleteData, ThrowOnError>) =>
|
|
401
|
+
export declare const oauthTokenDelete: <ThrowOnError extends boolean = false>(options: Options<OauthTokenDeleteData, ThrowOnError>) => RequestResult<OauthTokenDeleteResponses, OauthTokenDeleteErrors, ThrowOnError>;
|
|
414
402
|
/**
|
|
415
403
|
* Invalidate refresh token by ID
|
|
416
404
|
*
|
|
417
405
|
* Invalidate given access token
|
|
418
406
|
*/
|
|
419
|
-
export declare const oauthRefreshTokenDeleteId: <ThrowOnError extends boolean = false>(options: Options<OauthRefreshTokenDeleteIdData, ThrowOnError>) =>
|
|
407
|
+
export declare const oauthRefreshTokenDeleteId: <ThrowOnError extends boolean = false>(options: Options<OauthRefreshTokenDeleteIdData, ThrowOnError>) => RequestResult<OauthRefreshTokenDeleteIdResponses, OauthRefreshTokenDeleteIdErrors, ThrowOnError>;
|
|
420
408
|
/**
|
|
421
409
|
* Invalidate all access tokens of the same type as the current access token
|
|
422
410
|
*
|
|
423
411
|
* Invalidate all access token issued for the same user and client as the access token in the request
|
|
424
412
|
*/
|
|
425
|
-
export declare const oauthTokenCognateDeleteCurrent: <ThrowOnError extends boolean = false>(options?: Options<OauthTokenCognateDeleteCurrentData, ThrowOnError>) =>
|
|
413
|
+
export declare const oauthTokenCognateDeleteCurrent: <ThrowOnError extends boolean = false>(options?: Options<OauthTokenCognateDeleteCurrentData, ThrowOnError>) => RequestResult<OauthTokenCognateDeleteCurrentResponses, OauthTokenCognateDeleteCurrentErrors, ThrowOnError>;
|
|
426
414
|
/**
|
|
427
415
|
* Invalidate all access tokens of the same type as the given access token
|
|
428
416
|
*
|
|
429
417
|
* Invalidate all access token issued for the same user and client as the given access token
|
|
430
418
|
*/
|
|
431
|
-
export declare const oauthTokenCognateDelete: <ThrowOnError extends boolean = false>(options: Options<OauthTokenCognateDeleteData, ThrowOnError>) =>
|
|
419
|
+
export declare const oauthTokenCognateDelete: <ThrowOnError extends boolean = false>(options: Options<OauthTokenCognateDeleteData, ThrowOnError>) => RequestResult<OauthTokenCognateDeleteResponses, OauthTokenCognateDeleteErrors, ThrowOnError>;
|
|
432
420
|
/**
|
|
433
421
|
* Get settings
|
|
434
422
|
*
|
|
435
423
|
* Get settings
|
|
436
424
|
*/
|
|
437
|
-
export declare const settingsGet: <ThrowOnError extends boolean = false>(options?: Options<SettingsGetData, ThrowOnError>) =>
|
|
425
|
+
export declare const settingsGet: <ThrowOnError extends boolean = false>(options?: Options<SettingsGetData, ThrowOnError>) => RequestResult<SettingsGetResponses, SettingsGetErrors, ThrowOnError>;
|
|
438
426
|
/**
|
|
439
427
|
* Get a settings value
|
|
440
428
|
*
|
|
441
429
|
* Get a single settings value
|
|
442
430
|
*/
|
|
443
|
-
export declare const settingsGetDetail: <ThrowOnError extends boolean = false>(options: Options<SettingsGetDetailData, ThrowOnError>) =>
|
|
431
|
+
export declare const settingsGetDetail: <ThrowOnError extends boolean = false>(options: Options<SettingsGetDetailData, ThrowOnError>) => RequestResult<SettingsGetDetailResponses, SettingsGetDetailErrors, ThrowOnError>;
|
|
444
432
|
/**
|
|
445
433
|
* Update the settings value
|
|
446
434
|
*
|
|
447
435
|
* Updates the settings value.
|
|
448
436
|
*/
|
|
449
|
-
export declare const settingsUpdate: <ThrowOnError extends boolean = false>(options: Options<SettingsUpdateData, ThrowOnError>) =>
|
|
437
|
+
export declare const settingsUpdate: <ThrowOnError extends boolean = false>(options: Options<SettingsUpdateData, ThrowOnError>) => RequestResult<SettingsUpdateResponses, SettingsUpdateErrors, ThrowOnError>;
|
|
450
438
|
/**
|
|
451
439
|
* Get list of all stations available to user
|
|
452
440
|
*
|
|
453
441
|
* Get list of all monitoring stations available to user
|
|
454
442
|
*/
|
|
455
|
-
export declare const stationsList: <ThrowOnError extends boolean = false>(options?: Options<StationsListData, ThrowOnError>) =>
|
|
443
|
+
export declare const stationsList: <ThrowOnError extends boolean = false>(options?: Options<StationsListData, ThrowOnError>) => RequestResult<StationsListResponses, StationsListErrors, ThrowOnError>;
|
|
456
444
|
/**
|
|
457
445
|
* Create a station
|
|
458
446
|
*
|
|
459
447
|
* Create a station.
|
|
460
448
|
*/
|
|
461
|
-
export declare const stationsCreate: <ThrowOnError extends boolean = false>(options?: Options<StationsCreateData, ThrowOnError>) =>
|
|
449
|
+
export declare const stationsCreate: <ThrowOnError extends boolean = false>(options?: Options<StationsCreateData, ThrowOnError>) => RequestResult<StationsCreateResponses, StationsCreateErrors, ThrowOnError>;
|
|
462
450
|
/**
|
|
463
451
|
* Delete station
|
|
464
452
|
*
|
|
465
453
|
* Delete monitoring station
|
|
466
454
|
*/
|
|
467
|
-
export declare const stationDelete: <ThrowOnError extends boolean = false>(options: Options<StationDeleteData, ThrowOnError>) =>
|
|
455
|
+
export declare const stationDelete: <ThrowOnError extends boolean = false>(options: Options<StationDeleteData, ThrowOnError>) => RequestResult<StationDeleteResponses, StationDeleteErrors, ThrowOnError>;
|
|
468
456
|
/**
|
|
469
457
|
* Get individual station details
|
|
470
458
|
*
|
|
471
459
|
* Get individual station details
|
|
472
460
|
*/
|
|
473
|
-
export declare const stationsGet: <ThrowOnError extends boolean = false>(options: Options<StationsGetData, ThrowOnError>) =>
|
|
461
|
+
export declare const stationsGet: <ThrowOnError extends boolean = false>(options: Options<StationsGetData, ThrowOnError>) => RequestResult<StationsGetResponses, StationsGetErrors, ThrowOnError>;
|
|
474
462
|
/**
|
|
475
463
|
* Update a station
|
|
476
464
|
*
|
|
477
465
|
* Update a station.
|
|
478
466
|
*/
|
|
479
|
-
export declare const stationsUpdate: <ThrowOnError extends boolean = false>(options: Options<StationsUpdateData, ThrowOnError>) =>
|
|
467
|
+
export declare const stationsUpdate: <ThrowOnError extends boolean = false>(options: Options<StationsUpdateData, ThrowOnError>) => RequestResult<StationsUpdateResponses, StationsUpdateErrors, ThrowOnError>;
|
|
480
468
|
/**
|
|
481
469
|
* Remove the maintenance mode.
|
|
482
470
|
*
|
|
483
471
|
* Remove station from the maintenance mode (make it active).
|
|
484
472
|
*/
|
|
485
|
-
export declare const stationsDeleteMaintenance: <ThrowOnError extends boolean = false>(options: Options<StationsDeleteMaintenanceData, ThrowOnError>) =>
|
|
473
|
+
export declare const stationsDeleteMaintenance: <ThrowOnError extends boolean = false>(options: Options<StationsDeleteMaintenanceData, ThrowOnError>) => RequestResult<StationsDeleteMaintenanceResponses, StationsDeleteMaintenanceErrors, ThrowOnError>;
|
|
486
474
|
/**
|
|
487
475
|
* Put a station into maintenance mode.
|
|
488
476
|
*
|
|
489
477
|
* Put a station into maintenance.
|
|
490
478
|
*/
|
|
491
|
-
export declare const stationsPutMaintenance: <ThrowOnError extends boolean = false>(options: Options<StationsPutMaintenanceData, ThrowOnError>) =>
|
|
479
|
+
export declare const stationsPutMaintenance: <ThrowOnError extends boolean = false>(options: Options<StationsPutMaintenanceData, ThrowOnError>) => RequestResult<StationsPutMaintenanceResponses, StationsPutMaintenanceErrors, ThrowOnError>;
|
|
492
480
|
/**
|
|
493
481
|
* Get list of accessible on-premise stations
|
|
494
482
|
*
|
|
495
483
|
* Get list of accessible on-premise stations
|
|
496
484
|
*/
|
|
497
|
-
export declare const stationsOnpremiseList: <ThrowOnError extends boolean = false>(options?: Options<StationsOnpremiseListData, ThrowOnError>) =>
|
|
485
|
+
export declare const stationsOnpremiseList: <ThrowOnError extends boolean = false>(options?: Options<StationsOnpremiseListData, ThrowOnError>) => RequestResult<StationsOnpremiseListResponses, StationsOnpremiseListErrors, ThrowOnError>;
|
|
498
486
|
/**
|
|
499
487
|
* Get list of connected on-premise stations
|
|
500
488
|
*
|
|
501
489
|
* Get list of connected on-premise stations
|
|
502
490
|
*/
|
|
503
|
-
export declare const stationsOnpremiseConnected: <ThrowOnError extends boolean = false>(options?: Options<StationsOnpremiseConnectedData, ThrowOnError>) =>
|
|
491
|
+
export declare const stationsOnpremiseConnected: <ThrowOnError extends boolean = false>(options?: Options<StationsOnpremiseConnectedData, ThrowOnError>) => RequestResult<StationsOnpremiseConnectedResponses, StationsOnpremiseConnectedErrors, ThrowOnError>;
|
|
504
492
|
/**
|
|
505
493
|
* Get list of all connected on-premise stations (admins only)
|
|
506
494
|
*
|
|
507
495
|
* Get list of all connected on-premise stations (requires admin permission)
|
|
508
496
|
*/
|
|
509
|
-
export declare const stationsOnpremiseConnectedAll: <ThrowOnError extends boolean = false>(options?: Options<StationsOnpremiseConnectedAllData, ThrowOnError>) =>
|
|
497
|
+
export declare const stationsOnpremiseConnectedAll: <ThrowOnError extends boolean = false>(options?: Options<StationsOnpremiseConnectedAllData, ThrowOnError>) => RequestResult<StationsOnpremiseConnectedAllResponses, StationsOnpremiseConnectedAllErrors, ThrowOnError>;
|
|
510
498
|
/**
|
|
511
499
|
* Get the latest version of both the station and the installer
|
|
512
500
|
*
|
|
513
501
|
* Get the latest version of both the station and the installer
|
|
514
502
|
*/
|
|
515
|
-
export declare const stationsLatest: <ThrowOnError extends boolean = false>(options?: Options<StationsLatestData, ThrowOnError>) =>
|
|
503
|
+
export declare const stationsLatest: <ThrowOnError extends boolean = false>(options?: Options<StationsLatestData, ThrowOnError>) => RequestResult<StationsLatestResponses, unknown, ThrowOnError>;
|
|
516
504
|
/**
|
|
517
505
|
* Change the simple check agent to ccagent or cbot.
|
|
518
506
|
*
|
|
519
507
|
* Switch to {agent} for all simple checks on this monitoring station.
|
|
520
|
-
* On new monitoring stations the ccagent is used by default. You can switch it
|
|
521
|
-
*
|
|
522
|
-
* The new agent has many improvements compared to the old agent named cbot:
|
|
523
|
-
* it is using the new SSL3 library, provides asset with server response even
|
|
524
|
-
* for OK checks, create asset with server certificates, etc.
|
|
508
|
+
* On new monitoring stations the ccagent is used by default. You can switch it back to the old cbot agent for running simple checks like http(s), ftp(s), smtp, etc.
|
|
509
|
+
* The new agent has many improvements compared to the old agent named cbot: it is using the new SSL3 library, provides asset with server response even for OK checks, create asset with server certificates, etc.
|
|
525
510
|
* In the future, this API call will be removed.
|
|
526
511
|
*/
|
|
527
|
-
export declare const stationsAgentType: <ThrowOnError extends boolean = false>(options: Options<StationsAgentTypeData, ThrowOnError>) =>
|
|
512
|
+
export declare const stationsAgentType: <ThrowOnError extends boolean = false>(options: Options<StationsAgentTypeData, ThrowOnError>) => RequestResult<StationsAgentTypeResponses, StationsAgentTypeErrors, ThrowOnError>;
|
|
528
513
|
/**
|
|
529
514
|
* Get list of agents responsible for the monitor type.
|
|
530
515
|
*
|
|
531
516
|
* Get list of agents responsible for the monitor type.
|
|
532
517
|
*/
|
|
533
|
-
export declare const stationsGetAgents: <ThrowOnError extends boolean = false>(options: Options<StationsGetAgentsData, ThrowOnError>) =>
|
|
518
|
+
export declare const stationsGetAgents: <ThrowOnError extends boolean = false>(options: Options<StationsGetAgentsData, ThrowOnError>) => RequestResult<StationsGetAgentsResponses, StationsGetAgentsErrors, ThrowOnError>;
|
|
534
519
|
/**
|
|
535
520
|
* Get monitor statistics
|
|
536
521
|
*
|
|
537
522
|
* Get monitor statistics
|
|
538
523
|
*/
|
|
539
|
-
export declare const statistic: <ThrowOnError extends boolean = false>(options: Options<StatisticData, ThrowOnError>) =>
|
|
524
|
+
export declare const statistic: <ThrowOnError extends boolean = false>(options: Options<StatisticData, ThrowOnError>) => RequestResult<StatisticResponses, StatisticErrors, ThrowOnError>;
|
|
540
525
|
/**
|
|
541
526
|
* Get monitor tags of the user
|
|
542
527
|
*
|
|
543
528
|
* Get all monitor tags contacts
|
|
544
529
|
*/
|
|
545
|
-
export declare const tagsGetAll: <ThrowOnError extends boolean = false>(options?: Options<TagsGetAllData, ThrowOnError>) =>
|
|
530
|
+
export declare const tagsGetAll: <ThrowOnError extends boolean = false>(options?: Options<TagsGetAllData, ThrowOnError>) => RequestResult<TagsGetAllResponses, TagsGetAllErrors, ThrowOnError>;
|
|
546
531
|
/**
|
|
547
532
|
* Get list of all supported timezones
|
|
548
533
|
*
|
|
549
534
|
* Get list of all supported timezones
|
|
550
535
|
*/
|
|
551
|
-
export declare const timezonesList: <ThrowOnError extends boolean = false>(options?: Options<TimezonesListData, ThrowOnError>) =>
|
|
536
|
+
export declare const timezonesList: <ThrowOnError extends boolean = false>(options?: Options<TimezonesListData, ThrowOnError>) => RequestResult<TimezonesListResponses, TimezonesListErrors, ThrowOnError>;
|
|
552
537
|
/**
|
|
553
538
|
* Get user profile data
|
|
554
539
|
*
|
|
555
540
|
* Get profile
|
|
556
541
|
*/
|
|
557
|
-
export declare const userGet: <ThrowOnError extends boolean = false>(options?: Options<UserGetData, ThrowOnError>) =>
|
|
542
|
+
export declare const userGet: <ThrowOnError extends boolean = false>(options?: Options<UserGetData, ThrowOnError>) => RequestResult<UserGetResponses, UserGetErrors, ThrowOnError>;
|
|
558
543
|
/**
|
|
559
544
|
* Get subaccounts
|
|
560
545
|
*
|
|
561
546
|
* Get subaccounts
|
|
562
547
|
*/
|
|
563
|
-
export declare const userSubaccountsGet: <ThrowOnError extends boolean = false>(options?: Options<UserSubaccountsGetData, ThrowOnError>) =>
|
|
548
|
+
export declare const userSubaccountsGet: <ThrowOnError extends boolean = false>(options?: Options<UserSubaccountsGetData, ThrowOnError>) => RequestResult<UserSubaccountsGetResponses, UserSubaccountsGetErrors, ThrowOnError>;
|
|
564
549
|
/**
|
|
565
550
|
* Create a new subaccount
|
|
566
551
|
*
|
|
567
552
|
* Create a new subaccount
|
|
568
553
|
*/
|
|
569
|
-
export declare const userSubaccountsPost: <ThrowOnError extends boolean = false>(options: Options<UserSubaccountsPostData, ThrowOnError>) =>
|
|
554
|
+
export declare const userSubaccountsPost: <ThrowOnError extends boolean = false>(options: Options<UserSubaccountsPostData, ThrowOnError>) => RequestResult<UserSubaccountsPostResponses, UserSubaccountsPostErrors, ThrowOnError>;
|
|
570
555
|
/**
|
|
571
556
|
* Unblock an account
|
|
572
557
|
*
|
|
573
|
-
* Unblock an account - change the account status from BLOCKED to ACTIVE.
|
|
574
|
-
* Only owner of the account or privileged accounts can perform the action.
|
|
558
|
+
* Unblock an account - change the account status from BLOCKED to ACTIVE. Only owner of the account or privileged accounts can perform the action.
|
|
575
559
|
*/
|
|
576
|
-
export declare const userBlockDelete: <ThrowOnError extends boolean = false>(options: Options<UserBlockDeleteData, ThrowOnError>) =>
|
|
560
|
+
export declare const userBlockDelete: <ThrowOnError extends boolean = false>(options: Options<UserBlockDeleteData, ThrowOnError>) => RequestResult<UserBlockDeleteResponses, UserBlockDeleteErrors, ThrowOnError>;
|
|
577
561
|
/**
|
|
578
562
|
* Block an account
|
|
579
563
|
*
|
|
580
|
-
* Block an account - change the account status from ACTIVE or UNCONFIRMED to BLOCKED.
|
|
581
|
-
* Only owner of the account or privileged accounts can perform the action.
|
|
564
|
+
* Block an account - change the account status from ACTIVE or UNCONFIRMED to BLOCKED. Only owner of the account or privileged accounts can perform the action.
|
|
582
565
|
*/
|
|
583
|
-
export declare const userBlockPut: <ThrowOnError extends boolean = false>(options: Options<UserBlockPutData, ThrowOnError>) =>
|
|
566
|
+
export declare const userBlockPut: <ThrowOnError extends boolean = false>(options: Options<UserBlockPutData, ThrowOnError>) => RequestResult<UserBlockPutResponses, UserBlockPutErrors, ThrowOnError>;
|
|
584
567
|
/**
|
|
585
568
|
* Unlock an account
|
|
586
569
|
*
|
|
587
|
-
* Unlock an account when locked after too many unsuccessful login attempts.
|
|
588
|
-
* Only owner of the account or privileged accounts can perform the action.
|
|
570
|
+
* Unlock an account when locked after too many unsuccessful login attempts. Only owner of the account or privileged accounts can perform the action.
|
|
589
571
|
*/
|
|
590
|
-
export declare const userLockDelete: <ThrowOnError extends boolean = false>(options: Options<UserLockDeleteData, ThrowOnError>) =>
|
|
572
|
+
export declare const userLockDelete: <ThrowOnError extends boolean = false>(options: Options<UserLockDeleteData, ThrowOnError>) => RequestResult<UserLockDeleteResponses, UserLockDeleteErrors, ThrowOnError>;
|
|
591
573
|
/**
|
|
592
574
|
* Delete an account
|
|
593
575
|
*
|
|
594
576
|
* Delete an account
|
|
595
577
|
*/
|
|
596
|
-
export declare const userDelete: <ThrowOnError extends boolean = false>(options: Options<UserDeleteData, ThrowOnError>) =>
|
|
578
|
+
export declare const userDelete: <ThrowOnError extends boolean = false>(options: Options<UserDeleteData, ThrowOnError>) => RequestResult<UserDeleteResponses, UserDeleteErrors, ThrowOnError>;
|
|
597
579
|
/**
|
|
598
580
|
* Update an account
|
|
599
581
|
*
|
|
600
582
|
* Update an account
|
|
601
583
|
*/
|
|
602
|
-
export declare const userPut: <ThrowOnError extends boolean = false>(options: Options<UserPutData, ThrowOnError>) =>
|
|
584
|
+
export declare const userPut: <ThrowOnError extends boolean = false>(options: Options<UserPutData, ThrowOnError>) => RequestResult<UserPutResponses, UserPutErrors, ThrowOnError>;
|
|
603
585
|
//# sourceMappingURL=sdk.gen.d.ts.map
|