import { type Client, type Options as Options2, type TDataShape } from './client'; import type { AcceptPrivacyPolicyData, AcceptPrivacyPolicyResponses, AcceptTermsOfUseData, AcceptTermsOfUseResponses, AckAlarmData, AckAlarmResponses, ActivateEmailData, ActivateEmailResponses, ActivateInstanceData, ActivateInstanceResponses, ActivateUserByEmailCodeData, ActivateUserByEmailCodeResponses, ActivateUserData, ActivateUserResponses, AddEntitiesToEntityGroupData, AddEntitiesToEntityGroupResponses, AssignAlarmData, AssignAlarmResponses, AssignDeviceToTenantData, AssignDeviceToTenantResponses, AssignEntityGroupToEdgeData, AssignEntityGroupToEdgeResponses, AssignIntegrationToEdgeData, AssignIntegrationToEdgeResponses, AssignRuleChainToEdgeData, AssignRuleChainToEdgeResponses, AssignSchedulerEventToEdgeData, AssignSchedulerEventToEdgeResponses, AuthenticateByTwoFaConfigurationTokenData, AuthenticateByTwoFaConfigurationTokenResponses, AutoCommitSettingsExistsData, AutoCommitSettingsExistsResponses, CancelJobData, CancelJobResponses, ChangeOwnerToCustomerData, ChangeOwnerToCustomerResponses, ChangeOwnerToTenantData, ChangeOwnerToTenantResponses, ChangePasswordData, ChangePasswordResponses, CheckActivateTokenData, CheckActivateTokenResponses, CheckInstanceData, CheckInstanceResponses, CheckIntegrationConnectionData, CheckIntegrationConnectionResponses, CheckRepositoryAccessData, CheckRepositoryAccessResponses, CheckResetTokenData, CheckResetTokenResponses, CheckTwoFaVerificationCodeData, CheckTwoFaVerificationCodeResponses, CheckUpdatesData, CheckUpdatesResponses, ClaimDevice1Data, ClaimDevice1Responses, ClaimDeviceData, ClaimDeviceResponses, ClearAlarmData, ClearAlarmResponses, ClearEventsData, ClearEventsResponses, CodeProcessingUrlData, CodeProcessingUrlResponses, CompareEntityDataToVersionData, CompareEntityDataToVersionResponses, ConnectToTrendzData, ConnectToTrendzResponses, CountAlarmsByQueryData, CountAlarmsByQueryResponses, CountByDeviceGroupAndEmptyOtaPackageData, CountByDeviceGroupAndEmptyOtaPackageResponses, CountByDeviceProfileAndEmptyOtaPackageData, CountByDeviceProfileAndEmptyOtaPackageResponses, CountEntitiesByQueryData, CountEntitiesByQueryResponses, CreateCustomMenuData, CreateCustomMenuResponses, CreateNotificationRequestData, CreateNotificationRequestResponses, CreateReportData, CreateReportResponses, DeleteAiModelByIdData, DeleteAiModelByIdResponses, DeleteAlarmCommentData, DeleteAlarmCommentResponses, DeleteAlarmData, DeleteAlarmResponses, DeleteApiKeyData, DeleteApiKeyResponses, DeleteAssetData, DeleteAssetProfileData, DeleteAssetProfileResponses, DeleteAssetResponses, DeleteAutoCommitSettingsData, DeleteAutoCommitSettingsResponses, DeleteBlobEntityData, DeleteBlobEntityResponses, DeleteCalculatedFieldData, DeleteCalculatedFieldResponses, DeleteClientRegistrationTemplateData, DeleteClientRegistrationTemplateResponses, DeleteConverterData, DeleteConverterResponses, DeleteCurrentLoginWhiteLabelParamsData, DeleteCurrentLoginWhiteLabelParamsResponses, DeleteCurrentWhiteLabelParamsData, DeleteCurrentWhiteLabelParamsResponses, DeleteCustomerData, DeleteCustomerResponses, DeleteCustomMenuData, DeleteCustomMenuResponses, DeleteCustomTranslationData, DeleteCustomTranslationKeyData, DeleteCustomTranslationKeyResponses, DeleteCustomTranslationResponses, DeleteDashboardData, DeleteDashboardResponses, DeleteDeviceAttributesData, DeleteDeviceAttributesErrors, DeleteDeviceAttributesResponses, DeleteDeviceData, DeleteDeviceGroupOtaPackageData, DeleteDeviceGroupOtaPackageResponses, DeleteDeviceProfileData, DeleteDeviceProfileResponses, DeleteDeviceResponses, DeleteDomainData, DeleteDomainResponses, DeleteEdgeData, DeleteEdgeResponses, DeleteEntityAttributesData, DeleteEntityAttributesErrors, DeleteEntityAttributesResponses, DeleteEntityGroupData, DeleteEntityGroupResponses, DeleteEntityTimeseriesData, DeleteEntityTimeseriesErrors, DeleteEntityTimeseriesResponses, DeleteEntityViewData, DeleteEntityViewResponses, DeleteGroupPermissionData, DeleteGroupPermissionResponses, DeleteImageData, DeleteImageResponses, DeleteIntegrationData, DeleteIntegrationResponses, DeleteJobData, DeleteJobResponses, DeleteMobileAppBundleData, DeleteMobileAppBundleResponses, DeleteMobileAppData, DeleteMobileAppResponses, DeleteNotificationData, DeleteNotificationRequestData, DeleteNotificationRequestResponses, DeleteNotificationResponses, DeleteNotificationRuleData, DeleteNotificationRuleResponses, DeleteNotificationTargetByIdData, DeleteNotificationTargetByIdResponses, DeleteNotificationTemplateByIdData, DeleteNotificationTemplateByIdResponses, DeleteOauth2ClientData, DeleteOauth2ClientResponses, DeleteOtaPackageData, DeleteOtaPackageResponses, DeleteQueueData, DeleteQueueResponses, DeleteRelationData, DeleteRelationResponses, DeleteRelationsData, DeleteRelationsResponses, DeleteRelationV2Data, DeleteRelationV2Responses, DeleteReportData, DeleteReportResponses, DeleteReportTemplateData, DeleteReportTemplateResponses, DeleteRepositorySettingsData, DeleteRepositorySettingsResponses, DeleteResourceData, DeleteResourceResponses, DeleteRoleData, DeleteRoleResponses, DeleteRpcData, DeleteRpcResponses, DeleteRuleChainData, DeleteRuleChainResponses, DeleteSchedulerEventData, DeleteSchedulerEventResponses, DeleteSecretData, DeleteSecretResponses, DeleteTenantData, DeleteTenantProfileData, DeleteTenantProfileResponses, DeleteTenantResponses, DeleteTwoFaAccountConfigData, DeleteTwoFaAccountConfigResponses, DeleteUserData, DeleteUserResponses, DeleteUserSettings1Data, DeleteUserSettings1Responses, DeleteUserSettingsData, DeleteUserSettingsResponses, DeleteWebSelfRegistrationParamsData, DeleteWebSelfRegistrationParamsResponses, DeleteWidgetsBundleData, DeleteWidgetsBundleResponses, DeleteWidgetTypeData, DeleteWidgetTypeResponses, DownloadBlobEntityData, DownloadBlobEntityResponses, DownloadDashboardReportData, DownloadDashboardReportResponses, DownloadFullTranslationData, DownloadFullTranslationResponses, DownloadGatewayDockerComposeData, DownloadGatewayDockerComposeResponses, DownloadImageData, DownloadImagePreviewData, DownloadImagePreviewResponses, DownloadImageResponses, DownloadJksResourceIfChangedData, DownloadJksResourceIfChangedResponses, DownloadJsResourceIfChangedData, DownloadJsResourceIfChangedResponses, DownloadLoginFaviconData, DownloadLoginFaviconResponses, DownloadLoginLogoData, DownloadLoginLogoResponses, DownloadLwm2mResourceIfChangedData, DownloadLwm2mResourceIfChangedResponses, DownloadOtaPackageData, DownloadOtaPackageResponses, DownloadPkcs12ResourceIfChangedData, DownloadPkcs12ResourceIfChangedResponses, DownloadPublicImageData, DownloadPublicImageResponses, DownloadReportData, DownloadReportResponses, DownloadResourceData, DownloadResourceIfChangedData, DownloadResourceIfChangedResponses, DownloadResourceResponses, DownloadServerCertificateData, DownloadServerCertificateResponses, DownloadTestReportData, DownloadTestReportResponses, EnableApiKeyData, EnableApiKeyResponses, EnableSchedulerEventData, EnableSchedulerEventResponses, ExportGroupDashboardsData, ExportGroupDashboardsResponses, ExportImageData, ExportImageResponses, ExportRuleChainsData, ExportRuleChainsResponses, FindAlarmDataByQueryData, FindAlarmDataByQueryResponses, FindAllRelatedEdgesMissingAttributesData, FindAllRelatedEdgesMissingAttributesResponses, FindAvailableEntityKeysByQueryData, FindAvailableEntityKeysByQueryResponses, FindByQuery1Data, FindByQuery1Responses, FindByQuery2Data, FindByQuery2Responses, FindByQuery3Data, FindByQuery3Responses, FindByQuery4Data, FindByQuery4Responses, FindByQueryData, FindByQueryResponses, FindByToData, FindByToResponses, FindEdgeMissingAttributesData, FindEdgeMissingAttributesResponses, FindEntityDataByQueryData, FindEntityDataByQueryResponses, FindInfoByQueryData, FindInfoByQueryResponses, FindInfoByToData, FindInfoByToResponses, FindMissingToRelatedRuleChainsData, FindMissingToRelatedRuleChainsResponses, FindOAuth2ClientInfosData, FindOAuth2ClientInfosResponses, FindUsersByQueryData, FindUsersByQueryResponses, GenerateTwoFaAccountConfigData, GenerateTwoFaAccountConfigResponses, GetAccountTwoFaSettingsData, GetAccountTwoFaSettingsResponses, GetActivationLinkData, GetActivationLinkInfoData, GetActivationLinkInfoResponses, GetActivationLinkResponses, GetAdminSettingsData, GetAdminSettingsResponses, GetAiModelByIdData, GetAiModelByIdResponses, GetAiModelsData, GetAiModelsResponses, GetAlarmByIdData, GetAlarmByIdResponses, GetAlarmCommentsData, GetAlarmCommentsResponses, GetAlarmInfoByIdData, GetAlarmInfoByIdResponses, GetAlarmsData, GetAlarmsResponses, GetAlarmsV2Data, GetAlarmsV2Responses, GetAlarmTypesData, GetAlarmTypesResponses, GetAllAlarmsData, GetAllAlarmsResponses, GetAllAlarmsV2Data, GetAllAlarmsV2Responses, GetAllAssetInfosData, GetAllAssetInfosResponses, GetAllCustomerInfosData, GetAllCustomerInfosResponses, GetAllCustomerUsersData, GetAllCustomerUsersResponses, GetAllDashboardsData, GetAllDashboardsResponses, GetAllDeviceInfosData, GetAllDeviceInfosResponses, GetAllEdgeEntityGroupsData, GetAllEdgeEntityGroupsResponses, GetAllEdgeInfosData, GetAllEdgeInfosResponses, GetAllEdgeSchedulerEventsData, GetAllEdgeSchedulerEventsResponses, GetAllEntityViewInfosData, GetAllEntityViewInfosResponses, GetAllowedPermissionsData, GetAllowedPermissionsResponses, GetAllReportTemplateInfosData, GetAllReportTemplateInfosResponses, GetAllSchedulerEventsData, GetAllSchedulerEventsResponses, GetAllUserInfosData, GetAllUserInfosResponses, GetAppleAppSiteAssociationData, GetAppleAppSiteAssociationResponses, GetApplicationRedirectData, GetApplicationRedirectResponses, GetAssetByIdData, GetAssetByIdResponses, GetAssetInfoByIdData, GetAssetInfoByIdResponses, GetAssetLinksData, GetAssetLinksResponses, GetAssetProfileByIdData, GetAssetProfileByIdResponses, GetAssetProfileInfoByIdData, GetAssetProfileInfoByIdResponses, GetAssetProfileInfosData, GetAssetProfileInfosResponses, GetAssetProfileNamesData, GetAssetProfileNamesResponses, GetAssetProfilesData, GetAssetProfilesResponses, GetAssetsByEntityGroupIdData, GetAssetsByEntityGroupIdResponses, GetAssetsByIdsData, GetAssetsByIdsResponses, GetAssetTypesData, GetAssetTypesResponses, GetAttributeKeysByScopeData, GetAttributeKeysByScopeResponses, GetAttributeKeysData, GetAttributeKeysResponses, GetAttributesByScopeData, GetAttributesByScopeResponses, GetAttributesData, GetAttributesKeysData, GetAttributesKeysResponses, GetAttributesResponses, GetAuditLogsByCustomerIdData, GetAuditLogsByCustomerIdResponses, GetAuditLogsByEntityIdData, GetAuditLogsByEntityIdResponses, GetAuditLogsByUserIdData, GetAuditLogsByUserIdResponses, GetAuditLogsData, GetAuditLogsResponses, GetAuthorizationUrlData, GetAuthorizationUrlResponses, GetAutoAssignToEdgeRuleChainsData, GetAutoAssignToEdgeRuleChainsResponses, GetAutoCommitSettingsData, GetAutoCommitSettingsResponses, GetAvailableDeliveryMethodsData, GetAvailableDeliveryMethodsResponses, GetAvailableJavaLocalesData, GetAvailableJavaLocalesResponses, GetAvailableLocalesData, GetAvailableLocalesResponses, GetAvailableTwoFaProviders1Data, GetAvailableTwoFaProviders1Responses, GetAvailableTwoFaProvidersData, GetAvailableTwoFaProvidersResponses, GetBlobEntitiesData, GetBlobEntitiesResponses, GetBlobEntityInfoByIdData, GetBlobEntityInfoByIdResponses, GetBundleWidgetTypeFqnsData, GetBundleWidgetTypeFqnsResponses, GetBundleWidgetTypesData, GetBundleWidgetTypesDetailsData, GetBundleWidgetTypesDetailsResponses, GetBundleWidgetTypesInfosData, GetBundleWidgetTypesInfosResponses, GetBundleWidgetTypesResponses, GetCalculatedFieldByIdData, GetCalculatedFieldByIdResponses, GetCalculatedFieldNamesData, GetCalculatedFieldNamesResponses, GetCalculatedFieldsByEntityIdData, GetCalculatedFieldsByEntityIdResponses, GetCalculatedFieldsData, GetCalculatedFieldsResponses, GetClientRegistrationTemplates1Data, GetClientRegistrationTemplates1Responses, GetClientRegistrationTemplatesData, GetClientRegistrationTemplatesResponses, GetComponentDescriptorByClazzData, GetComponentDescriptorByClazzResponses, GetComponentDescriptorsByTypeData, GetComponentDescriptorsByTypeResponses, GetComponentDescriptorsByTypesData, GetComponentDescriptorsByTypesResponses, GetConverterByIdData, GetConverterByIdResponses, GetConvertersData, GetConvertersResponses, GetCurrentLoginWhiteLabelParamsData, GetCurrentLoginWhiteLabelParamsResponses, GetCurrentWhiteLabelParamsData, GetCurrentWhiteLabelParamsResponses, GetCustomerAssetInfosData, GetCustomerAssetInfosResponses, GetCustomerAssetsData, GetCustomerAssetsResponses, GetCustomerByIdData, GetCustomerByIdResponses, GetCustomerCustomerInfosData, GetCustomerCustomerInfosResponses, GetCustomerDashboardsData, GetCustomerDashboardsResponses, GetCustomerDeviceInfosData, GetCustomerDeviceInfosResponses, GetCustomerDevicesData, GetCustomerDevicesResponses, GetCustomerEdgeInfosData, GetCustomerEdgeInfosResponses, GetCustomerEdgesData, GetCustomerEdgesResponses, GetCustomerEntityViewInfosData, GetCustomerEntityViewInfosResponses, GetCustomerEntityViewsData, GetCustomerEntityViewsResponses, GetCustomerHomeDashboardInfoData, GetCustomerHomeDashboardInfoResponses, GetCustomerInfoByIdData, GetCustomerInfoByIdResponses, GetCustomersByEntityGroupIdData, GetCustomersByEntityGroupIdResponses, GetCustomersData, GetCustomersResponses, GetCustomerTitleByIdData, GetCustomerTitleByIdResponses, GetCustomerUserInfosData, GetCustomerUserInfosResponses, GetCustomerUsersData, GetCustomerUsersResponses, GetCustomMenuAssigneeListData, GetCustomMenuAssigneeListResponses, GetCustomMenuConfigData, GetCustomMenuConfigResponses, GetCustomMenuData, GetCustomMenuInfoByIdData, GetCustomMenuInfoByIdResponses, GetCustomMenuInfosData, GetCustomMenuInfosResponses, GetCustomMenuResponses, GetCustomTranslationData, GetCustomTranslationResponses, GetDashboardByIdData, GetDashboardByIdResponses, GetDashboardInfoByIdData, GetDashboardInfoByIdResponses, GetDashboardsByEntityGroupIdData, GetDashboardsByEntityGroupIdResponses, GetDashboardsByIdsData, GetDashboardsByIdsResponses, GetDefaultAssetProfileInfoData, GetDefaultAssetProfileInfoResponses, GetDefaultDeviceProfileInfoData, GetDefaultDeviceProfileInfoResponses, GetDefaultTenantProfileInfoData, GetDefaultTenantProfileInfoResponses, GetDeviceAttributesData, GetDeviceAttributesResponses, GetDeviceByIdData, GetDeviceByIdResponses, GetDeviceCredentialsByDeviceIdData, GetDeviceCredentialsByDeviceIdResponses, GetDeviceInfoByIdData, GetDeviceInfoByIdResponses, GetDeviceProfileByIdData, GetDeviceProfileByIdResponses, GetDeviceProfileInfoByIdData, GetDeviceProfileInfoByIdResponses, GetDeviceProfileInfosData, GetDeviceProfileInfosResponses, GetDeviceProfileNamesData, GetDeviceProfileNamesResponses, GetDeviceProfilesData, GetDeviceProfilesResponses, GetDevicePublishTelemetryCommandsData, GetDevicePublishTelemetryCommandsResponses, GetDevicesByEntityGroupIdData, GetDevicesByEntityGroupIdResponses, GetDevicesByIdsData, GetDevicesByIdsResponses, GetDeviceTypesData, GetDeviceTypesResponses, GetDomainInfoByIdData, GetDomainInfoByIdResponses, GetDomainInfosData, GetDomainInfosResponses, GetDownlinkConverterData, GetDownlinkConverterMetadataData, GetDownlinkConverterMetadataResponses, GetDownlinkConverterResponses, GetDownlinkPayloadData, GetDownlinkPayloadResponses, GetEdgeByIdData, GetEdgeByIdResponses, GetEdgeEntityGroupsData, GetEdgeEntityGroupsResponses, GetEdgeEventsData, GetEdgeEventsResponses, GetEdgeInfoByIdData, GetEdgeInfoByIdResponses, GetEdgeInstallInstructionsData, GetEdgeInstallInstructionsResponses, GetEdgeIntegrationInfosData, GetEdgeIntegrationInfosResponses, GetEdgeIntegrationsData, GetEdgeIntegrationsResponses, GetEdgeRuleChainsData, GetEdgeRuleChainsResponses, GetEdgesByEntityGroupIdData, GetEdgesByEntityGroupIdResponses, GetEdgeSchedulerEventsData, GetEdgeSchedulerEventsResponses, GetEdgesData, GetEdgesResponses, GetEdgeTypesData, GetEdgeTypesResponses, GetEdgeUpgradeInstructionsData, GetEdgeUpgradeInstructionsResponses, GetEdqsStateData, GetEdqsStateResponses, GetEntitiesData, GetEntitiesResponses, GetEntityDataInfoData, GetEntityDataInfoResponses, GetEntityGroupAllByOwnerAndTypeData, GetEntityGroupAllByOwnerAndTypeResponses, GetEntityGroupByIdData, GetEntityGroupByIdResponses, GetEntityGroupByOwnerAndNameAndTypeData, GetEntityGroupByOwnerAndNameAndTypeResponses, GetEntityGroupEntityInfoByIdData, GetEntityGroupEntityInfoByIdResponses, GetEntityGroupEntityInfosByIdsData, GetEntityGroupEntityInfosByIdsResponses, GetEntityGroupEntityInfosByOwnerAndTypeAndPageLinkData, GetEntityGroupEntityInfosByOwnerAndTypeAndPageLinkResponses, GetEntityGroupEntityInfosByTypeAndPageLinkData, GetEntityGroupEntityInfosByTypeAndPageLinkResponses, GetEntityGroupEntityInfosHierarchyByOwnerAndTypeAndPageLinkData, GetEntityGroupEntityInfosHierarchyByOwnerAndTypeAndPageLinkResponses, GetEntityGroupPermissionsData, GetEntityGroupPermissionsResponses, GetEntityGroupsByIdsData, GetEntityGroupsByIdsResponses, GetEntityGroupsByOwnerAndTypeData, GetEntityGroupsByOwnerAndTypeResponses, GetEntityGroupsByTypeData, GetEntityGroupsByTypeResponses, GetEntityGroupsForEntityData, GetEntityGroupsForEntityResponses, GetEntityGroupsHierarchyByOwnerAndTypeAndPageLinkData, GetEntityGroupsHierarchyByOwnerAndTypeAndPageLinkResponses, GetEntityViewByIdData, GetEntityViewByIdResponses, GetEntityViewInfoByIdData, GetEntityViewInfoByIdResponses, GetEntityViewsByEntityGroupIdData, GetEntityViewsByEntityGroupIdResponses, GetEntityViewsByIdsData, GetEntityViewsByIdsResponses, GetEntityViewTypesData, GetEntityViewTypesResponses, GetEvents1Data, GetEvents1Responses, GetEvents2Data, GetEvents2Responses, GetEventsData, GetEventsResponses, GetFeaturesInfoData, GetFeaturesInfoResponses, GetFirmwareByIdData, GetFirmwareByIdResponses, GetFirmwareData, GetFirmwareResponses, GetFullTranslationData, GetFullTranslationResponses, GetGroupEntityData, GetGroupEntityResponses, GetGroupOtaPackagesData, GetGroupOtaPackagesResponses, GetGroupPermissionByIdData, GetGroupPermissionByIdResponses, GetGroupPermissionInfoByIdData, GetGroupPermissionInfoByIdResponses, GetHelpBaseUrlData, GetHelpBaseUrlResponses, GetHighestAlarmSeverityData, GetHighestAlarmSeverityResponses, GetHomeDashboardData, GetHomeDashboardInfoData, GetHomeDashboardInfoResponses, GetHomeDashboardResponses, GetImageInfoData, GetImageInfoResponses, GetImagesData, GetImagesResponses, GetIntegrationByIdData, GetIntegrationByIdResponses, GetIntegrationByRoutingKeyData, GetIntegrationByRoutingKeyResponses, GetIntegrationInfosData, GetIntegrationInfosResponses, GetIntegrationsConvertersInfoData, GetIntegrationsConvertersInfoResponses, GetIntegrationsData, GetIntegrationsResponses, GetJobByIdData, GetJobByIdResponses, GetJobsData, GetJobsResponses, GetJwtSettingsData, GetJwtSettingsResponses, GetLastCalculatedFieldReprocessingJobData, GetLastCalculatedFieldReprocessingJobResponses, GetLatestCalculatedFieldDebugEventData, GetLatestCalculatedFieldDebugEventResponses, GetLatestConverterDebugInputData, GetLatestConverterDebugInputResponses, GetLatestRuleNodeDebugInputData, GetLatestRuleNodeDebugInputResponses, GetLatestTimeseriesData, GetLatestTimeseriesResponses, GetLicenseUsageInfoData, GetLicenseUsageInfoResponses, GetLoginMobileInfoData, GetLoginMobileInfoResponses, GetLoginPageTranslationData, GetLoginPageTranslationResponses, GetLoginProcessingUrlData, GetLoginProcessingUrlResponses, GetLoginWhiteLabelParamsData, GetLoginWhiteLabelParamsResponses, GetLwm2mBootstrapSecurityInfoData, GetLwm2mBootstrapSecurityInfoResponses, GetLwm2mListObjectsData, GetLwm2mListObjectsPageData, GetLwm2mListObjectsPageResponses, GetLwm2mListObjectsResponses, GetMailProcessingUrlData, GetMailProcessingUrlResponses, GetMailTemplatesData, GetMailTemplatesResponses, GetMaxDatapointsLimitData, GetMaxDatapointsLimitResponses, GetMergedCustomTranslationData, GetMergedCustomTranslationResponses, GetMergedMobileAppSettingsData, GetMergedMobileAppSettingsResponses, GetMobileAppBundleInfoByIdData, GetMobileAppBundleInfoByIdResponses, GetMobileAppByIdData, GetMobileAppByIdResponses, GetMobileAppDeepLinkData, GetMobileAppDeepLinkResponses, GetMobileSessionData, GetMobileSessionResponses, GetNotificationRequestByIdData, GetNotificationRequestByIdResponses, GetNotificationRequestPreviewData, GetNotificationRequestPreviewResponses, GetNotificationRequestsData, GetNotificationRequestsResponses, GetNotificationRuleByIdData, GetNotificationRuleByIdResponses, GetNotificationRulesData, GetNotificationRulesResponses, GetNotificationsData, GetNotificationSettingsData, GetNotificationSettingsResponses, GetNotificationsResponses, GetNotificationTargetByIdData, GetNotificationTargetByIdResponses, GetNotificationTargetsData, GetNotificationTargetsResponses, GetNotificationTemplateByIdData, GetNotificationTemplateByIdResponses, GetNotificationTemplatesData, GetNotificationTemplatesResponses, GetOAuth2ClientByIdData, GetOAuth2ClientByIdResponses, GetOAuth2ClientsData, GetOAuth2ClientsResponses, GetOtaPackageByIdData, GetOtaPackageByIdResponses, GetOtaPackageInfoByIdData, GetOtaPackageInfoByIdResponses, GetOtaPackages1Data, GetOtaPackages1Responses, GetOtaPackagesData, GetOtaPackagesResponses, GetOwnerInfoData, GetOwnerInfoResponses, GetOwnerInfosData, GetOwnerInfosResponses, GetOwnersData, GetOwnersResponses, GetPersistedRpcByDeviceData, GetPersistedRpcByDeviceResponses, GetPersistedRpcData, GetPersistedRpcResponses, GetPlatformTwoFaSettingsData, GetPlatformTwoFaSettingsResponses, GetPrivacyPolicyData, GetPrivacyPolicyResponses, GetQrCodeSettingsData, GetQrCodeSettingsResponses, GetQueueByIdData, GetQueueByIdResponses, GetQueueByNameData, GetQueueByNameResponses, GetQueueStatsByIdData, GetQueueStatsByIdResponses, GetQueueStatsByIdsData, GetQueueStatsByIdsResponses, GetRecipientsForNotificationTargetConfigData, GetRecipientsForNotificationTargetConfigResponses, GetRelationData, GetRelationResponses, GetReportByIdData, GetReportByIdResponses, GetReportInfosData, GetReportInfosResponses, GetReports1Data, GetReports1Responses, GetReportsData, GetReportsResponses, GetReportTemplateByIdData, GetReportTemplateByIdResponses, GetReportTemplateInfoByIdData, GetReportTemplateInfoByIdResponses, GetReportTemplatesByIdsData, GetReportTemplatesByIdsResponses, GetRepositorySettingsData, GetRepositorySettingsInfoData, GetRepositorySettingsInfoResponses, GetRepositorySettingsResponses, GetResourceByIdData, GetResourceByIdResponses, GetResourceInfoByIdData, GetResourceInfoByIdResponses, GetResourceInfoData, GetResourceInfoResponses, GetResourcesData, GetResourcesResponses, GetRoleByIdData, GetRoleByIdResponses, GetRolesByIdsData, GetRolesByIdsResponses, GetRuleChainByIdData, GetRuleChainByIdResponses, GetRuleChainMetaDataData, GetRuleChainMetaDataResponses, GetRuleChainOutputLabelsData, GetRuleChainOutputLabelsResponses, GetRuleChainOutputLabelsUsageData, GetRuleChainOutputLabelsUsageResponses, GetRuleChainsByIdsData, GetRuleChainsByIdsResponses, GetScheduledReportEventsData, GetScheduledReportEventsResponses, GetSchedulerEventByIdData, GetSchedulerEventByIdResponses, GetSchedulerEventInfoByIdData, GetSchedulerEventInfoByIdResponses, GetSecretInfoByIdData, GetSecretInfoByIdResponses, GetSecretInfoByNameData, GetSecretInfoByNameResponses, GetSecretInfosData, GetSecretInfosResponses, GetSecretNamesData, GetSecretNamesResponses, GetSecuritySettingsData, GetSecuritySettingsResponses, GetServerTimeData, GetServerTimeResponses, GetSharedEntityGroupEntityInfosByTypeAndPageLinkData, GetSharedEntityGroupEntityInfosByTypeAndPageLinkResponses, GetSharedEntityGroupsByTypeData, GetSharedEntityGroupsByTypeResponses, GetShortCustomerInfoByIdData, GetShortCustomerInfoByIdResponses, GetSignUpSelfRegistrationParamsData, GetSignUpSelfRegistrationParamsResponses, GetSoftwareData, GetSoftwareResponses, GetSolutionTemplateDetailsData, GetSolutionTemplateDetailsResponses, GetSolutionTemplateInfosData, GetSolutionTemplateInfosResponses, GetSolutionTemplateInstructionsData, GetSolutionTemplateInstructionsResponses, GetSubscriptionInfoData, GetSubscriptionInfoResponses, GetSystemInfoData, GetSystemInfoResponses, GetTenantAdminsData, GetTenantAdminsResponses, GetTenantAssetsData, GetTenantAssetsResponses, GetTenantByIdData, GetTenantByIdResponses, GetTenantCustomerData, GetTenantCustomerResponses, GetTenantDashboards1Data, GetTenantDashboards1Responses, GetTenantDashboardsData, GetTenantDashboardsResponses, GetTenantDevicesData, GetTenantDevicesResponses, GetTenantEdgesData, GetTenantEdgesResponses, GetTenantEntityViewsData, GetTenantEntityViewsResponses, GetTenantHomeDashboardInfoData, GetTenantHomeDashboardInfoResponses, GetTenantInfoByIdData, GetTenantInfoByIdResponses, GetTenantInfosData, GetTenantInfosResponses, GetTenantMobileAppBundleInfosData, GetTenantMobileAppBundleInfosResponses, GetTenantMobileAppsData, GetTenantMobileAppsResponses, GetTenantProfileByIdData, GetTenantProfileByIdResponses, GetTenantProfileInfoByIdData, GetTenantProfileInfoByIdResponses, GetTenantProfileInfosData, GetTenantProfileInfosResponses, GetTenantProfilesData, GetTenantProfilesResponses, GetTenantQueuesByServiceTypeData, GetTenantQueuesByServiceTypeResponses, GetTenantResourcesData, GetTenantResourcesResponses, GetTenantsByIdsData, GetTenantsByIdsResponses, GetTenantUsageInfoData, GetTenantUsageInfoResponses, GetTermsOfUseData, GetTermsOfUseResponses, GetTimeseriesByReadTsKvQueriesData, GetTimeseriesByReadTsKvQueriesResponses, GetTimeseriesKeys1Data, GetTimeseriesKeys1Responses, GetTimeseriesKeysData, GetTimeseriesKeysResponses, GetTranslationForBasicEditData, GetTranslationForBasicEditResponses, GetTranslationInfosData, GetTranslationInfosResponses, GetTrendzConfigData, GetTrendzConfigResponses, GetTrendzSummaryData, GetTrendzSummaryResponses, GetTrendzSyncResultData, GetTrendzSyncResultResponses, GetTrendzUsageData, GetTrendzUsageResponses, GetTrendzViewByIdData, GetTrendzViewByIdResponses, GetTrendzViewsData, GetTrendzViewsResponses, GetUnreadNotificationsCountData, GetUnreadNotificationsCountResponses, GetUplinkConverterData, GetUplinkConverterMetadataData, GetUplinkConverterMetadataResponses, GetUplinkConverterResponses, GetUplinkPayloadData, GetUplinkPayloadResponses, GetUserApiKeysData, GetUserApiKeysResponses, GetUserAssetsData, GetUserAssetsResponses, GetUserByIdData, GetUserByIdResponses, GetUserCustomersData, GetUserCustomersResponses, GetUserDashboardsInfoData, GetUserDashboardsInfoResponses, GetUserData, GetUserDevicesData, GetUserDevicesResponses, GetUserEdgesData, GetUserEdgesResponses, GetUserEntityViewsData, GetUserEntityViewsResponses, GetUserGroupPermissionsData, GetUserGroupPermissionsResponses, GetUserInfoByIdData, GetUserInfoByIdResponses, GetUserMobileInfoData, GetUserMobileInfoResponses, GetUserNotificationSettingsData, GetUserNotificationSettingsResponses, GetUserPasswordPolicyData, GetUserPasswordPolicyResponses, GetUserResponses, GetUsersByEntityGroupIdData, GetUsersByEntityGroupIdResponses, GetUsersByIdsData, GetUsersByIdsResponses, GetUserSettings1Data, GetUserSettings1Responses, GetUserSettingsData, GetUserSettingsResponses, GetUsersForAssignData, GetUsersForAssignResponses, GetUserTokenByMobileSecretData, GetUserTokenByMobileSecretResponses, GetUserTokenData, GetUserTokenResponses, GetUserUsersData, GetUserUsersResponses, GetVendorModelsData, GetVendorModelsResponses, GetVendorsData, GetVendorsResponses, GetVersionCreateRequestStatusData, GetVersionCreateRequestStatusResponses, GetVersionLoadRequestStatusData, GetVersionLoadRequestStatusResponses, GetWebSelfRegistrationParamsData, GetWebSelfRegistrationParamsResponses, GetWhiteLabelParamsData, GetWhiteLabelParamsResponses, GetWidgetsBundleByIdData, GetWidgetsBundleByIdResponses, GetWidgetsBundlesData, GetWidgetsBundlesResponses, GetWidgetTypeByBundleAliasAndTypeAliasData, GetWidgetTypeByBundleAliasAndTypeAliasResponses, GetWidgetTypeByIdData, GetWidgetTypeByIdResponses, GetWidgetTypeInfoByIdData, GetWidgetTypeInfoByIdResponses, HandleAuthorizedTrendzRequests1Data, HandleAuthorizedTrendzRequests1Responses, HandleAuthorizedTrendzRequests2Data, HandleAuthorizedTrendzRequests2Responses, HandleAuthorizedTrendzRequests3Data, HandleAuthorizedTrendzRequests3Responses, HandleAuthorizedTrendzRequests4Data, HandleAuthorizedTrendzRequests4Responses, HandleAuthorizedTrendzRequests5Data, HandleAuthorizedTrendzRequests5Responses, HandleAuthorizedTrendzRequests6Data, HandleAuthorizedTrendzRequests6Responses, HandleAuthorizedTrendzRequestsData, HandleAuthorizedTrendzRequestsResponses, HandleError1Data, HandleError1Responses, HandleError2Data, HandleError2Responses, HandleError3Data, HandleError3Responses, HandleError4Data, HandleError4Responses, HandleError5Data, HandleError5Responses, HandleError6Data, HandleError6Responses, HandleErrorData, HandleErrorResponses, HandleOneWayDeviceRpcRequest1Data, HandleOneWayDeviceRpcRequest1Responses, HandleOneWayDeviceRpcRequestData, HandleOneWayDeviceRpcRequestErrors, HandleOneWayDeviceRpcRequestResponses, HandleRuleEngineRequest1Data, HandleRuleEngineRequest1Responses, HandleRuleEngineRequest2Data, HandleRuleEngineRequest2Responses, HandleRuleEngineRequest3Data, HandleRuleEngineRequest3Responses, HandleRuleEngineRequestData, HandleRuleEngineRequestResponses, HandleTwoWayDeviceRpcRequest1Data, HandleTwoWayDeviceRpcRequest1Responses, HandleTwoWayDeviceRpcRequestData, HandleTwoWayDeviceRpcRequestErrors, HandleTwoWayDeviceRpcRequestResponses, HandleUnauthorizedTrendzRequests10Data, HandleUnauthorizedTrendzRequests10Responses, HandleUnauthorizedTrendzRequests11Data, HandleUnauthorizedTrendzRequests11Responses, HandleUnauthorizedTrendzRequests12Data, HandleUnauthorizedTrendzRequests12Responses, HandleUnauthorizedTrendzRequests13Data, HandleUnauthorizedTrendzRequests13Responses, HandleUnauthorizedTrendzRequests1Data, HandleUnauthorizedTrendzRequests1Responses, HandleUnauthorizedTrendzRequests2Data, HandleUnauthorizedTrendzRequests2Responses, HandleUnauthorizedTrendzRequests3Data, HandleUnauthorizedTrendzRequests3Responses, HandleUnauthorizedTrendzRequests4Data, HandleUnauthorizedTrendzRequests4Responses, HandleUnauthorizedTrendzRequests5Data, HandleUnauthorizedTrendzRequests5Responses, HandleUnauthorizedTrendzRequests6Data, HandleUnauthorizedTrendzRequests6Responses, HandleUnauthorizedTrendzRequests7Data, HandleUnauthorizedTrendzRequests7Responses, HandleUnauthorizedTrendzRequests8Data, HandleUnauthorizedTrendzRequests8Responses, HandleUnauthorizedTrendzRequests9Data, HandleUnauthorizedTrendzRequests9Responses, HandleUnauthorizedTrendzRequestsData, HandleUnauthorizedTrendzRequestsResponses, HasEntityPermissionData, HasEntityPermissionResponses, ImportGroupDashboardsData, ImportGroupDashboardsResponses, ImportImageData, ImportImageResponses, ImportRuleChainsData, ImportRuleChainsResponses, InstallSolutionTemplateData, InstallSolutionTemplateResponses, IsCustomerWhiteLabelingAllowedData, IsCustomerWhiteLabelingAllowedResponses, IsEdgesSupportEnabledData, IsEdgesSupportEnabledResponses, IsEdgeUpgradeAvailableData, IsEdgeUpgradeAvailableResponses, IsTbelEnabledData, IsTbelEnabledResponses, IsUserTokenAccessEnabledData, IsUserTokenAccessEnabledResponses, IsWhiteLabelingAllowedData, IsWhiteLabelingAllowedResponses, ListAllEntitiesAtVersionData, ListAllEntitiesAtVersionResponses, ListBranchesData, ListBranchesResponses, ListEntitiesAtVersionData, ListEntitiesAtVersionResponses, ListEntityTypeVersionsData, ListEntityTypeVersionsResponses, ListEntityVersionsData, ListEntityVersionsResponses, ListSlackConversationsData, ListSlackConversationsResponses, ListVersionsData, ListVersionsResponses, LoadEntitiesVersionData, LoadEntitiesVersionResponses, LoadUserGroupPermissionInfosData, LoadUserGroupPermissionInfosResponses, LogoutData, LogoutResponses, MakeEntityGroupPrivateData, MakeEntityGroupPrivateResponses, MakeEntityGroupPublicData, MakeEntityGroupPublicResponses, MarkAllNotificationsAsReadData, MarkAllNotificationsAsReadResponses, MarkNotificationAsReadData, MarkNotificationAsReadResponses, MobileLoginData, MobileLoginResponses, PatchCustomTranslationData, PatchCustomTranslationResponses, PerformTrendzHealthcheckData, PerformTrendzHealthcheckResponses, PostApiAuthLoginData, PostApiAuthLoginErrors, PostApiAuthLoginResponses, PostApiAuthTokenData, PostApiAuthTokenErrors, PostApiAuthTokenResponses, PostDeviceAttributesData, PostDeviceAttributesResponses, PostRpcRequestData, PostRpcRequestErrors, PostRpcRequestResponses, PostTelemetryData, PostTelemetryResponses, PreviewWhiteLabelParamsData, PreviewWhiteLabelParamsResponses, PrivacyPolicyAcceptedData, PrivacyPolicyAcceptedResponses, ProcessAssetBulkImportData, ProcessAssetBulkImportResponses, ProcessDevicesBulkImportData, ProcessDevicesBulkImportResponses, ProcessEdgesBulkImportData, ProcessEdgesBulkImportResponses, ProcessSystemEdqsRequestData, ProcessSystemEdqsRequestResponses, ProvisionDeviceData, ProvisionDeviceResponses, PublicConnectToTrendzData, PublicConnectToTrendzResponses, PutUserSettings1Data, PutUserSettings1Responses, PutUserSettingsData, PutUserSettingsResponses, ReClaimDeviceData, ReClaimDeviceResponses, RefreshLicenseData, RefreshLicenseResponses, RemoveEntitiesFromEntityGroupData, RemoveEntitiesFromEntityGroupResponses, RemoveMobileSessionData, RemoveMobileSessionResponses, ReplyToCommandData, ReplyToCommandErrors, ReplyToCommandResponses, ReportUserDashboardActionData, ReportUserDashboardActionResponses, RepositorySettingsExistsData, RepositorySettingsExistsResponses, ReprocessCalculatedFieldData, ReprocessCalculatedFieldResponses, ReprocessJobData, ReprocessJobResponses, RequestReportData, RequestReportResponses, RequestResetPasswordByEmailData, RequestResetPasswordByEmailResponses, RequestTwoFaVerificationCodeData, RequestTwoFaVerificationCodeResponses, ResendEmailActivationData, ResendEmailActivationResponses, ResetPasswordData, ResetPasswordResponses, SaveAdminSettingsData, SaveAdminSettingsResponses, SaveAiModelData, SaveAiModelResponses, SaveAlarmCommentData, SaveAlarmCommentResponses, SaveAlarmData, SaveAlarmResponses, SaveApiKeyData, SaveApiKeyResponses, SaveAssetData, SaveAssetProfileData, SaveAssetProfileResponses, SaveAssetResponses, SaveAutoCommitSettingsData, SaveAutoCommitSettingsResponses, SaveCalculatedFieldData, SaveCalculatedFieldResponses, SaveClientRegistrationTemplateData, SaveClientRegistrationTemplateResponses, SaveConverterData, SaveConverterResponses, SaveCustomerData, SaveCustomerResponses, SaveCustomTranslationData, SaveCustomTranslationResponses, SaveDashboardData, SaveDashboardResponses, SaveDeviceAttributesData, SaveDeviceAttributesErrors, SaveDeviceAttributesResponses, SaveDeviceData, SaveDeviceGroupOtaPackageData, SaveDeviceGroupOtaPackageResponses, SaveDeviceProfileData, SaveDeviceProfileResponses, SaveDeviceResponses, SaveDeviceWithCredentials1Data, SaveDeviceWithCredentials1Responses, SaveDeviceWithCredentialsData, SaveDeviceWithCredentialsResponses, SaveDomainData, SaveDomainResponses, SaveEdgeData, SaveEdgeResponses, SaveEntitiesVersionData, SaveEntitiesVersionResponses, SaveEntityAttributesV1Data, SaveEntityAttributesV1Errors, SaveEntityAttributesV1Responses, SaveEntityAttributesV2Data, SaveEntityAttributesV2Errors, SaveEntityAttributesV2Responses, SaveEntityGroupData, SaveEntityGroupResponses, SaveEntityTelemetryData, SaveEntityTelemetryErrors, SaveEntityTelemetryResponses, SaveEntityTelemetryWithTtlData, SaveEntityTelemetryWithTtlErrors, SaveEntityTelemetryWithTtlResponses, SaveEntityViewData, SaveEntityViewResponses, SaveGroupPermissionData, SaveGroupPermissionResponses, SaveIntegrationData, SaveIntegrationResponses, SaveJwtSettingsData, SaveJwtSettingsResponses, SaveLoginWhiteLabelParamsData, SaveLoginWhiteLabelParamsResponses, SaveMailTemplatesData, SaveMailTemplatesResponses, SaveMobileAppBundleData, SaveMobileAppBundleResponses, SaveMobileAppData, SaveMobileAppResponses, SaveMobileSessionData, SaveMobileSessionResponses, SaveNotificationRuleData, SaveNotificationRuleResponses, SaveNotificationSettingsData, SaveNotificationSettingsResponses, SaveNotificationTargetData, SaveNotificationTargetResponses, SaveNotificationTemplateData, SaveNotificationTemplateResponses, SaveOAuth2ClientData, SaveOAuth2ClientResponses, SaveOtaPackageDataData, SaveOtaPackageDataResponses, SaveOtaPackageInfoData, SaveOtaPackageInfoResponses, SavePlatformTwoFaSettingsData, SavePlatformTwoFaSettingsResponses, SaveQrCodeSettingsData, SaveQrCodeSettingsResponses, SaveQueueData, SaveQueueResponses, SaveRelationData, SaveRelationResponses, SaveRelationV2Data, SaveRelationV2Responses, SaveReportTemplateData, SaveReportTemplateResponses, SaveRepositorySettingsData, SaveRepositorySettingsResponses, SaveResourceData, SaveResourceResponses, SaveRoleData, SaveRoleResponses, SaveRuleChain1Data, SaveRuleChain1Responses, SaveRuleChainData, SaveRuleChainMetaDataData, SaveRuleChainMetaDataResponses, SaveRuleChainResponses, SaveSchedulerEventData, SaveSchedulerEventResponses, SaveSecretData, SaveSecretResponses, SaveSecuritySettingsData, SaveSecuritySettingsResponses, SaveTenantData, SaveTenantProfileData, SaveTenantProfileResponses, SaveTenantResponses, SaveTrendzConfigData, SaveTrendzConfigResponses, SaveUserData, SaveUserNotificationSettingsData, SaveUserNotificationSettingsResponses, SaveUserResponses, SaveUserSettingsData, SaveUserSettingsResponses, SaveWebSelfRegistrationParamsData, SaveWebSelfRegistrationParamsResponses, SaveWhiteLabelParamsData, SaveWhiteLabelParamsResponses, SaveWidgetsBundleData, SaveWidgetsBundleResponses, SaveWidgetTypeData, SaveWidgetTypeResponses, SendActivationEmailData, SendActivationEmailResponses, SendAddonAccessErrorData, SendAddonAccessErrorResponses, SendAddonAccessRequestData, SendAddonAccessRequestResponses, SendChatRequestData, SendChatRequestResponses, SendEntitiesLimitIncreaseRequestData, SendEntitiesLimitIncreaseRequestResponses, SendPlanUpgradeRequestData, SendPlanUpgradeRequestResponses, SendTestMailData, SendTestMailResponses, SendTestSmsData, SendTestSmsResponses, SetAutoAssignToEdgeRuleChainData, SetAutoAssignToEdgeRuleChainResponses, SetCustomerHomeDashboardInfoData, SetCustomerHomeDashboardInfoResponses, SetDefaultAssetProfileData, SetDefaultAssetProfileResponses, SetDefaultDeviceProfileData, SetDefaultDeviceProfileResponses, SetDefaultTenantProfileData, SetDefaultTenantProfileResponses, SetEdgeRootRuleChainData, SetEdgeRootRuleChainResponses, SetEdgeTemplateRootRuleChainData, SetEdgeTemplateRootRuleChainResponses, SetRootRuleChainData, SetRootRuleChainResponses, SetTenantHomeDashboardInfoData, SetTenantHomeDashboardInfoResponses, SetUserCredentialsEnabledData, SetUserCredentialsEnabledResponses, ShareEntityGroupData, ShareEntityGroupResponses, ShareEntityGroupToChildOwnerUserGroupData, ShareEntityGroupToChildOwnerUserGroupResponses, SignUpData, SignUpResponses, SubmitTwoFaAccountConfigData, SubmitTwoFaAccountConfigResponses, SubscribeToAttributesData, SubscribeToAttributesResponses, SubscribeToCommandsData, SubscribeToCommandsResponses, SyncEdgeData, SyncEdgeResponses, TermsOfUseAcceptedData, TermsOfUseAcceptedResponses, TestDownLinkConverterData, TestDownLinkConverterResponses, TestReportAndDownloadData, TestReportAndDownloadResponses, TestScript1Data, TestScript1Responses, TestScriptData, TestScriptResponses, TestUpLinkConverterData, TestUpLinkConverterResponses, UnassignAlarmData, UnassignAlarmResponses, UnassignEntityGroupFromEdgeData, UnassignEntityGroupFromEdgeResponses, UnassignIntegrationFromEdgeData, UnassignIntegrationFromEdgeResponses, UnassignRuleChainFromEdgeData, UnassignRuleChainFromEdgeResponses, UnassignSchedulerEventFromEdgeData, UnassignSchedulerEventFromEdgeResponses, UninstallSolutionTemplateData, UninstallSolutionTemplateResponses, UnsetAutoAssignToEdgeRuleChainData, UnsetAutoAssignToEdgeRuleChainResponses, UnwrapRawPayloadData, UnwrapRawPayloadResponses, UpdateApiKeyDescriptionData, UpdateApiKeyDescriptionResponses, UpdateCustomMenuAssigneeListData, UpdateCustomMenuAssigneeListResponses, UpdateCustomMenuConfigData, UpdateCustomMenuConfigResponses, UpdateCustomMenuNameData, UpdateCustomMenuNameResponses, UpdateDeviceCredentialsData, UpdateDeviceCredentialsResponses, UpdateImageData, UpdateImageInfoData, UpdateImageInfoResponses, UpdateImagePublicStatusData, UpdateImagePublicStatusResponses, UpdateImageResponses, UpdateOauth2Clients1Data, UpdateOauth2Clients1Responses, UpdateOauth2ClientsData, UpdateOauth2ClientsResponses, UpdateResourceDataData, UpdateResourceDataResponses, UpdateResourceInfoData, UpdateResourceInfoResponses, UpdateSecretDescriptionData, UpdateSecretDescriptionResponses, UpdateSecretValueData, UpdateSecretValueResponses, UpdateTwoFaAccountConfigData, UpdateTwoFaAccountConfigResponses, UpdateWidgetsBundleWidgetFqnsData, UpdateWidgetsBundleWidgetFqnsResponses, UpdateWidgetsBundleWidgetTypesData, UpdateWidgetsBundleWidgetTypesResponses, UploadCustomTranslationData, UploadCustomTranslationResponses, UploadImageData, UploadImageResponses, UploadResourceData, UploadResourceResponses, ValidateCalculatedFieldReprocessingData, ValidateCalculatedFieldReprocessingResponses, VerifyAndSaveTwoFaAccountConfigData, VerifyAndSaveTwoFaAccountConfigResponses } from './types.gen'; export type Options = Options2 & { /** * You can provide a client instance returned by `createClient()` instead of * individual options. This might be also useful if you want to implement a * custom client. */ client?: Client; /** * You can pass arbitrary values through the `meta` object. This can be * used to access values that aren't defined as part of the SDK function. */ meta?: Record; }; /** * Login method to get user JWT token data * * Login method used to authenticate user and get JWT token data. * * Value of the response **token** field can be used as **X-Authorization** header value: * * `X-Authorization: Bearer $JWT_TOKEN_VALUE`. */ export declare const postApiAuthLogin: (options?: Options) => import("./client").RequestResult; /** * Refresh user JWT token data * * Method to refresh JWT token. Provide a valid refresh token to get a new JWT token. * * The response contains a new token that can be used for authorization. * * `X-Authorization: Bearer $JWT_TOKEN_VALUE` */ export declare const postApiAuthToken: (options?: Options) => import("./client").RequestResult; /** * Get user settings (getUserSettings) * * Fetch the User settings based on authorized user. */ export declare const getUserSettings: (options?: Options) => import("./client").RequestResult; /** * Save user settings (saveUserSettings) * * Save user settings represented in json format for authorized user. */ export declare const saveUserSettings: (options: Options) => import("./client").RequestResult; /** * Update user settings (saveUserSettings) * * Update user settings for authorized user. Only specified json elements will be updated.Example: you have such settings: {A:5, B:{C:10, D:20}}. Updating it with {B:{C:10, D:30}} will result in{A:5, B:{C:10, D:30}}. The same could be achieved by putting {B.D:30} */ export declare const putUserSettings: (options: Options) => import("./client").RequestResult; /** * Get user settings (getUserSettings) * * Fetch the User settings based on authorized user. */ export declare const getUserSettings1: (options: Options) => import("./client").RequestResult; /** * Update user settings (saveUserSettings) * * Update user settings for authorized user. Only specified json elements will be updated.Example: you have such settings: {A:5, B:{C:10, D:20}}. Updating it with {B:{C:10, D:30}} will result in{A:5, B:{C:10, D:30}}. The same could be achieved by putting {B.D:30} */ export declare const putUserSettings1: (options: Options) => import("./client").RequestResult; /** * Update Secret value * * Updates the value of the existing Secret by secretId. Referencing a non-existing Secret Id will cause a 'Not Found' error. */ export declare const updateSecretValue: (options: Options) => import("./client").RequestResult; /** * Update Secret Description * * Updates the description of the existing Secret by secretId. Only the description can be updated. Referencing a non-existing Secret Id will cause a 'Not Found' error. */ export declare const updateSecretDescription: (options: Options) => import("./client").RequestResult; /** * Enable or disable Scheduler Event (enableSchedulerEvent) * * Updates scheduler event with enabled = true/false. Scheduler Event extends Scheduler Event Info object and adds 'configuration' - a JSON structure of scheduler event configuration. See the 'Model' tab of the Response Class for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const enableSchedulerEvent: (options: Options) => import("./client").RequestResult; export declare const updateResourceInfo: (options: Options) => import("./client").RequestResult; export declare const updateResourceData: (options: Options) => import("./client").RequestResult; /** * Mark all notifications as read (markAllNotificationsAsRead) * * Marks all unread notifications as read. * * Available for any authorized user. */ export declare const markAllNotificationsAsRead: (options?: Options) => import("./client").RequestResult; /** * Mark notification as read (markNotificationAsRead) * * Marks notification as read by its id. * * Available for any authorized user. */ export declare const markNotificationAsRead: (options: Options) => import("./client").RequestResult; /** * Update oauth2 clients (updateOauth2Clients) * * Update oauth2 clients of the specified mobile app bundle. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const updateOauth2Clients: (options: Options) => import("./client").RequestResult; export declare const deleteImage: (options: Options) => import("./client").RequestResult; export declare const downloadImage: (options: Options) => import("./client").RequestResult; export declare const updateImage: (options: Options) => import("./client").RequestResult; export declare const updateImagePublicStatus: (options: Options) => import("./client").RequestResult; export declare const getImageInfo: (options: Options) => import("./client").RequestResult; export declare const updateImageInfo: (options: Options) => import("./client").RequestResult; export declare const importImage: (options: Options) => import("./client").RequestResult; /** * Update oauth2 clients (updateOauth2Clients) * * Update oauth2 clients for the specified domain. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const updateOauth2Clients1: (options: Options) => import("./client").RequestResult; /** * Update custom menu assignee list (updateCustomMenuAssigneeList) * * The api designed to update the list of assignees or assignee type based on the provided Custom Menu Id. To change assignee type, put new assignee type in path parameter. * * Security check is performed to verify that the user has 'WRITE' permission for the custom menu with specified id. */ export declare const updateCustomMenuAssigneeList: (options: Options) => import("./client").RequestResult; /** * Update Custom Menu name based on the provided Custom Menu Id (updateCustomMenuName) * * * * Security check is performed to verify that the user has 'WRITE' permission for the custom menu with specified id. */ export declare const updateCustomMenuName: (options: Options) => import("./client").RequestResult; /** * Get Custom Menu configuration by id (getCustomMenuConfig) * * Fetch the Custom Menu configuration based on the provided Custom Menu Id. * * Security check is performed to verify that the user has 'READ' permission for the custom menu with specified id. */ export declare const getCustomMenuConfig: (options: Options) => import("./client").RequestResult; /** * Update Custom Menu configuration based on the provided Custom Menu Id (updateCustomMenuConfig) * * * * Security check is performed to verify that the user has 'WRITE' permission for the custom menu with specified id. */ export declare const updateCustomMenuConfig: (options: Options) => import("./client").RequestResult; /** * Enable or disable API key (enableApiKey) * * Updates api key with enabled = true/false. * * Available for any authorized user. */ export declare const enableApiKey: (options: Options) => import("./client").RequestResult; /** * Update API key Description * * Updates the description of the existing API key by apiKeyId. Only the description can be updated. Referencing a non-existing ApiKey Id will cause a 'Not Found' error. * * Available for any authorized user. */ export declare const updateApiKeyDescription: (options: Options) => import("./client").RequestResult; /** * Delete 2FA account config (deleteTwoFaAccountConfig) * * Delete 2FA config for a given 2FA provider type. * Returns whole account's 2FA settings object. * * * Available for any authorized user. */ export declare const deleteTwoFaAccountConfig: (options: Options) => import("./client").RequestResult; /** * Verify and save 2FA account config (verifyAndSaveTwoFaAccountConfig) * * Checks the verification code for submitted config, and if it is correct, saves the provided account config. * * Returns whole account's 2FA settings object. * Will throw an error (Bad Request) if the provider is not configured for usage. * * Available for any authorized user. */ export declare const verifyAndSaveTwoFaAccountConfig: (options: Options) => import("./client").RequestResult; /** * Update 2FA account config (updateTwoFaAccountConfig) * * Update config for a given provider type. * Update request example: * ``` * { * "useByDefault": true * } * ``` * Returns whole account's 2FA settings object. * * * Available for any authorized user. */ export declare const updateTwoFaAccountConfig: (options: Options) => import("./client").RequestResult; /** * Create Or Update Widget Bundle (saveWidgetsBundle) * * Create or update the Widget Bundle. Widget Bundle represents a group(bundle) of widgets. Widgets are grouped into bundle by type or use case. When creating the bundle, platform generates Widget Bundle Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Widget Bundle Id will be present in the response. Specify existing Widget Bundle id to update the Widget Bundle. Referencing non-existing Widget Bundle Id will cause 'Not Found' error. * * Widget Bundle alias is unique in the scope of tenant. Special Tenant Id '13814000-1dd2-11b2-8080-808080808080' is automatically used if the create bundle request is sent by user with 'SYS_ADMIN' authority.Remove 'id', 'tenantId' from the request body example (below) to create new Widgets Bundle entity. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const saveWidgetsBundle: (options: Options) => import("./client").RequestResult; /** * Update widgets bundle widgets types list (updateWidgetsBundleWidgetTypes) * * Updates widgets bundle widgets list. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const updateWidgetsBundleWidgetTypes: (options: Options) => import("./client").RequestResult; /** * Update widgets bundle widgets list from widget type FQNs list (updateWidgetsBundleWidgetFqns) * * Updates widgets bundle widgets list from widget type FQNs list. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const updateWidgetsBundleWidgetFqns: (options: Options) => import("./client").RequestResult; /** * Get Widget Type (getWidgetType) * * Get the Widget Type by FQN. Widget Type represents the template for widget creation. Widget Type and Widget are similar to class and object in OOP theory. * * Available for any authorized user. * * @deprecated */ export declare const getWidgetTypeByBundleAliasAndTypeAlias: (options: Options) => import("./client").RequestResult; /** * Create Or Update Widget Type (saveWidgetType) * * Create or update the Widget Type. Widget Type represents the template for widget creation. Widget Type and Widget are similar to class and object in OOP theory. When creating the Widget Type, platform generates Widget Type Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Widget Type Id will be present in the response. Specify existing Widget Type id to update the Widget Type. Referencing non-existing Widget Type Id will cause 'Not Found' error. * * Widget Type fqn is unique in the scope of System or Tenant. Special Tenant Id '13814000-1dd2-11b2-8080-808080808080' is automatically used if the create request is sent by user with 'SYS_ADMIN' authority.Remove 'id', 'tenantId' rom the request body example (below) to create new Widget Type entity. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const saveWidgetType: (options: Options) => import("./client").RequestResult; /** * Get White Labeling parameters * * Returns white-labeling parameters for the current user. */ export declare const getWhiteLabelParams: (options?: Options) => import("./client").RequestResult; /** * Create Or Update White Labeling configuration (saveWhiteLabelParams) * * Creates or Updates the White Labeling configuration. * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const saveWhiteLabelParams: (options: Options) => import("./client").RequestResult; /** * Preview Login White Labeling configuration (saveWhiteLabelParams) * * Merge the White Labeling configuration with the parent configuration and return the result. * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const previewWhiteLabelParams: (options: Options) => import("./client").RequestResult; /** * Get the Mail templates settings (getMailTemplates) * * Fetch Mail template settings. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'READ' permission for the white labeling resource. */ export declare const getMailTemplates: (options?: Options) => import("./client").RequestResult; /** * Save the Mail templates settings (saveMailTemplates) * * Creates or Updates the Mail templates settings. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const saveMailTemplates: (options: Options) => import("./client").RequestResult; /** * Create Or Update Login White Labeling configuration (saveWhiteLabelParams) * * Creates or Updates the White Labeling configuration. * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const saveLoginWhiteLabelParams: (options: Options) => import("./client").RequestResult; export declare const createReport: (options?: Options) => import("./client").RequestResult; /** * Download test report (downloadTestReport) * * Generate and download test report. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const testReportAndDownload: (options: Options) => import("./client").RequestResult; export declare const requestReport: (options: Options) => import("./client").RequestResult; /** * Delete Relation (deleteRelationV2) * * Deletes a relation between two entities in the platform. * * If the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer. */ export declare const deleteRelationV2: (options: Options) => import("./client").RequestResult; /** * Create Relation (saveRelationV2) * * Creates or updates a relation between two entities in the platform. Relations unique key is a combination of from/to entity id and relation type group and relation type. * * If the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer. */ export declare const saveRelationV2: (options: Options) => import("./client").RequestResult; /** * Post time series data (postTelemetry) * * Post time series data on behalf of device. * Example of the request: The request payload is a JSON document with three possible formats: * * Simple format without timestamp. In such a case, current server time will be used: * * * * ```json * { * "stringKey":"value1", * "booleanKey":true, * "doubleKey":42.0, * "longKey":73, * "jsonKey": { * "someNumber": 42, * "someArray": [1,2,3], * "someNestedObject": {"key": "value"} * } * } * ``` * * * * Single JSON object with timestamp: * * * * ```json * {"ts":1634712287000,"values":{"temperature":26, "humidity":87}} * ``` * * * * JSON array with timestamps: * * * * ```json * [ * {"ts":1634712287000,"values":{"temperature":26, "humidity":87}}, * {"ts":1634712588000,"values":{"temperature":25, "humidity":88}} * ] * ``` * * The API call is designed to be used by device firmware and requires device access token ('deviceToken'). It is not recommended to use this API call by third-party scripts, rule-engine or platform widgets (use 'Telemetry Controller' instead). * */ export declare const postTelemetry: (options: Options) => import("./client").RequestResult; /** * Subscribe to RPC commands (subscribeToCommands) (Deprecated) * * Subscribes to RPC commands using http long polling. Deprecated, since long polling is resource and network consuming. Consider using MQTT or CoAP protocol for light-weight real-time updates. * * The API call is designed to be used by device firmware and requires device access token ('deviceToken'). It is not recommended to use this API call by third-party scripts, rule-engine or platform widgets (use 'Telemetry Controller' instead). * */ export declare const subscribeToCommands: (options: Options) => import("./client").RequestResult; /** * Send the RPC command (postRpcRequest) * * Send the RPC request to server. The request payload is a JSON document that contains 'method' and 'params'. For example: * * ```json * {"method": "sumOnServer", "params":{"a":2, "b":2}} * ``` * * The response contains arbitrary JSON with the RPC reply. For example: * * ```json * {"result": 4} * ``` * * The API call is designed to be used by device firmware and requires device access token ('deviceToken'). It is not recommended to use this API call by third-party scripts, rule-engine or platform widgets (use 'Telemetry Controller' instead). * */ export declare const postRpcRequest: (options: Options) => import("./client").RequestResult; /** * Reply to RPC commands (replyToCommand) * * Replies to server originated RPC command identified by 'requestId' parameter. The response is arbitrary JSON. * * The API call is designed to be used by device firmware and requires device access token ('deviceToken'). It is not recommended to use this API call by third-party scripts, rule-engine or platform widgets (use 'Telemetry Controller' instead). * */ export declare const replyToCommand: (options: Options) => import("./client").RequestResult; /** * Save claiming information (claimDevice) * * Saves the information required for user to claim the device. See more info about claiming in the corresponding 'Claiming devices' platform documentation. * Example of the request payload: * * ```json * {"secretKey":"value", "durationMs":60000} * ``` * * Note: both 'secretKey' and 'durationMs' is optional parameters. In case the secretKey is not specified, the empty string as a default value is used. In case the durationMs is not specified, the system parameter device.claim.duration is used. * * The API call is designed to be used by device firmware and requires device access token ('deviceToken'). It is not recommended to use this API call by third-party scripts, rule-engine or platform widgets (use 'Telemetry Controller' instead). * */ export declare const claimDevice: (options: Options) => import("./client").RequestResult; /** * Get attributes (getDeviceAttributes) * * Returns all attributes that belong to device. Use optional 'clientKeys' and/or 'sharedKeys' parameter to return specific attributes. * Example of the result: * * ```json * { * "stringKey":"value1", * "booleanKey":true, * "doubleKey":42.0, * "longKey":73, * "jsonKey": { * "someNumber": 42, * "someArray": [1,2,3], * "someNestedObject": {"key": "value"} * } * } * ``` * * The API call is designed to be used by device firmware and requires device access token ('deviceToken'). It is not recommended to use this API call by third-party scripts, rule-engine or platform widgets (use 'Telemetry Controller' instead). * */ export declare const getDeviceAttributes: (options: Options) => import("./client").RequestResult; /** * Post attributes (postDeviceAttributes) * * Post client attribute updates on behalf of device. * Example of the request: * * ```json * { * "stringKey":"value1", * "booleanKey":true, * "doubleKey":42.0, * "longKey":73, * "jsonKey": { * "someNumber": 42, * "someArray": [1,2,3], * "someNestedObject": {"key": "value"} * } * } * ``` * * The API call is designed to be used by device firmware and requires device access token ('deviceToken'). It is not recommended to use this API call by third-party scripts, rule-engine or platform widgets (use 'Telemetry Controller' instead). * */ export declare const postDeviceAttributes: (options: Options) => import("./client").RequestResult; /** * Provision new device (provisionDevice) * * Exchange the provision request to the device credentials. See more info about provisioning in the corresponding 'Device provisioning' platform documentation.Requires valid JSON request with the following format: * * ```json * { * "deviceName": "NEW_DEVICE_NAME", * "provisionDeviceKey": "u7piawkboq8v32dmcmpp", * "provisionDeviceSecret": "jpmwdn8ptlswmf4m29bw" * } * ``` * * Where 'deviceName' is the name of enw or existing device which depends on the provisioning strategy. The 'provisionDeviceKey' and 'provisionDeviceSecret' matches info configured in one of the existing device profiles. The result of the successful call is the JSON object that contains new credentials: * * ```json * { * "credentialsType":"ACCESS_TOKEN", * "credentialsValue":"DEVICE_ACCESS_TOKEN", * "status":"SUCCESS" * } * ``` * * */ export declare const provisionDevice: (options: Options) => import("./client").RequestResult; /** * Save Or update User (saveUser) * * Create or update the User. When creating user, platform generates User Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created User Id will be present in the response. Specify existing User Id to update the device. Referencing non-existing User Id will cause 'Not Found' error. * * Device email is unique for entire platform setup. * * Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new User entity. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const saveUser: (options: Options) => import("./client").RequestResult; /** * Load User Group Permissions (loadUserGroupPermissionInfos) * * Enrich a list of group permission objects with the information about Role, User and Entity Groups. Group permission entity represents list of allowed operations for certain User Group to perform against certain Entity Group. Basically, this entity wires three other entities: * * * Role that defines set of allowed operations; * * User Group that defines set of users who may perform the operations; * * Entity Group that defines set of entities which will be accessible to users; * * Group Permission Info object extends the Group Permissions with the full information about Role and User and/or Entity Groups. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const loadUserGroupPermissionInfos: (options: Options) => import("./client").RequestResult; /** * Enable/Disable User credentials (setUserCredentialsEnabled) * * Enables or Disables user credentials. Useful when you would like to block user account without deleting it. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const setUserCredentialsEnabled: (options: Options) => import("./client").RequestResult; /** * Send or re-send the activation email * * Force send the activation email to the user. Useful to resend the email if user has accidentally deleted it. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const sendActivationEmail: (options: Options) => import("./client").RequestResult; export declare const removeMobileSession: (options: Options) => import("./client").RequestResult; export declare const getMobileSession: (options: Options) => import("./client").RequestResult; export declare const saveMobileSession: (options: Options) => import("./client").RequestResult; /** * Public connect to Trendz (publicConnectToTrendz) * * Initiates synchronization with Trendz if Trendz is not synced yet. Uses Trendz configuration from settings or falls back to environment variables. Generates API key, saves configuration, checks Trendz version, and performs initial sync. */ export declare const publicConnectToTrendz: (options?: Options) => import("./client").RequestResult; /** * Connect to Trendz (connectToTrendz) * * Initiates synchronization with Trendz (Connect button action). Uses Trendz configuration from settings or falls back to environment variables. Generates API key, saves configuration, checks Trendz version, and performs initial sync. * * Available for users with 'SYS_ADMIN' authority. */ export declare const connectToTrendz: (options?: Options) => import("./client").RequestResult; /** * Get Trendz configuration (getTrendzConfig) * * Retrieves Trendz configuration (URLs). Returns trendzUrl and tbUrl. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getTrendzConfig: (options?: Options) => import("./client").RequestResult; /** * Save Trendz configuration (saveTrendzConfig) * * Saves Trendz configuration (URLs only, without triggering synchronization). Request body example: * ```json * { * "trendzUrl": "https://trendz.domain.com", * "tbUrl": "https://thingsboard.domain.com" * } * ``` * * Available for users with 'SYS_ADMIN' authority. */ export declare const saveTrendzConfig: (options: Options) => import("./client").RequestResult; /** * Delete Custom Translation for specified locale (deleteCustomTranslation) * * Delete entire custom translation settings for end-user * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const deleteCustomTranslation: (options: Options) => import("./client").RequestResult; /** * Get Custom Translation configuration (getCustomTranslation) * * Fetch the Custom Translation for specified locale that corresponds to the authority of the user. The API call is designed to load the custom translation items for edition. So, the result is NOT merged with the parent level configuration. Let's assume there is a custom translation configured on a system level. And there is no custom translation items configured on a tenant level. In such a case, the API call will return empty object for the tenant administrator. * * Response example: * * ```json * {"home":"MyHome"} * ``` * * Security check is performed to verify that the user has 'READ' permission for the white labeling resource. */ export declare const getCustomTranslation: (options: Options) => import("./client").RequestResult; /** * Update Custom Translation for specified translation keys only (patchCustomTranslation) * * The API call is designed to update the custom translation for specified key only. * * Request example: * * ```json * {"notification.active":"active"} * ``` * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const patchCustomTranslation: (options: Options) => import("./client").RequestResult; /** * Create Or Update Custom Translation (saveCustomTranslation) * * Creates or Updates the Custom Translation for specified locale. * * Request example: * * ```json * {"home":"MyHome"} * ``` * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const saveCustomTranslation: (options: Options) => import("./client").RequestResult; /** * Upload Custom Translation (uploadCustomTranslation) * * Upload the Custom Translation for specified locale. * * Request example: * * ```json * {"home":"MyHome"} * ``` * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const uploadCustomTranslation: (options: Options) => import("./client").RequestResult; /** * Create Or update Tenant (saveTenant) * * Create or update the Tenant. When creating tenant, platform generates Tenant Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). Default Rule Chain and Device profile are also generated for the new tenants automatically. The newly created Tenant Id will be present in the response. Specify existing Tenant Id id to update the Tenant. Referencing non-existing Tenant Id will cause 'Not Found' error.Remove 'id', 'tenantId' from the request body example (below) to create new Tenant entity. * * Available for users with 'SYS_ADMIN' authority. */ export declare const saveTenant: (options: Options) => import("./client").RequestResult; /** * Create Or update Tenant Profile (saveTenantProfile) * * Create or update the Tenant Profile. When creating tenant profile, platform generates Tenant Profile Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Tenant Profile Id will be present in the response. Specify existing Tenant Profile Id id to update the Tenant Profile. Referencing non-existing Tenant Profile Id will cause 'Not Found' error. * * Update of the tenant profile configuration will cause immediate recalculation of API limits for all affected Tenants. * * The **'profileData'** object is the part of Tenant Profile that defines API limits and Rate limits. * * You have an ability to define maximum number of devices ('maxDevice'), assets ('maxAssets') and other entities. You may also define maximum number of messages to be processed per month ('maxTransportMessages', 'maxREExecutions', etc). The '*RateLimit' defines the rate limits using simple syntax. For example, '1000:1,20000:60' means up to 1000 events per second but no more than 20000 event per minute. Let's review the example of tenant profile data below: * * ```json * { * "name": "Your name", * "description": "Your description", * "isolatedTbRuleEngine": false, * "profileData": { * "configuration": { * "type": "DEFAULT", * "maxDevices": 0, * "maxAssets": 0, * "maxCustomers": 0, * "maxUsers": 0, * "maxDashboards": 0, * "maxRuleChains": 0, * "maxResourcesInBytes": 0, * "maxOtaPackagesInBytes": 0, * "maxResourceSize": 0, * "transportTenantMsgRateLimit": "1000:1,20000:60", * "transportTenantTelemetryMsgRateLimit": "1000:1,20000:60", * "transportTenantTelemetryDataPointsRateLimit": "1000:1,20000:60", * "transportDeviceMsgRateLimit": "20:1,600:60", * "transportDeviceTelemetryMsgRateLimit": "20:1,600:60", * "transportDeviceTelemetryDataPointsRateLimit": "20:1,600:60", * "transportGatewayMsgRateLimit": "20:1,600:60", * "transportGatewayTelemetryMsgRateLimit": "20:1,600:60", * "transportGatewayTelemetryDataPointsRateLimit": "20:1,600:60", * "transportGatewayDeviceMsgRateLimit": "20:1,600:60", * "transportGatewayDeviceTelemetryMsgRateLimit": "20:1,600:60", * "transportGatewayDeviceTelemetryDataPointsRateLimit": "20:1,600:60", * "integrationMsgsPerTenantRateLimit": "20:1,600:60", * "integrationMsgsPerDeviceRateLimit": "20:1,600:60", * "integrationMsgsPerAssetRateLimit": "20:1,600:60", * "maxTransportMessages": 10000000, * "maxTransportDataPoints": 10000000, * "maxREExecutions": 4000000, * "maxJSExecutions": 5000000, * "maxDPStorageDays": 0, * "maxRuleNodeExecutionsPerMessage": 50, * "maxDebugModeDurationMinutes": 15, * "maxEmails": 0, * "maxSms": 0, * "maxCreatedAlarms": 1000, * "defaultStorageTtlDays": 0, * "alarmsTtlDays": 0, * "rpcTtlDays": 0, * "queueStatsTtlDays": 0, * "ruleEngineExceptionsTtlDays": 0, * "blobEntityTtlDays": 0, * "warnThreshold": 0, * "maxCalculatedFieldsPerEntity": 100, * "maxArgumentsPerCF": 10, * "minAllowedScheduledUpdateIntervalInSecForCF": 10, * "maxRelationLevelPerCfArgument": 2, * "maxRelatedEntitiesToReturnPerCfArgument": 1000, * "maxDataPointsPerRollingArg": 1000, * "maxStateSizeInKBytes": 512, * "maxSingleValueArgumentSizeInKBytes": 32, "minAllowedDeduplicationIntervalInSecForCF": 10, "minAllowedAggregationIntervalInSecForCF": 60, "intermediateAggregationIntervalInSecForCF": 300, "cfReevaluationCheckInterval": 60, "alarmsReevaluationInterval": 60 } * }, * "default": false * } * ```Remove 'id', from the request body example (below) to create new Tenant Profile entity. * * Available for users with 'SYS_ADMIN' authority. */ export declare const saveTenantProfile: (options: Options) => import("./client").RequestResult; /** * Make tenant profile default (setDefaultTenantProfile) * * Makes specified tenant profile to be default. Referencing non-existing tenant profile Id will cause an error. * * Available for users with 'SYS_ADMIN' authority. */ export declare const setDefaultTenantProfile: (options: Options) => import("./client").RequestResult; /** * Assign device to tenant (assignDeviceToTenant) * * Creates assignment of the device to tenant. Thereafter tenant will be able to reassign the device to a customer. * * Available for users with 'TENANT_ADMIN' authority. Security check is performed to verify that the user has 'ASSIGN_TO_TENANT' permission for the entity (entities). */ export declare const assignDeviceToTenant: (options: Options) => import("./client").RequestResult; /** * Get Tenant Home Dashboard Info (getTenantHomeDashboardInfo) * * Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the corresponding tenant. * * Available for users with 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'READ' permission for the white labeling resource. */ export declare const getTenantHomeDashboardInfo: (options?: Options) => import("./client").RequestResult; /** * Update Tenant Home Dashboard Info (getTenantHomeDashboardInfo) * * Update the home dashboard assignment for the current tenant. * * Available for users with 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const setTenantHomeDashboardInfo: (options: Options) => import("./client").RequestResult; /** * Install Solution Template (installSolutionTemplate) * * Install solution template based on the provided id * * Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const installSolutionTemplate: (options: Options) => import("./client").RequestResult; /** * Accept Terms of Use (acceptTermsOfUse) * * Accept Terms of Use by the current user. */ export declare const acceptTermsOfUse: (options?: Options) => import("./client").RequestResult; /** * Accept privacy policy (acceptPrivacyPolicy) * * Accept privacy policy by the current user. */ export declare const acceptPrivacyPolicy: (options?: Options) => import("./client").RequestResult; export declare const deleteWebSelfRegistrationParams: (options?: Options) => import("./client").RequestResult; /** * Get Self Registration parameters (getSelfRegistrationParams) * * Fetch the Self Registration parameters object for the tenant of the current user. * * Available for users with 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'READ' permission for the white labeling resource. */ export declare const getWebSelfRegistrationParams: (options?: Options) => import("./client").RequestResult; /** * Create Or Update Self Registration parameters (saveSelfRegistrationParams) * * Creates or Updates the Self Registration parameters. When creating, platform generates Admin Settings Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Admin Settings Id will be present in the response. Specify existing Admin Settings Id to update the Self Registration parameters. Referencing non-existing Admin Settings Id will cause 'Not Found' error. * * Self Registration allows users to signup for using the platform and automatically create a Customer account for them. You may configure default dashboard and user roles that will be assigned for this Customer. This allows you to build out-of-the-box solutions for customers. Ability to white-label the login and main pages helps to brand the platform. * * Available for users with 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const saveWebSelfRegistrationParams: (options: Options) => import("./client").RequestResult; /** * Get Secret info by name (getSecretInfoByName) * * * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getSecretInfoByName: (options: Options) => import("./client").RequestResult; /** * Save or Update Secret (saveSecret) * * Create or update the Secret. When creating secret, platform generates Secret Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Secret Id will be present in the response. Specify existing Secret Id to update the secret. Secret name is not updatable, only value could be changed. Referencing non-existing Secret Id will cause 'Not Found' error. * * Secret name is unique in the scope of tenant. */ export declare const saveSecret: (options: Options) => import("./client").RequestResult; /** * Save Scheduler Event (saveSchedulerEvent) * * Creates or Updates scheduler event. Scheduler Event extends Scheduler Event Info object and adds 'configuration' - a JSON structure of scheduler event configuration. See the 'Model' tab of the Response Class for more details. When creating scheduler event, platform generates scheduler event Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created scheduler event id will be present in the response. Specify existing scheduler event id to update the scheduler event. Referencing non-existing scheduler event Id will cause 'Not Found' error. Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Scheduler Event entity. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveSchedulerEvent: (options: Options) => import("./client").RequestResult; /** * Import Rule Chains * * Imports all tenant rule chains as one JSON. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const importRuleChains: (options: Options) => import("./client").RequestResult; /** * Create Or Update Rule Chain (saveRuleChain) * * Create or update the Rule Chain. When creating Rule Chain, platform generates Rule Chain Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Rule Chain Id will be present in the response. Specify existing Rule Chain id to update the rule chain. Referencing non-existing rule chain Id will cause 'Not Found' error. * * The rule chain object is lightweight and contains general information about the rule chain. List of rule nodes and their connection is stored in a separate 'metadata' object.Remove 'id', 'tenantId' from the request body example (below) to create new Rule Chain entity. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveRuleChain: (options: Options) => import("./client").RequestResult; /** * Set Root Rule Chain (setRootRuleChain) * * Makes the rule chain to be root rule chain. Updates previous root rule chain as well. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const setRootRuleChain: (options: Options) => import("./client").RequestResult; /** * Set Edge Template Root Rule Chain (setEdgeTemplateRootRuleChain) * * Makes the rule chain to be root rule chain for any new edge that will be created. Does not update root rule chain for already created edges. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const setEdgeTemplateRootRuleChain: (options: Options) => import("./client").RequestResult; /** * Unset Auto Assign To Edge Rule Chain (unsetAutoAssignToEdgeRuleChain) * * Removes the rule chain from the list of rule chains that are going to be automatically assigned for any new edge that will be created. Does not unassign this rule chain for already assigned edges. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const unsetAutoAssignToEdgeRuleChain: (options: Options) => import("./client").RequestResult; /** * Set Auto Assign To Edge Rule Chain (setAutoAssignToEdgeRuleChain) * * Makes the rule chain to be automatically assigned for any new edge that will be created. Does not assign this rule chain for already created edges. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const setAutoAssignToEdgeRuleChain: (options: Options) => import("./client").RequestResult; /** * Test Script function * * Execute the Script function and return the result. The format of request: * * ```json * { * "script": "Your Function as String", * "scriptType": "One of: update, generate, filter, switch, json, string", * "argNames": ["msg", "metadata", "type"], * "msg": "{\"temperature\": 42}", * "metadata": { * "deviceName": "Device A", * "deviceType": "Thermometer" * }, * "msgType": "POST_TELEMETRY_REQUEST" * } * ``` * * Expected result JSON contains "output" and "error". * * Available for users with 'TENANT_ADMIN' authority. */ export declare const testScript: (options: Options) => import("./client").RequestResult; /** * Update Rule Chain Metadata * * Updates the rule chain metadata. The metadata object contains information about the rule nodes and their connections. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveRuleChainMetaData: (options: Options) => import("./client").RequestResult; /** * Create Default Rule Chain * * Create rule chain from template, based on the specified name in the request. Creates the rule chain based on the template that is used to create root rule chain. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveRuleChain1: (options: Options) => import("./client").RequestResult; /** * Push entity message to the rule engine (handleRuleEngineRequest) * * Creates the Message with type 'REST_API_REQUEST' and payload taken from the request body. Uses specified Entity Id as the Rule Engine message originator. This method allows you to extend the regular platform API with the power of Rule Engine. You may use default and custom rule nodes to handle the message. The generated message contains two important metadata fields: * * * **'serviceId'** to identify the platform server that received the request; * * **'requestUUID'** to identify the request and route possible response from the Rule Engine; * * Use **'rest call reply'** rule node to push the reply from rule engine back as a REST API call response. The default timeout of the request processing is 10 seconds. * * Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const handleRuleEngineRequest: (options: Options) => import("./client").RequestResult; /** * Push entity message with timeout to the rule engine (handleRuleEngineRequest) * * Creates the Message with type 'REST_API_REQUEST' and payload taken from the request body. Uses specified Entity Id as the Rule Engine message originator. This method allows you to extend the regular platform API with the power of Rule Engine. You may use default and custom rule nodes to handle the message. The generated message contains two important metadata fields: * * * **'serviceId'** to identify the platform server that received the request; * * **'requestUUID'** to identify the request and route possible response from the Rule Engine; * * Use **'rest call reply'** rule node to push the reply from rule engine back as a REST API call response. The platform expects the timeout value in milliseconds. * * Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const handleRuleEngineRequest1: (options: Options) => import("./client").RequestResult; /** * Push entity message with timeout and specified queue to the rule engine (handleRuleEngineRequest) * * Creates the Message with type 'REST_API_REQUEST' and payload taken from the request body. Uses specified Entity Id as the Rule Engine message originator. This method allows you to extend the regular platform API with the power of Rule Engine. You may use default and custom rule nodes to handle the message. The generated message contains two important metadata fields: * * * **'serviceId'** to identify the platform server that received the request; * * **'requestUUID'** to identify the request and route possible response from the Rule Engine; * * Use **'rest call reply'** rule node to push the reply from rule engine back as a REST API call response. If request sent for Device/Device Profile or Asset/Asset Profile entity, specified queue will be used instead of the queue selected in the device or asset profile. The platform expects the timeout value in milliseconds. * * Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const handleRuleEngineRequest2: (options: Options) => import("./client").RequestResult; /** * Push user message to the rule engine (handleRuleEngineRequest) * * Creates the Message with type 'REST_API_REQUEST' and payload taken from the request body. Uses current User Id ( the one which credentials is used to perform the request) as the Rule Engine message originator. This method allows you to extend the regular platform API with the power of Rule Engine. You may use default and custom rule nodes to handle the message. The generated message contains two important metadata fields: * * * **'serviceId'** to identify the platform server that received the request; * * **'requestUUID'** to identify the request and route possible response from the Rule Engine; * * Use **'rest call reply'** rule node to push the reply from rule engine back as a REST API call response. The default timeout of the request processing is 10 seconds. * * Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const handleRuleEngineRequest3: (options: Options) => import("./client").RequestResult; /** * Send two-way RPC request * * Sends the two-way remote-procedure call (RPC) request to device. Sends the one-way remote-procedure call (RPC) request to device. The RPC call is A JSON that contains the method name ('method'), parameters ('params') and multiple optional fields. See example below. We will review the properties of the RPC call one-by-one below. * * ```json * { * "method": "setGpio", * "params": { * "pin": 7, * "value": 1 * }, * "persistent": false, * "timeout": 5000 * } * ``` * * ### Server-side RPC structure * * The body of server-side RPC request consists of multiple fields: * * * **method** - mandatory, name of the method to distinct the RPC calls. * For example, "getCurrentTime" or "getWeatherForecast". The value of the parameter is a string. * * **params** - mandatory, parameters used for processing of the request. The value is a JSON. Leave empty JSON "{}" if no parameters needed. * * **timeout** - optional, value of the processing timeout in milliseconds. The default value is 10000 (10 seconds). The minimum value is 5000 (5 seconds). * * **expirationTime** - optional, value of the epoch time (in milliseconds, UTC timezone). Overrides **timeout** if present. * * **persistent** - optional, indicates persistent RPC. The default value is "false". * * **retries** - optional, defines how many times persistent RPC will be re-sent in case of failures on the network and/or device side. * * **additionalInfo** - optional, defines metadata for the persistent RPC that will be added to the persistent RPC events. * * ### RPC Result * In case of persistent RPC, the result of this call is 'rpcId' UUID. In case of lightweight RPC, the result of this call is the response from device, or 504 Gateway Timeout if device is offline. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const handleTwoWayDeviceRpcRequest: (options: Options) => import("./client").RequestResult; /** * Send one-way RPC request * * Sends the one-way remote-procedure call (RPC) request to device. Sends the one-way remote-procedure call (RPC) request to device. The RPC call is A JSON that contains the method name ('method'), parameters ('params') and multiple optional fields. See example below. We will review the properties of the RPC call one-by-one below. * * ```json * { * "method": "setGpio", * "params": { * "pin": 7, * "value": 1 * }, * "persistent": false, * "timeout": 5000 * } * ``` * * ### Server-side RPC structure * * The body of server-side RPC request consists of multiple fields: * * * **method** - mandatory, name of the method to distinct the RPC calls. * For example, "getCurrentTime" or "getWeatherForecast". The value of the parameter is a string. * * **params** - mandatory, parameters used for processing of the request. The value is a JSON. Leave empty JSON "{}" if no parameters needed. * * **timeout** - optional, value of the processing timeout in milliseconds. The default value is 10000 (10 seconds). The minimum value is 5000 (5 seconds). * * **expirationTime** - optional, value of the epoch time (in milliseconds, UTC timezone). Overrides **timeout** if present. * * **persistent** - optional, indicates persistent RPC. The default value is "false". * * **retries** - optional, defines how many times persistent RPC will be re-sent in case of failures on the network and/or device side. * * **additionalInfo** - optional, defines metadata for the persistent RPC that will be added to the persistent RPC events. * * ### RPC Result * In case of persistent RPC, the result of this call is 'rpcId' UUID. In case of lightweight RPC, the result of this call is either 200 OK if the message was sent to device, or 504 Gateway Timeout if device is offline. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const handleOneWayDeviceRpcRequest: (options: Options) => import("./client").RequestResult; /** * Create Or Update Role (saveRole) * * Creates or Updates the Role. When creating Role, platform generates Role Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Role id will be present in the response. Specify existing Role id to update the permission. Referencing non-existing Group Permission Id will cause 'Not Found' error. * * Role Contains a set of permissions. Role has two types. Generic Role may be assigned to the user group and will provide permissions for all entities of a certain type. Group Role may be assigned to both user and entity group and will provides permissions only for the entities that belong to specified entity group. The assignment of the Role to the User Group is done using [Group Permission Controller](/swagger-ui.html#/group-permission-controller). * * Example of Generic Role with read-only permissions for any resource and all permissions for the 'DEVICE' and 'PROFILE' resources is listed below: * * ```json * { * "name": "Read-Only User", * "type": "GENERIC", * "permissions": { * "ALL": [ * "READ", * "RPC_CALL", * "READ_CREDENTIALS", * "READ_ATTRIBUTES", * "READ_TELEMETRY" * ], * "DEVICE": [ * "ALL" * ] * "PROFILE": [ * "ALL" * ] * }, * "additionalInfo": { * "description": "Read-only permissions for everything, Write permissions for devices and own profile." * } * } * ``` * * Example of Group Role with read-only permissions. Note that the group role has no association with the resources. The type of the resource is taken from the entity group that this role is assigned to: * * ```json * { * "name": "Entity Group Read-only User", * "type": "GROUP", * "permissions": [ * "READ", * "RPC_CALL", * "READ_CREDENTIALS", * "READ_ATTRIBUTES", * "READ_TELEMETRY" * ], * "additionalInfo": { * "description": "Read-only permissions." * } * } * ``` * * Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const saveRole: (options: Options) => import("./client").RequestResult; /** * Get Resource Infos by ids (getSystemOrTenantResourcesByIds) * * Returns a page of Resource Info objects owned by tenant or sysadmin. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Resource Info is a lightweight object that includes main information about the Resource excluding the heavyweight data. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getResources: (options: Options) => import("./client").RequestResult; /** * Create Or Update Resource (saveResource) * * Create or update the Resource. When creating the Resource, platform generates Resource id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Resource id will be present in the response. Specify existing Resource id to update the Resource. Referencing non-existing Resource Id will cause 'Not Found' error. * * Resource combination of the title with the key is unique in the scope of tenant. Remove 'id', 'tenantId' from the request body example (below) to create new Resource entity. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * @deprecated */ export declare const saveResource: (options: Options) => import("./client").RequestResult; /** * Upload Resource via Multipart File (uploadResource) * * Create the Resource using multipart file upload. * * Resource combination of the title with the key is unique in the scope of tenant. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const uploadResource: (options?: Options) => import("./client").RequestResult; /** * Save Report Template (saveReportTemplate) * * Creates or Updates report template. Report Template extends Report Template Info object and adds 'configuration' - a JSON structure of report template configuration. See the 'Model' tab of the Response Class for more details. When creating report template, platform generates report template Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created report template id will be present in the response. Specify existing report template id to update the report template. Referencing non-existing report template Id will cause 'Not Found' error. Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Report Template entity. * * Available for users with 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const saveReportTemplate: (options: Options) => import("./client").RequestResult; /** * Download dashboard report (downloadDashboardReport) * * Generate and download a report from the specified dashboard. The request payload is a JSON object with params of report. For example: * * ```json * { * "type": "pdf", * "timezone": "Europe/Kiev", * "timewindow": { * "displayValue": "", * "hideInterval": false, * "hideLastInterval": false, * "hideQuickInterval": false, * "hideAggregation": false, * "hideAggInterval": false, * "hideTimezone": false, * "selectedTab": 0, * "realtime": { * "realtimeType": 0, * "interval": 1000, * "timewindowMs": 60000, * "quickInterval": "CURRENT_DAY" * }, * "history": { * "historyType": 0, * "interval": 1000, * "timewindowMs": 60000, * "fixedTimewindow": { * "startTimeMs": 1703687976592, * "endTimeMs": 1703774376592 * }, * "quickInterval": "CURRENT_DAY" * }, * "aggregation": { * "type": "AVG", * "limit": 25000 * } * }, * "state": null * } * ``` * * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const downloadDashboardReport: (options: Options) => import("./client").RequestResult; /** * Download test report (downloadTestReport) * * Generate and download test report. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const downloadTestReport: (options: Options) => import("./client").RequestResult; /** * Delete common relations (deleteCommonRelations) * * Deletes all the relations ('from' and 'to' direction) for the specified entity and relation type group: 'COMMON'. * * If the user has the authority of 'System Administrator', the server checks that the entity is owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that the entity is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the entity is assigned to the same customer. */ export declare const deleteRelations: (options: Options) => import("./client").RequestResult; /** * Get List of Relations (findByFrom) * * Returns list of relation objects for the specified entity by the 'from' direction and relation type. * * If the user has the authority of 'System Administrator', the server checks that the entity is owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that the entity is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the entity is assigned to the same customer. */ export declare const findByTo: (options: Options) => import("./client").RequestResult; /** * Find related entities (findByQuery) * * Returns all entities that are related to the specific entity. The entity id, relation type, entity types, depth of the search, and other query parameters defined using complex 'EntityRelationsQuery' object. See 'Model' tab of the Parameters for more info. */ export declare const findByQuery: (options: Options) => import("./client").RequestResult; /** * Get List of Relation Infos (findInfoByFrom) * * Returns list of relation info objects for the specified entity by the 'from' direction. * * If the user has the authority of 'System Administrator', the server checks that the entity is owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that the entity is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the entity is assigned to the same customer. Relation Info is an extension of the default Relation object that contains information about the 'from' and 'to' entity names. */ export declare const findInfoByTo: (options: Options) => import("./client").RequestResult; /** * Find related entity infos (findInfoByQuery) * * Returns all entity infos that are related to the specific entity. The entity id, relation type, entity types, depth of the search, and other query parameters defined using complex 'EntityRelationsQuery' object. See 'Model' tab of the Parameters for more info. Relation Info is an extension of the default Relation object that contains information about the 'from' and 'to' entity names. */ export declare const findInfoByQuery: (options: Options) => import("./client").RequestResult; /** * Delete Relation (deleteRelation) * * Deletes a relation between two entities in the platform. * * If the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer. */ export declare const deleteRelation: (options: Options) => import("./client").RequestResult; /** * Get Relation (getRelation) * * Returns relation object between two specified entities if present. Otherwise throws exception. * * If the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer. */ export declare const getRelation: (options: Options) => import("./client").RequestResult; /** * Create Relation (saveRelation) * * Creates or updates a relation between two entities in the platform. Relations unique key is a combination of from/to entity id and relation type group and relation type. * * If the user has the authority of 'System Administrator', the server checks that 'from' and 'to' entities are owned by the sysadmin. If the user has the authority of 'Tenant Administrator', the server checks that 'from' and 'to' entities are owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the 'from' and 'to' entities are assigned to the same customer. */ export declare const saveRelation: (options: Options) => import("./client").RequestResult; /** * Get Queues (getTenantQueuesByServiceType) * * Returns a page of queues registered in the platform. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getTenantQueuesByServiceType: (options: Options) => import("./client").RequestResult; /** * Create Or Update Queue (saveQueue) * * Create or update the Queue. When creating queue, platform generates Queue Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). Specify existing Queue id to update the queue. Referencing non-existing Queue Id will cause 'Not Found' error. * * Queue name is unique in the scope of sysadmin. Remove 'id', 'tenantId' from the request body example (below) to create new Queue entity. * * Available for users with 'SYS_ADMIN' authority. */ export declare const saveQueue: (options: Options) => import("./client").RequestResult; /** * Delete entity attributes (deleteEntityAttributes) * * Delete entity attributes using provided Entity Id, scope and a list of keys. Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const deleteEntityAttributes: (options: Options) => import("./client").RequestResult; /** * Save entity attributes (saveEntityAttributesV1) * * Creates or updates the entity attributes based on Entity Id and the specified attribute scope. List of possible attribute scopes depends on the entity type: * * * SERVER_SCOPE - supported for all entity types; * * SHARED_SCOPE - supported for devices. * * The request payload is a JSON object with key-value format of attributes to create or update. For example: * * ```json * { * "stringKey":"value1", * "booleanKey":true, * "doubleKey":42.0, * "longKey":73, * "jsonKey": { * "someNumber": 42, * "someArray": [1,2,3], * "someNestedObject": {"key": "value"} * } * } * ``` * Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveEntityAttributesV1: (options: Options) => import("./client").RequestResult; /** * Get time series data (getTimeseries) * * Returns a range of time series values for specified entity. Returns not aggregated data by default. Use aggregation function ('agg') and aggregation interval ('interval') to enable aggregation of the results on the database / server side. The aggregation is generally more efficient then fetching all records. * * ```json * { * "temperature": [ * { * "value": 36.7, * "ts": 1609459200000 * }, * { * "value": 36.6, * "ts": 1609459201000 * } * ] * } * ``` * * Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getLatestTimeseries: (options: Options) => import("./client").RequestResult; /** * Get time series data by read queries (getTimeseriesByReadTsKvQueries) * * Returns aggregated time series values according to queries for specified entity. ```json * [ * { * "queryId": 49, * "data": [ * { * "ts": 1751450399999, * "kv": { * "key": "temperature", * "value": 26, * "doubleValue": 26, * "valueAsString": "26.0", * "dataType": "DOUBLE", * "longValue": null, * "booleanValue": null, * "jsonValue": null, * "strValue": null * }, * "version": null * } * ], * "lastEntryTs": 1750264592675 * }, * { * "queryId": 50, * "data": [], * "lastEntryTs": 1751317200000 * } * ] * ``` * * Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getTimeseriesByReadTsKvQueries: (options: Options) => import("./client").RequestResult; /** * Save or update time series data (saveEntityTelemetry) * * Creates or updates the entity time series data based on the Entity Id and request payload.The request payload is a JSON document with three possible formats: * * Simple format without timestamp. In such a case, current server time will be used: * * ```json * {"temperature": 26} * ``` * * Single JSON object with timestamp: * * ```json * {"ts":1634712287000,"values":{"temperature":26, "humidity":87}} * ``` * * JSON array with timestamps: * * ```json * [{"ts":1634712287000,"values":{"temperature":26, "humidity":87}}, {"ts":1634712588000,"values":{"temperature":25, "humidity":88}}] * ``` * * The scope parameter is not used in the API call implementation but should be specified whatever value because it is used as a path variable. Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveEntityTelemetry: (options: Options) => import("./client").RequestResult; /** * Save or update time series data with TTL (saveEntityTelemetryWithTTL) * * Creates or updates the entity time series data based on the Entity Id and request payload.The request payload is a JSON document with three possible formats: * * Simple format without timestamp. In such a case, current server time will be used: * * ```json * {"temperature": 26} * ``` * * Single JSON object with timestamp: * * ```json * {"ts":1634712287000,"values":{"temperature":26, "humidity":87}} * ``` * * JSON array with timestamps: * * ```json * [{"ts":1634712287000,"values":{"temperature":26, "humidity":87}}, {"ts":1634712588000,"values":{"temperature":25, "humidity":88}}] * ``` * * The scope parameter is not used in the API call implementation but should be specified whatever value because it is used as a path variable. * * The ttl parameter takes affect only in case of Cassandra DB.Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveEntityTelemetryWithTtl: (options: Options) => import("./client").RequestResult; /** * Save entity attributes (saveEntityAttributesV2) * * Creates or updates the entity attributes based on Entity Id and the specified attribute scope. List of possible attribute scopes depends on the entity type: * * * SERVER_SCOPE - supported for all entity types; * * SHARED_SCOPE - supported for devices. * * The request payload is a JSON object with key-value format of attributes to create or update. For example: * * ```json * { * "stringKey":"value1", * "booleanKey":true, * "doubleKey":42.0, * "longKey":73, * "jsonKey": { * "someNumber": 42, * "someArray": [1,2,3], * "someNestedObject": {"key": "value"} * } * } * ``` * Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveEntityAttributesV2: (options: Options) => import("./client").RequestResult; /** * Delete device attributes (deleteDeviceAttributes) * * Delete device attributes using provided Device Id, scope and a list of keys. Referencing a non-existing Device Id will cause an error * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const deleteDeviceAttributes: (options: Options) => import("./client").RequestResult; /** * Save device attributes (saveDeviceAttributes) * * Creates or updates the device attributes based on device id and specified attribute scope. The request payload is a JSON object with key-value format of attributes to create or update. For example: * * ```json * { * "stringKey":"value1", * "booleanKey":true, * "doubleKey":42.0, * "longKey":73, * "jsonKey": { * "someNumber": 42, * "someArray": [1,2,3], * "someNestedObject": {"key": "value"} * } * } * ``` * * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveDeviceAttributes: (options: Options) => import("./client").RequestResult; /** * Send two-way RPC request (handleTwoWayDeviceRPCRequest) * * Deprecated. See 'Rpc V 2 Controller' instead. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const handleTwoWayDeviceRpcRequest1: (options: Options) => import("./client").RequestResult; /** * Send one-way RPC request (handleOneWayDeviceRPCRequest) * * Deprecated. See 'Rpc V 2 Controller' instead. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const handleOneWayDeviceRpcRequest1: (options: Options) => import("./client").RequestResult; /** * Change owner to tenant (changeOwnerToTenant) * * Tenant changes Owner from Customer or sub-Customer to Tenant. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const changeOwnerToTenant: (options: Options) => import("./client").RequestResult; /** * Change owner to customer (changeOwnerToCustomer) * * Tenant/Customer changes Owner to Customer or sub-Customer. Sub-Customer can`t perform this operation! * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const changeOwnerToCustomer: (options: Options) => import("./client").RequestResult; /** * Create Or Update OTA Package Info (saveOtaPackageInfo) * * Create or update the OTA Package Info. When creating OTA Package Info, platform generates OTA Package id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created OTA Package id will be present in the response. Specify existing OTA Package id to update the OTA Package Info. Referencing non-existing OTA Package Id will cause 'Not Found' error. * * OTA Package combination of the title with the version is unique in the scope of tenant. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveOtaPackageInfo: (options: Options) => import("./client").RequestResult; /** * Delete OTA Package (deleteOtaPackage) * * Deletes the OTA Package. Referencing non-existing OTA Package Id will cause an error. Can't delete the OTA Package if it is referenced by existing devices or device profile. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const deleteOtaPackage: (options: Options) => import("./client").RequestResult; /** * Get OTA Package (getOtaPackageById) * * Fetch the OTA Package object based on the provided OTA Package Id. The server checks that the OTA Package is owned by the same tenant. OTA Package is a heavyweight object that includes main information about the OTA Package and also data. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getOtaPackageById: (options: Options) => import("./client").RequestResult; /** * Save OTA Package data (saveOtaPackageData) * * Update the OTA Package. Adds the date to the existing OTA Package Info * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveOtaPackageData: (options: Options) => import("./client").RequestResult; /** * Get the list of all OAuth2 client registration templates (getClientRegistrationTemplates) * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * Client registration template is OAuth2 provider configuration template with default settings for registering new OAuth2 clients */ export declare const getClientRegistrationTemplates: (options?: Options) => import("./client").RequestResult; /** * Create or update OAuth2 client registration template (saveClientRegistrationTemplate) * * Available for users with 'SYS_ADMIN' authority. * * Client registration template is OAuth2 provider configuration template with default settings for registering new OAuth2 clients */ export declare const saveClientRegistrationTemplate: (options: Options) => import("./client").RequestResult; /** * Save OAuth2 Client (saveOAuth2Client) * * * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveOAuth2Client: (options: Options) => import("./client").RequestResult; /** * Save notification template (saveNotificationTemplate) * * Creates or updates notification template. * * Here is an example of template to send notification via Web, SMS and Slack: * ```json * { * "name": "Greetings", * "notificationType": "GENERAL", * "configuration": { * "deliveryMethodsTemplates": { * "WEB": { * "enabled": true, * "subject": "Greetings", * "body": "Hi there, ${recipientTitle}", * "additionalConfig": { * "icon": { * "enabled": true, * "icon": "back_hand", * "color": "#757575" * }, * "actionButtonConfig": { * "enabled": false * } * }, * "method": "WEB" * }, * "SMS": { * "enabled": true, * "body": "Hi there, ${recipientTitle}", * "method": "SMS" * }, * "SLACK": { * "enabled": true, * "body": "Hi there, @${recipientTitle}", * "method": "SLACK" * } * } * } * } * ``` * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const saveNotificationTemplate: (options: Options) => import("./client").RequestResult; /** * Save notification target (saveNotificationTarget) * * Creates or updates notification target. * * Available `configuration` types are `PLATFORM_USERS` and `SLACK`. * For `PLATFORM_USERS` the `usersFilter` must be specified. For tenant, there are following users filter types available: `USER_LIST`, `CUSTOMER_USERS`, `USER_GROUP_LIST`, `TENANT_ADMINISTRATORS`, `USER_ROLE`, `ALL_USERS`, `ORIGINATOR_ENTITY_OWNER_USERS`, `AFFECTED_USER`. * For sysadmin: `TENANT_ADMINISTRATORS`, `AFFECTED_TENANT_ADMINISTRATORS`, `SYSTEM_ADMINISTRATORS`, `ALL_USERS`. * * Here is an example of tenant-level notification target to send notification to customer's users: * ```json * { * "name": "Users of Customer A", * "configuration": { * "type": "PLATFORM_USERS", * "usersFilter": { * "type": "CUSTOMER_USERS", * "customerId": "32499a20-d785-11ed-a06c-21dd57dd88ca" * }, * "description": "Users of Customer A" * } * } * ``` * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const saveNotificationTarget: (options: Options) => import("./client").RequestResult; /** * Get recipients for notification target config (getRecipientsForNotificationTargetConfig) * * Returns the page of recipients for such notification target configuration. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getRecipientsForNotificationTargetConfig: (options: Options) => import("./client").RequestResult; /** * Get notification settings (getNotificationSettings) * * Retrieves notification settings for this tenant or sysadmin. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getNotificationSettings: (options?: Options) => import("./client").RequestResult; /** * Save notification settings (saveNotificationSettings) * * Saves notification settings for this tenant or sysadmin. * `deliveryMethodsConfigs` of the settings must be specified. * * Here is an example of the notification settings with Slack configuration: * ```json * { * "deliveryMethodsConfigs": { * "SLACK": { * "method": "SLACK", * "botToken": "xoxb-...." * } * } * } * ``` * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const saveNotificationSettings: (options: Options) => import("./client").RequestResult; export declare const getUserNotificationSettings: (options?: Options) => import("./client").RequestResult; export declare const saveUserNotificationSettings: (options: Options) => import("./client").RequestResult; /** * Send plan upgrade request notification to System administrators (sendPlanUpgradeRequest) * * Send plan upgrade access request notification by Tenant Administrator to System administrators. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const sendPlanUpgradeRequest: (options: Options) => import("./client").RequestResult; /** * Send add-on access request notification to System/Tenant administrators (sendAddonAccessRequest) * * Send add-on access request notification by Tenant Administrator or Customer User to System/Tenant administrators. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const sendAddonAccessRequest: (options: Options) => import("./client").RequestResult; /** * Send add-on access error notification to System/Tenant administrators (sendAddonAccessError) * * Send add-on access error notification by Tenant Administrator or Customer User to System/Tenant administrators. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const sendAddonAccessError: (options: Options) => import("./client").RequestResult; /** * Save notification rule (saveNotificationRule) * * Creates or updates notification rule. * * Mandatory properties are `name`, `templateId` (of a template with `notificationType` matching to rule's `triggerType`), `triggerType`, `triggerConfig` and `recipientConfig`. Additionally, you may specify rule `description` inside of `additionalConfig`. * * Trigger type of the rule cannot be changed. Available trigger types for tenant: `ENTITY_ACTION`, `ALARM`, `ALARM_COMMENT`, `ALARM_ASSIGNMENT`, `DEVICE_ACTIVITY`, `RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT`. * For sysadmin, there are following trigger types available: `ENTITIES_LIMIT`, `API_USAGE_LIMIT`, `NEW_PLATFORM_VERSION`. * * Here is an example of notification rule to send notification when a device, asset or customer is created or deleted: * ```json * { * "name": "Entity action", * "templateId": { * "entityType": "NOTIFICATION_TEMPLATE", * "id": "32117320-d785-11ed-a06c-21dd57dd88ca" * }, * "triggerType": "ENTITY_ACTION", * "triggerConfig": { * "entityTypes": [ * "CUSTOMER", * "DEVICE", * "ASSET" * ], * "created": true, * "updated": false, * "deleted": true, * "triggerType": "ENTITY_ACTION" * }, * "recipientsConfig": { * "targets": [ * "320f2930-d785-11ed-a06c-21dd57dd88ca" * ], * "triggerType": "ENTITY_ACTION" * }, * "additionalConfig": { * "description": "Send notification to tenant admins or customer users when a device, asset or customer is created" * }, * "templateName": "Entity action notification", * "deliveryMethods": [ * "WEB" * ] * } * ``` * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const saveNotificationRule: (options: Options) => import("./client").RequestResult; /** * Create notification request (createNotificationRequest) * * Processes notification request. * Mandatory request properties are `targets` (list of targets ids to send notification to), and either `templateId` (existing notification template id) or `template` (to send notification without saving the template). * Optionally, you can set `sendingDelayInSec` inside the `additionalConfig` field to schedule the notification. * * For each enabled delivery method in the notification template, there must be a target in the `targets` list that supports this delivery method: if you chose `WEB`, `EMAIL` or `SMS` - there must be at least one target in `targets` of `PLATFORM_USERS` type. * For `SLACK` delivery method - you need to chose at least one `SLACK` notification target. * * Notification request object with `PROCESSING` status will be returned immediately, and the notification sending itself is done asynchronously. After all notifications are sent, the `status` of the request becomes `SENT`. Use `getNotificationRequestById` to see the notification request processing status and some sending stats. * * Here is an example of notification request to one target using saved template: * ```json * { * "templateId": { * "entityType": "NOTIFICATION_TEMPLATE", * "id": "6dbc3670-e4dd-11ed-9401-dbcc5dff78be" * }, * "targets": [ * "320e3ed0-d785-11ed-a06c-21dd57dd88ca" * ], * "additionalConfig": { * "sendingDelayInSec": 0 * } * } * ``` * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const createNotificationRequest: (options: Options) => import("./client").RequestResult; /** * Get notification request preview (getNotificationRequestPreview) * * Returns preview for notification request. * * `processedTemplates` shows how the notifications for each delivery method will look like for the first recipient of the corresponding notification target. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getNotificationRequestPreview: (options: Options) => import("./client").RequestResult; /** * Send entity limit increase request notification to System/Tenant administrators (sendEntitiesLimitIncreaseRequest) * * Send entity limit increase request notification by Tenant Administrator or Customer User to System/Tenant administrators. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const sendEntitiesLimitIncreaseRequest: (options: Options) => import("./client").RequestResult; /** * User Sign Up (signUp) * * Process user sign up request. Creates the Customer and corresponding User based on self Registration parameters for the domain. See [Self Registration Controller](/swagger-ui.html#/self-registration-controller) for more details. The result is either 'SUCCESS' or 'INACTIVE_USER_EXISTS'. If Success, the user will receive an email with instruction to activate the account. The content of the email is customizable via the mail templates. */ export declare const signUp: (options: Options) => import("./client").RequestResult; /** * Check password reset token (checkResetToken) * * Checks the password reset token and forwards user to 'Reset Password' page. If token is valid, returns '303 See Other' (redirect) response code with the correct address of 'Reset Password' page and same 'resetToken' specified in the URL parameters. If token is not valid, returns '409 Conflict'. If token is expired, redirects to error page. */ export declare const checkResetToken: (options: Options) => import("./client").RequestResult; /** * Reset password (resetPassword) * * Checks the password reset token and updates the password. If token is not valid, returns '400 Bad Request'. */ export declare const resetPassword: (options: Options) => import("./client").RequestResult; /** * Request reset password email (requestResetPasswordByEmail) * * Request to send the reset password email if the user with specified email address is present in the database. Always return '200 OK' status for security purposes. */ export declare const requestResetPasswordByEmail: (options: Options) => import("./client").RequestResult; /** * Resend Activation Email (resendEmailActivation) * * Request to resend the activation email for the user. Checks that user was not activated yet. */ export declare const resendEmailActivation: (options: Options) => import("./client").RequestResult; /** * Get OAuth2 clients (getOAuth2Clients) * * Get the list of OAuth2 clients to log in with, available for such domain scheme (HTTP or HTTPS) (if x-forwarded-proto request header is present - the scheme is known from it) and domain name and port (port may be known from x-forwarded-port header) */ export declare const getOAuth2Clients: (options?: Options) => import("./client").RequestResult; /** * Check Activate User Token (checkActivateToken) * * Checks the activation token and forwards user to 'Create Password' page. If token is valid, returns '303 See Other' (redirect) response code with the correct address of 'Create Password' page and same 'activateToken' specified in the URL parameters. If token is not valid, returns '409 Conflict'. If token is expired, redirects to error page. */ export declare const checkActivateToken: (options: Options) => import("./client").RequestResult; /** * Activate User * * Checks the activation token and updates corresponding user password in the database. Now the user may start using his password to login. The response already contains the [JWT](https://jwt.io) activation and refresh tokens, to simplify the user activation flow and avoid asking user to input password again after activation. If token is valid, returns the object that contains [JWT](https://jwt.io/) access and refresh tokens. If token is not valid, returns '400 Bad Request'. */ export declare const activateUser: (options: Options) => import("./client").RequestResult; /** * Activate and login using code from Email (activateUserByEmailCode) * * Activate the user using code(link) from the activation email and return the JWT Token. Sends the notification and email about user activation. Checks that user was not activated yet. */ export declare const activateUserByEmailCode: (options: Options) => import("./client").RequestResult; /** * Get Mobile application settings (getMobileAppSettings) * * The response payload contains configuration for android/iOS applications and platform qr code widget settings. * * Available for any authorized user. */ export declare const getQrCodeSettings: (options?: Options) => import("./client").RequestResult; /** * Create Or Update the Mobile application settings (saveMobileAppSettings) * * The request payload contains configuration for android/iOS applications and platform qr code widget settings. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const saveQrCodeSettings: (options: Options) => import("./client").RequestResult; /** * Save Or update Mobile app bundle (saveMobileAppBundle) * * Create or update the Mobile app bundle that represents tha pair of ANDROID and IOS app and mobile settings like oauth2 clients, self-registration and layout configuration.When creating mobile app bundle, platform generates Mobile App Bundle Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Mobile App Bundle Id will be present in the response. Referencing non-existing Mobile App Bundle Id will cause 'Not Found' error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const saveMobileAppBundle: (options: Options) => import("./client").RequestResult; /** * Get mobile app infos (getTenantMobileAppInfos) * * * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getTenantMobileApps: (options: Options) => import("./client").RequestResult; /** * Save Or update Mobile app (saveMobileApp) * * Create or update the Mobile app. When creating mobile app, platform generates Mobile App Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Mobile App Id will be present in the response. Specify existing Mobile App Id to update the mobile app. Referencing non-existing Mobile App Id will cause 'Not Found' error. * * The pair of mobile app package name and platform type is unique for entire platform setup. * * * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const saveMobileApp: (options: Options) => import("./client").RequestResult; /** * Save device with credentials (Deprecated) */ export declare const saveDeviceWithCredentials: (options: Options) => import("./client").RequestResult; /** * Check edge license (checkInstance) * * Checks license request from edge service by forwarding request to license portal. */ export declare const checkInstance: (options: Options) => import("./client").RequestResult; /** * Activate edge instance (activateInstance) * * Activates edge license on license portal. */ export declare const activateInstance: (options: Options) => import("./client").RequestResult; /** * Reprocess job (reprocessJob) * * Reprocesses the job. Failures are located at job.result.results list. Platform iterates over this list and submits new tasks for them. Doesn't create new job entity but updates the existing one. Successfully reprocessed job will look the same as completed one. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const reprocessJob: (options: Options) => import("./client").RequestResult; /** * Cancel job (cancelJob) * * Cancels the job. The status of the job must be QUEUED, PENDING or RUNNING. * * For a running job, all the tasks not yet processed will be discarded. * * See the example of a cancelled job result in getJobById method description. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const cancelJob: (options: Options) => import("./client").RequestResult; /** * Create Or Update Integration (saveIntegration) * * Create or update the Integration. When creating integration, platform generates Integration Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created integration id will be present in the response. Specify existing Integration id to update the integration. Referencing non-existing integration Id will cause 'Not Found' error. Integration configuration is validated for each type of the integration before it can be created. * * # Integration Configuration * * Integration configuration (**'configuration'** field) is the JSON object representing the special configuration per integration type with the connectivity fields and other important parameters dependent on the specific integration type. Let's review the configuration object for the MQTT Integration type below. * * ```json * { * "clientConfiguration":{ * "host":"broker.hivemq.com", * "port":1883, * "cleanSession":false, * "ssl":false, * "connectTimeoutSec":10, * "clientId":"", * "maxBytesInMessage":32368, * "credentials":{ * "type":"anonymous" * } * }, * "downlinkTopicPattern":"${topic}", * "topicFilters":[ * { * "filter":"tb/mqtt-integration-tutorial/sensors/+/temperature", * "qos":0 * } * ], * "metadata":{ * } * } * ``` * * Remove 'id', 'tenantId' from the request body example (below) to create new Integration entity. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveIntegration: (options: Options) => import("./client").RequestResult; /** * Check integration connectivity (checkIntegrationConnection) * * Checks if the connection to the integration is established. Throws an error if the connection is not established. Example: Failed to connect to MQTT broker at host:port. */ export declare const checkIntegrationConnection: (options: Options) => import("./client").RequestResult; export declare const uploadImage: (options?: Options) => import("./client").RequestResult; /** * Create Or Update Group Permission (saveGroupPermission) * * Creates or Updates the Group Permission. When creating group permission, platform generates Group Permission Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Group Permission id will be present in the response. Specify existing Group Permission id to update the permission. Referencing non-existing Group Permission Id will cause 'Not Found' error. * * Group permission entity represents list of allowed operations for certain User Group to perform against certain Entity Group. Basically, this entity wires three other entities: * * * Role that defines set of allowed operations; * * User Group that defines set of users who may perform the operations; * * Entity Group that defines set of entities which will be accessible to users; * * Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const saveGroupPermission: (options: Options) => import("./client").RequestResult; /** * Get Events (Deprecated) * * Returns a page of events for specified entity. Deprecated and will be removed in next minor release. The call was deprecated to improve the performance of the system. Current implementation will return 'Lifecycle' events only. Use 'Get events by type' or 'Get events by filter' instead. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. */ export declare const getEvents: (options: Options) => import("./client").RequestResult; /** * Get Events by event filter (getEvents) * * Returns a page of events for the chosen entity by specifying the event filter. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * # Event Filter Definition * * 6 different eventFilter objects could be set for different event types. The eventType field is required. Others are optional. If some of them are set, the filtering will be applied according to them. See the examples below for all the fields used for each event type filtering. * * Note, * * * 'server' - string value representing the server name, identif ier or ip address where the platform is running; * * 'errorStr' - the case insensitive 'contains' filter based on error message. * * ## Error Event Filter * * ```json * { * "eventType":"ERROR", * "server":"ip-172-31-24-152", * "method":"onClusterEventMsg", * "errorStr":"Error Message" * } * ``` * * * 'method' - string value representing the method name when the error happened. * * ## Lifecycle Event Filter * * ```json * { * "eventType":"LC_EVENT", * "server":"ip-172-31-24-152", * "event":"STARTED", * "status":"Success", * "errorStr":"Error Message" * } * ``` * * * 'event' - string value representing the lifecycle event type; * * 'status' - string value representing status of the lifecycle event. * * ## Statistics Event Filter * * ```json * { * "eventType":"STATS", * "server":"ip-172-31-24-152", * "messagesProcessed":10, * "errorsOccurred":5 * } * ``` * * * 'messagesProcessed' - the minimum number of successfully processed messages; * * 'errorsOccurred' - the minimum number of errors occurred during messages processing. * * ## Debug Rule Node Event Filter * * ```json * { * "eventType":"DEBUG_RULE_NODE", * "msgDirectionType":"IN", * "server":"ip-172-31-24-152", * "dataSearch":"humidity", * "metadataSearch":"deviceName", * "entityName":"DEVICE", * "relationType":"Success", * "entityId":"de9d54a0-2b7a-11ec-a3cc-23386423d98f", * "msgType":"POST_TELEMETRY_REQUEST", * "isError":"false", * "errorStr":"Error Message" * } * ``` * * ## Debug Rule Chain Event Filter * * ```json * { * "eventType":"DEBUG_RULE_CHAIN", * "msgDirectionType":"IN", * "server":"ip-172-31-24-152", * "dataSearch":"humidity", * "metadataSearch":"deviceName", * "entityName":"DEVICE", * "relationType":"Success", * "entityId":"de9d54a0-2b7a-11ec-a3cc-23386423d98f", * "msgType":"POST_TELEMETRY_REQUEST", * "isError":"false", * "errorStr":"Error Message" * } * ``` * * * 'msgDirectionType' - string value representing msg direction type (incoming to entity or outcoming from entity); * * 'dataSearch' - the case insensitive 'contains' filter based on data (key and value) for the message; * * 'metadataSearch' - the case insensitive 'contains' filter based on metadata (key and value) for the message; * * 'entityName' - string value representing the entity type; * * 'relationType' - string value representing the type of message routing; * * 'entityId' - string value representing the entity id in the event body (originator of the message); * * 'msgType' - string value representing the message type; * * 'isError' - boolean value to filter the errors. * * ## Debug Calculated Field Event Filter * * ```json * { * "eventType":"DEBUG_CALCULATED_FIELD", * "server":"ip-172-31-24-152", * "isError":"false", * "errorStr":"Error Message" * "entityId":"cf4b8741-f618-471f-ae08-d881ca7f9fe9", * "msgId":"5cf7d3a0-aee7-40dd-a737-ade05528e7eb", * "msgType":"POST_TELEMETRY_REQUEST", * "arguments":"{ * "x": { * "ts": 1739432016629, * "value": 20 * }, * "y": { * "ts": 1739429717656, * "value": 12 * } * }", * "result":"{ * "x + y": 32 * }", * } * ``` * * * 'entityId' - string value representing the entity id in the event body; * * 'entityType' - string value representing the entity type; * * 'msgId' - string value representing the message id in the rule engine; * * 'msgType' - string value representing the message type; * * 'arguments' - string value representing the arguments that were used in the calculation performed; * * 'result' - string value representing the result of a calculation; * * 'isError' - boolean value to filter the errors. * * */ export declare const getEvents1: (options: Options) => import("./client").RequestResult; /** * Clear Events (clearEvents) * * Clears events by filter for specified entity. */ export declare const clearEvents: (options: Options) => import("./client").RequestResult; /** * Get Entity Views By Ids (getEntityViewsByIds) * * Requested entity views must be owned by tenant or assigned to customer which user is performing the request. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getEntityViewsByIds: (options: Options) => import("./client").RequestResult; /** * Find related entity views (findByQuery) * * Returns all entity views that are related to the specific entity. The entity id, relation type, entity view types, depth of the search, and other query parameters defined using complex 'EntityViewSearchQuery' object. See 'Model' tab of the Parameters for more info. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const findByQuery1: (options: Options) => import("./client").RequestResult; /** * Save or update entity view (saveEntityView) * * Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. See the 'Model' tab for more details.Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Entity View entity. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveEntityView: (options: Options) => import("./client").RequestResult; /** * Create Or Update Entity Group (saveEntityGroup) * * Create or update the Entity Group. When creating Entity Group, platform generates Entity Group Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Entity Group Id will be present in the response. Specify existing Entity Group Id to update the group. Referencing non-existing Entity Group Id will cause 'Not Found' error.Remove 'id', 'tenantId' and optionally 'ownerId' from the request body example (below) to create new Entity Group entity. * * Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. */ export declare const saveEntityGroup: (options: Options) => import("./client").RequestResult; /** * Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroup) * * Share the entity group with specified user group using specified role. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. */ export declare const shareEntityGroupToChildOwnerUserGroup: (options: Options) => import("./client").RequestResult; /** * Share the Entity Group (shareEntityGroup) * * Share the entity group with certain user group based on the provided Share Group Request. The request is quite flexible and processing of the request involves multiple security checks using platform RBAC feature. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. */ export declare const shareEntityGroup: (options: Options) => import("./client").RequestResult; /** * Make Entity Group Publicly available (makeEntityGroupPublic) * * Make the entity group available for non authorized users. Useful for public dashboards that will be embedded into the public websites. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. */ export declare const makeEntityGroupPublic: (options: Options) => import("./client").RequestResult; /** * Make Entity Group Private (makeEntityGroupPrivate) * * Make the entity group not available for non authorized users. Every group is private by default. This call is useful to hide the group that was previously made public. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. */ export declare const makeEntityGroupPrivate: (options: Options) => import("./client").RequestResult; /** * Remove entities from the group (removeEntitiesFromEntityGroup) * * Removes entities from the specified entity group. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'REMOVE_FROM_GROUP' permission for specified group. */ export declare const removeEntitiesFromEntityGroup: (options: Options) => import("./client").RequestResult; /** * Import Dashboards (importGroupDashboards) * * Import the dashboards to specified group.The Dashboard object is a heavyweight object that contains information about the dashboard (e.g. title, image, assigned customers) and also configuration JSON (e.g. layouts, widgets, entity aliases). * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. */ export declare const importGroupDashboards: (options: Options) => import("./client").RequestResult; /** * Add entities to the group (addEntitiesToEntityGroup) * * Add entities to the specified entity group. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'ADD_TO_GROUP' permission for specified group. */ export declare const addEntitiesToEntityGroup: (options: Options) => import("./client").RequestResult; /** * Find Entity Data by Query * * Allows to run complex queries over platform entities (devices, assets, customers, etc) based on the combination of main entity filter and multiple key filters. Returns the paginated result of the query that contains requested entity fields and latest values of requested attributes and time series data. * * # Query Definition * * * * Main **entity filter** is mandatory and defines generic search criteria. For example, "find all devices with profile 'Moisture Sensor'" or "Find all devices related to asset 'Building A'" * * Optional **key filters** allow to filter results of the **entity filter** by complex criteria against main entity fields (name, label, type, etc), attributes and telemetry. For example, "temperature > 20 or temperature< 10" or "name starts with 'T', and attribute 'model' is 'T1000', and time series field 'batteryLevel' > 40". * * The **entity fields** and **latest values** contains list of entity fields and latest attribute/telemetry fields to fetch for each entity. * * The **page link** contains information about the page to fetch and the sort ordering. * * Let's review the example: * * ```json * { * "entityFilter": { * "type": "entityType", * "resolveMultiple": true, * "entityType": "DEVICE" * }, * "keyFilters": [ * { * "key": { * "type": "TIME_SERIES", * "key": "temperature" * }, * "valueType": "NUMERIC", * "predicate": { * "operation": "GREATER", * "value": { * "defaultValue": 0, * "dynamicValue": { * "sourceType": "CURRENT_USER", * "sourceAttribute": "temperatureThreshold", * "inherit": false * } * }, * "type": "NUMERIC" * } * } * ], * "entityFields": [ * { * "type": "ENTITY_FIELD", * "key": "name" * }, * { * "type": "ENTITY_FIELD", * "key": "label" * }, * { * "type": "ENTITY_FIELD", * "key": "additionalInfo" * } * ], * "latestValues": [ * { * "type": "ATTRIBUTE", * "key": "model" * }, * { * "type": "TIME_SERIES", * "key": "temperature" * } * ], * "pageLink": { * "page": 0, * "pageSize": 10, * "sortOrder": { * "key": { * "key": "name", * "type": "ENTITY_FIELD" * }, * "direction": "ASC" * } * } * } * ``` * * Example mentioned above search all devices which have attribute 'active' set to 'true'. Now let's review available entity filters and key filters syntax: * * # Entity Filters * Entity Filter body depends on the 'type' parameter. Let's review available entity filter types. In fact, they do correspond to available dashboard aliases. * * ## Single Entity * * Allows to filter only one entity based on the id. For example, this entity filter selects certain device: * * ```json * { * "type": "singleEntity", * "singleEntity": { * "id": "d521edb0-2a7a-11ec-94eb-213c95f54092", * "entityType": "DEVICE" * } * } * ``` * * ## Group Entities Filter * * Allows to filter multiple entities of the same type using the entity group type and id. For example, this entity filter selects all devices that belong to the group 'e52b0020-2a7a-11ec-94eb-213c95f54092': * * ```json * { * "type": "entityGroup", * "groupType": "DEVICE", * "entityGroup": "e52b0020-2a7a-11ec-94eb-213c95f54092" * } * ``` * * ## Entity List Filter * * Allows to filter entities of the same type using their ids. For example, this entity filter selects two devices: * * ```json * { * "type": "entityList", * "entityType": "DEVICE", * "entityList": [ * "e6501f30-2a7a-11ec-94eb-213c95f54092", * "e6657bf0-2a7a-11ec-94eb-213c95f54092" * ] * } * ``` * * ## Entity Name Filter * * Allows to filter entities of the same type using the **'starts with'** expression over entity name. For example, this entity filter selects all devices which name starts with 'Air Quality': * * ```json * { * "type": "entityName", * "entityType": "DEVICE", * "entityNameFilter": "Air Quality" * } * ``` * * ## Entity Type Filter * * Allows to filter entities based on their type (CUSTOMER, USER, DASHBOARD, ASSET, DEVICE, etc)For example, this entity filter selects all tenant customers: * * ```json * { * "type": "entityType", * "entityType": "CUSTOMER" * } * ``` * * ## Group List Filter * * Return multiple groups of the same type using specified ids. For example, this entity filter selects 2 device groups (if they are present in the system) with ids 'e52b0020-2a7a-11ec-94eb-213c95f54092' and 'e52b0020-2a7a-11ec-94eb-213c95f54093': * * ```json * { * "type": "entityGroupList", * "groupType": "DEVICE", * "entityGroupList": ["e52b0020-2a7a-11ec-94eb-213c95f54092", "e52b0020-2a7a-11ec-94eb-213c95f54093"] * } * ``` * * ## Group Name Filter * * Allows to filter entity groups based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all devices which name starts with 'CAT': * * ```json * { * "type": "entityGroupName", * "groupType": "DEVICE", * "entityGroupNameFilter": "CAT" * } * ``` * * ## Entities by Group Name Filter * * Allows to filter entities that belong to group based on the entity type and the group name. Optional parameter 'ownerId' allows you to specify the owner of the group (Tenant or Customer, current user owner by default).For example, this entity filter selects all devices which belong to group 'Water Meters': * * ```json * { * "type": "entitiesByGroupName", * "groupType": "DEVICE", * "entityGroupNameFilter": "Water Meters" * } * ``` * * Other example, this entity filter selects all devices which belong to group 'Water Meters' which in turn belongs to (sub-)Customer with id 'e52b0020-2a7a-11ec-94eb-213c95f54093': * * ```json * { * "type": "entitiesByGroupName", * "ownerId": {"entityType": "CUSTOMER","id":"e52b0020-2a7a-11ec-94eb-213c95f54093"}, * "groupType": "DEVICE", * "entityGroupNameFilter": "Water Meters" * } * ``` * * ## Entity owner Filter * * Allows to fetch owner (Tenant or Customer) of the specified entity. For example, this entity filter selects owner of the device with id 'e52b0020-2a7a-11ec-94eb-213c95f54093': * * ```json * { * "type": "stateEntityOwner", * "singleEntity": { * "id": "d521edb0-2a7a-11ec-94eb-213c95f54092", * "entityType": "DEVICE" * } * } * ``` * * ## Asset Type Filter * * Allows to filter assets based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'charging station' assets which name starts with 'Tesla': * * ```json * { * "type": "assetType", * "assetType": "charging station", * "assetNameFilter": "Tesla" * } * ``` * * ## Device Type Filter * * Allows to filter devices based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Temperature Sensor' devices which name starts with 'ABC': * * ```json * { * "type": "deviceType", * "deviceType": "Temperature Sensor", * "deviceNameFilter": "ABC" * } * ``` * * ## Edge Type Filter * * Allows to filter edge instances based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Factory' edge instances which name starts with 'Nevada': * * ```json * { * "type": "edgeType", * "edgeType": "Factory", * "edgeNameFilter": "Nevada" * } * ``` * * ## Entity View Filter * * Allows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT': * * ```json * { * "type": "entityViewType", * "entityViewType": "Concrete Mixer", * "entityViewNameFilter": "CAT" * } * ``` * * ## Api Usage Filter * * Allows to query for Api Usage based on optional customer id. If the customer id is not set, returns current tenant API usage.For example, this entity filter selects the 'Api Usage' entity for customer with id 'e6501f30-2a7a-11ec-94eb-213c95f54092': * * ```json * { * "type": "apiUsageState", * "customerId": { * "id": "d521edb0-2a7a-11ec-94eb-213c95f54092", * "entityType": "CUSTOMER" * } * } * ``` * * ## Relations Query Filter * * Allows to filter entities that are related to the provided root entity. Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. The 'filter' object allows you to define the relation type and set of acceptable entity types to search for. The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only those who match the 'filters'. * * For example, this entity filter selects all devices and assets which are related to the asset with id 'e51de0c0-2a7a-11ec-94eb-213c95f54092': * * ```json * { * "type": "relationsQuery", * "rootEntity": { * "entityType": "ASSET", * "id": "e51de0c0-2a7a-11ec-94eb-213c95f54092" * }, * "direction": "FROM", * "maxLevel": 1, * "fetchLastLevelOnly": false, * "filters": [ * { * "relationType": "Contains", * "entityTypes": [ * "DEVICE", * "ASSET" * ] * } * ] * } * ``` * * ## Asset Search Query * * Allows to filter assets that are related to the provided root entity. Filters related assets based on the relation type and set of asset types. Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. The 'relationType' defines the type of the relation to search for. The 'assetTypes' defines the type of the asset to search for. The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only assets that match 'relationType' and 'assetTypes' conditions. * * For example, this entity filter selects 'charging station' assets which are related to the asset with id 'e51de0c0-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation: * * ```json * { * "type": "assetSearchQuery", * "rootEntity": { * "entityType": "ASSET", * "id": "e51de0c0-2a7a-11ec-94eb-213c95f54092" * }, * "direction": "FROM", * "maxLevel": 1, * "fetchLastLevelOnly": false, * "relationType": "Contains", * "assetTypes": [ * "charging station" * ] * } * ``` * * ## Device Search Query * * Allows to filter devices that are related to the provided root entity. Filters related devices based on the relation type and set of device types. Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. The 'relationType' defines the type of the relation to search for. The 'deviceTypes' defines the type of the device to search for. The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only devices that match 'relationType' and 'deviceTypes' conditions. * * For example, this entity filter selects 'Charging port' and 'Air Quality Sensor' devices which are related to the asset with id 'e52b0020-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation: * * ```json * { * "type": "deviceSearchQuery", * "rootEntity": { * "entityType": "ASSET", * "id": "e52b0020-2a7a-11ec-94eb-213c95f54092" * }, * "direction": "FROM", * "maxLevel": 2, * "fetchLastLevelOnly": true, * "relationType": "Contains", * "deviceTypes": [ * "Air Quality Sensor", * "Charging port" * ] * } * ``` * * ## Entity View Query * * Allows to filter entity views that are related to the provided root entity. Filters related entity views based on the relation type and set of entity view types. Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. The 'relationType' defines the type of the relation to search for. The 'entityViewTypes' defines the type of the entity view to search for. The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only devices that match 'relationType' and 'deviceTypes' conditions. * * For example, this entity filter selects 'Concrete mixer' entity views which are related to the asset with id 'e52b0020-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation: * * ```json * { * "type": "entityViewSearchQuery", * "rootEntity": { * "entityType": "ASSET", * "id": "e52b0020-2a7a-11ec-94eb-213c95f54092" * }, * "direction": "FROM", * "maxLevel": 1, * "fetchLastLevelOnly": false, * "relationType": "Contains", * "entityViewTypes": [ * "Concrete mixer" * ] * } * ``` * * ## Edge Search Query * * Allows to filter edge instances that are related to the provided root entity. Filters related edge instances based on the relation type and set of edge types. Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. The 'relationType' defines the type of the relation to search for. The 'deviceTypes' defines the type of the device to search for. The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only devices that match 'relationType' and 'deviceTypes' conditions. * * For example, this entity filter selects 'Factory' edge instances which are related to the asset with id 'e52b0020-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation: * * ```json * { * "type": "deviceSearchQuery", * "rootEntity": { * "entityType": "ASSET", * "id": "e52b0020-2a7a-11ec-94eb-213c95f54092" * }, * "direction": "FROM", * "maxLevel": 2, * "fetchLastLevelOnly": true, * "relationType": "Contains", * "edgeTypes": [ * "Factory" * ] * } * ``` * * # Key Filters * Key Filter allows you to define complex logical expressions over entity field, attribute or latest time series value. The filter is defined using 'key', 'valueType' and 'predicate' objects. Single Entity Query may have zero, one or multiple predicates. If multiple filters are defined, they are evaluated using logical 'AND'. The example below checks that temperature of the entity is above 20 degrees: * * ```json * { * "key": { * "type": "TIME_SERIES", * "key": "temperature" * }, * "valueType": "NUMERIC", * "predicate": { * "operation": "GREATER", * "value": { * "defaultValue": 20, * "dynamicValue": null * }, * "type": "NUMERIC" * } * } * ``` * * Now let's review 'key', 'valueType' and 'predicate' objects in detail. * * ## Filter Key * * Filter Key defines either entity field, attribute or telemetry. It is a JSON object that consists the key name and type. The following filter key types are supported: * * * 'CLIENT_ATTRIBUTE' - used for client attributes; * * 'SHARED_ATTRIBUTE' - used for shared attributes; * * 'SERVER_ATTRIBUTE' - used for server attributes; * * 'ATTRIBUTE' - used for any of the above; * * 'TIME_SERIES' - used for time series values; * * 'ENTITY_FIELD' - used for accessing entity fields like 'name', 'label', etc. The list of available fields depends on the entity type; * * 'ALARM_FIELD' - similar to entity field, but is used in alarm queries only; * * * Let's review the example: * * ```json * { * "type": "TIME_SERIES", * "key": "temperature" * } * ``` * * ## Value Type and Operations * * Provides a hint about the data type of the entity field that is defined in the filter key. The value type impacts the list of possible operations that you may use in the corresponding predicate. For example, you may use 'STARTS_WITH' or 'END_WITH', but you can't use 'GREATER_OR_EQUAL' for string values.The following filter value types and corresponding predicate operations are supported: * * * 'STRING' - used to filter any 'String' or 'JSON' values. Operations: EQUAL, NOT_EQUAL, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS; * * 'NUMERIC' - used for 'Long' and 'Double' values. Operations: EQUAL, NOT_EQUAL, GREATER, LESS, GREATER_OR_EQUAL, LESS_OR_EQUAL; * * 'BOOLEAN' - used for boolean values. Operations: EQUAL, NOT_EQUAL; * * 'DATE_TIME' - similar to numeric, transforms value to milliseconds since epoch. Operations: EQUAL, NOT_EQUAL, GREATER, LESS, GREATER_OR_EQUAL, LESS_OR_EQUAL; * * * ## Filter Predicate * * Filter Predicate defines the logical expression to evaluate. The list of available operations depends on the filter value type, see above. Platform supports 4 predicate types: 'STRING', 'NUMERIC', 'BOOLEAN' and 'COMPLEX'. The last one allows to combine multiple operations over one filter key. * * Simple predicate example to check 'value < 100': * * ```json * { * "operation": "LESS", * "value": { * "defaultValue": 100, * "dynamicValue": null * }, * "type": "NUMERIC" * } * ``` * * Complex predicate example, to check 'value < 10 or value > 20': * * ```json * { * "type": "COMPLEX", * "operation": "OR", * "predicates": [ * { * "operation": "LESS", * "value": { * "defaultValue": 10, * "dynamicValue": null * }, * "type": "NUMERIC" * }, * { * "operation": "GREATER", * "value": { * "defaultValue": 20, * "dynamicValue": null * }, * "type": "NUMERIC" * } * ] * } * ``` * * More complex predicate example, to check 'value < 10 or (value > 50 && value < 60)': * * ```json * { * "type": "COMPLEX", * "operation": "OR", * "predicates": [ * { * "operation": "LESS", * "value": { * "defaultValue": 10, * "dynamicValue": null * }, * "type": "NUMERIC" * }, * { * "type": "COMPLEX", * "operation": "AND", * "predicates": [ * { * "operation": "GREATER", * "value": { * "defaultValue": 50, * "dynamicValue": null * }, * "type": "NUMERIC" * }, * { * "operation": "LESS", * "value": { * "defaultValue": 60, * "dynamicValue": null * }, * "type": "NUMERIC" * } * ] * } * ] * } * ``` * * You may also want to replace hardcoded values (for example, temperature > 20) with the more dynamic expression (for example, temperature > 'value of the tenant attribute with key 'temperatureThreshold'). It is possible to use 'dynamicValue' to define attribute of the tenant, customer or user that is performing the API call. See example below: * * ```json * { * "operation": "GREATER", * "value": { * "defaultValue": 0, * "dynamicValue": { * "sourceType": "CURRENT_USER", * "sourceAttribute": "temperatureThreshold" * } * }, * "type": "NUMERIC" * } * ``` * * Note that you may use 'CURRENT_USER', 'CURRENT_CUSTOMER' and 'CURRENT_TENANT' as a 'sourceType'. The 'defaultValue' is used when the attribute with such a name is not defined for the chosen source. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const findEntityDataByQuery: (options: Options) => import("./client").RequestResult; /** * Find Available Entity Keys by Query * * Returns unique time series and/or attribute key names from entities matching the query. * * Executes the Entity Data Query to find up to 100 entities, then fetches and aggregates all distinct key names. * * Primarily used for UI features like autocomplete suggestions. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const findAvailableEntityKeysByQuery: (options: Options) => import("./client").RequestResult; /** * Count Entities by Query * * Allows to run complex queries to search the count of platform entities (devices, assets, customers, etc) based on the combination of main entity filter and multiple key filters. Returns the number of entities that match the query definition. * * # Query Definition * * * * Main **entity filter** is mandatory and defines generic search criteria. For example, "find all devices with profile 'Moisture Sensor'" or "Find all devices related to asset 'Building A'" * * Optional **key filters** allow to filter results of the entity filter by complex criteria against main entity fields (name, label, type, etc), attributes and telemetry. For example, "temperature > 20 or temperature< 10" or "name starts with 'T', and attribute 'model' is 'T1000', and time series field 'batteryLevel' > 40". * * Let's review the example: * * ```json * { * "entityFilter": { * "type": "entityType", * "entityType": "DEVICE" * }, * "keyFilters": [ * { * "key": { * "type": "ATTRIBUTE", * "key": "active" * }, * "valueType": "BOOLEAN", * "predicate": { * "operation": "EQUAL", * "value": { * "defaultValue": true, * "dynamicValue": null * }, * "type": "BOOLEAN" * } * } * ] * } * ``` * * Example mentioned above search all devices which have attribute 'active' set to 'true'. Now let's review available entity filters and key filters syntax: * * # Entity Filters * Entity Filter body depends on the 'type' parameter. Let's review available entity filter types. In fact, they do correspond to available dashboard aliases. * * ## Single Entity * * Allows to filter only one entity based on the id. For example, this entity filter selects certain device: * * ```json * { * "type": "singleEntity", * "singleEntity": { * "id": "d521edb0-2a7a-11ec-94eb-213c95f54092", * "entityType": "DEVICE" * } * } * ``` * * ## Group Entities Filter * * Allows to filter multiple entities of the same type using the entity group type and id. For example, this entity filter selects all devices that belong to the group 'e52b0020-2a7a-11ec-94eb-213c95f54092': * * ```json * { * "type": "entityGroup", * "groupType": "DEVICE", * "entityGroup": "e52b0020-2a7a-11ec-94eb-213c95f54092" * } * ``` * * ## Entity List Filter * * Allows to filter entities of the same type using their ids. For example, this entity filter selects two devices: * * ```json * { * "type": "entityList", * "entityType": "DEVICE", * "entityList": [ * "e6501f30-2a7a-11ec-94eb-213c95f54092", * "e6657bf0-2a7a-11ec-94eb-213c95f54092" * ] * } * ``` * * ## Entity Name Filter * * Allows to filter entities of the same type using the **'starts with'** expression over entity name. For example, this entity filter selects all devices which name starts with 'Air Quality': * * ```json * { * "type": "entityName", * "entityType": "DEVICE", * "entityNameFilter": "Air Quality" * } * ``` * * ## Entity Type Filter * * Allows to filter entities based on their type (CUSTOMER, USER, DASHBOARD, ASSET, DEVICE, etc)For example, this entity filter selects all tenant customers: * * ```json * { * "type": "entityType", * "entityType": "CUSTOMER" * } * ``` * * ## Group List Filter * * Return multiple groups of the same type using specified ids. For example, this entity filter selects 2 device groups (if they are present in the system) with ids 'e52b0020-2a7a-11ec-94eb-213c95f54092' and 'e52b0020-2a7a-11ec-94eb-213c95f54093': * * ```json * { * "type": "entityGroupList", * "groupType": "DEVICE", * "entityGroupList": ["e52b0020-2a7a-11ec-94eb-213c95f54092", "e52b0020-2a7a-11ec-94eb-213c95f54093"] * } * ``` * * ## Group Name Filter * * Allows to filter entity groups based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all devices which name starts with 'CAT': * * ```json * { * "type": "entityGroupName", * "groupType": "DEVICE", * "entityGroupNameFilter": "CAT" * } * ``` * * ## Entities by Group Name Filter * * Allows to filter entities that belong to group based on the entity type and the group name. Optional parameter 'ownerId' allows you to specify the owner of the group (Tenant or Customer, current user owner by default).For example, this entity filter selects all devices which belong to group 'Water Meters': * * ```json * { * "type": "entitiesByGroupName", * "groupType": "DEVICE", * "entityGroupNameFilter": "Water Meters" * } * ``` * * Other example, this entity filter selects all devices which belong to group 'Water Meters' which in turn belongs to (sub-)Customer with id 'e52b0020-2a7a-11ec-94eb-213c95f54093': * * ```json * { * "type": "entitiesByGroupName", * "ownerId": {"entityType": "CUSTOMER","id":"e52b0020-2a7a-11ec-94eb-213c95f54093"}, * "groupType": "DEVICE", * "entityGroupNameFilter": "Water Meters" * } * ``` * * ## Entity owner Filter * * Allows to fetch owner (Tenant or Customer) of the specified entity. For example, this entity filter selects owner of the device with id 'e52b0020-2a7a-11ec-94eb-213c95f54093': * * ```json * { * "type": "stateEntityOwner", * "singleEntity": { * "id": "d521edb0-2a7a-11ec-94eb-213c95f54092", * "entityType": "DEVICE" * } * } * ``` * * ## Asset Type Filter * * Allows to filter assets based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'charging station' assets which name starts with 'Tesla': * * ```json * { * "type": "assetType", * "assetType": "charging station", * "assetNameFilter": "Tesla" * } * ``` * * ## Device Type Filter * * Allows to filter devices based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Temperature Sensor' devices which name starts with 'ABC': * * ```json * { * "type": "deviceType", * "deviceType": "Temperature Sensor", * "deviceNameFilter": "ABC" * } * ``` * * ## Edge Type Filter * * Allows to filter edge instances based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Factory' edge instances which name starts with 'Nevada': * * ```json * { * "type": "edgeType", * "edgeType": "Factory", * "edgeNameFilter": "Nevada" * } * ``` * * ## Entity View Filter * * Allows to filter entity views based on their type and the **'starts with'** expression over their name. For example, this entity filter selects all 'Concrete Mixer' entity views which name starts with 'CAT': * * ```json * { * "type": "entityViewType", * "entityViewType": "Concrete Mixer", * "entityViewNameFilter": "CAT" * } * ``` * * ## Api Usage Filter * * Allows to query for Api Usage based on optional customer id. If the customer id is not set, returns current tenant API usage.For example, this entity filter selects the 'Api Usage' entity for customer with id 'e6501f30-2a7a-11ec-94eb-213c95f54092': * * ```json * { * "type": "apiUsageState", * "customerId": { * "id": "d521edb0-2a7a-11ec-94eb-213c95f54092", * "entityType": "CUSTOMER" * } * } * ``` * * ## Relations Query Filter * * Allows to filter entities that are related to the provided root entity. Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. The 'filter' object allows you to define the relation type and set of acceptable entity types to search for. The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only those who match the 'filters'. * * For example, this entity filter selects all devices and assets which are related to the asset with id 'e51de0c0-2a7a-11ec-94eb-213c95f54092': * * ```json * { * "type": "relationsQuery", * "rootEntity": { * "entityType": "ASSET", * "id": "e51de0c0-2a7a-11ec-94eb-213c95f54092" * }, * "direction": "FROM", * "maxLevel": 1, * "fetchLastLevelOnly": false, * "filters": [ * { * "relationType": "Contains", * "entityTypes": [ * "DEVICE", * "ASSET" * ] * } * ] * } * ``` * * ## Asset Search Query * * Allows to filter assets that are related to the provided root entity. Filters related assets based on the relation type and set of asset types. Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. The 'relationType' defines the type of the relation to search for. The 'assetTypes' defines the type of the asset to search for. The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only assets that match 'relationType' and 'assetTypes' conditions. * * For example, this entity filter selects 'charging station' assets which are related to the asset with id 'e51de0c0-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation: * * ```json * { * "type": "assetSearchQuery", * "rootEntity": { * "entityType": "ASSET", * "id": "e51de0c0-2a7a-11ec-94eb-213c95f54092" * }, * "direction": "FROM", * "maxLevel": 1, * "fetchLastLevelOnly": false, * "relationType": "Contains", * "assetTypes": [ * "charging station" * ] * } * ``` * * ## Device Search Query * * Allows to filter devices that are related to the provided root entity. Filters related devices based on the relation type and set of device types. Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. The 'relationType' defines the type of the relation to search for. The 'deviceTypes' defines the type of the device to search for. The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only devices that match 'relationType' and 'deviceTypes' conditions. * * For example, this entity filter selects 'Charging port' and 'Air Quality Sensor' devices which are related to the asset with id 'e52b0020-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation: * * ```json * { * "type": "deviceSearchQuery", * "rootEntity": { * "entityType": "ASSET", * "id": "e52b0020-2a7a-11ec-94eb-213c95f54092" * }, * "direction": "FROM", * "maxLevel": 2, * "fetchLastLevelOnly": true, * "relationType": "Contains", * "deviceTypes": [ * "Air Quality Sensor", * "Charging port" * ] * } * ``` * * ## Entity View Query * * Allows to filter entity views that are related to the provided root entity. Filters related entity views based on the relation type and set of entity view types. Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. The 'relationType' defines the type of the relation to search for. The 'entityViewTypes' defines the type of the entity view to search for. The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only devices that match 'relationType' and 'deviceTypes' conditions. * * For example, this entity filter selects 'Concrete mixer' entity views which are related to the asset with id 'e52b0020-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation: * * ```json * { * "type": "entityViewSearchQuery", * "rootEntity": { * "entityType": "ASSET", * "id": "e52b0020-2a7a-11ec-94eb-213c95f54092" * }, * "direction": "FROM", * "maxLevel": 1, * "fetchLastLevelOnly": false, * "relationType": "Contains", * "entityViewTypes": [ * "Concrete mixer" * ] * } * ``` * * ## Edge Search Query * * Allows to filter edge instances that are related to the provided root entity. Filters related edge instances based on the relation type and set of edge types. Possible direction values are 'TO' and 'FROM'. The 'maxLevel' defines how many relation levels should the query search 'recursively'. Assuming the 'maxLevel' is > 1, the 'fetchLastLevelOnly' defines either to return all related entities or only entities that are on the last level of relations. The 'relationType' defines the type of the relation to search for. The 'deviceTypes' defines the type of the device to search for. The relation query calculates all related entities, even if they are filtered using different relation types, and then extracts only devices that match 'relationType' and 'deviceTypes' conditions. * * For example, this entity filter selects 'Factory' edge instances which are related to the asset with id 'e52b0020-2a7a-11ec-94eb-213c95f54092' using 'Contains' relation: * * ```json * { * "type": "deviceSearchQuery", * "rootEntity": { * "entityType": "ASSET", * "id": "e52b0020-2a7a-11ec-94eb-213c95f54092" * }, * "direction": "FROM", * "maxLevel": 2, * "fetchLastLevelOnly": true, * "relationType": "Contains", * "edgeTypes": [ * "Factory" * ] * } * ``` * * # Key Filters * Key Filter allows you to define complex logical expressions over entity field, attribute or latest time series value. The filter is defined using 'key', 'valueType' and 'predicate' objects. Single Entity Query may have zero, one or multiple predicates. If multiple filters are defined, they are evaluated using logical 'AND'. The example below checks that temperature of the entity is above 20 degrees: * * ```json * { * "key": { * "type": "TIME_SERIES", * "key": "temperature" * }, * "valueType": "NUMERIC", * "predicate": { * "operation": "GREATER", * "value": { * "defaultValue": 20, * "dynamicValue": null * }, * "type": "NUMERIC" * } * } * ``` * * Now let's review 'key', 'valueType' and 'predicate' objects in detail. * * ## Filter Key * * Filter Key defines either entity field, attribute or telemetry. It is a JSON object that consists the key name and type. The following filter key types are supported: * * * 'CLIENT_ATTRIBUTE' - used for client attributes; * * 'SHARED_ATTRIBUTE' - used for shared attributes; * * 'SERVER_ATTRIBUTE' - used for server attributes; * * 'ATTRIBUTE' - used for any of the above; * * 'TIME_SERIES' - used for time series values; * * 'ENTITY_FIELD' - used for accessing entity fields like 'name', 'label', etc. The list of available fields depends on the entity type; * * 'ALARM_FIELD' - similar to entity field, but is used in alarm queries only; * * * Let's review the example: * * ```json * { * "type": "TIME_SERIES", * "key": "temperature" * } * ``` * * ## Value Type and Operations * * Provides a hint about the data type of the entity field that is defined in the filter key. The value type impacts the list of possible operations that you may use in the corresponding predicate. For example, you may use 'STARTS_WITH' or 'END_WITH', but you can't use 'GREATER_OR_EQUAL' for string values.The following filter value types and corresponding predicate operations are supported: * * * 'STRING' - used to filter any 'String' or 'JSON' values. Operations: EQUAL, NOT_EQUAL, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS; * * 'NUMERIC' - used for 'Long' and 'Double' values. Operations: EQUAL, NOT_EQUAL, GREATER, LESS, GREATER_OR_EQUAL, LESS_OR_EQUAL; * * 'BOOLEAN' - used for boolean values. Operations: EQUAL, NOT_EQUAL; * * 'DATE_TIME' - similar to numeric, transforms value to milliseconds since epoch. Operations: EQUAL, NOT_EQUAL, GREATER, LESS, GREATER_OR_EQUAL, LESS_OR_EQUAL; * * * ## Filter Predicate * * Filter Predicate defines the logical expression to evaluate. The list of available operations depends on the filter value type, see above. Platform supports 4 predicate types: 'STRING', 'NUMERIC', 'BOOLEAN' and 'COMPLEX'. The last one allows to combine multiple operations over one filter key. * * Simple predicate example to check 'value < 100': * * ```json * { * "operation": "LESS", * "value": { * "defaultValue": 100, * "dynamicValue": null * }, * "type": "NUMERIC" * } * ``` * * Complex predicate example, to check 'value < 10 or value > 20': * * ```json * { * "type": "COMPLEX", * "operation": "OR", * "predicates": [ * { * "operation": "LESS", * "value": { * "defaultValue": 10, * "dynamicValue": null * }, * "type": "NUMERIC" * }, * { * "operation": "GREATER", * "value": { * "defaultValue": 20, * "dynamicValue": null * }, * "type": "NUMERIC" * } * ] * } * ``` * * More complex predicate example, to check 'value < 10 or (value > 50 && value < 60)': * * ```json * { * "type": "COMPLEX", * "operation": "OR", * "predicates": [ * { * "operation": "LESS", * "value": { * "defaultValue": 10, * "dynamicValue": null * }, * "type": "NUMERIC" * }, * { * "type": "COMPLEX", * "operation": "AND", * "predicates": [ * { * "operation": "GREATER", * "value": { * "defaultValue": 50, * "dynamicValue": null * }, * "type": "NUMERIC" * }, * { * "operation": "LESS", * "value": { * "defaultValue": 60, * "dynamicValue": null * }, * "type": "NUMERIC" * } * ] * } * ] * } * ``` * * You may also want to replace hardcoded values (for example, temperature > 20) with the more dynamic expression (for example, temperature > 'value of the tenant attribute with key 'temperatureThreshold'). It is possible to use 'dynamicValue' to define attribute of the tenant, customer or user that is performing the API call. See example below: * * ```json * { * "operation": "GREATER", * "value": { * "defaultValue": 0, * "dynamicValue": { * "sourceType": "CURRENT_USER", * "sourceAttribute": "temperatureThreshold" * } * }, * "type": "NUMERIC" * } * ``` * * Note that you may use 'CURRENT_USER', 'CURRENT_CUSTOMER' and 'CURRENT_TENANT' as a 'sourceType'. The 'defaultValue' is used when the attribute with such a name is not defined for the chosen source. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const countEntitiesByQuery: (options: Options) => import("./client").RequestResult; /** * List all versions (listVersions) * * Lists all available versions in a branch for all entity types. * If specified branch does not exist - empty page data will be returned. The response format is the same as for `listEntityVersions` API method. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const listVersions: (options: Options) => import("./client").RequestResult; /** * Save entities version (saveEntitiesVersion) * * Creates a new version of entities (or a single entity) by request. * Supported entity types: CUSTOMER, ASSET, RULE_CHAIN, DASHBOARD, DEVICE_PROFILE, DEVICE, ENTITY_VIEW, WIDGETS_BUNDLE, CONVERTER, INTEGRATION, ROLE and USER group. * * There are two available types of request: `SINGLE_ENTITY` and `COMPLEX`. Each of them contains version name (`versionName`) and name of a branch (`branch`) to create version (commit) in. If specified branch does not exists in a remote repo, then new empty branch will be created. Request of the `SINGLE_ENTITY` type has id of an entity (`entityId`) and additional configuration (`config`) which has following options: * - `saveRelations` - whether to add inbound and outbound relations of type COMMON to created entity version; * - `saveAttributes` - to save attributes of server scope (and also shared scope for devices); * - `saveCredentials` - when saving a version of a device, to add its credentials to the version; * - `savePermissions` - when saving a user group - to save group permission list; * - `saveGroupEntities` - when saving an entity group - to save its entities as well. * * An example of a `SINGLE_ENTITY` version create request: * ```json * { * "type": "SINGLE_ENTITY", * * "versionName": "Version 1.0", * "branch": "dev", * * "entityId": { * "entityType": "DEVICE", * "id": "b79448e0-d4f4-11ec-847b-0f432358ab48" * }, * "config": { * "saveRelations": true, * "saveAttributes": true, * "saveCredentials": false * } * } * ``` * * Second request type (`COMPLEX`), additionally to `branch` and `versionName`, contains following properties: * - `entityTypes` - a structure with entity types to export and configuration for each entity type; this configuration has all the options available for `SINGLE_ENTITY` and additionally has these ones: * - `allEntities` and `entityIds` - if you want to save the version of all entities of the entity type then set `allEntities` param to true, otherwise set it to false and specify `entityIds` - in case entity type is group entity, list of specific entity groups, or if not - list of entities; * - `syncStrategy` - synchronization strategy to use for this entity type: when set to `OVERWRITE` then the list of remote entities of this type will be overwritten by newly added entities. If set to `MERGE` - existing remote entities of this entity type will not be removed, new entities will just be added on top (or existing remote entities will be updated). * - `syncStrategy` - default synchronization strategy to use when it is not specified for an entity type. * * Example for this type of request: * ```json * { * "type": "COMPLEX", * * "versionName": "Devices and profiles: release 2", * "branch": "master", * * "syncStrategy": "OVERWRITE", * "entityTypes": { * "DEVICE": { * "syncStrategy": null, * "allEntities": true, * "saveRelations": true, * "saveAttributes": true, * "saveCredentials": true * }, * "DEVICE_PROFILE": { * "syncStrategy": "MERGE", * "allEntities": false, * "entityIds": [ * "b79448e0-d4f4-11ec-847b-0f432358ab48" * ], * "saveRelations": true * } * } * } * ``` * * Response wil contain generated request UUID, that can be then used to retrieve status of operation via `getVersionCreateRequestStatus`. * * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveEntitiesVersion: (options: Options) => import("./client").RequestResult; /** * Load entities version (loadEntitiesVersion) * * Loads specific version of remote entities (or single entity) by request. Supported entity types: CUSTOMER, ASSET, RULE_CHAIN, DASHBOARD, DEVICE_PROFILE, DEVICE, ENTITY_VIEW, WIDGETS_BUNDLE, CONVERTER, INTEGRATION, ROLE and USER group. * * There are multiple types of request. Each of them requires branch name (`branch`) and version id (`versionId`). Request of type `SINGLE_ENTITY` is needed to restore a concrete version of a specific entity. It contains id of a remote entity (`externalEntityId`), internal entity id (`internalEntityId`) and additional configuration (`config`): * - `loadRelations` - to update relations list (in case `saveRelations` option was enabled during version creation); * - `loadAttributes` - to load entity attributes (if `saveAttributes` config option was enabled); * - `loadCredentials` - to update device credentials (if `saveCredentials` option was enabled during version creation); * - `loadPermissions` - when loading user group, to update group permission list; * - `loadGroupEntities` - when loading an entity group, to load its entities as well; * - `autoGenerateIntegrationKey` - if loading integration version, to autogenerate routing key. * * An example of such request: * ```json * { * "type": "SINGLE_ENTITY", * * "branch": "dev", * "versionId": "b3c28d722d328324c7c15b0b30047b0c40011cf7", * * "externalEntityId": { * "entityType": "DEVICE", * "id": "b7944123-d4f4-11ec-847b-0f432358ab48" * }, * "config": { * "loadRelations": false, * "loadAttributes": true, * "loadCredentials": true * } * } * ``` * * Another request type (`ENTITY_TYPE`) is needed to load specific version of the whole entity types. It contains a structure with entity types to load and configs for each entity type (`entityTypes`). For each specified entity type, the method will load all remote entities of this type that are present at the version. A config for each entity type contains the same options as in `SINGLE_ENTITY` request type, and additionally contains following options: * - `removeOtherEntities` - to remove local entities that are not present on the remote - basically to overwrite local entity type with the remote one; * - `findExistingEntityByName` - when you are loading some remote entities that are not yet present at this tenant, try to find existing entity by name and update it rather than create new. * * Here is an example of the request to completely restore version of the whole device entity type: * ```json * { * "type": "ENTITY_TYPE", * * "branch": "dev", * "versionId": "b3c28d722d328324c7c15b0b30047b0c40011cf7", * * "entityTypes": { * "DEVICE": { * "removeOtherEntities": true, * "findExistingEntityByName": false, * "loadRelations": true, * "loadAttributes": true, * "loadCredentials": true * } * } * } * ``` * * The response will contain generated request UUID that is to be used to check the status of operation via `getVersionLoadRequestStatus`. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const loadEntitiesVersion: (options: Options) => import("./client").RequestResult; export declare const processSystemEdqsRequest: (options: Options) => import("./client").RequestResult; /** * Get Edges By Ids (getEdgesByIds) * * Requested edges must be owned by tenant or assigned to customer which user is performing the request. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getEdges: (options: Options) => import("./client").RequestResult; /** * Find related edges (findByQuery) * * Returns all edges that are related to the specific entity. The entity id, relation type, edge types, depth of the search, and other query parameters defined using complex 'EdgeSearchQuery' object. See 'Model' tab of the Parameters for more info. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const findByQuery2: (options: Options) => import("./client").RequestResult; /** * Create Or Update Edge (saveEdge) * * Create or update the Edge. When creating edge, platform generates Edge Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created edge id will be present in the response. Specify existing Edge id to update the edge. Referencing non-existing Edge Id will cause 'Not Found' error. * * Edge name is unique in the scope of tenant. Use unique identifiers like MAC or IMEI for the edge names and non-unique 'label' field for user-friendly visualization purposes.Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Edge entity. */ export declare const saveEdge: (options: Options) => import("./client").RequestResult; /** * Set root rule chain for provided edge (setEdgeRootRuleChain) * * Change root rule chain of the edge to the new provided rule chain. * This operation will send a notification to update root rule chain on remote edge service. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const setEdgeRootRuleChain: (options: Options) => import("./client").RequestResult; /** * Unassign scheduler event from edge (unassignSchedulerEventFromEdge) * * Clears assignment of the scheduler event to the edge. Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. Second, remote edge service will receive an 'unassign' command to remove entity group (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once 'unassign' command will be delivered to edge service, it's going to remove entity group and entities inside this group locally. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const unassignSchedulerEventFromEdge: (options: Options) => import("./client").RequestResult; /** * Assign scheduler event to edge (assignSchedulerEventToEdge) * * Creates assignment of an existing scheduler event to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment scheduler event (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once scheduler event will be delivered to edge service, it is going to be available for usage on remote edge instance. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const assignSchedulerEventToEdge: (options: Options) => import("./client").RequestResult; /** * Unassign rule chain from edge (unassignRuleChainFromEdge) * * Clears assignment of the rule chain to the edge. Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. Second, remote edge service will receive an 'unassign' command to remove rule chain (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once 'unassign' command will be delivered to edge service, it's going to remove rule chain locally. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const unassignRuleChainFromEdge: (options: Options) => import("./client").RequestResult; /** * Assign rule chain to edge (assignRuleChainToEdge) * * Creates assignment of an existing rule chain to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment rule chain (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once rule chain will be delivered to edge service, it's going to start processing messages locally. * * Only rule chain with type 'EDGE' can be assigned to edge. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const assignRuleChainToEdge: (options: Options) => import("./client").RequestResult; /** * Unassign integration from edge (unassignIntegrationFromEdge) * * Clears assignment of the integration to the edge. Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. Second, remote edge service will receive an 'unassign' command to remove integration (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once 'unassign' command will be delivered to edge service, it's going to remove integration locally. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const unassignIntegrationFromEdge: (options: Options) => import("./client").RequestResult; /** * Assign integration to edge (assignIntegrationToEdge) * * Creates assignment of an existing integration edge template to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment integration (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once integration will be delivered to edge service, it's going to start locally. * * Only integration edge template can be assigned to edge. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const assignIntegrationToEdge: (options: Options) => import("./client").RequestResult; /** * Unassign entity group from edge (unassignEntityGroupFromEdge) * * Clears assignment of the entity group to the edge. Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. Second, remote edge service will receive an 'unassign' command to remove entity group (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once 'unassign' command will be delivered to edge service, it's going to remove entity group and entities inside this group locally. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const unassignEntityGroupFromEdge: (options: Options) => import("./client").RequestResult; /** * Assign entity group to edge (assignEntityGroupToEdge) * * Creates assignment of an existing entity group to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment entity group (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once entity group will be delivered to edge service, edge will request entities of this group to be send to edge. Once entities will be delivered to edge service, they are going to be available for usage on remote edge instance. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const assignEntityGroupToEdge: (options: Options) => import("./client").RequestResult; /** * Sync edge (syncEdge) * * Starts synchronization process between edge and cloud. * All entities that are assigned to particular edge are going to be send to remote edge service. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const syncEdge: (options: Options) => import("./client").RequestResult; /** * Import the bulk of edges (processEdgesBulkImport) * * There's an ability to import the bulk of edges using the only .csv file. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const processEdgesBulkImport: (options: Options) => import("./client").RequestResult; /** * Save or Update Domain (saveDomain) * * Create or update the Domain. When creating domain, platform generates Domain Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Domain Id will be present in the response. Specify existing Domain Id to update the domain. Referencing non-existing Domain Id will cause 'Not Found' error. * * Domain name is unique for entire platform setup. * * * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveDomain: (options: Options) => import("./client").RequestResult; /** * Get Devices By Ids (getDevicesByIds) * * Requested devices must be owned by tenant or assigned to customer which user is performing the request. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getDevicesByIds: (options: Options) => import("./client").RequestResult; /** * Find related devices (findByQuery) * * Returns all devices that are related to the specific entity. The entity id, relation type, device types, depth of the search, and other query parameters defined using complex 'DeviceSearchQuery' object. See 'Model' tab of the Parameters for more info. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const findByQuery3: (options: Options) => import("./client").RequestResult; /** * Create Or Update Device (saveDevice) * * Create or update the Device. When creating device, platform generates Device Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). Device credentials are also generated if not provided in the 'accessToken' request parameter. The newly created device id will be present in the response. Specify existing Device id to update the device. Referencing non-existing device Id will cause 'Not Found' error. * * Device name is unique in the scope of tenant. Use unique identifiers like MAC or IMEI for the device names and non-unique 'label' field for user-friendly visualization purposes.Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Device entity. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const saveDevice: (options: Options) => import("./client").RequestResult; /** * Create Or Update Device Profile (saveDeviceProfile) * * Create or update the Device Profile. When creating device profile, platform generates device profile id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created device profile id will be present in the response. Specify existing device profile id to update the device profile. Referencing non-existing device profile Id will cause 'Not Found' error. * * Device profile name is unique in the scope of tenant. Only one 'default' device profile may exist in scope of tenant. * * # Device profile data definition * * Device profile data object contains alarm rules configuration, device provision strategy and transport type configuration for device connectivity. Let's review some examples. First one is the default device profile data configuration and second one - the custom one. * * ```json * { * "alarms":[ * ], * "configuration":{ * "type":"DEFAULT" * }, * "provisionConfiguration":{ * "type":"DISABLED", * "provisionDeviceSecret":null * }, * "transportConfiguration":{ * "type":"DEFAULT" * } * } * ``` * * ```json * { * "alarms":[ * { * "id":"2492b935-1226-59e9-8615-17d8978a4f93", * "alarmType":"Temperature Alarm", * "clearRule":{ * "schedule":null, * "condition":{ * "spec":{ * "type":"SIMPLE" * }, * "condition":[ * { * "key":{ * "key":"temperature", * "type":"TIME_SERIES" * }, * "value":null, * "predicate":{ * "type":"NUMERIC", * "value":{ * "userValue":null, * "defaultValue":30.0, * "dynamicValue":null * }, * "operation":"LESS" * }, * "valueType":"NUMERIC" * } * ] * }, * "dashboardId":null, * "alarmDetails":null * }, * "propagate":false, * "createRules":{ * "MAJOR":{ * "schedule":{ * "type":"SPECIFIC_TIME", * "endsOn":64800000, * "startsOn":43200000, * "timezone":"Europe/Kiev", * "daysOfWeek":[ * 1, * 3, * 5 * ] * }, * "condition":{ * "spec":{ * "type":"DURATION", * "unit":"MINUTES", * "predicate":{ * "userValue":null, * "defaultValue":30, * "dynamicValue":null * } * }, * "condition":[ * { * "key":{ * "key":"temperature", * "type":"TIME_SERIES" * }, * "value":null, * "predicate":{ * "type":"COMPLEX", * "operation":"OR", * "predicates":[ * { * "type":"NUMERIC", * "value":{ * "userValue":null, * "defaultValue":50.0, * "dynamicValue":null * }, * "operation":"LESS_OR_EQUAL" * }, * { * "type":"NUMERIC", * "value":{ * "userValue":null, * "defaultValue":30.0, * "dynamicValue":null * }, * "operation":"GREATER" * } * ] * }, * "valueType":"NUMERIC" * } * ] * }, * "dashboardId":null, * "alarmDetails":null * }, * "WARNING":{ * "schedule":{ * "type":"CUSTOM", * "items":[ * { * "endsOn":0, * "enabled":false, * "startsOn":0, * "dayOfWeek":1 * }, * { * "endsOn":64800000, * "enabled":true, * "startsOn":43200000, * "dayOfWeek":2 * }, * { * "endsOn":0, * "enabled":false, * "startsOn":0, * "dayOfWeek":3 * }, * { * "endsOn":57600000, * "enabled":true, * "startsOn":36000000, * "dayOfWeek":4 * }, * { * "endsOn":0, * "enabled":false, * "startsOn":0, * "dayOfWeek":5 * }, * { * "endsOn":0, * "enabled":false, * "startsOn":0, * "dayOfWeek":6 * }, * { * "endsOn":0, * "enabled":false, * "startsOn":0, * "dayOfWeek":7 * } * ], * "timezone":"Europe/Kiev" * }, * "condition":{ * "spec":{ * "type":"REPEATING", * "predicate":{ * "userValue":null, * "defaultValue":5, * "dynamicValue":null * } * }, * "condition":[ * { * "key":{ * "key":"tempConstant", * "type":"CONSTANT" * }, * "value":30, * "predicate":{ * "type":"NUMERIC", * "value":{ * "userValue":null, * "defaultValue":0.0, * "dynamicValue":{ * "inherit":false, * "sourceType":"CURRENT_DEVICE", * "sourceAttribute":"tempThreshold" * } * }, * "operation":"EQUAL" * }, * "valueType":"NUMERIC" * } * ] * }, * "dashboardId":null, * "alarmDetails":null * }, * "CRITICAL":{ * "schedule":null, * "condition":{ * "spec":{ * "type":"SIMPLE" * }, * "condition":[ * { * "key":{ * "key":"temperature", * "type":"TIME_SERIES" * }, * "value":null, * "predicate":{ * "type":"NUMERIC", * "value":{ * "userValue":null, * "defaultValue":50.0, * "dynamicValue":null * }, * "operation":"GREATER" * }, * "valueType":"NUMERIC" * } * ] * }, * "dashboardId":null, * "alarmDetails":null * } * }, * "propagateRelationTypes":null * } * ], * "configuration":{ * "type":"DEFAULT" * }, * "provisionConfiguration":{ * "type":"ALLOW_CREATE_NEW_DEVICES", * "provisionDeviceSecret":"vaxb9hzqdbz3oqukvomg" * }, * "transportConfiguration":{ * "type":"MQTT", * "deviceTelemetryTopic":"v1/devices/me/telemetry", * "deviceAttributesTopic":"v1/devices/me/attributes", * "transportPayloadTypeConfiguration":{ * "transportPayloadType":"PROTOBUF", * "deviceTelemetryProtoSchema":"syntax =\"proto3\";\npackage telemetry;\n\nmessage SensorDataReading {\n\n optional double temperature = 1;\n optional double humidity = 2;\n InnerObject innerObject = 3;\n\n message InnerObject {\n optional string key1 = 1;\n optional bool key2 = 2;\n optional double key3 = 3;\n optional int32 key4 = 4;\n optional string key5 = 5;\n }\n}", * "deviceAttributesProtoSchema":"syntax =\"proto3\";\npackage attributes;\n\nmessage SensorConfiguration {\n optional string firmwareVersion = 1;\n optional string serialNumber = 2;\n}", * "deviceRpcRequestProtoSchema":"syntax =\"proto3\";\npackage rpc;\n\nmessage RpcRequestMsg {\n optional string method = 1;\n optional int32 requestId = 2;\n optional string params = 3;\n}", * "deviceRpcResponseProtoSchema":"syntax =\"proto3\";\npackage rpc;\n\nmessage RpcResponseMsg {\n optional string payload = 1;\n}" * } * } * } * ``` * * Let's review some specific objects examples related to the device profile configuration: * * # Alarm Schedule * * Alarm Schedule JSON object represents the time interval during which the alarm rule is active. Note, * * ```json * "schedule": null * ``` * * means alarm rule is active all the time. **'daysOfWeek'** field represents Monday as 1, Tuesday as 2 and so on. **'startsOn'** and **'endsOn'** fields represent hours in millis (e.g. 64800000 = 18:00 or 6pm). **'enabled'** flag specifies if item in a custom rule is active for specific day of the week: * * ## Specific Time Schedule * * ```json * { * "schedule":{ * "type":"SPECIFIC_TIME", * "endsOn":64800000, * "startsOn":43200000, * "timezone":"Europe/Kiev", * "daysOfWeek":[ * 1, * 3, * 5 * ] * } * } * ``` * * ## Custom Schedule * * ```json * { * "schedule":{ * "type":"CUSTOM", * "items":[ * { * "endsOn":0, * "enabled":false, * "startsOn":0, * "dayOfWeek":1 * }, * { * "endsOn":64800000, * "enabled":true, * "startsOn":43200000, * "dayOfWeek":2 * }, * { * "endsOn":0, * "enabled":false, * "startsOn":0, * "dayOfWeek":3 * }, * { * "endsOn":57600000, * "enabled":true, * "startsOn":36000000, * "dayOfWeek":4 * }, * { * "endsOn":0, * "enabled":false, * "startsOn":0, * "dayOfWeek":5 * }, * { * "endsOn":0, * "enabled":false, * "startsOn":0, * "dayOfWeek":6 * }, * { * "endsOn":0, * "enabled":false, * "startsOn":0, * "dayOfWeek":7 * } * ], * "timezone":"Europe/Kiev" * } * } * ``` * * # Alarm condition type (**'spec'**) * * Alarm condition type can be either simple, duration, or repeating. For example, 5 times in a row or during 5 minutes. * * Note, **'userValue'** field is not used and reserved for future usage, **'dynamicValue'** is used for condition appliance by using the value of the **'sourceAttribute'** or else **'defaultValue'** is used (if **'sourceAttribute'** is absent). * * **'sourceType'** of the **'sourceAttribute'** can be: * * 'CURRENT_DEVICE'; * * 'CURRENT_CUSTOMER'; * * 'CURRENT_TENANT'. * * **'sourceAttribute'** can be inherited from the owner if **'inherit'** is set to true (for CURRENT_DEVICE and CURRENT_CUSTOMER). * * ## Repeating alarm condition * * ```json * { * "spec":{ * "type":"REPEATING", * "predicate":{ * "userValue":null, * "defaultValue":5, * "dynamicValue":{ * "inherit":true, * "sourceType":"CURRENT_DEVICE", * "sourceAttribute":"tempAttr" * } * } * } * } * ``` * * ## Duration alarm condition * * ```json * { * "spec":{ * "type":"DURATION", * "unit":"MINUTES", * "predicate":{ * "userValue":null, * "defaultValue":30, * "dynamicValue":null * } * } * } * ``` * * **'unit'** can be: * * 'SECONDS'; * * 'MINUTES'; * * 'HOURS'; * * 'DAYS'. * * # Key Filters * * Key filter objects are created under the **'condition'** array. They allow you to define complex logical expressions over entity field, attribute, latest time series value or constant. The filter is defined using 'key', 'valueType', 'value' (refers to the value of the 'CONSTANT' alarm filter key type) and 'predicate' objects. Let's review each object: * * ## Alarm Filter Key * * Filter Key defines either entity field, attribute, telemetry or constant. It is a JSON object that consists the key name and type. The following filter key types are supported: * * 'ATTRIBUTE' - used for attributes values; * * 'TIME_SERIES' - used for time series values; * * 'ENTITY_FIELD' - used for accessing entity fields like 'name', 'label', etc. The list of available fields depends on the entity type; * * 'CONSTANT' - constant value specified. * * Let's review the example: * * ```json * { * "type": "TIME_SERIES", * "key": "temperature" * } * ``` * * ## Value Type and Operations * * Provides a hint about the data type of the entity field that is defined in the filter key. The value type impacts the list of possible operations that you may use in the corresponding predicate. For example, you may use 'STARTS_WITH' or 'END_WITH', but you can't use 'GREATER_OR_EQUAL' for string values.The following filter value types and corresponding predicate operations are supported: * * * 'STRING' - used to filter any 'String' or 'JSON' values. Operations: EQUAL, NOT_EQUAL, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS; * * 'NUMERIC' - used for 'Long' and 'Double' values. Operations: EQUAL, NOT_EQUAL, GREATER, LESS, GREATER_OR_EQUAL, LESS_OR_EQUAL; * * 'BOOLEAN' - used for boolean values. Operations: EQUAL, NOT_EQUAL; * * 'DATE_TIME' - similar to numeric, transforms value to milliseconds since epoch. Operations: EQUAL, NOT_EQUAL, GREATER, LESS, GREATER_OR_EQUAL, LESS_OR_EQUAL; * * * * * ## Filter Predicate * * Filter Predicate defines the logical expression to evaluate. The list of available operations depends on the filter value type, see above. Platform supports 4 predicate types: 'STRING', 'NUMERIC', 'BOOLEAN' and 'COMPLEX'. The last one allows to combine multiple operations over one filter key. * * Simple predicate example to check 'value < 100': * * ```json * { * "operation": "LESS", * "value": { * "userValue": null, * "defaultValue": 100, * "dynamicValue": null * }, * "type": "NUMERIC" * } * ``` * * Complex predicate example, to check 'value < 10 or value > 20': * * ```json * { * "type": "COMPLEX", * "operation": "OR", * "predicates": [ * { * "operation": "LESS", * "value": { * "userValue": null, * "defaultValue": 10, * "dynamicValue": null * }, * "type": "NUMERIC" * }, * { * "operation": "GREATER", * "value": { * "userValue": null, * "defaultValue": 20, * "dynamicValue": null * }, * "type": "NUMERIC" * } * ] * } * ``` * * More complex predicate example, to check 'value < 10 or (value > 50 && value < 60)': * * ```json * { * "type": "COMPLEX", * "operation": "OR", * "predicates": [ * { * "operation": "LESS", * "value": { * "userValue": null, * "defaultValue": 10, * "dynamicValue": null * }, * "type": "NUMERIC" * }, * { * "type": "COMPLEX", * "operation": "AND", * "predicates": [ * { * "operation": "GREATER", * "value": { * "userValue": null, * "defaultValue": 50, * "dynamicValue": null * }, * "type": "NUMERIC" * }, * { * "operation": "LESS", * "value": { * "userValue": null, * "defaultValue": 60, * "dynamicValue": null * }, * "type": "NUMERIC" * } * ] * } * ] * } * ``` * * You may also want to replace hardcoded values (for example, temperature > 20) with the more dynamic expression (for example, temperature > value of the tenant attribute with key 'temperatureThreshold'). It is possible to use 'dynamicValue' to define attribute of the tenant, customer or device. See example below: * * ```json * { * "operation": "GREATER", * "value": { * "userValue": null, * "defaultValue": 0, * "dynamicValue": { * "inherit": false, * "sourceType": "CURRENT_TENANT", * "sourceAttribute": "temperatureThreshold" * } * }, * "type": "NUMERIC" * } * ``` * * Note that you may use 'CURRENT_DEVICE', 'CURRENT_CUSTOMER' and 'CURRENT_TENANT' as a 'sourceType'. The 'defaultValue' is used when the attribute with such a name is not defined for the chosen source. The 'sourceAttribute' can be inherited from the owner of the specified 'sourceType' if 'inherit' is set to true. * * # Provision Configuration * * There are 3 types of device provision configuration for the device profile: * * 'DISABLED'; * * 'ALLOW_CREATE_NEW_DEVICES'; * * 'CHECK_PRE_PROVISIONED_DEVICES'. * * Please refer to the [docs](https://thingsboard.io/docs/user-guide/device-provisioning/) for more details. * * # Transport Configuration * * 5 transport configuration types are available: * * 'DEFAULT'; * * 'MQTT'; * * 'LWM2M'; * * 'COAP'; * * 'SNMP'. * * Default type supports basic MQTT, HTTP, CoAP and LwM2M transports. Please refer to the [docs](https://thingsboard.io/docs/user-guide/device-profiles/#transport-configuration) for more details about other types. * * See another example of COAP transport configuration below: * * ```json * { * "type":"COAP", * "clientSettings":{ * "edrxCycle":null, * "powerMode":"DRX", * "psmActivityTimer":null, * "pagingTransmissionWindow":null * }, * "coapDeviceTypeConfiguration":{ * "coapDeviceType":"DEFAULT", * "transportPayloadTypeConfiguration":{ * "transportPayloadType":"JSON" * } * } * } * ```Remove 'id', 'tenantId' from the request body example (below) to create new Device Profile entity. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveDeviceProfile: (options: Options) => import("./client").RequestResult; /** * Make Device Profile Default (setDefaultDeviceProfile) * * Marks device profile as default within a tenant scope. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const setDefaultDeviceProfile: (options: Options) => import("./client").RequestResult; export declare const saveDeviceGroupOtaPackage: (options: Options) => import("./client").RequestResult; /** * Update device credentials (updateDeviceCredentials) * * During device creation, platform generates random 'ACCESS_TOKEN' credentials. * Use this method to update the device credentials. First use 'getDeviceCredentialsByDeviceId' to get the credentials id and value. * Then use current method to update the credentials type and value. It is not possible to create multiple device credentials for the same device. * The structure of device credentials id and value is simple for the 'ACCESS_TOKEN' but is much more complex for the 'MQTT_BASIC' or 'LWM2M_CREDENTIALS'. * You may find the example of device with different type of credentials below: * * - Credentials type: "Access token" with device ID and with device ID below: * * ```json * { * "id": { * "id":"c886a090-168d-11ee-87c9-6f157dbc816a" * }, * "deviceId": { * "id":"c5fb3ac0-168d-11ee-87c9-6f157dbc816a", * "entityType":"DEVICE" * }, * "credentialsType": "ACCESS_TOKEN", * "credentialsId": "6hmxew8pmmzng4e3une4" * } * ``` * * - Credentials type: "X509" with device profile ID below: * * Note: credentialsId - format Sha3Hash, certificateValue - format PEM (with "--BEGIN CERTIFICATE----" and -"----END CERTIFICATE-"). * * ```json * { * "id": { * "id":"309bd9c0-14f4-11ee-9fc9-d9b7463abb63" * }, * "deviceId": { * "id":"3092b200-14f4-11ee-9fc9-d9b7463abb63", * "entityType":"DEVICE" * }, * "credentialsType": "X509_CERTIFICATE", * "credentialsId": "6b8adb49015500e51a527acd332b51684ab9b49b4ade03a9582a44c455e2e9b6", * "credentialsValue": "-----BEGIN CERTIFICATE----- MIICMTCCAdegAwIBAgIUUEKxS9hTz4l+oLUMF0LV6TC/gCIwCgYIKoZIzj0EAwIwbjELMAkGA1UEBhMCVVMxETAPBgNVBAgMCE5ldyBZb3JrMRowGAYDVQQKDBFUaGluZ3NCb2FyZCwgSW5jLjEwMC4GA1UEAwwnZGV2aWNlUHJvZmlsZUNlcnRAWDUwOVByb3Zpc2lvblN0cmF0ZWd5MB4XDTIzMDMyOTE0NTczNloXDTI0MDMyODE0NTczNlowbjELMAkGA1UEBhMCVVMxETAPBgNVBAgMCE5ldyBZb3JrMRowGAYDVQQKDBFUaGluZ3NCb2FyZCwgSW5jLjEwMC4GA1UEAwwnZGV2aWNlUHJvZmlsZUNlcnRAWDUwOVByb3Zpc2lvblN0cmF0ZWd5MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAECMlWO72krDoUL9FQjUmSCetkhaEGJUfQkdSfkLSNa0GyAEIMbfmzI4zITeapunu4rGet3EMyLydQzuQanBicp6NTMFEwHQYDVR0OBBYEFHpZ78tPnztNii4Da/yCw6mhEIL3MB8GA1UdIwQYMBaAFHpZ78tPnztNii4Da/yCw6mhEIL3MA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwIDSAAwRQIgJ7qyMFqNcwSYkH6o+UlQXzLWfwZbNjVk+aR7foAZNGsCIQDsd7v3WQIGHiArfZeDs1DLEDuV/2h6L+ZNoGNhEKL+1A== -----END CERTIFICATE-----" * } * ``` * * - Credentials type: "MQTT_BASIC" with device profile ID below: * * ```json * { * "id": { * "id":"d877ffb0-14f5-11ee-9fc9-d9b7463abb63" * }, * "deviceId": { * "id":"d875dcd0-14f5-11ee-9fc9-d9b7463abb63", * "entityType":"DEVICE" * }, * "credentialsType": "MQTT_BASIC", * "credentialsValue": "{\"clientId\":\"juy03yv4owqxcmqhqtvk\",\"userName\":\"ov19fxca0cyjn7lm7w7u\",\"password\":\"twy94he114dfi9usyk1o\"}" * } * ``` * * - You may find the example of LwM2M device and RPK credentials below: * * Note: LwM2M device - only existing device profile ID (Transport configuration -> Transport type: "LWM2M". * * ```json * { * "id": { * "id":"e238d4d0-1689-11ee-98c6-1713c1be5a8e" * }, * "deviceId": { * "id":"e232e160-1689-11ee-98c6-1713c1be5a8e", * "entityType":"DEVICE" * }, * "credentialsType": "LWM2M_CREDENTIALS", * "credentialsId": "LwRpk00000000", * "credentialsValue": * "{\"client\":{ \"endpoint\":\"LwRpk00000000\", \"securityConfigClientMode\":\"RPK\", \"key\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdvBZZ2vQRK9wgDhctj6B1c7bxR3Z0wYg1+YdoYFnVUKWb+rIfTTyYK9tmQJx5Vlb5fxdLnVv1RJOPiwsLIQbAA==\" }, \"bootstrap\":{ \"bootstrapServer\":{ \"securityMode\":\"RPK\", \"clientPublicKeyOrId\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\", \"clientSecretKey\":\"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\"}, \"lwm2mServer\":{ \"securityMode\":\"RPK\", \"clientPublicKeyOrId\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\", \"clientSecretKey\":\"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\"}} }" * } * ``` * * Update to real value: * - 'id' (this is id of Device Credentials -> "Get Device Credentials (getDeviceCredentialsByDeviceId)", * - 'deviceId.id' (this is id of Device). * Remove 'tenantId' and optionally 'customerId' from the request body example (below) to create new Device entity. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const updateDeviceCredentials: (options: Options) => import("./client").RequestResult; /** * Import the bulk of devices (processDevicesBulkImport) * * There's an ability to import the bulk of devices using the only .csv file. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const processDevicesBulkImport: (options: Options) => import("./client").RequestResult; /** * Create Device (saveDevice) with credentials * * Create or update the Device. When creating device, platform generates Device Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). Requires to provide the Device Credentials object as well as an existing device profile ID or use "default". * You may find the example of device with different type of credentials below: * * - Credentials type: "Access token" with device profile ID below: * * ```json * { * "device": { * "name":"Name_DeviceWithCredantial_AccessToken", * "label":"Label_DeviceWithCredantial_AccessToken", * "deviceProfileId":{ * "id":"5636aba0-1022-11ee-9631-51fb57f69174", * "entityType":"DEVICE_PROFILE" * } * }, * "credentials": { * "credentialsType": "ACCESS_TOKEN", * "credentialsId": "6hmxew8pmmzng4e3une2" * } * } * ``` * * - Credentials type: "Access token" with device profile default below: * * ```json * { * "device": { * "name":"Name_DeviceWithCredantial_AccessToken_Default", * "label":"Label_DeviceWithCredantial_AccessToken_Default", * "type": "default" * }, * "credentials": { * "credentialsType": "ACCESS_TOKEN", * "credentialsId": "6hmxew8pmmzng4e3une3" * } * } * ``` * * - Credentials type: "X509" with device profile ID below: * * Note: credentialsId - format Sha3Hash, certificateValue - format PEM (with "--BEGIN CERTIFICATE----" and -"----END CERTIFICATE-"). * * ```json * { * "device": { * "name":"Name_DeviceWithCredantial_X509_Certificate", * "label":"Label_DeviceWithCredantial_X509_Certificate", * "deviceProfileId":{ * "id":"9d9588c0-06c9-11ee-b618-19be30fdeb60", * "entityType":"DEVICE_PROFILE" * } * }, * "credentials": { * "credentialsType": "X509_CERTIFICATE", * "credentialsId": "84f5911765abba1f96bf4165604e9e90338fc6214081a8e623b6ff9669aedb27", * "credentialsValue": "-----BEGIN CERTIFICATE----- MIICMTCCAdegAwIBAgIUI9dBuwN6pTtK6uZ03rkiCwV4wEYwCgYIKoZIzj0EAwIwbjELMAkGA1UEBhMCVVMxETAPBgNVBAgMCE5ldyBZb3JrMRowGAYDVQQKDBFUaGluZ3NCb2FyZCwgSW5jLjEwMC4GA1UEAwwnZGV2aWNlQ2VydGlmaWNhdGVAWDUwOVByb3Zpc2lvblN0cmF0ZWd5MB4XDTIzMDMyOTE0NTYxN1oXDTI0MDMyODE0NTYxN1owbjELMAkGA1UEBhMCVVMxETAPBgNVBAgMCE5ldyBZb3JrMRowGAYDVQQKDBFUaGluZ3NCb2FyZCwgSW5jLjEwMC4GA1UEAwwnZGV2aWNlQ2VydGlmaWNhdGVAWDUwOVByb3Zpc2lvblN0cmF0ZWd5MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE9Zo791qKQiGNBm11r4ZGxh+w+ossZL3xc46ufq5QckQHP7zkD2XDAcmP5GvdkM1sBFN9AWaCkQfNnWmfERsOOKNTMFEwHQYDVR0OBBYEFFFc5uyCyglQoZiKhzXzMcQ3BKORMB8GA1UdIwQYMBaAFFFc5uyCyglQoZiKhzXzMcQ3BKORMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwIDSAAwRQIhANbA9CuhoOifZMMmqkpuld+65CR+ItKdXeRAhLMZuccuAiB0FSQB34zMutXrZj1g8Gl5OkE7YryFHbei1z0SveHR8g== -----END CERTIFICATE-----" * } * } * ``` * * - Credentials type: "MQTT_BASIC" with device profile ID below: * * ```json * { * "device": { * "name":"Name_DeviceWithCredantial_MQTT_Basic", * "label":"Label_DeviceWithCredantial_MQTT_Basic", * "deviceProfileId":{ * "id":"9d9588c0-06c9-11ee-b618-19be30fdeb60", * "entityType":"DEVICE_PROFILE" * } * }, * "credentials": { * "credentialsType": "MQTT_BASIC", * "credentialsValue": "{\"clientId\":\"5euh5nzm34bjjh1efmlt\",\"userName\":\"onasd1lgwasmjl7v2v7h\",\"password\":\"b9xtm4ny8kt9zewaga5o\"}" * } * } * ``` * * - You may find the example of LwM2M device and RPK credentials below: * * Note: LwM2M device - only existing device profile ID (Transport configuration -> Transport type: "LWM2M". * * ```json * { * "device": { * "name":"Name_LwRpk00000000", * "label":"Label_LwRpk00000000", * "deviceProfileId":{ * "id":"a660bd50-10ef-11ee-8737-b5634e73c779", * "entityType":"DEVICE_PROFILE" * } * }, * "credentials": { * "credentialsType": "LWM2M_CREDENTIALS", * "credentialsId": "LwRpk00000000", * "credentialsValue": * "{\"client\":{ \"endpoint\":\"LwRpk00000000\", \"securityConfigClientMode\":\"RPK\", \"key\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\" }, \"bootstrap\":{ \"bootstrapServer\":{ \"securityMode\":\"RPK\", \"clientPublicKeyOrId\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\", \"clientSecretKey\":\"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\"}, \"lwm2mServer\":{ \"securityMode\":\"RPK\", \"clientPublicKeyOrId\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEUEBxNl/RcYJNm8mk91CyVXoIJiROYDlXcSSqK6e5bDHwOW4ZiN2lNnXalyF0Jxw8MbAytnDMERXyAja5VEMeVQ==\", \"clientSecretKey\":\"MIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgd9GAx7yZW37autew5KZykn4IgRpge/tZSjnudnZJnMahRANCAARQQHE2X9Fxgk2byaT3ULJVeggmJE5gOVdxJKorp7lsMfA5bhmI3aU2ddqXIXQnHDwxsDK2cMwRFfICNrlUQx5V\"}} }" * } * } * ``` * * Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Device entity. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const saveDeviceWithCredentials1: (options: Options) => import("./client").RequestResult; /** * Create Or Update Dashboard (saveDashboard) * * Create or update the Dashboard. When creating dashboard, platform generates Dashboard Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Dashboard id will be present in the response. Specify existing Dashboard id to update the dashboard. Referencing non-existing dashboard Id will cause 'Not Found' error. Only users with 'TENANT_ADMIN') authority may create the dashboards.Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Dashboard entity. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveDashboard: (options: Options) => import("./client").RequestResult; /** * Create or update Customer (saveCustomer) * * Creates or Updates the Customer. When creating customer, platform generates Customer Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Customer Id will be present in the response. Specify existing Customer Id to update the Customer. Referencing non-existing Customer Id will cause 'Not Found' error.Remove 'id', 'tenantId' from the request body example (below) to create new Customer entity. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const saveCustomer: (options: Options) => import("./client").RequestResult; /** * Reclaim device (reClaimDevice) * * Reclaiming means the device will be unassigned from the customer and the device will be available for claiming again. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'CLAIM_DEVICES' permission for the entity (entities). */ export declare const reClaimDevice: (options: Options) => import("./client").RequestResult; /** * Claim device (claimDevice) * * Claiming makes it possible to assign a device to the specific customer using device/server side claiming data (in the form of secret key).To make this happen you have to provide unique device name and optional claiming data (it is needed only for device-side claiming).Once device is claimed, the customer becomes its owner and customer users may access device data as well as control the device. * In order to enable claiming devices feature a system parameter security.claim.allowClaimingByDefault should be set to true, otherwise a server-side claimingAllowed attribute with the value true is obligatory for provisioned devices. * See official documentation for more details regarding claiming. * * Available for users with 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'CLAIM_DEVICES' permission for the entity (entities). */ export declare const claimDevice1: (options: Options) => import("./client").RequestResult; /** * Get Customer Home Dashboard Info (getCustomerHomeDashboardInfo) * * Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the corresponding customer. * * Available for users with 'CUSTOMER_USER' authority. * * Security check is performed to verify that the user has 'READ' permission for the white labeling resource. */ export declare const getCustomerHomeDashboardInfo: (options?: Options) => import("./client").RequestResult; /** * Update Customer Home Dashboard Info (setCustomerHomeDashboardInfo) * * Update the home dashboard assignment for the current customer. * * Available for users with 'CUSTOMER_USER' authority. * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const setCustomerHomeDashboardInfo: (options: Options) => import("./client").RequestResult; /** * Get end-user Custom Menu configuration (getCustomMenu) * * Fetch the Custom Menu configuration object for the authorized user. The custom menu is configured in the white labeling parameters and has one of three user scopes:SYSTEM, TENANT, CUSTOMER and four assignee type: NO_ASSIGN, ALL, CUSTOMERS, USERS.There are three default (assignee type: ALL) menus configured on the system level for each scope and if no other menu is configured for user, system configuration of the corresponding scope will be applied.If a custom menu with assignee type ALL is configured on the tenant level, it overrides the menu configuration of the corresponding scope on the system level. If a custom menu with assignee type USER_GROUPS is configured on the tenant level, it overrides default tenant menu.If a custom menu with assignee type CUSTOMERS is configured on tenant level for specific customer, it will be applied to all customer users.If a custom menu with assignee type ALL is configured on the customer level, it overrides the menu assigned on tenant level.If a custom menu with assignee type USER_GROUPS is configured on the customer level, it overrides default customer menu.If a custom menu is assigned to specific user, it overrides all other configuration. */ export declare const getCustomMenu: (options?: Options) => import("./client").RequestResult; /** * Create Custom Menu (createCustomMenu) * * The api is designed to create Custom Menu without configuration. Is not applicable for update. * * Security check is performed to verify that the user has 'WRITE' permission for the custom menu with specified id. */ export declare const createCustomMenu: (options: Options) => import("./client").RequestResult; /** * Create Or Update Converter (saveConverter) * * Create or update the Converter. When creating converter, platform generates Converter Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created converter id will be present in the response. Specify existing Converter id to update the converter. Referencing non-existing converter Id will cause 'Not Found' error. Converter name is unique in the scope of tenant. * * # Converter Configuration * * Converter configuration (**'configuration'** field) is the JSON object that should contain one of two possible fields: **'decoder'** or **'encoder'**. The former is used when the converter has UPLINK type, the latter is used - when DOWNLINK type. It can contain both 'decoder' and 'encoder' fields, when the correct one is specified for the appropriate converter type, another one can be set to 'null'. See the examples of each one below. * * ## Uplink Converter Configuration * * ***Default converter may be different, depending on integration type***. * * ```json * { * "decoder":"// Decode an uplink message from a buffer\n// payload - array of bytes\n// metadata - key/value object\n\n** Decoder **\n\n// decode payload to string\nvar payloadStr = decodeToString(payload);\n\n// decode payload to JSON\n// var data = decodeToJson(payload);\n\nvar deviceName = 'Device A';\nvar deviceType = 'thermostat';\nvar customerName = 'customer';\nvar groupName = 'thermostat devices';\nvar manufacturer = 'Example corporation';\n// use assetName and assetType instead of deviceName and deviceType\n// to automatically create assets instead of devices.\n// var assetName = 'Asset A';\n// var assetType = 'building';\n\n// Result object with device/asset attributes/telemetry data\nvar result = {\n// Use deviceName and deviceType or assetName and assetType, but not both.\n deviceName: deviceName,\n deviceType: deviceType,\n// assetName: assetName,\n// assetType: assetType,\n customerName: customerName,\n groupName: groupName,\n contentAwareAttributeKeys: ['manufacturer'],\n attributes: {\n model: 'Model A',\n serialNumber: 'SN111',\n integrationName: metadata['integrationName'],\n manufacturer: manufacturer\n },\n telemetry: {\n temperature: 42,\n humidity: 80,\n rawData: payloadStr\n }\n};\n\n** Helper functions **\n\nfunction decodeToString(payload) {\n return String.fromCharCode.apply(String, payload);\n}\n\nfunction decodeToJson(payload) {\n // covert payload to string.\n var str = decodeToString(payload);\n\n // parse string to JSON\n var data = JSON.parse(str);\n return data;\n}\n\nreturn result;", * "encoder":null * } * ``` * * Decoder field in the more readable form: * * ```text * // Decode an uplink message from a buffer * // payload - array of bytes * // metadata - key/value object * * ** Decoder ** * * // decode payload to string * var payloadStr = decodeToString(payload); * * // decode payload to JSON * // var data = decodeToJson(payload); * * var deviceName = 'Device A'; * var deviceType = 'thermostat'; * var customerName = 'customer'; * var groupName = 'thermostat devices'; * var manufacturer = 'Example corporation'; * // use assetName and assetType instead of deviceName and deviceType * // to automatically create assets instead of devices. * // var assetName = 'Asset A'; * // var assetType = 'building'; * * // Result object with device/asset attributes/telemetry data * var result = { * // Use deviceName and deviceType or assetName and assetType, but not both. * deviceName: deviceName, * deviceType: deviceType, * // assetName: assetName, * // assetType: assetType, * customerName: customerName, * groupName: groupName, * attributes: { * model: 'Model A', * serialNumber: 'SN111', * integrationName: metadata['integrationName'] * manufacturer: manufacturer, * }, * telemetry: { * temperature: 42, * humidity: 80, * rawData: payloadStr * } * }; * * ** Helper functions ** * * function decodeToString(payload) { * return String.fromCharCode.apply(String, payload); * } * * function decodeToJson(payload) { * // covert payload to string. * var str = decodeToString(payload); * * // parse string to JSON * var data = JSON.parse(str); * return data; * } * * return result; * ``` * * ## Downlink Converter Configuration * * ```json * { * "decoder":null, * "encoder":"// Encode downlink data from incoming Rule Engine message\n\n// msg - JSON message payload downlink message json\n// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.\n// metadata - list of key-value pairs with additional data about the message\n// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter\n\n** Encoder **\n\nvar data = {};\n\n// Process data from incoming message and metadata\n\ndata.tempFreq = msg.temperatureUploadFrequency;\ndata.humFreq = msg.humidityUploadFrequency;\n\ndata.devSerialNumber = metadata['ss_serialNumber'];\n\n// Result object with encoded downlink payload\nvar result = {\n\n // downlink data content type: JSON, TEXT or BINARY (base64 format)\n contentType: \"JSON\",\n\n // downlink data\n data: JSON.stringify(data),\n\n // Optional metadata object presented in key/value format\n metadata: {\n topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'\n }\n\n};\n\nreturn result;" * } * ``` * * Encoder field in the more readable form: * * ```text * // Encode downlink data from incoming Rule Engine message * * // msg - JSON message payload downlink message json * // msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc. * // metadata - list of key-value pairs with additional data about the message * // integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter * * ** Encoder ** * * var data = {}; * * // Process data from incoming message and metadata * * data.tempFreq = msg.temperatureUploadFrequency; * data.humFreq = msg.humidityUploadFrequency; * * data.devSerialNumber = metadata['ss_serialNumber']; * * // Result object with encoded downlink payload * var result = { * * // downlink data content type: JSON, TEXT or BINARY (base64 format) * contentType: "JSON", * * // downlink data * data: JSON.stringify(data), * * // Optional metadata object presented in key/value format * metadata: { * topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload' * } * * }; * * return result; * ``` * * Remove 'id', 'tenantId' from the request body example (below) to create new converter entity. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveConverter: (options: Options) => import("./client").RequestResult; /** * Transform input raw payload to the dedicated converter data (unwrapRawPayload) * * Returns a JSON object representing the result of the unwrapped incoming raw message. * * ## Request Body Example * * ```json * { * "metadata":{ * }, * "payload":"ewogICAgImRhdGEiOiAiZGF0YSIKfQ==", * } * ``` * 'metadata' - integration metadata; * * 'payload' - JSON object representing the input raw message. * * ## Response Body Example * * * 'metadata' - integration metadata enriched with the data from the input message; * * 'payload' - base64 string representation of the payload from the unwrapped input message; * * 'contentType' - string representation payload contentType. */ export declare const unwrapRawPayload: (options: Options) => import("./client").RequestResult; /** * Test converter function (testUpLinkConverter) * * Returns a JSON object representing the result of the processed incoming message. * * ## Request Body Example * * ```json * { * "metadata":{ * }, * "payload":"ewogICAgImRhdGEiOiAiZGF0YSIKfQ==", * "decoder":"// Decode an uplink message from a buffer\n// payload - array of bytes\n// metadata - key/value object\n\n** Decoder **\n\n// decode payload to string\nvar payloadStr = decodeToString(payload);\n\n// decode payload to JSON\n// var data = decodeToJson(payload);\n\nvar deviceName = 'Device A';\nvar deviceType = 'thermostat';\nvar customerName = 'customer';\nvar groupName = 'thermostat devices';\nvar manufacturer = 'Example corporation';\n// use assetName and assetType instead of deviceName and deviceType\n// to automatically create assets instead of devices.\n// var assetName = 'Asset A';\n// var assetType = 'building';\n\n// Result object with device/asset attributes/telemetry data\nvar result = {\n// Use deviceName and deviceType or assetName and assetType, but not both.\n deviceName: deviceName,\n deviceType: deviceType,\n// assetName: assetName,\n// assetType: assetType,\n customerName: customerName,\n groupName: groupName,\n attributes: {\n model: 'Model A',\n serialNumber: 'SN111',\n integrationName: metadata['integrationName']\n manufacturer: manufacturer\n },\n telemetry: {\n temperature: 42,\n humidity: 80,\n rawData: payloadStr\n }\n};\n\n** Helper functions **\n\nfunction decodeToString(payload) {\n return String.fromCharCode.apply(String, payload);\n}\n\nfunction decodeToJson(payload) {\n // covert payload to string.\n var str = decodeToString(payload);\n\n // parse string to JSON\n var data = JSON.parse(str);\n return data;\n}\n\nreturn result;" * } * ``` * * * 'metadata' - integration metadata; * * 'payload' - base64 string representation of the data; * * 'decoder' - string representation of the decoder configuration; * * 'converter' - JSON object representing converter. * * ## Response Body Example * * ```json * { * "output":"{\"deviceName\":\"Device A\",\"deviceType\":\"thermostat\",\"customerName\":\"customer\",\"groupName\":\"thermostat devices\",\"attributes\":{\"model\":\"Model A\",\"serialNumber\":\"SN111\"},\"telemetry\":{\"temperature\":42,\"humidity\":80,\"rawData\":\"{\\n \\\"data\\\": \\\"data\\\"\\n}\"}}", * "error":"" * } * ``` * * * 'output' - string representation of the output message; * * 'error' - string representation of the error message. * */ export declare const testUpLinkConverter: (options: Options) => import("./client").RequestResult; /** * Test converter function (testDownLinkConverter) * * Returns a JSON object representing the result of the processed incoming message. * * ## Request Body Example * * ```json * { * "metadata":{ * "data":"40" * }, * "msg":"{\n \"temp\": 42,\n \"humidity\": 77\n}", * "msgType":"POST_TELEMETRY_REQUEST", * "integrationMetadata":{ * "integrationName":"Integration" * }, * "encoder":"// Encode downlink data from incoming Rule Engine message\n\n// msg - JSON message payload downlink message json\n// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.\n// metadata - list of key-value pairs with additional data about the message\n// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter\n\n** Encoder **\n\nvar data = {};\n\n// Process data from incoming message and metadata\n\ndata.tempValue = msg.temp;\ndata.humValue = msg.humidity;\n\ndata.devSerialNumber = metadata['ss_serialNumber'];\n\n// Result object with encoded downlink payload\nvar result = {\n\n // downlink data content type: JSON, TEXT or BINARY (base64 format)\n contentType: \"JSON\",\n\n // downlink data\n data: JSON.stringify(data),\n\n // Optional metadata object presented in key/value format\n metadata: {\n topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'\n }\n\n};\n\nreturn result;" * } * ``` * * * 'metadata' - message metadata pushed from the rule engine; * * 'msg' - message data pushed from the rule engine; * * 'msgType' - type of the message pushed from the rule engine; * * 'integrationMetadata' - integration metadata object; * * 'encoder' - string representation of the encoder configuration. * * ## Response Body Example * * ```json * { * "contentType":"JSON", * "data":"{\"tempValue\":42,\"humValue\":77}", * "metadata":{ * "topic":"sensor/Temp Sensor/upload" * } * } * ``` * * * 'contentType' - downlink data content type; * * 'data' - downlink data; * * 'metadata' - optional metadata object. * */ export declare const testDownLinkConverter: (options: Options) => import("./client").RequestResult; /** * Create Or Update Calculated Field (saveCalculatedField) * * Creates or Updates the Calculated Field. When creating calculated field, platform generates Calculated Field Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Calculated Field Id will be present in the response. Specify existing Calculated Field Id to update the calculated field. Referencing non-existing Calculated Field Id will cause 'Not Found' error. Remove 'id', 'tenantId' from the request body example (below) to create new Calculated Field entity. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveCalculatedField: (options: Options) => import("./client").RequestResult; /** * Test Script expression * * Execute the Script expression and return the result. The format of request: * * ```json * { * "expression": "var temp = 0; foreach(element: temperature.values) {temp += element.value;} var avgTemperature = temp / temperature.values.size(); var adjustedTemperature = avgTemperature + 0.1 * humidity.value; return {\"adjustedTemperature\": adjustedTemperature};", * "arguments": { * "temperature": { * "type": "TS_ROLLING", * "timeWindow": { * "startTs": 1739775630002, * "endTs": 65432211, * "limit": 5 * }, * "values": [ * { "ts": 1739775639851, "value": 23 }, * { "ts": 1739775664561, "value": 43 }, * { "ts": 1739775713079, "value": 15 }, * { "ts": 1739775999522, "value": 34 }, * { "ts": 1739776228452, "value": 22 } * ] * }, * "humidity": { "type": "SINGLE_VALUE", "ts": 1739776478057, "value": 23 } * } * } * ``` * * Expected result JSON contains "output" and "error". * * Available for users with 'TENANT_ADMIN' authority. */ export declare const testScript1: (options: Options) => import("./client").RequestResult; /** * Logout (logout) * * Special API call to record the 'logout' of the user to the Audit Logs. Since platform uses [JWT](https://jwt.io/), the actual logout is the procedure of clearing the [JWT](https://jwt.io/) token on the client side. */ export declare const logout: (options?: Options) => import("./client").RequestResult; /** * Change password for current User (changePassword) * * Change the password for the User which credentials are used to perform this REST API call. Be aware that previously generated [JWT](https://jwt.io/) tokens will be still valid until they expire. */ export declare const changePassword: (options: Options) => import("./client").RequestResult; /** * Request 2FA verification code (requestTwoFaVerificationCode) * * Request 2FA verification code. * * To make a request to this endpoint, you need an access token with the scope of PRE_VERIFICATION_TOKEN, which is issued on username/password auth if 2FA is enabled. * * The API method is rate limited (using rate limit config from TwoFactorAuthSettings). Will return a Bad Request error if provider is not configured for usage, and Too Many Requests error if rate limits are exceeded. */ export declare const requestTwoFaVerificationCode: (options: Options) => import("./client").RequestResult; /** * Check 2FA verification code (checkTwoFaVerificationCode) * * Checks 2FA verification code, and if it is correct the method returns a regular access and refresh token pair. * * The API method is rate limited (using rate limit config from TwoFactorAuthSettings), and also will block a user after X unsuccessful verification attempts if such behavior is configured (in TwoFactorAuthSettings). * * Will return a Bad Request error if provider is not configured for usage, and Too Many Requests error if rate limits are exceeded. */ export declare const checkTwoFaVerificationCode: (options: Options) => import("./client").RequestResult; /** * Get regular token pair after successfully configuring 2FA * * Checks 2FA is configured, returning token pair on success. */ export declare const authenticateByTwoFaConfigurationToken: (options?: Options) => import("./client").RequestResult; /** * Get Assets By Ids (getAssetsByIds) * * Requested assets must be owned by tenant or assigned to customer which user is performing the request. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAssetsByIds: (options: Options) => import("./client").RequestResult; /** * Find related assets (findByQuery) * * Returns all assets that are related to the specific entity. The entity id, relation type, asset types, depth of the search, and other query parameters defined using complex 'AssetSearchQuery' object. See 'Model' tab of the Parameters for more info. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const findByQuery4: (options: Options) => import("./client").RequestResult; /** * Create Or Update Asset (saveAsset) * * Creates or Updates the Asset. When creating asset, platform generates Asset Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Asset id will be present in the response. Specify existing Asset id to update the asset. Referencing non-existing Asset Id will cause 'Not Found' error. Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Asset entity. * * Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const saveAsset: (options: Options) => import("./client").RequestResult; /** * Create Or Update Asset Profile (saveAssetProfile) * * Create or update the Asset Profile. When creating asset profile, platform generates asset profile id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created asset profile id will be present in the response. Specify existing asset profile id to update the asset profile. Referencing non-existing asset profile Id will cause 'Not Found' error. * * Asset profile name is unique in the scope of tenant. Only one 'default' asset profile may exist in scope of tenant. Remove 'id', 'tenantId' from the request body example (below) to create new Asset Profile entity. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveAssetProfile: (options: Options) => import("./client").RequestResult; /** * Make Asset Profile Default (setDefaultAssetProfile) * * Marks asset profile as default within a tenant scope. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const setDefaultAssetProfile: (options: Options) => import("./client").RequestResult; /** * Import the bulk of assets (processAssetsBulkImport) * * There's an ability to import the bulk of assets using the only .csv file. * * Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const processAssetBulkImport: (options: Options) => import("./client").RequestResult; /** * Save API key for user (saveApiKey) * * Creates an API key for the given user and returns the token ONCE as 'ApiKey '. * * Available for any authorized user. */ export declare const saveApiKey: (options: Options) => import("./client").RequestResult; /** * Find Alarms by Query * * This method description defines how Alarm Data Query extends the Entity Data Query. See method 'Find Entity Data by Query' first to get the info about 'Entity Data Query'. * * The platform will first search the entities that match the entity and key filters. Then, the platform will use 'Alarm Page Link' to filter the alarms related to those entities. Finally, platform fetch the properties of alarm that are defined in the **'alarmFields'** and combine them with the other entity, attribute and latest time series fields to return the result. * * See example of the alarm query below. The query will search first 100 active alarms with type 'Temperature Alarm' or 'Fire Alarm' for any device with current temperature > 0. The query will return combination of the entity fields: name of the device, device model and latest temperature reading and alarms fields: createdTime, type, severity and status: * * ```json * { * "entityFilter": { * "type": "entityType", * "resolveMultiple": true, * "entityType": "DEVICE" * }, * "pageLink": { * "page": 0, * "pageSize": 100, * "textSearch": null, * "searchPropagatedAlarms": false, * "statusList": [ * "ACTIVE" * ], * "severityList": [ * "CRITICAL", * "MAJOR" * ], * "typeList": [ * "Temperature Alarm", * "Fire Alarm" * ], * "sortOrder": { * "key": { * "key": "createdTime", * "type": "ALARM_FIELD" * }, * "direction": "DESC" * }, * "timeWindow": 86400000 * }, * "keyFilters": [ * { * "key": { * "type": "TIME_SERIES", * "key": "temperature" * }, * "valueType": "NUMERIC", * "predicate": { * "operation": "GREATER", * "value": { * "defaultValue": 0, * "dynamicValue": null * }, * "type": "NUMERIC" * } * } * ], * "alarmFields": [ * { * "type": "ALARM_FIELD", * "key": "createdTime" * }, * { * "type": "ALARM_FIELD", * "key": "type" * }, * { * "type": "ALARM_FIELD", * "key": "severity" * }, * { * "type": "ALARM_FIELD", * "key": "status" * } * ], * "entityFields": [ * { * "type": "ENTITY_FIELD", * "key": "name" * } * ], * "latestValues": [ * { * "type": "ATTRIBUTE", * "key": "model" * }, * { * "type": "TIME_SERIES", * "key": "temperature" * } * ] * } * ``` */ export declare const findAlarmDataByQuery: (options: Options) => import("./client").RequestResult; /** * Count Alarms by Query (countAlarmsByQuery) * * Returns the number of alarms that match the query definition. */ export declare const countAlarmsByQuery: (options: Options) => import("./client").RequestResult; /** * Create or Update Alarm (saveAlarm) * * Creates or Updates the Alarm. When creating alarm, platform generates Alarm Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Alarm id will be present in the response. Specify existing Alarm id to update the alarm. Referencing non-existing Alarm Id will cause 'Not Found' error. * * Platform also deduplicate the alarms based on the entity id of originator and alarm 'type'. For example, if the user or system component create the alarm with the type 'HighTemperature' for device 'Device A' the new active alarm is created. If the user tries to create 'HighTemperature' alarm for the same device again, the previous alarm will be updated (the 'end_ts' will be set to current timestamp). If the user clears the alarm (see 'Clear Alarm(clearAlarm)'), than new alarm with the same type and same device may be created. Remove 'id', 'tenantId' and optionally 'customerId' from the request body example (below) to create new Alarm entity. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const saveAlarm: (options: Options) => import("./client").RequestResult; /** * Get Alarm comments (getAlarmComments) * * Returns a page of alarm comments for specified alarm. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getAlarmComments: (options: Options) => import("./client").RequestResult; /** * Create or update Alarm Comment * * Creates or Updates the Alarm Comment. When creating comment, platform generates Alarm Comment Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Alarm Comment id will be present in the response. Specify existing Alarm Comment id to update the alarm. Referencing non-existing Alarm Comment Id will cause 'Not Found' error. * * To create new Alarm comment entity it is enough to specify 'comment' json element with 'text' node, for example: {"comment": { "text": "my comment"}}. * * If comment type is not specified the default value 'OTHER' will be saved. If 'alarmId' or 'userId' specified in body it will be ignored. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const saveAlarmComment: (options: Options) => import("./client").RequestResult; /** * Clear Alarm (clearAlarm) * * Clear the Alarm. Once cleared, the 'clear_ts' field will be set to current timestamp and special rule chain event 'ALARM_CLEAR' will be generated. Referencing non-existing Alarm Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const clearAlarm: (options: Options) => import("./client").RequestResult; /** * Assign/Reassign Alarm (assignAlarm) * * Assign the Alarm. Once assigned, the 'assign_ts' field will be set to current timestamp and special rule chain event 'ALARM_ASSIGNED' (or ALARM_REASSIGNED in case of assigning already assigned alarm) will be generated. Referencing non-existing Alarm Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const assignAlarm: (options: Options) => import("./client").RequestResult; /** * Acknowledge Alarm (ackAlarm) * * Acknowledge the Alarm. Once acknowledged, the 'ack_ts' field will be set to current timestamp and special rule chain event 'ALARM_ACK' will be generated. Referencing non-existing Alarm Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). */ export declare const ackAlarm: (options: Options) => import("./client").RequestResult; /** * Get AI models (getAiModels) * * Returns a page of AI models. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getAiModels: (options: Options) => import("./client").RequestResult; /** * Create or update AI model (saveAiModel) * * Creates or updates an AI model record. * * • **Create:** Omit the `id` to create a new record. The platform assigns a UUID to the new record and returns it in the `id` field of the response. * * • **Update:** Include an existing `id` to modify that record. If no matching record exists, the API responds with **404 Not Found**. * * Tenant ID for the AI model will be taken from the authenticated user making the request, regardless of any value provided in the request body. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveAiModel: (options: Options) => import("./client").RequestResult; /** * Send request to AI chat model (sendChatRequest) * * Submits a single prompt - made up of an optional system message and a required user message - to the specified AI chat model and returns either the generated answer or an error envelope. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const sendChatRequest: (options: Options) => import("./client").RequestResult; /** * Creates or Updates the Administration Settings (saveAdminSettings) * * Creates or Updates the Administration Settings. Platform generates random Administration Settings Id during settings creation. The Administration Settings Id will be present in the response. Specify the Administration Settings Id when you would like to update the Administration Settings. Referencing non-existing Administration Settings Id will cause an error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'WRITE' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource. */ export declare const saveAdminSettings: (options: Options) => import("./client").RequestResult; /** * Send test sms (sendTestSms) * * Attempts to send test sms to the System Administrator User using SMS Settings and phone number provided as a parameters of the request. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'READ' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource. */ export declare const sendTestSms: (options: Options) => import("./client").RequestResult; /** * Send test email (sendTestMail) * * Attempts to send test email using Mail Settings provided as a parameter. Email is sent to the address specified in the profile of user who is performing the requestYou may change the 'To' email in the user profile of the System/Tenant Administrator. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'READ' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource. */ export declare const sendTestMail: (options: Options) => import("./client").RequestResult; /** * Get the Security Settings object (getSecuritySettings) * * Get the Security Settings object that contains password policy, etc. * * Available for users with 'SYS_ADMIN' authority. * * Security check is performed to verify that the user has 'READ' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource. */ export declare const getSecuritySettings: (options?: Options) => import("./client").RequestResult; /** * Update Security Settings (saveSecuritySettings) * * Updates the Security Settings object that contains password policy, etc. * * Available for users with 'SYS_ADMIN' authority. * * Security check is performed to verify that the user has 'WRITE' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource. */ export declare const saveSecuritySettings: (options: Options) => import("./client").RequestResult; /** * Delete repository settings (deleteRepositorySettings) * * Deletes the repository settings. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const deleteRepositorySettings: (options?: Options) => import("./client").RequestResult; /** * Get repository settings (getRepositorySettings) * * Get the repository settings object. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getRepositorySettings: (options?: Options) => import("./client").RequestResult; /** * Creates or Updates the repository settings (saveRepositorySettings) * * Creates or Updates the repository settings object. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveRepositorySettings: (options: Options) => import("./client").RequestResult; /** * Check repository access (checkRepositoryAccess) * * Attempts to check repository access. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const checkRepositoryAccess: (options: Options) => import("./client").RequestResult; /** * Refresh license (refreshLicense) * * Refresh license info. * * Available for users with 'SYS_ADMIN' authority. */ export declare const refreshLicense: (options?: Options) => import("./client").RequestResult; /** * Get the JWT Settings object (getJwtSettings) * * Get the JWT Settings object that contains JWT token policy, etc. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getJwtSettings: (options?: Options) => import("./client").RequestResult; /** * Update JWT Settings (saveJwtSettings) * * Updates the JWT Settings object that contains JWT token policy, etc. The tokenSigningKey field is a Base64 encoded string. * * Available for users with 'SYS_ADMIN' authority. */ export declare const saveJwtSettings: (options: Options) => import("./client").RequestResult; /** * Delete auto commit settings (deleteAutoCommitSettings) * * Deletes the auto commit settings. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const deleteAutoCommitSettings: (options?: Options) => import("./client").RequestResult; /** * Get auto commit settings (getAutoCommitSettings) * * Get the auto commit settings object. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getAutoCommitSettings: (options?: Options) => import("./client").RequestResult; /** * Creates or Updates the auto commit settings (saveAutoCommitSettings) * * Creates or Updates the auto commit settings object. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const saveAutoCommitSettings: (options: Options) => import("./client").RequestResult; /** * Get platform 2FA settings (getPlatformTwoFaSettings) * * Get platform settings for 2FA. The settings are described for savePlatformTwoFaSettings API method. If 2FA is not configured, then an empty response will be returned. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getPlatformTwoFaSettings: (options?: Options) => import("./client").RequestResult; /** * Save platform 2FA settings (savePlatformTwoFaSettings) * * Save 2FA settings for platform. The settings have following properties: * - `useSystemTwoFactorAuthSettings` - option for tenant admins to use 2FA settings configured by sysadmin. If this param is set to true, then the settings will not be validated for constraints (if it is a tenant admin; for sysadmin this param is ignored). * - `providers` - the list of 2FA providers' configs. Users will only be allowed to use 2FA providers from this list. * * - `minVerificationCodeSendPeriod` - minimal period in seconds to wait after verification code send request to send next request. * - `verificationCodeCheckRateLimit` - rate limit configuration for verification code checking. * The format is standard: 'amountOfRequests:periodInSeconds'. The value of '1:60' would limit verification code checking requests to one per minute. * - `maxVerificationFailuresBeforeUserLockout` - maximum number of verification failures before a user gets disabled. * - `totalAllowedTimeForVerification` - total amount of time in seconds allotted for verification. Basically, this property sets a lifetime for pre-verification token. If not set, default value of 30 minutes is used. * * * TOTP 2FA provider config has following settings: * - `issuerName` - issuer name that will be displayed in an authenticator app near a username. Must not be blank. * * For SMS 2FA provider: * - `smsVerificationMessageTemplate` - verification message template. Available template variables are ${code} and ${userEmail}. It must not be blank and must contain verification code variable. * - `verificationCodeLifetime` - verification code lifetime in seconds. Required to be positive. * * For EMAIL provider type: * - `verificationCodeLifetime` - the same as for SMS. * * Example of the settings: * ``` * { * "useSystemTwoFactorAuthSettings": false, * "providers": [ * { * "providerType": "TOTP", * "issuerName": "TB" * }, * { * "providerType": "EMAIL", * "verificationCodeLifetime": 60 * }, * { * "providerType": "SMS", * "verificationCodeLifetime": 60, * "smsVerificationMessageTemplate": "Here is your verification code: ${code}" * } * ], * "minVerificationCodeSendPeriod": 60, * "verificationCodeCheckRateLimit": "3:900", * "maxVerificationFailuresBeforeUserLockout": 10, * "totalAllowedTimeForVerification": 600 * } * ``` * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const savePlatformTwoFaSettings: (options: Options) => import("./client").RequestResult; /** * Submit 2FA account config (submitTwoFaAccountConfig) * * Submit 2FA account config to prepare for a future verification. Basically, this method will send a verification code for a given account config, if this has sense for a chosen 2FA provider. This code is needed to then verify and save the account config. * * Example of EMAIL 2FA account config: * ``` * { * "providerType": "EMAIL", * "useByDefault": true, * "email": "separate-email-for-2fa@thingsboard.org" * } * ``` * * Example of SMS 2FA account config: * ``` * { * "providerType": "SMS", * "useByDefault": false, * "phoneNumber": "+38012312321" * } * ``` * * For TOTP this method does nothing. * * Will throw an error (Bad Request) if submitted account config is not valid, or if the provider is not configured for usage. * * Available for any authorized user. */ export declare const submitTwoFaAccountConfig: (options: Options) => import("./client").RequestResult; /** * Generate 2FA account config (generateTwoFaAccountConfig) * * Generate new 2FA account config template for specified provider type. * * For TOTP, this will return a corresponding account config template with a generated OTP auth URL (with new random secret key for each API call) that can be then converted to a QR code to scan with an authenticator app. Example: * ``` * { * "providerType": "TOTP", * "useByDefault": false, * "authUrl": "otpauth://totp/TB%202FA:tenant@thingsboard.org?issuer=TB+2FA&secret=PNJDNWJVAK4ZTUYT7RFGPQLXA7XGU7PX" * } * ``` * * For EMAIL, the generated config will contain email from user's account: * ``` * { * "providerType": "EMAIL", * "useByDefault": false, * "email": "tenant@thingsboard.org" * } * ``` * * For SMS 2FA this method will just return a config with empty/default values as there is nothing to generate/preset: * ``` * { * "providerType": "SMS", * "useByDefault": false, * "phoneNumber": null * } * ``` * * Will throw an error (Bad Request) if the provider is not configured for usage. * * Available for any authorized user. */ export declare const generateTwoFaAccountConfig: (options: Options) => import("./client").RequestResult; /** * Get Calculated Fields by Entity Id (getCalculatedFieldsByEntityId) * * Fetch the Calculated Fields based on the provided Entity Id. */ export declare const getCalculatedFieldsByEntityId: (options: Options) => import("./client").RequestResult; /** * Get Widget Bundles (getWidgetsBundles) * * Returns a page of Widget Bundle objects available for current user. Widget Bundle represents a group(bundle) of widgets. Widgets are grouped into bundle by type or use case. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for any authorized user. */ export declare const getWidgetsBundles: (options: Options) => import("./client").RequestResult; /** * Delete widgets bundle (deleteWidgetsBundle) * * Deletes the widget bundle. Referencing non-existing Widget Bundle Id will cause an error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const deleteWidgetsBundle: (options: Options) => import("./client").RequestResult; /** * Get Widget Bundle (getWidgetsBundleById) * * Get the Widget Bundle based on the provided Widget Bundle Id. Widget Bundle represents a group(bundle) of widgets. Widgets are grouped into bundle by type or use case. * * Available for any authorized user. */ export declare const getWidgetsBundleById: (options: Options) => import("./client").RequestResult; /** * Get all Widget types for specified Bundle (getBundleWidgetTypesByBundleAlias) (Deprecated) * * Returns an array of Widget Type objects that belong to specified Widget Bundle.Widget Type represents the template for widget creation. Widget Type and Widget are similar to class and object in OOP theory. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * @deprecated */ export declare const getBundleWidgetTypes: (options: Options) => import("./client").RequestResult; /** * Get Widget Type Info objects (getBundleWidgetTypesInfosByBundleAlias) (Deprecated) * * Get the Widget Type Info objects based on the provided parameters. Widget Type Info is a lightweight object that represents Widget Type but does not contain the heavyweight widget descriptor JSON * * Available for any authorized user. * * @deprecated */ export declare const getBundleWidgetTypesInfos: (options: Options) => import("./client").RequestResult; /** * Get all Widget types details for specified Bundle (getBundleWidgetTypesDetailsByBundleAlias) (Deprecated) * * Returns an array of Widget Type Details objects that belong to specified Widget Bundle.Widget Type Details extend Widget Type and add image and description properties. Those properties are useful to edit the Widget Type but they are not required for Dashboard rendering. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * @deprecated */ export declare const getBundleWidgetTypesDetails: (options: Options) => import("./client").RequestResult; /** * Get Widget Type Info (getWidgetTypeInfoById) * * Get the Widget Type Info based on the provided Widget Type Id. Widget Type Details extend Widget Type and add image and description properties. Those properties are useful to edit the Widget Type but they are not required for Dashboard rendering. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getWidgetTypeInfoById: (options: Options) => import("./client").RequestResult; /** * Get all Widget type fqns for specified Bundle (getBundleWidgetTypeFqns) * * Returns an array of Widget Type fqns that belong to specified Widget Bundle. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getBundleWidgetTypeFqns: (options: Options) => import("./client").RequestResult; /** * Delete widget type (deleteWidgetType) * * Deletes the Widget Type. Referencing non-existing Widget Type Id will cause an error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const deleteWidgetType: (options: Options) => import("./client").RequestResult; /** * Get Widget Type Details (getWidgetTypeById) * * Get the Widget Type Details based on the provided Widget Type Id. Widget Type Details extend Widget Type and add image and description properties. Those properties are useful to edit the Widget Type but they are not required for Dashboard rendering. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getWidgetTypeById: (options: Options) => import("./client").RequestResult; /** * Check White Labeling Allowed * * Check if the White Labeling is enabled for the current user owner (tenant or customer) * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const isWhiteLabelingAllowed: (options?: Options) => import("./client").RequestResult; /** * Check Customer White Labeling Allowed * * Check if the White Labeling is enabled for the customers of the current tenant * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const isCustomerWhiteLabelingAllowed: (options?: Options) => import("./client").RequestResult; /** * Delete General White Labeling configuration (deleteCurrentWhiteLabelParams) * * Delete the White Labeling configuration that corresponds to the authority of the user. * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const deleteCurrentWhiteLabelParams: (options?: Options) => import("./client").RequestResult; /** * Get White Labeling configuration (getCurrentWhiteLabelParams) * * Fetch the White Labeling configuration that corresponds to the authority of the user. The API call is designed to load the White Labeling configuration for edition. So, the result is NOT merged with the parent level White Labeling configuration. Let's assume there is a custom White Labeling configured on a system level. And there is no custom White Labeling items configured on a tenant level. In such a case, the API call will return default object for the tenant administrator. * * Security check is performed to verify that the user has 'READ' permission for the white labeling resource. */ export declare const getCurrentWhiteLabelParams: (options?: Options) => import("./client").RequestResult; /** * Delete Login White Labeling configuration (deleteCurrentLoginWhiteLabelParams) * * Delete the Login White Labeling configuration that corresponds to the authority of the user. * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const deleteCurrentLoginWhiteLabelParams: (options?: Options) => import("./client").RequestResult; /** * Get Login White Labeling configuration (getCurrentWhiteLabelParams) * * Fetch the Login White Labeling configuration that corresponds to the authority of the user. The API call is designed to load the Login White Labeling configuration for edition. So, the result is NOT merged with the parent level White Labeling configuration. Let's assume there is a custom White Labeling configured on a system level. And there is no custom White Labeling items configured on a tenant level. In such a case, the API call will return default object for the tenant administrator. * * Security check is performed to verify that the user has 'READ' permission for the white labeling resource. */ export declare const getCurrentLoginWhiteLabelParams: (options?: Options) => import("./client").RequestResult; export declare const getReports: (options: Options) => import("./client").RequestResult; export declare const getReports1: (options: Options) => import("./client").RequestResult; export declare const getReportInfos: (options: Options) => import("./client").RequestResult; /** * Delete Report (deleteReport) * * Deletes the report. Referencing non-existing Report Id will cause 'Not Found' error. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteReport: (options: Options) => import("./client").RequestResult; /** * Get Report (getReportById) * * Fetch the Report object based on the provided report Id. The platform uses Report to store generated reports information.Referencing non-existing Report Id will cause 'Not Found' error. * * Available for users with 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getReportById: (options: Options) => import("./client").RequestResult; export declare const downloadReport: (options: Options) => import("./client").RequestResult; /** * Get All Alarms (getAllAlarmsV2) * * Returns a page of alarms that belongs to the current user owner. If the user has the authority of 'Tenant Administrator', the server returns alarms that belongs to the tenant of current user. If the user has the authority of 'Customer User', the server returns alarms that belongs to the customer of current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getAllAlarmsV2: (options: Options) => import("./client").RequestResult; /** * Get Alarms (getAlarmsV2) * * Returns a page of alarms for the selected entity. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getAlarmsV2: (options: Options) => import("./client").RequestResult; /** * Get Device Software (getSoftware) * * Downloads the current software package.When the platform initiates software update, it informs the device by updating the 'sw_title', 'sw_version', 'sw_checksum' and 'sw_checksum_algorithm' shared attributes.The 'sw_title' and 'sw_version' parameters must be supplied in this request to double-check that the software that device is downloading matches the software it expects to download. This is important, since the administrator may change the software assignment while device is downloading the software. * * Optional 'chunk' and 'size' parameters may be used to download the software in chunks. For example, device may request first 16 KB of software using 'chunk'=0 and 'size'=16384. Next 16KB using 'chunk'=1 and 'size'=16384. The last chunk should have less bytes then requested using 'size' parameter. * * The API call is designed to be used by device firmware and requires device access token ('deviceToken'). It is not recommended to use this API call by third-party scripts, rule-engine or platform widgets (use 'Telemetry Controller' instead). * */ export declare const getSoftware: (options: Options) => import("./client").RequestResult; /** * Get Device Firmware (getFirmware) * * Downloads the current firmware package.When the platform initiates firmware update, it informs the device by updating the 'fw_title', 'fw_version', 'fw_checksum' and 'fw_checksum_algorithm' shared attributes.The 'fw_title' and 'fw_version' parameters must be supplied in this request to double-check that the firmware that device is downloading matches the firmware it expects to download. This is important, since the administrator may change the firmware assignment while device is downloading the firmware. * * Optional 'chunk' and 'size' parameters may be used to download the firmware in chunks. For example, device may request first 16 KB of firmware using 'chunk'=0 and 'size'=16384. Next 16KB using 'chunk'=1 and 'size'=16384. The last chunk should have less bytes then requested using 'size' parameter. * * The API call is designed to be used by device firmware and requires device access token ('deviceToken'). It is not recommended to use this API call by third-party scripts, rule-engine or platform widgets (use 'Telemetry Controller' instead). * */ export declare const getFirmware: (options: Options) => import("./client").RequestResult; /** * Subscribe to attribute updates (subscribeToAttributes) (Deprecated) * * Subscribes to client and shared scope attribute updates using http long polling. Deprecated, since long polling is resource and network consuming. Consider using MQTT or CoAP protocol for light-weight real-time updates. * * The API call is designed to be used by device firmware and requires device access token ('deviceToken'). It is not recommended to use this API call by third-party scripts, rule-engine or platform widgets (use 'Telemetry Controller' instead). * */ export declare const subscribeToAttributes: (options: Options) => import("./client").RequestResult; /** * Get Users By Ids (getUsersByIds) * * Requested users must be owned by tenant or assigned to customer which user is performing the request. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUsersByIds: (options: Options) => import("./client").RequestResult; /** * Find users by query (findUsersByQuery) * * Returns page of user data objects. Search is been executed by email, firstName and lastName fields. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const findUsersByQuery: (options: Options) => import("./client").RequestResult; /** * Get usersForAssign (getUsersForAssign) * * Returns page of user data objects that can be assigned to provided alarmId. Search is been executed by email, firstName and lastName fields. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getUsersForAssign: (options: Options) => import("./client").RequestResult; /** * Get All User Infos for current user (getAllUserInfos) * * Returns a page of user info objects owned by the tenant or the customer of a current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllUserInfos: (options: Options) => import("./client").RequestResult; /** * Get group permissions by User Group Id (getUserGroupPermissions) * * Returns a list of group permission objects that belongs to specified User Group Id. Group permission entity represents list of allowed operations for certain User Group to perform against certain Entity Group. Basically, this entity wires three other entities: * * * Role that defines set of allowed operations; * * User Group that defines set of users who may perform the operations; * * Entity Group that defines set of entities which will be accessible to users; * * Group Permission Info object extends the Group Permissions with the full information about Role and User and/or Entity Groups. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUserGroupPermissions: (options: Options) => import("./client").RequestResult; /** * Delete User (deleteUser) * * Deletes the User, it's credentials and all the relations (from and to the User). Referencing non-existing User Id will cause an error. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteUser: (options: Options) => import("./client").RequestResult; /** * Get User (getUserById) * * Fetch the User object based on the provided User Id. If the user has the authority of 'SYS_ADMIN', the server does not perform additional checks. If the user has the authority of 'TENANT_ADMIN', the server checks that the requested user is owned by the same tenant. If the user has the authority of 'CUSTOMER_USER', the server checks that the requested user is owned by the same customer. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUserById: (options: Options) => import("./client").RequestResult; /** * Get User Token (getUserToken) * * Returns the token of the User based on the provided User Id. If the user who performs the request has the authority of 'SYS_ADMIN', it is possible to get the token of any tenant administrator. If the user who performs the request has the authority of 'TENANT_ADMIN', it is possible to get the token of any customer user that belongs to the same tenant. */ export declare const getUserToken: (options: Options) => import("./client").RequestResult; /** * Get activation link (getActivationLink) * * Get the activation link for the user. The base url for activation link is configurable in the general settings of system administrator. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getActivationLink: (options: Options) => import("./client").RequestResult; /** * Get activation link info (getActivationLinkInfo) * * Get the activation link info for the user. The base url for activation link is configurable in the general settings of system administrator. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getActivationLinkInfo: (options: Options) => import("./client").RequestResult; /** * Get Users (getUsers) * * Returns a page of user objects available for the current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUserUsers: (options: Options) => import("./client").RequestResult; /** * Check Token Access Enabled (isUserTokenAccessEnabled) * * Checks that the system is configured to allow administrators to impersonate themself as other users. If the user who performs the request has the authority of 'SYS_ADMIN', it is possible to login as any tenant administrator. If the user who performs the request has the authority of 'TENANT_ADMIN', it is possible to login as any customer user. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const isUserTokenAccessEnabled: (options?: Options) => import("./client").RequestResult; /** * Get User info (getUserInfoById) * * Fetch the User info object based on the provided User Id. If the user has the authority of 'SYS_ADMIN', the server does not perform additional checks. If the user has the authority of 'TENANT_ADMIN', the server checks that the requested user is owned by the same tenant. If the user has the authority of 'CUSTOMER_USER', the server checks that the requested user is owned by the same customer. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUserInfoById: (options: Options) => import("./client").RequestResult; /** * Get Entity Views (getUserEntityViews) * * Returns a page of entity views that are available for the current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUserEntityViews: (options: Options) => import("./client").RequestResult; /** * Get Edges (getUserEdges) * * Returns a page of edges available for current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUserEdges: (options: Options) => import("./client").RequestResult; /** * Get Devices (getUserDevices) * * Returns a page of devices that are available for the current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUserDevices: (options: Options) => import("./client").RequestResult; /** * Get Dashboards (getUserDashboards) * * Returns a page of Dashboard Info objects available for specified or current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUserDashboardsInfo: (options: Options) => import("./client").RequestResult; /** * Report action of User over the dashboard (reportUserDashboardAction) * * Report action of User over the dashboard. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const reportUserDashboardAction: (options: Options) => import("./client").RequestResult; /** * Get Customers (getUserCustomers) * * Returns a page of customers available for the user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUserCustomers: (options: Options) => import("./client").RequestResult; /** * Get Assets (getUserAssets) * * Returns a page of assets objects available for the current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Asset Info is an extension of the default Asset object that contains information about the owner name. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getUserAssets: (options: Options) => import("./client").RequestResult; export declare const getTenantUsageInfo: (options?: Options) => import("./client").RequestResult; /** * Get UI help base url (getHelpBaseUrl) * * Get UI help base url used to fetch help assets. The actual value of the base url is configurable in the system configuration file. */ export declare const getHelpBaseUrl: (options?: Options) => import("./client").RequestResult; /** * Get Trendz View by Id (getTrendzViewById) * * Fetch the Trendz View object based on the provided Trendz View Id. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getTrendzViewById: (options: Options) => import("./client").RequestResult; /** * Get Trendz Views (getTrendzViews) * * Returns a page of Trendz views that are available for the current user. Can only be used if Trendz is already synchronized and integration is enabled. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getTrendzViews: (options: Options) => import("./client").RequestResult; /** * Get Trendz Usage (getTrendzUsage) * * Fetch the Trendz usage object. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getTrendzUsage: (options?: Options) => import("./client").RequestResult; /** * Get Trendz synchronization result (getTrendzSyncResult) * * Retrieves Trendz synchronization result and status. Returns trendzVersion, updatedTs, resultType, and status. * * Available for any authorized user. */ export declare const getTrendzSyncResult: (options?: Options) => import("./client").RequestResult; /** * Get Trendz Summary (getTrendzSummary) * * Fetch the Trendz summary object. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getTrendzSummary: (options?: Options) => import("./client").RequestResult; /** * Perform Trendz healthcheck (performTrendzHealthcheck) * * Performs healthcheck for Trendz integration. Returns version, type, status, and message. Can only be performed if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const performTrendzHealthcheck: (options?: Options) => import("./client").RequestResult; /** * Get Translation info (getTranslationInfos) * * Fetch the list of customized locales and corresponding details such as language display name, country display name and translation progress percentage. * * Response example: * * ```json * [ * { * "localeCode": "uk_UA", * "language": "Ukrainian (українська)", * "country": "Україна", * "progress": 32 * }, * { * "localeCode": "es_ES", * "language": "Spanish (español)", * "country": "España", * "progress": 79 * }] * ``` * * Security check is performed to verify that the user has 'READ' permission for the white labeling resource. */ export declare const getTranslationInfos: (options?: Options) => import("./client").RequestResult; /** * Get end-user all-to-one translation (getFullTranslation) * * Fetch the end-user translation for specified locale. The result is the merge of user custom translation, system language translation and default locale translation. */ export declare const getFullTranslation: (options: Options) => import("./client").RequestResult; /** * Download end-user all-to-one translation (downloadFullTranslation) * * Fetch the end-user translation for the specified locale. The result is a json file with merged user custom translation, system language translation and default locale translation. */ export declare const downloadFullTranslation: (options: Options) => import("./client").RequestResult; /** * Get end-user multi-translation for basic edit (getTranslationForBasicEdit) * * Fetch the translation info map where value is info object containing key translation, origin translation, translation of parent level, translation status. */ export declare const getTranslationForBasicEdit: (options: Options) => import("./client").RequestResult; /** * Get end-user Custom Translation configuration (getMergedCustomTranslation) * * Fetch end-user Custom Translation for specified locale. The custom translation is configured in the white labeling parameters. If custom translation translation is defined on the tenant level, it overrides the custom translation of the system level. Similar, if the custom translation is defined on the customer level, it overrides the translation configuration of the tenant level. */ export declare const getMergedCustomTranslation: (options: Options) => import("./client").RequestResult; /** * Get list of available locales (getAvailableLocales) * * Fetch the list of customized locales from all levels * * Security check is performed to verify that the user has 'READ' permission for the white labeling resource. */ export declare const getAvailableLocales: (options?: Options) => import("./client").RequestResult; /** * Get list of available java locales (getAvailableJavaLocales) * * The result is map where key is locale code and value is locale language and country */ export declare const getAvailableJavaLocales: (options?: Options) => import("./client").RequestResult; /** * Get Tenants (getTenants) * * Returns a page of tenants registered in the platform. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getTenantsByIds: (options: Options) => import("./client").RequestResult; /** * Get Tenant Profiles (getTenantProfiles) * * Returns a page of tenant profiles registered in the platform. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getTenantProfiles: (options: Options) => import("./client").RequestResult; /** * Get Tenant Profiles Info (getTenantProfileInfos) * * Returns a page of tenant profile info objects registered in the platform. Tenant Profile Info is a lightweight object that contains only id and name of the profile. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getTenantProfileInfos: (options: Options) => import("./client").RequestResult; /** * Get Tenant Profile Info (getTenantProfileInfoById) * * Fetch the Tenant Profile Info object based on the provided Tenant Profile Id. Tenant Profile Info is a lightweight object that contains only id and name of the profile. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getTenantProfileInfoById: (options: Options) => import("./client").RequestResult; /** * Get default Tenant Profile Info (getDefaultTenantProfileInfo) * * Fetch the default Tenant Profile Info object based. Tenant Profile Info is a lightweight object that contains only id and name of the profile. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getDefaultTenantProfileInfo: (options?: Options) => import("./client").RequestResult; /** * Delete Tenant Profile (deleteTenantProfile) * * Deletes the tenant profile. Referencing non-existing tenant profile Id will cause an error. Referencing profile that is used by the tenants will cause an error. * * Available for users with 'SYS_ADMIN' authority. */ export declare const deleteTenantProfile: (options: Options) => import("./client").RequestResult; /** * Get Tenant Profile (getTenantProfileById) * * Fetch the Tenant Profile object based on the provided Tenant Profile Id. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getTenantProfileById: (options: Options) => import("./client").RequestResult; /** * Get Tenants Info (getTenants) * * Returns a page of tenant info objects registered in the platform. The Tenant Info object extends regular Tenant object and includes Tenant Profile name. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getTenantInfos: (options: Options) => import("./client").RequestResult; /** * Delete Tenant (deleteTenant) * * Deletes the tenant, it's customers, rule chains, devices and all other related entities. Referencing non-existing tenant Id will cause an error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const deleteTenant: (options: Options) => import("./client").RequestResult; /** * Get Tenant (getTenantById) * * Fetch the Tenant object based on the provided Tenant Id. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getTenantById: (options: Options) => import("./client").RequestResult; /** * Get Tenant Users (getTenantAdmins) * * Returns a page of users owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getTenantAdmins: (options: Options) => import("./client").RequestResult; /** * Get Tenant Dashboards by System Administrator (getTenantDashboards) * * Returns a page of dashboard info objects owned by tenant. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getTenantDashboards: (options: Options) => import("./client").RequestResult; /** * Get Tenant Info (getTenantInfoById) * * Fetch the Tenant Info object based on the provided Tenant Id. The Tenant Info object extends regular Tenant object and includes Tenant Profile name. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getTenantInfoById: (options: Options) => import("./client").RequestResult; /** * Get Entity View by name (getTenantEntityView) * * Fetch the Entity View object based on the tenant id and entity view name. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getTenantEntityViews: (options: Options) => import("./client").RequestResult; /** * Get Tenant Edge (getTenantEdge) * * Requested edge must be owned by tenant or customer that the user belongs to. Edge name is an unique property of edge. So it can be used to identify the edge. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getTenantEdges: (options: Options) => import("./client").RequestResult; /** * Get Tenant Device (getTenantDevice) * * Requested device must be owned by tenant that the user belongs to. Device name is an unique property of device. So it can be used to identify the device. * * Available for users with 'TENANT_ADMIN' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getTenantDevices: (options: Options) => import("./client").RequestResult; /** * Get Tenant Dashboards (getTenantDashboards) * * Returns a page of dashboard info objects owned by the tenant of a current user. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getTenantDashboards1: (options: Options) => import("./client").RequestResult; /** * Get Tenant Customer by Customer title (getTenantCustomer) * * Get the Customer using Customer Title. * * Available for users with 'TENANT_ADMIN' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getTenantCustomer: (options: Options) => import("./client").RequestResult; /** * Get Tenant Asset (getTenantAsset) * * Requested asset must be owned by tenant that the user belongs to. Asset name is an unique property of asset. So it can be used to identify the asset. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getTenantAssets: (options: Options) => import("./client").RequestResult; /** * Get Solution Template Instructions (getSolutionTemplateInstructions) * * Get a solution template instructions based on the provided id * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getSolutionTemplateInstructions: (options: Options) => import("./client").RequestResult; /** * Get Solution templates (getSolutionTemplateInfos) * * Get a list of solution template descriptors * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getSolutionTemplateInfos: (options?: Options) => import("./client").RequestResult; /** * Get Solution template details (getSolutionTemplateDetails) * * Get a solution template details based on the provided id * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getSolutionTemplateDetails: (options: Options) => import("./client").RequestResult; /** * Check Terms Of User (termsOfUseAccepted) * * Checks that current user accepted the privacy policy. */ export declare const termsOfUseAccepted: (options?: Options) => import("./client").RequestResult; /** * Check privacy policy (privacyPolicyAccepted) * * Checks that current user accepted the privacy policy. */ export declare const privacyPolicyAccepted: (options?: Options) => import("./client").RequestResult; /** * Get Tenant Secret infos (getSecretInfos) * * Returns a page of secret infos owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getSecretInfos: (options: Options) => import("./client").RequestResult; /** * Get Secret info by Id (getSecretInfoById) * * * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getSecretInfoById: (options: Options) => import("./client").RequestResult; /** * Get Tenant Secret names (getSecretNames) * * Returns a page of secret names owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getSecretNames: (options?: Options) => import("./client").RequestResult; /** * Get scheduler events (getSchedulerEvents) * * Requested scheduler events must be owned by tenant or assigned to customer which user is performing the request. Scheduler Event With Customer Info extends Scheduler Event Info object and adds 'customerTitle' - a String value representing the title of the customer which user created a Scheduler Event and 'customerIsPublic' - a boolean parameter that specifies if customer is public. See the 'Model' tab of the Response Class for more details. * * You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllSchedulerEvents: (options: Options) => import("./client").RequestResult; /** * Delete Scheduler Event (deleteSchedulerEvent) * * Deletes the scheduler event. Referencing non-existing Scheduler Event Id will cause 'Not Found' error. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteSchedulerEvent: (options: Options) => import("./client").RequestResult; /** * Get Scheduler Event (getSchedulerEventById) * * Fetch the SchedulerEvent object based on the provided scheduler event Id. Scheduler Event extends Scheduler Event Info object and adds 'configuration' - a JSON structure of scheduler event configuration. See the 'Model' tab of the Response Class for more details. Referencing non-existing Scheduler Event Id will cause 'Not Found' error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getSchedulerEventById: (options: Options) => import("./client").RequestResult; /** * Get Scheduler Event With Customer Info (getSchedulerEventInfoById) * * Fetch the SchedulerEventWithCustomerInfo object based on the provided scheduler event Id. Scheduler Event With Customer Info extends Scheduler Event Info object and adds 'customerTitle' - a String value representing the title of the customer which user created a Scheduler Event and 'customerIsPublic' - a boolean parameter that specifies if customer is public. See the 'Model' tab of the Response Class for more details. Referencing non-existing Scheduler Event Id will cause 'Not Found' error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getSchedulerEventInfoById: (options: Options) => import("./client").RequestResult; /** * Get Scheduled Report Events (getScheduledReportEvents) * * * * Available for users with 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getScheduledReportEvents: (options: Options) => import("./client").RequestResult; /** * Get latest input message (getLatestRuleNodeDebugInput) * * Gets the input message from the debug events for specified Rule Chain Id. Referencing non-existing rule chain Id will cause an error. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getLatestRuleNodeDebugInput: (options: Options) => import("./client").RequestResult; /** * Get Rule Chains (getRuleChains) * * Returns a page of Rule Chains owned by tenant. The rule chain object is lightweight and contains general information about the rule chain. List of rule nodes and their connection is stored in a separate 'metadata' object.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getRuleChainsByIds: (options: Options) => import("./client").RequestResult; /** * Export Rule Chains * * Exports all tenant rule chains as one JSON. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const exportRuleChains: (options: Options) => import("./client").RequestResult; /** * Delete rule chain (deleteRuleChain) * * Deletes the rule chain. Referencing non-existing rule chain Id will cause an error. Referencing rule chain that is used in the device profiles will cause an error. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const deleteRuleChain: (options: Options) => import("./client").RequestResult; /** * Get Rule Chain (getRuleChainById) * * Fetch the Rule Chain object based on the provided Rule Chain Id. The rule chain object is lightweight and contains general information about the rule chain. List of rule nodes and their connection is stored in a separate 'metadata' object. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getRuleChainById: (options: Options) => import("./client").RequestResult; /** * Get Rule Chain output labels (getRuleChainOutputLabels) * * Fetch the unique labels for the "output" Rule Nodes that belong to the Rule Chain based on the provided Rule Chain Id. The rule chain object is lightweight and contains general information about the rule chain. List of rule nodes and their connection is stored in a separate 'metadata' object. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getRuleChainOutputLabels: (options: Options) => import("./client").RequestResult; /** * Get output labels usage (getRuleChainOutputLabelsUsage) * * Fetch the list of rule chains and the relation types (labels) they use to process output of the current rule chain based on the provided Rule Chain Id. The rule chain object is lightweight and contains general information about the rule chain. List of rule nodes and their connection is stored in a separate 'metadata' object. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getRuleChainOutputLabelsUsage: (options: Options) => import("./client").RequestResult; /** * Get Rule Chain (getRuleChainById) * * Fetch the Rule Chain Metadata object based on the provided Rule Chain Id. The metadata object contains information about the rule nodes and their connections. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getRuleChainMetaData: (options: Options) => import("./client").RequestResult; /** * Is TBEL script executor enabled * * Returns 'True' if the TBEL script execution is enabled * * Available for users with 'TENANT_ADMIN' authority. */ export declare const isTbelEnabled: (options?: Options) => import("./client").RequestResult; /** * Get Auto Assign To Edge Rule Chains (getAutoAssignToEdgeRuleChains) * * Returns a list of Rule Chains that will be assigned to a newly created edge. The rule chain object is lightweight and contains general information about the rule chain. List of rule nodes and their connection is stored in a separate 'metadata' object. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getAutoAssignToEdgeRuleChains: (options?: Options) => import("./client").RequestResult; /** * Delete persistent RPC * * Deletes the persistent RPC request. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const deleteRpc: (options: Options) => import("./client").RequestResult; /** * Get persistent RPC request * * Get information about the status of the RPC call. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getPersistedRpc: (options: Options) => import("./client").RequestResult; /** * Get persistent RPC requests * * Allows to query RPC calls for specific device using pagination. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getPersistedRpcByDevice: (options: Options) => import("./client").RequestResult; /** * Get Roles (getRoles) * * Returns a page of roles that are available for the current user. Role Contains a set of permissions. Role has two types. Generic Role may be assigned to the user group and will provide permissions for all entities of a certain type. Group Role may be assigned to both user and entity group and will provides permissions only for the entities that belong to specified entity group. The assignment of the Role to the User Group is done using [Group Permission Controller](/swagger-ui.html#/group-permission-controller).You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getRolesByIds: (options: Options) => import("./client").RequestResult; /** * Delete role (deleteRole) * * Deletes the role. Referencing non-existing role Id will cause an error. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteRole: (options: Options) => import("./client").RequestResult; /** * Get Role by Id (getRoleById) * * Fetch the Role object based on the provided Role Id. Role Contains a set of permissions. Role has two types. Generic Role may be assigned to the user group and will provide permissions for all entities of a certain type. Group Role may be assigned to both user and entity group and will provides permissions only for the entities that belong to specified entity group. The assignment of the Role to the User Group is done using [Group Permission Controller](/swagger-ui.html#/group-permission-controller). Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getRoleById: (options: Options) => import("./client").RequestResult; /** * Download resource (downloadResource) * * Download resource with a given type and key for the given scope * * Available for any authorized user. */ export declare const downloadResourceIfChanged: (options: Options) => import("./client").RequestResult; /** * Get resource info (getResourceInfo) * * Get info for the resource with the given type, scope and key. Resource Info is a lightweight object that includes main information about the Resource excluding the heavyweight data. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getResourceInfo: (options: Options) => import("./client").RequestResult; /** * Delete Resource (deleteResource) * * Deletes the Resource. Referencing non-existing Resource Id will cause an error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const deleteResource: (options: Options) => import("./client").RequestResult; /** * Get Resource (getResourceById) * * Fetch the Resource object based on the provided Resource Id. Resource is a heavyweight object that includes main information about the Resource and also data. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * @deprecated */ export declare const getResourceById: (options: Options) => import("./client").RequestResult; /** * Download Resource (downloadResource) * * Download Resource based on the provided Resource Id. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const downloadResource: (options: Options) => import("./client").RequestResult; /** * Get All Resource Infos (getAllResources) * * Returns a page of Resource Info objects owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. Resource Info is a lightweight object that includes main information about the Resource excluding the heavyweight data. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getTenantResources: (options: Options) => import("./client").RequestResult; /** * Download PKCS_12 Resource (downloadPkcs12ResourceIfChanged) * * Download Resource based on the provided Resource Id or return 304 status code if resource was not changed. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const downloadPkcs12ResourceIfChanged: (options: Options) => import("./client").RequestResult; /** * Get LwM2M Objects (getLwm2mListObjects) * * Returns a page of LwM2M objects parsed from Resources with type 'LWM2M_MODEL' owned by tenant or sysadmin. You can specify parameters to filter the results. LwM2M Object is a object that includes information about the LwM2M model which can be used in transport configuration for the LwM2M device profile. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getLwm2mListObjects: (options: Options) => import("./client").RequestResult; /** * Download LWM2M Resource (downloadLwm2mResourceIfChanged) * * Download Resource based on the provided Resource Id or return 304 status code if resource was not changed. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const downloadLwm2mResourceIfChanged: (options: Options) => import("./client").RequestResult; /** * Get LwM2M Objects (getLwm2mListObjectsPage) * * Returns a page of LwM2M objects parsed from Resources with type 'LWM2M_MODEL' owned by tenant or sysadmin. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. LwM2M Object is a object that includes information about the LwM2M model which can be used in transport configuration for the LwM2M device profile. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getLwm2mListObjectsPage: (options: Options) => import("./client").RequestResult; /** * Download JS Resource (downloadJsResourceIfChanged) * * Download Resource based on the provided Resource Id or return 304 status code if resource was not changed. * * Available for any authorized user. */ export declare const downloadJsResourceIfChanged: (options: Options) => import("./client").RequestResult; /** * Download JKS Resource (downloadJksResourceIfChanged) * * Download Resource based on the provided Resource Id or return 304 status code if resource was not changed. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const downloadJksResourceIfChanged: (options: Options) => import("./client").RequestResult; /** * Get Resource Info (getResourceInfoById) * * Fetch the Resource Info object based on the provided Resource Id. Resource Info is a lightweight object that includes main information about the Resource excluding the heavyweight data. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getResourceInfoById: (options: Options) => import("./client").RequestResult; /** * Get report templates by Report Template Ids (getReportTemplatesByIds) * * Returns a list of ReportTemplateInfo objects based on the provided ids. Filters the list based on the user permissions. * * Available for users with 'TENANT_ADMIN' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getReportTemplatesByIds: (options: Options) => import("./client").RequestResult; /** * Get All Report Templates for current user (getAllReportTemplateInfos) * * Returns a page of report template info objects owned by the tenant or the customer of a current user. Report Templates allows you to create reports according to the report template configuration. Report service uses report template configuration to generate report. See the 'Model' tab of the Response Class for more details. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllReportTemplateInfos: (options: Options) => import("./client").RequestResult; /** * Delete Report Template (deleteReportTemplate) * * Deletes the report template. Referencing non-existing Report Template Id will cause 'Not Found' error. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteReportTemplate: (options: Options) => import("./client").RequestResult; /** * Get Report Template (getReportTemplateById) * * Fetch the ReportTemplate object based on the provided report template Id. Report Template extends Report Template Info object and adds 'configuration' - a JSON structure of report template configuration. See the 'Model' tab of the Response Class for more details. Referencing non-existing Report Template Id will cause 'Not Found' error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getReportTemplateById: (options: Options) => import("./client").RequestResult; /** * Get Report Template Info (getReportTemplateInfoById) * * Fetch the ReportTemplateInfo object based on the provided report template Id. Report Templates allows you to create reports according to the report template configuration. Report service uses report template configuration to generate report. See the 'Model' tab of the Response Class for more details. Referencing non-existing Report Template Id will cause 'Not Found' error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getReportTemplateInfoById: (options: Options) => import("./client").RequestResult; /** * Delete Queue (deleteQueue) * * Deletes the Queue. * * Available for users with 'SYS_ADMIN' authority. */ export declare const deleteQueue: (options: Options) => import("./client").RequestResult; /** * Get Queue (getQueueById) * * Fetch the Queue object based on the provided Queue Id. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getQueueById: (options: Options) => import("./client").RequestResult; /** * Get Queue (getQueueByName) * * Fetch the Queue object based on the provided Queue name. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getQueueByName: (options: Options) => import("./client").RequestResult; /** * Get Queue Stats entities (getTenantQueueStats) * * Returns a page of queue stats objects that are designed to collect queue statistics for every service. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getQueueStatsByIds: (options: Options) => import("./client").RequestResult; /** * Get Queue stats entity by id (getQueueStatsById) * * Fetch the Queue stats object based on the provided Queue stats id. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getQueueStatsById: (options: Options) => import("./client").RequestResult; /** * Get attributes (getAttributes) * * Returns all attributes that belong to specified entity. Use optional 'keys' parameter to return specific attributes. * Example of the result: * * ```json * [ * {"key": "stringAttributeKey", "value": "value", "lastUpdateTs": 1609459200000}, * {"key": "booleanAttributeKey", "value": false, "lastUpdateTs": 1609459200001}, * {"key": "doubleAttributeKey", "value": 42.2, "lastUpdateTs": 1609459200002}, * {"key": "longKeyExample", "value": 73, "lastUpdateTs": 1609459200003}, * {"key": "jsonKeyExample", * "value": { * "someNumber": 42, * "someArray": [1,2,3], * "someNestedObject": {"key": "value"} * }, * "lastUpdateTs": 1609459200004 * } * ] * ``` * * Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getAttributes: (options: Options) => import("./client").RequestResult; /** * Get attributes by scope (getAttributesByScope) * * Returns all attributes of a specified scope that belong to specified entity. List of possible attribute scopes depends on the entity type: * * * SERVER_SCOPE - supported for all entity types; * * SHARED_SCOPE - supported for devices; * * CLIENT_SCOPE - supported for devices. * * Use optional 'keys' parameter to return specific attributes. * Example of the result: * * ```json * [ * {"key": "stringAttributeKey", "value": "value", "lastUpdateTs": 1609459200000}, * {"key": "booleanAttributeKey", "value": false, "lastUpdateTs": 1609459200001}, * {"key": "doubleAttributeKey", "value": 42.2, "lastUpdateTs": 1609459200002}, * {"key": "longKeyExample", "value": 73, "lastUpdateTs": 1609459200003}, * {"key": "jsonKeyExample", * "value": { * "someNumber": 42, * "someArray": [1,2,3], * "someNestedObject": {"key": "value"} * }, * "lastUpdateTs": 1609459200004 * } * ] * ``` * * Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getAttributesByScope: (options: Options) => import("./client").RequestResult; /** * Get time series keys (getTimeseriesKeys) * * Returns a set of unique time series key names for the selected entity. * * Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getTimeseriesKeys: (options: Options) => import("./client").RequestResult; /** * Get all attribute keys (getAttributeKeys) * * Returns a set of unique attribute key names for the selected entity. The response will include merged key names set for all attribute scopes: * * * SERVER_SCOPE - supported for all entity types; * * CLIENT_SCOPE - supported for devices; * * SHARED_SCOPE - supported for devices. * * Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getAttributeKeys: (options: Options) => import("./client").RequestResult; /** * Get all attribute keys by scope (getAttributeKeysByScope) * * Returns a set of unique attribute key names for the selected entity and attributes scope: * * * SERVER_SCOPE - supported for all entity types; * * CLIENT_SCOPE - supported for devices; * * SHARED_SCOPE - supported for devices. * * Referencing a non-existing entity Id or invalid entity type will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getAttributeKeysByScope: (options: Options) => import("./client").RequestResult; /** * Get Permissions (getAllowedPermissions) * * Returns a complex object that describes: * * * all possible (both granted and not granted) permissions for the authority of the user (Tenant or Customer); * * all granted permissions for the user; * * The result impacts UI behavior and hides certain UI elements if user has no permissions to invoke the related operations. Nevertheless, all API calls check the permissions each time they are executed on the server side.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllowedPermissions: (options?: Options) => import("./client").RequestResult; /** * Check permission for specified entity (hasEntityPermission) * * Returns true if the user has permission to perform the operation, and false otherwise. * */ export declare const hasEntityPermission: (options: Options) => import("./client").RequestResult; /** * Get Owners (getOwners) * * Provides a rage view of Customers that the current user has READ access to. If the current user is Tenant administrator, the result set also contains the tenant. The call is designed for the UI auto-complete component to show tenant and all possible Customers that the user may select to change the owner of the particular entity or entity group. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getOwners: (options: Options) => import("./client").RequestResult; /** * Get Owner Infos (getOwnerInfos) * * Provides a rage view of Customers that the current user has READ access to. If the current user is Tenant administrator, the result set also contains the tenant. The call is designed for the UI auto-complete component to show tenant and all possible Customers that the user may select to change the owner of the particular entity or entity group. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getOwnerInfos: (options: Options) => import("./client").RequestResult; /** * Get Owner Info (getOwnerInfo) * * Fetch the owner info (tenant or customer) presented as Entity Info object based on the provided owner Id. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getOwnerInfo: (options: Options) => import("./client").RequestResult; /** * Get OTA Package Infos (getOtaPackages) * * Returns a page of OTA Package Info objects owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. OTA Package Info is a lightweight object that includes main information about the OTA Package excluding the heavyweight data. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getOtaPackages: (options: Options) => import("./client").RequestResult; /** * Get OTA Package Infos (getOtaPackages) * * Returns a page of OTA Package Info objects owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. OTA Package Info is a lightweight object that includes main information about the OTA Package excluding the heavyweight data. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getOtaPackages1: (options: Options) => import("./client").RequestResult; /** * Get group OTA Package Infos (getGroupOtaPackages) * * Returns a page of OTA Package Info objects owned by tenant, and by entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. OTA Package Info is a lightweight object that includes main information about the OTA Package excluding the heavyweight data. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getGroupOtaPackages: (options: Options) => import("./client").RequestResult; /** * Download OTA Package (downloadOtaPackage) * * Download OTA Package based on the provided OTA Package Id. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const downloadOtaPackage: (options: Options) => import("./client").RequestResult; /** * Get OTA Package Info (getOtaPackageInfoById) * * Fetch the OTA Package Info object based on the provided OTA Package Id. OTA Package Info is a lightweight object that includes main information about the OTA Package excluding the heavyweight data. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getOtaPackageInfoById: (options: Options) => import("./client").RequestResult; /** * Get OAuth2 log in processing URL (getLoginProcessingUrl) * * Returns the URL enclosed in double quotes. After successful authentication with OAuth2 provider, it makes a redirect to this path so that the platform can do further log in processing. This URL may be configured as 'security.oauth2.loginProcessingUrl' property in yml configuration file, or as 'SECURITY_OAUTH2_LOGIN_PROCESSING_URL' env variable. By default it is '/login/oauth2/code/' * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getLoginProcessingUrl: (options?: Options) => import("./client").RequestResult; /** * Delete oauth2 client (deleteOauth2Client) * * Deletes the oauth2 client. Referencing non-existing oauth2 client Id will cause an error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const deleteOauth2Client: (options: Options) => import("./client").RequestResult; /** * Get OAuth2 Client by id (getOAuth2ClientById) * * * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getOAuth2ClientById: (options: Options) => import("./client").RequestResult; /** * Get OAuth2 Client infos By Ids (findOAuth2ClientInfosByIds) * * Fetch OAuth2 Client info objects based on the provided ids. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const findOAuth2ClientInfos: (options: Options) => import("./client").RequestResult; /** * Get notifications (getNotifications) * * Returns the page of notifications for current user. * * You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for any authorized user. * * **WebSocket API**: * * There are 2 types of subscriptions: one for unread notifications count, another for unread notifications themselves. * * The URI for opening WS session for notifications: `/api/ws/plugins/notifications`. * * Subscription command for unread notifications count: * ``` * { * "unreadCountSubCmd": { * "cmdId": 1234 * } * } * ``` * To subscribe for latest unread notifications: * ``` * { * "unreadSubCmd": { * "cmdId": 1234, * "limit": 10 * } * } * ``` * To unsubscribe from any subscription: * ``` * { * "unsubCmd": { * "cmdId": 1234 * } * } * ``` * To mark certain notifications as read, use following command: * ``` * { * "markAsReadCmd": { * "cmdId": 1234, * "notifications": [ * "6f860330-7fc2-11ed-b855-7dd3b7d2faa9", * "5b6dfee0-8d0d-11ed-b61f-35a57b03dade" * ] * } * } * * ``` * To mark all notifications as read: * ``` * { * "markAllAsReadCmd": { * "cmdId": 1234 * } * } * ``` * * * Update structure for unread **notifications count subscription**: * ``` * { * "cmdId": 1234, * "totalUnreadCount": 55 * } * ``` * For **notifications subscription**: * - full update of latest unread notifications: * ``` * { * "cmdId": 1234, * "notifications": [ * { * "id": { * "entityType": "NOTIFICATION", * "id": "6f860330-7fc2-11ed-b855-7dd3b7d2faa9" * }, * ... * } * ], * "totalUnreadCount": 1 * } * ``` * - when new notification arrives or shown notification is updated: * ``` * { * "cmdId": 1234, * "update": { * "id": { * "entityType": "NOTIFICATION", * "id": "6f860330-7fc2-11ed-b855-7dd3b7d2faa9" * }, * # updated notification info, text, subject etc. * ... * }, * "totalUnreadCount": 2 * } * ``` * - when unread notifications count changes: * ``` * { * "cmdId": 1234, * "totalUnreadCount": 5 * } * ``` */ export declare const getNotifications: (options: Options) => import("./client").RequestResult; /** * Get unread notifications count (getUnreadNotificationsCount) * * Returns unread notifications count for chosen delivery method. * * Available for any authorized user. */ export declare const getUnreadNotificationsCount: (options?: Options) => import("./client").RequestResult; /** * Get notification templates (getNotificationTemplates) * * Returns the page of notification templates owned by sysadmin or tenant. * * You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getNotificationTemplates: (options: Options) => import("./client").RequestResult; /** * Delete notification template by id (deleteNotificationTemplateById * * Deletes notification template by its id. * * This template cannot be referenced by existing scheduled notification requests or any notification rules. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const deleteNotificationTemplateById: (options: Options) => import("./client").RequestResult; /** * Get notification template by id (getNotificationTemplateById) * * Fetches notification template by id. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getNotificationTemplateById: (options: Options) => import("./client").RequestResult; /** * Get notification targets by ids (getNotificationTargetsByIds) * * Returns the list of notification targets found by provided ids. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getNotificationTargets: (options: Options) => import("./client").RequestResult; /** * Delete notification target by id (deleteNotificationTargetById) * * Deletes notification target by its id. * * This target cannot be referenced by existing scheduled notification requests or any notification rules. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const deleteNotificationTargetById: (options: Options) => import("./client").RequestResult; /** * Get notification target by id (getNotificationTargetById) * * Fetches notification target by id. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getNotificationTargetById: (options: Options) => import("./client").RequestResult; /** * List Slack conversations (listSlackConversations) * * List available Slack conversations by type. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const listSlackConversations: (options: Options) => import("./client").RequestResult; /** * Get notification rules (getNotificationRules) * * Returns the page of notification rules. * * You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getNotificationRules: (options: Options) => import("./client").RequestResult; /** * Delete notification rule (deleteNotificationRule) * * Deletes notification rule by id. * Cancels all related scheduled notification requests (e.g. due to escalation table) * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const deleteNotificationRule: (options: Options) => import("./client").RequestResult; /** * Get notification rule by id (getNotificationRuleById) * * Fetches notification rule info by rule's id. * In addition to regular notification rule fields, there are `templateName` and `deliveryMethods` in the response. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getNotificationRuleById: (options: Options) => import("./client").RequestResult; /** * Get notification requests (getNotificationRequests) * * Returns the page of notification requests submitted by users of this tenant or sysadmins. * * You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getNotificationRequests: (options: Options) => import("./client").RequestResult; /** * Delete notification request (deleteNotificationRequest) * * Deletes notification request by its id. * * If the request has status `SENT` - all sent notifications for this request will be deleted. If it is `SCHEDULED`, the request will be cancelled. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const deleteNotificationRequest: (options: Options) => import("./client").RequestResult; /** * Get notification request by id (getNotificationRequestById) * * Fetches notification request info by request id. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getNotificationRequestById: (options: Options) => import("./client").RequestResult; /** * Get available delivery methods (getAvailableDeliveryMethods) * * Returns the list of delivery methods that are properly configured and are allowed to be used for sending notifications. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getAvailableDeliveryMethods: (options?: Options) => import("./client").RequestResult; /** * Get Login White Labeling parameters * * Returns login white-labeling parameters based on the hostname from request. */ export declare const getLoginWhiteLabelParams: (options?: Options) => import("./client").RequestResult; export declare const downloadLoginLogo: (options: Options) => import("./client").RequestResult; export declare const downloadLoginFavicon: (options: Options) => import("./client").RequestResult; /** * Get the current User password policy (getUserPasswordPolicy) * * API call to get the password policy for the password validation form(s). */ export declare const getUserPasswordPolicy: (options?: Options) => import("./client").RequestResult; /** * Get system translation for login page * * Fetch the end-user translation for specified locale. */ export declare const getLoginPageTranslation: (options: Options) => import("./client").RequestResult; /** * Get Terms of Use for Self Registration form (getTermsOfUse) * * Fetch the Terms of Use based on the domain name from the request. Available for non-authorized users. */ export declare const getTermsOfUse: (options?: Options) => import("./client").RequestResult; /** * Get Self Registration form parameters without authentication (getSignUpSelfRegistrationParams) * * Fetch the Self Registration parameters based on the domain name from the request. Available for non-authorized users. Contains the information to customize the sign-up form. */ export declare const getSignUpSelfRegistrationParams: (options?: Options) => import("./client").RequestResult; /** * Get Privacy Policy for Self Registration form (getPrivacyPolicy) * * Fetch the Privacy Policy based on the domain name from the request. Available for non-authorized users. */ export declare const getPrivacyPolicy: (options?: Options) => import("./client").RequestResult; export declare const getApplicationRedirect: (options: Options) => import("./client").RequestResult; /** * Get User Token (getUserTokenByMobileSecret) * * Returns the token of the User based on the provided secret key. */ export declare const getUserTokenByMobileSecret: (options: Options) => import("./client").RequestResult; /** * Get mobile app login info (getLoginMobileInfo) */ export declare const getLoginMobileInfo: (options: Options) => import("./client").RequestResult; /** * Mobile Login redirect (mobileLogin) * * This method generates redirect to the special link that is handled by mobile application. Useful for email verification flow on mobile app. */ export declare const mobileLogin: (options: Options) => import("./client").RequestResult; /** * Activate User using code from Email (activateEmail) * * Activate the user using code(link) from the activation email. Validates the code an redirects according to the signup flow. Checks that user was not activated yet. */ export declare const activateEmail: (options: Options) => import("./client").RequestResult; /** * Get user mobile app basic info (getUserMobileInfo) * * * * Available for any authorized user. */ export declare const getUserMobileInfo: (options: Options) => import("./client").RequestResult; /** * Get QR code configuration for home page (getMobileAppQrCodeConfig) * * The response payload contains ui configuration of qr code * * Available for any authorized user. */ export declare const getMergedMobileAppSettings: (options?: Options) => import("./client").RequestResult; /** * Get the deep link to the associated mobile application (getMobileAppDeepLink) * * Fetch the url that takes user to linked mobile application * * Available for any authorized user. */ export declare const getMobileAppDeepLink: (options?: Options) => import("./client").RequestResult; /** * Get mobile app bundle infos (getTenantMobileAppBundleInfos) * * * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getTenantMobileAppBundleInfos: (options: Options) => import("./client").RequestResult; /** * Get mobile app bundle info by id (getMobileAppBundleInfoById) * * * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getMobileAppBundleInfoById: (options: Options) => import("./client").RequestResult; /** * Delete Mobile App by ID (deleteMobileApp) * * Deletes Mobile App by ID. Referencing non-existing mobile app Id will cause an error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const deleteMobileApp: (options: Options) => import("./client").RequestResult; /** * Get mobile info by id (getMobileAppInfoById) * * * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getMobileAppById: (options: Options) => import("./client").RequestResult; /** * Get the list of all OAuth2 client registration templates (getClientRegistrationTemplates) * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * Mail configuration template is set of default smtp settings for mail server that specific provider supports */ export declare const getClientRegistrationTemplates1: (options?: Options) => import("./client").RequestResult; /** * Get Lwm2m Bootstrap SecurityInfo (getLwm2mBootstrapSecurityInfo) * * Get the Lwm2m Bootstrap SecurityInfo object (of the current server) based on the provided isBootstrapServer parameter. If isBootstrapServer == true, get the parameters of the current Bootstrap Server. If isBootstrapServer == false, get the parameters of the current Lwm2m Server. Used for client settings when starting the client in Bootstrap mode. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getLwm2mBootstrapSecurityInfo: (options: Options) => import("./client").RequestResult; /** * Get jobs (getJobs) * * Returns the page of jobs. * * You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getJobs: (options: Options) => import("./client").RequestResult; export declare const deleteJob: (options: Options) => import("./client").RequestResult; /** * Get job by id (getJobById) * * Fetches job info by id. * * Example of a RUNNING CF_REPROCESSING job response: * ```json * { * "id": { * "entityType": "JOB", * "id": "475e94e0-2f2d-11f0-8240-91e99922a704" * }, * "createdTime": 1747053196590, * "tenantId": { * "entityType": "TENANT", * "id": "46859a00-2f2d-11f0-8240-91e99922a704" * }, * "type": "CF_REPROCESSING", * "key": "474e4130-2f2d-11f0-8240-91e99922a704", * "entityId": { * "entityType": "DEVICE_PROFILE", * "id": "9fd41f20-31a1-11f0-933e-27998d6db02e" * }, * "status": "RUNNING", * "configuration": { * "type": "CF_REPROCESSING", * "calculatedFieldId": { * "entityType": "CALCULATED_FIELD", * "id": "474e4130-2f2d-11f0-8240-91e99922a704" * }, * "startTs": 1747051995760, * "endTs": 1747052895760, * "tasksKey": "c3cdbd42-799e-4d3a-9aad-9310f767aa36", * "toReprocess": null * }, * "result": { * "jobType": "CF_REPROCESSING", * "successfulCount": 1, * "failedCount": 0, * "discardedCount": 0, * "totalCount": 2, * "results": [], * "generalError": null, * "startTs": 1747323069445, * "finishTs": 1747323070585, * "cancellationTs": 0 * } * } * * ``` * * Example of a CF_REPROCESSING job with failures: * ```json * { * ..., * "status": "FAILED", * ..., * "result": { * "jobType": "CF_REPROCESSING", * "successfulCount": 0, * "failedCount": 2, * "discardedCount": 0, * "totalCount": 2, * "results": [ * { * "jobType": "CF_REPROCESSING", * "key": "c3cdbd42-799e-4d3a-9aad-9310f767aa36", * "success": false, * "discarded": false, * "failure": { * "error": "Failed to fetch temperature: Failed to fetch timeseries data", * "entityInfo": { * "id": { * "entityType": "DEVICE", * "id": "9fd41f20-31a1-11f0-933e-27998d6db02e" * }, * "name": "Test device 1" * } * } * }, * { * "jobType": "CF_REPROCESSING", * "key": "c3cdbd42-799e-4d3a-9aad-9310f767aa36", * "success": false, * "discarded": false, * "failure": { * "error": "Failed to fetch temperature: Failed to fetch timeseries data", * "entityInfo": { * "id": { * "entityType": "DEVICE", * "id": "9ffc4090-31a1-11f0-933e-27998d6db02e" * }, * "name": "Test device 2" * } * } * } * ], * "generalError": null, * "startTs": 1747323069445, * "finishTs": 1747323070585, * "cancellationTs": 0 * } * } * * ``` * * Example of a FAILED job result with general error: * ```json * { * ..., * "status": "FAILED", * ..., * "result": { * "jobType": "CF_REPROCESSING", * "successfulCount": 1, * "failedCount": 0, * "discardedCount": 0, * "totalCount": null, * "results": [], * "generalError": "Timeout to find devices by profile", * "cancellationTs": 0 * } * } * * ``` * * Example of a CANCELLED job result: * ```json * { * ..., * "status": "CANCELLED", * ..., * "result": { * "jobType": "CF_REPROCESSING", * "successfulCount": 15, * "failedCount": 0, * "discardedCount": 85, * "totalCount": 100, * "results": [], * "generalError": null, * "cancellationTs": 1747065908414 * } * } * * ``` * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getJobById: (options: Options) => import("./client").RequestResult; /** * Get Integrations By Ids (getIntegrationsByIds) * * Requested integrations must be owned by tenant which is performing the request. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getIntegrations: (options: Options) => import("./client").RequestResult; /** * Get Integrations Converters info (getIntegrationsConvertersInfo) * * Returns a JSON object containing information about existing tenant converters and converters available in library. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getIntegrationsConvertersInfo: (options?: Options) => import("./client").RequestResult; /** * Get Integration Infos (getIntegrationInfos) * * Returns a page of integration infos owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getIntegrationInfos: (options: Options) => import("./client").RequestResult; /** * Delete integration (deleteIntegration) * * Deletes the integration and all the relations (from and to the integration). Referencing non-existing integration Id will cause an error. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteIntegration: (options: Options) => import("./client").RequestResult; /** * Get Integration (getIntegrationById) * * Fetch the Integration object based on the provided Integration Id. The server checks that the integration is owned by the same tenant. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getIntegrationById: (options: Options) => import("./client").RequestResult; /** * Get Integration by Routing Key (getIntegrationByRoutingKey) * * Fetch the Integration object based on the provided routing key. The server checks that the integration is owned by the same tenant. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getIntegrationByRoutingKey: (options: Options) => import("./client").RequestResult; export declare const getImages: (options: Options) => import("./client").RequestResult; export declare const downloadImagePreview: (options: Options) => import("./client").RequestResult; export declare const exportImage: (options: Options) => import("./client").RequestResult; export declare const downloadPublicImage: (options: Options) => import("./client").RequestResult; /** * Delete group permission (deleteGroupPermission) * * Deletes the group permission. Referencing non-existing group permission Id will cause an error. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteGroupPermission: (options: Options) => import("./client").RequestResult; /** * Get Group Permission (getGroupPermissionById) * * Fetch the Group Permission object based on the provided Group Permission Id. Group permission entity represents list of allowed operations for certain User Group to perform against certain Entity Group. Basically, this entity wires three other entities: * * * Role that defines set of allowed operations; * * User Group that defines set of users who may perform the operations; * * Entity Group that defines set of entities which will be accessible to users; * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getGroupPermissionById: (options: Options) => import("./client").RequestResult; /** * Get Group Permission Info (getGroupPermissionInfoById) * * Fetch the Group Permission Info object based on the provided Group Permission Id and the flag that controls what additional information to load: User or Entity Group. Group permission entity represents list of allowed operations for certain User Group to perform against certain Entity Group. Basically, this entity wires three other entities: * * * Role that defines set of allowed operations; * * User Group that defines set of users who may perform the operations; * * Entity Group that defines set of entities which will be accessible to users; * * Group Permission Info object extends the Group Permissions with the full information about Role and User and/or Entity Groups. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getGroupPermissionInfoById: (options: Options) => import("./client").RequestResult; /** * Get Events by type (getEvents) * * Returns a page of events for specified entity by specifying event type. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. */ export declare const getEvents2: (options: Options) => import("./client").RequestResult; /** * Get All Entity View Infos for current user (getAllEntityViewInfos) * * Returns a page of entity view info objects owned by the tenant or the customer of a current user. Entity Views Info extends the Entity View with owner name. Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllEntityViewInfos: (options: Options) => import("./client").RequestResult; /** * Delete entity view (deleteEntityView) * * Delete the EntityView object based on the provided entity view id. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const deleteEntityView: (options: Options) => import("./client").RequestResult; /** * Get entity view (getEntityViewById) * * Fetch the EntityView object based on the provided entity view id. Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. See the 'Model' tab for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getEntityViewById: (options: Options) => import("./client").RequestResult; /** * Get Entity View Types (getEntityViewTypes) * * Returns a set of unique entity view types based on entity views that are either owned by the tenant or assigned to the customer which user is performing the request. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getEntityViewTypes: (options?: Options) => import("./client").RequestResult; /** * Get entity view info (getEntityViewInfoById) * * Fetch the Entity View info object based on the provided entity view id. Entity Views Info extends the Entity View with owner name. Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. See the 'Model' tab for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getEntityViewInfoById: (options: Options) => import("./client").RequestResult; /** * Get Entity Groups by Ids (getEntityGroupsByIds) * * Fetch the list of Entity Group Info objects based on the provided entity group ids list. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupsByIds: (options: Options) => import("./client").RequestResult; /** * Get Entity Groups for all owners starting from specified than ending with owner of current user (getEntityGroupsHierarchyByOwnerAndTypeAndPageLink) * * Returns a page of Entity Group objects based on the provided Owner Id and Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupsHierarchyByOwnerAndTypeAndPageLink: (options: Options) => import("./client").RequestResult; /** * Get Entity Groups by owner and entity type and page link (getEntityGroupsByOwnerAndTypeAndPageLink) * * Returns a page of Entity Group objects based on the provided Owner Id and Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupsByOwnerAndType: (options: Options) => import("./client").RequestResult; /** * Get Entity Groups by entity type and page link (getEntityGroupsByTypeAndPageLink) * * Returns a page of Entity Group Info objects based on the provided Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupsByType: (options: Options) => import("./client").RequestResult; /** * Get Shared Entity Groups by entity type and page link (getSharedEntityGroupsByTypeAndPageLink) * * Returns a page of Shared Entity Group Info objects based on the provided Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getSharedEntityGroupsByType: (options: Options) => import("./client").RequestResult; /** * Get Entity Groups by Entity Id (getEntityGroupsForEntity) * * Returns a list of groups that contain the specified Entity Id. For example, all device groups that contain specific device. The list always contain at least one element - special group 'All'.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getEntityGroupsForEntity: (options: Options) => import("./client").RequestResult; /** * Get Edge Entity Groups by entity type (getEdgeEntityGroups) * * Returns a page of Entity Group Info objects based on the provided Entity Type and assigned to the provided Edge entity. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getEdgeEntityGroups: (options: Options) => import("./client").RequestResult; /** * Get Entity Group Entity Infos by Ids (getEntityGroupEntityInfosByIds) * * Fetch the list of Entity Group Entity Info objects based on the provided entity group ids list. Entity Info is a lightweight object that contains only id and name of the entity group. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupEntityInfosByIds: (options: Options) => import("./client").RequestResult; /** * Get Entity Group Entity Infos for all owners starting from specified than ending with owner of current user (getEntityGroupEntityInfosHierarchyByOwnerAndTypeAndPageLink) * * Returns a page of Entity Group Entity Info objects based on the provided Owner Id and Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupEntityInfosHierarchyByOwnerAndTypeAndPageLink: (options: Options) => import("./client").RequestResult; /** * Get Entity Group Entity Infos by owner and entity type and page link (getEntityGroupEntityInfosByOwnerAndTypeAndPageLink) * * Returns a page of Entity Group Entity Info objects based on the provided Owner Id and Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupEntityInfosByOwnerAndTypeAndPageLink: (options: Options) => import("./client").RequestResult; /** * Get Entity Group Entity Infos by entity type and page link (getEntityGroupEntityInfosByTypeAndPageLink) * * Returns a page of Entity Group Entity Info objects based on the provided Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupEntityInfosByTypeAndPageLink: (options: Options) => import("./client").RequestResult; /** * Get Shared Entity Group Entity Infos by entity type and page link (getSharedEntityGroupEntityInfosByTypeAndPageLink) * * Returns a page of Shared Entity Group Entity Info objects based on the provided Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getSharedEntityGroupEntityInfosByTypeAndPageLink: (options: Options) => import("./client").RequestResult; /** * Get Entity Group Entity Info (getEntityGroupEntityInfoById) * * Fetch the Entity Group Entity Info object based on the provided Entity Group Id. Entity Info is a lightweight object that contains only id and name of the entity group. * * Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupEntityInfoById: (options: Options) => import("./client").RequestResult; /** * Get Entity Group by owner, type and name (getEntityGroupByOwnerAndNameAndType) * * Fetch the Entity Group object based on the provided Entity Group Id. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. * * Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupByOwnerAndNameAndType: (options: Options) => import("./client").RequestResult; /** * Delete Entity Group (deleteEntityGroup) * * Deletes the entity group but does not delete the entities in the group, since they are also present in reserved group 'All'. Referencing non-existing Entity Group Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'DELETE' permission for specified group. */ export declare const deleteEntityGroup: (options: Options) => import("./client").RequestResult; /** * Get Entity Group Info (getEntityGroupById) * * Fetch the Entity Group object based on the provided Entity Group Id. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. * * Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupById: (options: Options) => import("./client").RequestResult; /** * Get Group Entity (getGroupEntity) * * Fetch the Short Entity View object based on the group and entity id. Short Entity View object contains the entity id and number of fields (attributes, telemetry, etc). List of those fields is configurable and defined in the group configuration. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getGroupEntity: (options: Options) => import("./client").RequestResult; /** * Get users by Entity Group Id (getUsersByEntityGroupId) * * Returns a page of user objects that belongs to specified Entity Group Id. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getUsersByEntityGroupId: (options: Options) => import("./client").RequestResult; /** * Get group permissions by Entity Group Id (getEntityGroupPermissions) * * Returns a list of group permission objects that is assigned for the specified Entity Group Id. Group permission entity represents list of allowed operations for certain User Group to perform against certain Entity Group. Basically, this entity wires three other entities: * * * Role that defines set of allowed operations; * * User Group that defines set of users who may perform the operations; * * Entity Group that defines set of entities which will be accessible to users; * * Group Permission Info object extends the Group Permissions with the full information about Role and User and/or Entity Groups. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getEntityGroupPermissions: (options: Options) => import("./client").RequestResult; /** * Get entity views by Entity Group Id (getEntityViewsByEntityGroupId) * * Returns a page of Entity View objects that belongs to specified Entity View Id. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityViewsByEntityGroupId: (options: Options) => import("./client").RequestResult; /** * Get Group Entities (getEntities) * * Returns a page of Short Entity View objects that belongs to specified Entity Group Id. Short Entity View object contains the entity id and number of fields (attributes, telemetry, etc). List of those fields is configurable and defined in the group configuration.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntities: (options: Options) => import("./client").RequestResult; /** * Get edges by Entity Group Id (getEdgesByEntityGroupId) * * Returns a page of Edge objects that belongs to specified Entity Group Id. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEdgesByEntityGroupId: (options: Options) => import("./client").RequestResult; /** * Get devices by Entity Group Id (getDevicesByEntityGroupId) * * Returns a page of Device objects that belongs to specified Entity Group Id. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getDevicesByEntityGroupId: (options: Options) => import("./client").RequestResult; /** * Get dashboards by Entity Group Id (getDashboardsByEntityGroupId) * * Returns a page of Dashboard objects that belongs to specified Entity Group Id. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getDashboardsByEntityGroupId: (options: Options) => import("./client").RequestResult; /** * Export Dashboards (exportGroupDashboards) * * Export the dashboards that belong to specified group id.The Dashboard object is a heavyweight object that contains information about the dashboard (e.g. title, image, assigned customers) and also configuration JSON (e.g. layouts, widgets, entity aliases). * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const exportGroupDashboards: (options: Options) => import("./client").RequestResult; /** * Get customers by Entity Group Id (getCustomersByEntityGroupId) * * Returns a page of Customer objects that belongs to specified Entity Group Id. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getCustomersByEntityGroupId: (options: Options) => import("./client").RequestResult; /** * Get assets by Entity Group Id (getAssetsByEntityGroupId) * * Returns a page of asset objects that belongs to specified Entity Group Id. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getAssetsByEntityGroupId: (options: Options) => import("./client").RequestResult; /** * Get special group All by owner and entity type (getEntityGroupsByOwnerAndType) * * Fetch reserved group 'All' based on the provided Owner Id and Entity Type. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. */ export declare const getEntityGroupAllByOwnerAndType: (options: Options) => import("./client").RequestResult; /** * Get version create request status (getVersionCreateRequestStatus) * * Returns the status of previously made version create request. * * This status contains following properties: * - `done` - whether request processing is finished; * - `version` - created version info: timestamp, version id (commit hash), commit name and commit author; * - `added` - count of items that were created in the remote repo; * - `modified` - modified items count; * - `removed` - removed items count; * - `error` - error message, if an error occurred while handling the request. * * An example of successful status: * ```json * { * "done": true, * "added": 10, * "modified": 2, * "removed": 5, * "version": { * "timestamp": 1655198528000, * "id":"8a834dd389ed80e0759ba8ee338b3f1fd160a114", * "name": "My devices v2.0", * "author": "John Doe" * }, * "error": null * } * ``` * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getVersionCreateRequestStatus: (options: Options) => import("./client").RequestResult; /** * List entity type versions (listEntityTypeVersions) * * Returns list of versions of an entity type in a branch. This is a collected list of versions that were created for entities of this type in a remote branch. * If specified branch does not exist - empty page data will be returned. The response structure is the same as for `listEntityVersions` API method. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const listEntityTypeVersions: (options: Options) => import("./client").RequestResult; /** * List entity versions (listEntityVersions) * * Returns list of versions for a specific entity in a concrete branch. * You need to specify external id of an entity to list versions for. This is `externalId` property of an entity, or otherwise if not set - simply id of this entity. * If specified branch does not exist - empty page data will be returned. * * Each version info item has timestamp, id, name and author. Version id can then be used to restore the version. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Response example: * ```json * { * "data": [ * { * "timestamp": 1655198593000, * "id": "fd82625bdd7d6131cf8027b44ee967012ecaf990", * "name": "Devices and assets - v2.0", * "author": "John Doe " * }, * { * "timestamp": 1655198528000, * "id": "682adcffa9c8a2f863af6f00c4850323acbd4219", * "name": "Update my device", * "author": "John Doe " * }, * { * "timestamp": 1655198280000, * "id": "d2a6087c2b30e18cc55e7cdda345a8d0dfb959a4", * "name": "Devices and assets - v1.0", * "author": "John Doe " * } * ], * "totalPages": 1, * "totalElements": 3, * "hasNext": false * } * ``` * * Available for users with 'TENANT_ADMIN' authority. */ export declare const listEntityVersions: (options: Options) => import("./client").RequestResult; /** * Get entity data info (getEntityDataInfo) * * Retrieves short info about the remote entity by external id at a concrete version. * Returned entity data info contains following properties: `hasRelations` (whether stored entity data contains relations), `hasAttributes` (contains attributes), `hasCredentials` (whether stored device data has credentials), `hasPermissions` (user group data contains group permission list) and `hasGroupEntities` (entity group data contains group entities). * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getEntityDataInfo: (options: Options) => import("./client").RequestResult; /** * List all entities at version (listAllEntitiesAtVersion) * * Returns a list of all remote entities available in a specific version. Response type is the same as for listAllEntitiesAtVersion API method. * Returned entities order will be the same as in the repository. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const listAllEntitiesAtVersion: (options: Options) => import("./client").RequestResult; /** * Get version load request status (getVersionLoadRequestStatus) * * Returns the status of previously made version load request. The structure contains following parameters: * - `done` - if the request was successfully processed; * - `result` - a list of load results for each entity type: * - `created` - created entities count; * - `updated` - updated entities count; * - `deleted` - removed entities count; * - `groupsCreated` - created entity groups count; * - `groupsUpdated` - updated entity groups count; * - `groupsDeleted` - removed entity groups count. * - `error` - if an error occurred during processing, error info: * - `type` - error type; * - `source` - an external id of remote entity; * - `target` - if failed to find referenced entity by external id - this external id; * - `message` - error message. * * An example of successfully processed request status: * ```json * { * "done": true, * "result": [ * { * "entityType": "DEVICE", * "created": 10, * "updated": 5, * "deleted": 5, * "groupsCreated": 1, * "groupsUpdated": 1, * "groupsDeleted": 1 * }, * { * "entityType": "ASSET", * "created": 4, * "updated": 0, * "deleted": 8, * "groupsCreated": 1, * "groupsUpdated": 0, * "groupsDeleted": 2 * } * ] * } * ``` * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getVersionLoadRequestStatus: (options: Options) => import("./client").RequestResult; /** * List entities at version (listEntitiesAtVersion) * * Returns a list of remote entities of a specific entity type that are available at a concrete version. * Each entity item in the result has `externalId` property. Entities order will be the same as in the repository. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const listEntitiesAtVersion: (options: Options) => import("./client").RequestResult; /** * Compare entity data to version (compareEntityDataToVersion) * * Returns an object with current entity data and the one at a specific version. Entity data structure is the same as stored in a repository. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const compareEntityDataToVersion: (options: Options) => import("./client").RequestResult; /** * List branches (listBranches) * * Lists branches available in the remote repository. * * Response example: * ```json * [ * { * "name": "master", * "default": true * }, * { * "name": "dev", * "default": false * }, * { * "name": "dev-2", * "default": false * } * ] * ``` */ export declare const listBranches: (options?: Options) => import("./client").RequestResult; export declare const getEdqsState: (options?: Options) => import("./client").RequestResult; /** * Is edges support enabled (isEdgesSupportEnabled) * * Returns 'true' if edges support enabled on server, 'false' - otherwise. */ export declare const isEdgesSupportEnabled: (options?: Options) => import("./client").RequestResult; /** * Get All Edge Infos for current user (getAllEdgeInfos) * * Returns a page of edge info objects owned by the tenant or the customer of a current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllEdgeInfos: (options: Options) => import("./client").RequestResult; /** * Delete edge (deleteEdge) * * Deletes the edge. Referencing non-existing edge Id will cause an error. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const deleteEdge: (options: Options) => import("./client").RequestResult; /** * Get Edge (getEdgeById) * * Get the Edge object based on the provided Edge Id. If the user has the authority of 'Tenant Administrator', the server checks that the edge is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the edge is assigned to the same customer. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getEdgeById: (options: Options) => import("./client").RequestResult; /** * Is edge upgrade enabled (isEdgeUpgradeAvailable) * * Returns 'true' if upgrade available for connected edge, 'false' - otherwise. */ export declare const isEdgeUpgradeAvailable: (options: Options) => import("./client").RequestResult; /** * Get Edge Scheduler Events (getEdgeSchedulerEvents) * * Returns a page of Scheduler Events Info objects based on the provided Edge entity. Scheduler Event extends Scheduler Event Info object and adds 'configuration' - a JSON structure of scheduler event configuration. See the 'Model' tab of the Response Class for more details. Scheduler Events allows you to schedule various types of events with flexible schedule configuration. Scheduler fires configured scheduler events according to their schedule. See the 'Model' tab of the Response Class for more details. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getEdgeSchedulerEvents: (options: Options) => import("./client").RequestResult; /** * Get Edge Rule Chains (getEdgeRuleChains) * * Returns a page of Rule Chains assigned to the specified edge. The rule chain object is lightweight and contains general information about the rule chain. List of rule nodes and their connection is stored in a separate 'metadata' object.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getEdgeRuleChains: (options: Options) => import("./client").RequestResult; /** * Get Edge Integrations (getEdgeIntegrations) * * Returns a page of Integrations assigned to the specified edge. The integration object contains information about the Integration, including the heavyweight configuration object. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getEdgeIntegrations: (options: Options) => import("./client").RequestResult; /** * Get Edge Integrations (getEdgeIntegrationInfos) * * Returns a page of Integrations assigned to the specified edge. The integration object contains information about the Integration, including the heavyweight configuration object. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getEdgeIntegrationInfos: (options: Options) => import("./client").RequestResult; /** * Get Edge Events (getEdgeEvents) * * Returns a page of edge events for the requested edge. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. */ export declare const getEdgeEvents: (options: Options) => import("./client").RequestResult; /** * Get All Edge Scheduler Events (getAllEdgeSchedulerEvents) * * Fetch the list of Scheduler Event Info objects based on the provided Edge entity. Scheduler Event extends Scheduler Event Info object and adds 'configuration' - a JSON structure of scheduler event configuration. See the 'Model' tab of the Response Class for more details. Scheduler Events allows you to schedule various types of events with flexible schedule configuration. Scheduler fires configured scheduler events according to their schedule. See the 'Model' tab of the Response Class for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllEdgeSchedulerEvents: (options: Options) => import("./client").RequestResult; /** * Get Edge Types (getEdgeTypes) * * Returns a set of unique edge types based on edges that are either owned by the tenant or assigned to the customer which user is performing the request. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getEdgeTypes: (options?: Options) => import("./client").RequestResult; /** * Find missing rule chains (findMissingToRelatedRuleChains) * * Returns list of rule chains ids that are not assigned to particular edge, but these rule chains are present in the already assigned rule chains to edge. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const findMissingToRelatedRuleChains: (options: Options) => import("./client").RequestResult; /** * Find missing attributes for all related edges (findAllRelatedEdgesMissingAttributes) * * Returns list of attribute names of all related edges that are missing in the integration configuration. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const findAllRelatedEdgesMissingAttributes: (options: Options) => import("./client").RequestResult; /** * Find edge missing attributes for assigned integrations (findEdgeMissingAttributes) * * Returns list of edge attribute names that are missing in assigned integrations. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const findEdgeMissingAttributes: (options: Options) => import("./client").RequestResult; /** * Get Edge Upgrade Instructions (getEdgeUpgradeInstructions) * * Get an upgrade instructions for provided edge version.If the user has the authority of 'Tenant Administrator', the server checks that the edge is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the edge is assigned to the same customer. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getEdgeUpgradeInstructions: (options: Options) => import("./client").RequestResult; /** * Get Edge Install Instructions (getEdgeInstallInstructions) * * Get an install instructions for provided edge id.If the user has the authority of 'Tenant Administrator', the server checks that the edge is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the edge is assigned to the same customer. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getEdgeInstallInstructions: (options: Options) => import("./client").RequestResult; /** * Get Edge Info (getEdgeInfoById) * * Get the Edge info object based on the provided Edge Id. If the user has the authority of 'Tenant Administrator', the server checks that the edge is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the edge is assigned to the same customer. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getEdgeInfoById: (options: Options) => import("./client").RequestResult; /** * Get Domain infos (getDomainInfos) * * * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getDomainInfos: (options: Options) => import("./client").RequestResult; /** * Get Domain info by Id (getDomainInfoById) * * * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getDomainInfoById: (options: Options) => import("./client").RequestResult; /** * Count devices by device profile (countByDeviceProfileAndEmptyOtaPackage) * * The platform gives an ability to load OTA (over-the-air) packages to devices. It can be done in two different ways: device scope or device profile scope.In the response you will find the number of devices with specified device profile, but without previously defined device scope OTA package. It can be useful when you want to define number of devices that will be affected with future OTA package * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const countByDeviceGroupAndEmptyOtaPackage: (options: Options) => import("./client").RequestResult; /** * Count devices by device profile (countByDeviceProfileAndEmptyOtaPackage) * * The platform gives an ability to load OTA (over-the-air) packages to devices. It can be done in two different ways: device scope or device profile scope.In the response you will find the number of devices with specified device profile, but without previously defined device scope OTA package. It can be useful when you want to define number of devices that will be affected with future OTA package * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const countByDeviceProfileAndEmptyOtaPackage: (options: Options) => import("./client").RequestResult; /** * Get Device Profiles (getDeviceProfiles) * * Returns a page of devices profile objects owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getDeviceProfiles: (options: Options) => import("./client").RequestResult; /** * Get Device Profiles By Ids (getDeviceProfilesByIds) * * Requested device profiles must be owned by tenant which is performing the request. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getDeviceProfileInfos: (options: Options) => import("./client").RequestResult; /** * Get Device Profile Info (getDeviceProfileInfoById) * * Fetch the Device Profile Info object based on the provided Device Profile Id. Device Profile Info is a lightweight object that includes main information about Device Profile excluding the heavyweight configuration object. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getDeviceProfileInfoById: (options: Options) => import("./client").RequestResult; /** * Get Default Device Profile (getDefaultDeviceProfileInfo) * * Fetch the Default Device Profile Info object. Device Profile Info is a lightweight object that includes main information about Device Profile excluding the heavyweight configuration object. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getDefaultDeviceProfileInfo: (options?: Options) => import("./client").RequestResult; /** * Delete device profile (deleteDeviceProfile) * * Deletes the device profile. Referencing non-existing device profile Id will cause an error. Can't delete the device profile if it is referenced by existing devices. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const deleteDeviceProfile: (options: Options) => import("./client").RequestResult; /** * Get Device Profile (getDeviceProfileById) * * Fetch the Device Profile object based on the provided Device Profile Id. The server checks that the device profile is owned by the same tenant. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getDeviceProfileById: (options: Options) => import("./client").RequestResult; /** * Get Device Profile names (getDeviceProfileNames) * * Returns a set of unique device profile names owned by the tenant. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getDeviceProfileNames: (options?: Options) => import("./client").RequestResult; /** * Get time series keys (getTimeseriesKeys) * * Get a set of unique time series keys used by devices that belong to specified profile. If profile is not set returns a list of unique keys among all profiles. The call is used for auto-complete in the UI forms. The implementation limits the number of devices that participate in search to 100 as a trade of between accurate results and time-consuming queries. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getTimeseriesKeys1: (options?: Options) => import("./client").RequestResult; /** * Get attribute keys (getAttributesKeys) * * Get a set of unique attribute keys used by devices that belong to specified profile. If profile is not set returns a list of unique keys among all profiles. The call is used for auto-complete in the UI forms. The implementation limits the number of devices that participate in search to 100 as a trade of between accurate results and time-consuming queries. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getAttributesKeys: (options?: Options) => import("./client").RequestResult; /** * Get All Device Infos for current user (getAllDeviceInfos) * * Returns a page of device info objects owned by the tenant or the customer of a current user. Device Info is an extension of the default Device object that contains information about the owner name. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllDeviceInfos: (options: Options) => import("./client").RequestResult; export declare const getFirmwareById: (options: Options) => import("./client").RequestResult; /** * Delete device (deleteDevice) * * Deletes the device, it's credentials and all the relations (from and to the device). Referencing non-existing device Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteDevice: (options: Options) => import("./client").RequestResult; /** * Get Device (getDeviceById) * * Fetch the Device object based on the provided Device Id. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getDeviceById: (options: Options) => import("./client").RequestResult; /** * Get Device Credentials (getDeviceCredentialsByDeviceId) * * If during device creation there wasn't specified any credentials, platform generates random 'ACCESS_TOKEN' credentials. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ_CREDENTIALS' permission for the entity (entities). */ export declare const getDeviceCredentialsByDeviceId: (options: Options) => import("./client").RequestResult; /** * Get Device Types (getDeviceTypes) * * Deprecated. See 'getDeviceProfileNames' API from Device Profile Controller instead. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. * * @deprecated */ export declare const getDeviceTypes: (options?: Options) => import("./client").RequestResult; /** * Get Device (getDeviceInfoById) * * Fetch the Device info object based on the provided Device Id. Device Info is an extension of the default Device object that contains information about the owner name. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getDeviceInfoById: (options: Options) => import("./client").RequestResult; /** * Download server certificate using file path defined in device.connectivity properties (downloadServerCertificate) * * Download server certificate. */ export declare const downloadServerCertificate: (options: Options) => import("./client").RequestResult; /** * Get commands to publish device telemetry (getDevicePublishTelemetryCommands) * * Fetch the list of commands to publish device telemetry based on device profile If the user has the authority of 'Tenant Administrator', the server checks that the device is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the device is assigned to the same customer. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getDevicePublishTelemetryCommands: (options: Options) => import("./client").RequestResult; /** * Download generated docker-compose.yml file for gateway (downloadGatewayDockerCompose) * * Download generated docker-compose.yml for gateway. */ export declare const downloadGatewayDockerCompose: (options: Options) => import("./client").RequestResult; /** * Get dashboards by Dashboard Ids (getDashboardsByIds) * * Returns a list of DashboardInfo objects based on the provided ids. Filters the list based on the user permissions. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getDashboardsByIds: (options: Options) => import("./client").RequestResult; /** * Get All Dashboards for current user (getAllDashboards) * * Returns a page of dashboard info objects owned by the tenant or the customer of a current user. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllDashboards: (options: Options) => import("./client").RequestResult; /** * Delete the Dashboard (deleteDashboard) * * Delete the Dashboard. Only users with 'TENANT_ADMIN') authority may delete the dashboards. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const deleteDashboard: (options: Options) => import("./client").RequestResult; /** * Get Dashboard (getDashboardById) * * Get the dashboard based on 'dashboardId' parameter. The Dashboard object is a heavyweight object that contains information about the dashboard (e.g. title, image, assigned customers) and also configuration JSON (e.g. layouts, widgets, entity aliases). * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getDashboardById: (options: Options) => import("./client").RequestResult; /** * Get server time (getServerTime) * * Get the server time (milliseconds since January 1, 1970 UTC). Used to adjust view of the dashboards according to the difference between browser and server time. */ export declare const getServerTime: (options?: Options) => import("./client").RequestResult; /** * Get max data points limit (getMaxDatapointsLimit) * * Get the maximum number of data points that dashboard may request from the server per in a single subscription command. This value impacts the time window behavior. It impacts 'Max values' parameter in case user selects 'None' as 'Data aggregation function'. It also impacts the 'Grouping interval' in case of any other 'Data aggregation function' is selected. The actual value of the limit is configurable in the system configuration file. */ export declare const getMaxDatapointsLimit: (options?: Options) => import("./client").RequestResult; /** * Get Dashboard Info (getDashboardInfoById) * * Get the information about the dashboard based on 'dashboardId' parameter. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. */ export declare const getDashboardInfoById: (options: Options) => import("./client").RequestResult; /** * Get Home Dashboard (getHomeDashboard) * * Returns the home dashboard object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the User. If 'homeDashboardId' parameter is not set on the User level and the User has authority 'CUSTOMER_USER', check the same parameter for the corresponding Customer. If 'homeDashboardId' parameter is not set on the User and Customer levels then checks the same parameter for the Tenant that owns the user. The Dashboard object is a heavyweight object that contains information about the dashboard (e.g. title, image, assigned customers) and also configuration JSON (e.g. layouts, widgets, entity aliases). * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getHomeDashboard: (options?: Options) => import("./client").RequestResult; /** * Get Home Dashboard Info (getHomeDashboardInfo) * * Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the User. If 'homeDashboardId' parameter is not set on the User level and the User has authority 'CUSTOMER_USER', check the same parameter for the corresponding Customer. If 'homeDashboardId' parameter is not set on the User and Customer levels then checks the same parameter for the Tenant that owns the user. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getHomeDashboardInfo: (options?: Options) => import("./client").RequestResult; /** * Get customers by Customer Ids (getCustomersByEntityGroupId) * * Returns a list of Customer objects based on the provided ids. Filters the list based on the user permissions. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomers: (options: Options) => import("./client").RequestResult; /** * Get All Customer Infos for current user (getAllCustomerInfos) * * Returns a page of customer info objects owned by the tenant or the customer of a current user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllCustomerInfos: (options: Options) => import("./client").RequestResult; /** * Delete Customer (deleteCustomer) * * Deletes the Customer and all customer Users. All assigned Dashboards, Assets, Devices, etc. will be unassigned but not deleted. Referencing non-existing Customer Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteCustomer: (options: Options) => import("./client").RequestResult; /** * Get Customer (getCustomerById) * * Get the Customer object based on the provided Customer Id. If the user has the authority of 'Tenant Administrator', the server checks that the customer is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the user belongs to the customer. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerById: (options: Options) => import("./client").RequestResult; /** * Get Customer Users (getCustomerUsers) * * Returns a page of users owned by customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerUsers: (options: Options) => import("./client").RequestResult; /** * Get Customer user Infos (getCustomerUserInfos) * * Returns a page of user info objects owned by the specified customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerUserInfos: (options: Options) => import("./client").RequestResult; /** * Get Customer Title (getCustomerTitleById) * * Get the title of the customer. If the user has the authority of 'Tenant Administrator', the server checks that the customer is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the user belongs to the customer. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerTitleById: (options: Options) => import("./client").RequestResult; /** * Get short Customer info (getShortCustomerInfoById) * * Get the short customer object that contains only the title and 'isPublic' flag. If the user has the authority of 'Tenant Administrator', the server checks that the customer is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the user belongs to the customer. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getShortCustomerInfoById: (options: Options) => import("./client").RequestResult; /** * Get Customer Entity Views (getCustomerEntityViews) * * Returns a page of Entity View objects assigned to customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getCustomerEntityViews: (options: Options) => import("./client").RequestResult; /** * Get Customer Entity View Infos (getCustomerEntityViewInfos) * * Returns a page of entity view info objects owned by the specified customer. Entity Views Info extends the Entity View with owner name. Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerEntityViewInfos: (options: Options) => import("./client").RequestResult; /** * Get Customer Edges (getCustomerEdges) * * Returns a page of edges objects assigned to customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getCustomerEdges: (options: Options) => import("./client").RequestResult; /** * Get Customer Edge Infos (getCustomerEdgeInfos) * * Returns a page of edge info objects owned by the specified customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerEdgeInfos: (options: Options) => import("./client").RequestResult; /** * Get Customer Devices (getCustomerDevices) * * Returns a page of devices objects assigned to customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerDevices: (options: Options) => import("./client").RequestResult; /** * Get Customer Device Infos (getCustomerDeviceInfos) * * Returns a page of device info objects owned by the specified customer. Device Info is an extension of the default Device object that contains information about the owner name. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerDeviceInfos: (options: Options) => import("./client").RequestResult; /** * Get Customer Dashboards (getCustomerDashboards) * * Returns a page of dashboard info objects owned by the specified customer. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerDashboards: (options: Options) => import("./client").RequestResult; /** * Get Customer sub-customers Infos (getCustomerCustomerInfos) * * Returns a page of customer info objects owned by the specified customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerCustomerInfos: (options: Options) => import("./client").RequestResult; /** * Get Customer Assets (getCustomerAssets) * * Returns a page of assets objects owned by customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerAssets: (options: Options) => import("./client").RequestResult; /** * Get Customer Asset Infos (getCustomerAssetInfos) * * Returns a page of asset info objects owned by the specified customer. Asset Info is an extension of the default Asset object that contains information about the owner name. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerAssetInfos: (options: Options) => import("./client").RequestResult; /** * Get Customer Users (getCustomerUsers) * * Returns a page of users for the current tenant with authority 'CUSTOMER_USER'. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllCustomerUsers: (options: Options) => import("./client").RequestResult; /** * Get Customer info (getCustomerInfoById) * * Get the Customer info object based on the provided Customer Id. If the user has the authority of 'Tenant Administrator', the server checks that the customer is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the user belongs to the customer. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getCustomerInfoById: (options: Options) => import("./client").RequestResult; /** * Get Custom Menu Info (getCustomMenuInfoById) * * Fetch the Custom Menu Info object based on the provided Custom Menu Id. * * Security check is performed to verify that the user has 'READ' permission for the custom menu with specified id. */ export declare const getCustomMenuInfoById: (options: Options) => import("./client").RequestResult; /** * Get Custom Menu assignee list (getCustomMenuAssigneeList) * * Fetch the list of Entity Info objects that represents users or customers, or empty list if custom menu is not assigned or has NO_ASSIGN/ALL assignee type. * * Security check is performed to verify that the user has 'READ' permission for the custom menu with specified id. */ export declare const getCustomMenuAssigneeList: (options: Options) => import("./client").RequestResult; /** * Get all custom menus configured at user level (getCustomMenuInfos) * * Returns a page of custom menu info objects owned by the tenant or the customer of a current user, scope and assigneeType request parameters can be used to filter the result. * * Security check is performed to verify that the user has 'READ' permission for the white labeling resource. */ export declare const getCustomMenuInfos: (options: Options) => import("./client").RequestResult; /** * Get Converters By Ids (getConvertersByIds) * * Requested converters must be owned by tenant which is performing the request. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getConverters: (options: Options) => import("./client").RequestResult; /** * Delete converter (deleteConverter) * * Deletes the converter and all the relations (from and to the converter). Referencing non-existing converter Id will cause an error. If the converter is associated with the integration, it will not be allowed for deletion. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteConverter: (options: Options) => import("./client").RequestResult; /** * Get Converter (getConverterById) * * Fetch the Converter object based on the provided Converter Id. The server checks that the converter is owned by the same tenant. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getConverterById: (options: Options) => import("./client").RequestResult; /** * Get latest debug input event (getLatestConverterDebugInput) * * Returns a JSON object of the latest debug event representing the input message the converter processed. * * ## Uplink Converter Debug Input Event Example * * ```json * { * "inContentType":"JSON", * "inContent":"{\"temp\":40}", * "inMetadata":"{\"Header:sec-ch-ua\":\"\\\"Chromium\\\";v=\\\"94\\\", \\\"Google Chrome\\\";v=\\\"94\\\", \\\";Not A Brand\\\";v=\\\"99\\\"\",\"Header:user-agent\":\"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.71 Safari/537.36\",\"integrationName\":\"Integration\",\"Header:cookie\":\"GUID=zYSs8hymSwZKv8kHALKY; redirect_to=%2F; JSESSIONID=B0A7C8E481409CE7924E738DB04F62F9\",\"Header:sec-ch-ua-platform\":\"\\\"Linux\\\"\",\"Header:accept\":\"**\",\"Header:origin\":\"http://localhost:8080\",\"Header:sec-fetch-site\":\"same-origin\",\"Header:connection\":\"keep-alive\",\"Header:accept-encoding\":\"gzip, deflate, br\",\"Header:content-type\":\"application/json\",\"Header:content-length\":\"16\",\"Header:sec-fetch-mode\":\"cors\",\"Header:sec-ch-ua-mobile\":\"?0\",\"Header:sec-fetch-dest\":\"empty\",\"Header:host\":\"localhost:8080\",\"Header:referer\":\"http://localhost:8080/swagger-ui.html\",\"Header:accept-language\":\"en-US,en;q=0.9,ru-RU;q=0.8,ru;q=0.7,uk;q=0.6,und;q=0.5\"}" * } * ``` * * * 'inContentType' - content type of the message received by the integration; * * 'inContent' - message data received; * * 'inMetadata' - integration metadata (e.g. headers). * * ## Downlink Converter Debug Input Event Example * * ```json * { * "inContentType":"JSON", * "inContent":"{\"temp\":42,\"humidity\":77}", * "inMsgType":"POST_TELEMETRY_REQUEST", * "inMetadata":"{\"data\":\"40\"}", * "inIntegrationMetadata":"{\"integrationName\":\"Integration\"}" * } * ``` * * * 'inContentType' - content type of the message received by the integration; * * 'inContent' - content of the message pushed from the rule engine; * * 'inMsgType' - type of the message pushed from the rule engine; * * 'inMetadata' - content of the message metadata pushed from the rule engine; * * 'inIntegrationMetadata' - integration metadata. * * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getLatestConverterDebugInput: (options: Options) => import("./client").RequestResult; /** * Get uplink converter (getUplinkConverter) * * Returns uplink converter body for the vendor, integration type and model */ export declare const getUplinkConverter: (options: Options) => import("./client").RequestResult; /** * Get uplink payload (getUplinkPayload) * * Returns payload example for the uplink converter for the vendor, integration type and model */ export declare const getUplinkPayload: (options: Options) => import("./client").RequestResult; /** * Get uplink converter metadata (getUplinkConverterMetadata) * * Returns uplink converter metadata for the vendor, integration type and model */ export declare const getUplinkConverterMetadata: (options: Options) => import("./client").RequestResult; /** * Get downlink converter (getDownlinkConverter) * * Returns downlink converter body for the vendor, integration type and model */ export declare const getDownlinkConverter: (options: Options) => import("./client").RequestResult; /** * Get downlink payload (getDownlinkPayload) * * Returns payload example for the downlink converter for the vendor, integration type and model */ export declare const getDownlinkPayload: (options: Options) => import("./client").RequestResult; /** * Get downlink converter metadata (getDownlinkConverterMetadata) * * Returns downlink converter metadata for the vendor, integration type and model */ export declare const getDownlinkConverterMetadata: (options: Options) => import("./client").RequestResult; /** * Get vendor models (getVendorModels) * * Returns a list of models for the vendor, integration type and converter type */ export declare const getVendorModels: (options: Options) => import("./client").RequestResult; /** * Get vendors (getVendors) * * Returns a list of vendors for the integration type */ export declare const getVendors: (options: Options) => import("./client").RequestResult; /** * Get Component Descriptors (getComponentDescriptorsByTypes) * * Gets the Component Descriptors using coma separated list of rule node types and optional rule chain type request parameters. Each Component Descriptor represents configuration of specific rule node (e.g. 'Save Timeseries' or 'Send Email'.). The Component Descriptors are used by the rule chain Web UI to build the configuration forms for the rule nodes. The Component Descriptors are discovered at runtime by scanning the class path and searching for @RuleNode annotation. Once discovered, the up to date list of descriptors is persisted to the database. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getComponentDescriptorsByTypes: (options: Options) => import("./client").RequestResult; /** * Get Component Descriptors (getComponentDescriptorsByType) * * Gets the Component Descriptors using rule node type and optional rule chain type request parameters. Each Component Descriptor represents configuration of specific rule node (e.g. 'Save Timeseries' or 'Send Email'.). The Component Descriptors are used by the rule chain Web UI to build the configuration forms for the rule nodes. The Component Descriptors are discovered at runtime by scanning the class path and searching for @RuleNode annotation. Once discovered, the up to date list of descriptors is persisted to the database. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getComponentDescriptorsByType: (options: Options) => import("./client").RequestResult; /** * Get Component Descriptor (getComponentDescriptorByClazz) * * Gets the Component Descriptor object using class name from the path parameters. Each Component Descriptor represents configuration of specific rule node (e.g. 'Save Timeseries' or 'Send Email'.). The Component Descriptors are used by the rule chain Web UI to build the configuration forms for the rule nodes. The Component Descriptors are discovered at runtime by scanning the class path and searching for @RuleNode annotation. Once discovered, the up to date list of descriptors is persisted to the database. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const getComponentDescriptorByClazz: (options: Options) => import("./client").RequestResult; /** * Get calculated fields (getCalculatedFields) * * Fetch tenant calculated fields based on the filter. */ export declare const getCalculatedFields: (options: Options) => import("./client").RequestResult; /** * Get calculated field names (getCalculatedFieldNames) * * Fetch the list of calculated field names for specified type. */ export declare const getCalculatedFieldNames: (options: Options) => import("./client").RequestResult; /** * Delete Calculated Field (deleteCalculatedField) * * Deletes the calculated field. Referencing non-existing Calculated Field Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const deleteCalculatedField: (options: Options) => import("./client").RequestResult; /** * Get Calculated Field (getCalculatedFieldById) * * Fetch the Calculated Field object based on the provided Calculated Field Id. */ export declare const getCalculatedFieldById: (options: Options) => import("./client").RequestResult; /** * Reprocess Calculated Field (reprocessCalculatedField) * * Reprocesses the calculated field. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const reprocessCalculatedField: (options: Options) => import("./client").RequestResult; /** * Validate reprocessing capability of a calculated field (validateCalculatedFieldReprocessing) * * Checks whether the specified calculated field can be reprocessed. Returns a validation result indicating if reprocessing is allowed and, if not, provides a reason. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const validateCalculatedFieldReprocessing: (options: Options) => import("./client").RequestResult; export declare const getLastCalculatedFieldReprocessingJob: (options: Options) => import("./client").RequestResult; /** * Get latest calculated field debug event (getLatestCalculatedFieldDebugEvent) * * Gets latest calculated field debug event for specified calculated field id. Referencing non-existing calculated field id will cause an error. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getLatestCalculatedFieldDebugEvent: (options: Options) => import("./client").RequestResult; /** * Download Blob Entity By Id (downloadBlobEntity) * * Download report file based on the provided Blob entity Id. Referencing non-existing Blob entity Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const downloadBlobEntity: (options: Options) => import("./client").RequestResult; /** * Get Blob Entity With Customer Info (getBlobEntityInfoById) * * Fetch the BlobEntityWithCustomerInfo object based on the provided Blob entity Id. The platform uses Blob(binary large object) entities in the reporting feature, in order to store Dashboard states snapshots of different content types in base64 format. BlobEntityWithCustomerInfo represents an object that contains base info about the blob entity(name, type, contentType, etc.) and info about the customer(customerTitle, customerIsPublic) of the user that scheduled generation of the dashboard report. Referencing non-existing Blob entity Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getBlobEntityInfoById: (options: Options) => import("./client").RequestResult; /** * Get Blob Entities By Ids (getBlobEntitiesByIds) * * Requested blob entities must be owned by tenant or assigned to customer which user is performing the request. The platform uses Blob(binary large object) entities in the reporting feature, in order to store Dashboard states snapshots of different content types in base64 format. BlobEntityInfo represents an object that contains base info about the blob entity(name, type, contentType, etc.). See the 'Model' tab of the Response Class for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getBlobEntities: (options: Options) => import("./client").RequestResult; /** * Get current User (getUser) * * Get the information about the User which credentials are used to perform this REST API call. */ export declare const getUser: (options?: Options) => import("./client").RequestResult; /** * Get available 2FA providers (getAvailableTwoFaProviders) * * Get the list of 2FA provider infos available for user to use. Example: * ``` * [ * { * "type": "EMAIL", * "default": true, * "contact": "ab*****ko@gmail.com" * }, * { * "type": "TOTP", * "default": false, * "contact": null * }, * { * "type": "SMS", * "default": false, * "contact": "+38********12" * } * ] * ``` */ export declare const getAvailableTwoFaProviders: (options?: Options) => import("./client").RequestResult; /** * Get all audit logs (getAuditLogs) * * Returns a page of audit logs related to all entities in the scope of the current user's Tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the audit logs. */ export declare const getAuditLogs: (options: Options) => import("./client").RequestResult; /** * Get audit logs by user id (getAuditLogsByUserId) * * Returns a page of audit logs related to the actions of targeted user. For example, RPC call to a particular device, or alarm acknowledgment for a specific device, etc. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the audit logs. */ export declare const getAuditLogsByUserId: (options: Options) => import("./client").RequestResult; /** * Get audit logs by entity id (getAuditLogsByEntityId) * * Returns a page of audit logs related to the actions on the targeted entity. Basically, this API call is used to get the full lifecycle of some specific entity. For example to see when a device was created, updated, assigned to some customer, or even deleted from the system. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the audit logs. */ export declare const getAuditLogsByEntityId: (options: Options) => import("./client").RequestResult; /** * Get audit logs by customer id (getAuditLogsByCustomerId) * * Returns a page of audit logs related to the targeted customer entities (devices, assets, etc.), and users actions (login, logout, etc.) that belong to this customer. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the audit logs. */ export declare const getAuditLogsByCustomerId: (options: Options) => import("./client").RequestResult; /** * Get Asset Profiles (getAssetProfiles) * * Returns a page of asset profile objects owned by tenant. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getAssetProfiles: (options: Options) => import("./client").RequestResult; /** * Get Asset Profiles By Ids (getAssetProfilesByIds) * * Requested asset profiles must be owned by tenant which is performing the request. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAssetProfileInfos: (options: Options) => import("./client").RequestResult; /** * Get Asset Profile Info (getAssetProfileInfoById) * * Fetch the Asset Profile Info object based on the provided Asset Profile Id. Asset Profile Info is a lightweight object that includes main information about Asset Profile. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getAssetProfileInfoById: (options: Options) => import("./client").RequestResult; /** * Get Default Asset Profile (getDefaultAssetProfileInfo) * * Fetch the Default Asset Profile Info object. Asset Profile Info is a lightweight object that includes main information about Asset Profile. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getDefaultAssetProfileInfo: (options?: Options) => import("./client").RequestResult; /** * Delete asset profile (deleteAssetProfile) * * Deletes the asset profile. Referencing non-existing asset profile Id will cause an error. Can't delete the asset profile if it is referenced by existing assets. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const deleteAssetProfile: (options: Options) => import("./client").RequestResult; /** * Get Asset Profile (getAssetProfileById) * * Fetch the Asset Profile object based on the provided Asset Profile Id. The server checks that the asset profile is owned by the same tenant. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getAssetProfileById: (options: Options) => import("./client").RequestResult; /** * Get Asset Profile names (getAssetProfileNames) * * Returns a set of unique asset profile names owned by the tenant. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const getAssetProfileNames: (options?: Options) => import("./client").RequestResult; /** * Get All Asset Infos for current user (getAllAssetInfos) * * Returns a page of asset info objects owned by the tenant or the customer of a current user. Asset Info is an extension of the default Asset object that contains information about the owner name. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllAssetInfos: (options: Options) => import("./client").RequestResult; /** * Delete asset (deleteAsset) * * Deletes the asset and all the relations (from and to the asset). Referencing non-existing asset Id will cause an error. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteAsset: (options: Options) => import("./client").RequestResult; /** * Get Asset (getAssetById) * * Fetch the Asset object based on the provided Asset Id. If the user has the authority of 'Tenant Administrator', the server checks that the asset is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the asset is assigned to the same customer. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAssetById: (options: Options) => import("./client").RequestResult; /** * Get Asset Types (getAssetTypes) * * Deprecated. See 'getAssetProfileNames' API from Asset Profile Controller instead. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. * * @deprecated */ export declare const getAssetTypes: (options?: Options) => import("./client").RequestResult; /** * Get Asset Info (getAssetInfoById) * * Fetch the Asset Info object based on the provided Asset Id. If the user has the authority of 'Tenant Administrator', the server checks that the asset is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the asset is assigned to the same customer.Asset Info is an extension of the default Asset object that contains information about the owner name. * * Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAssetInfoById: (options: Options) => import("./client").RequestResult; /** * Get User Api Keys (getUserApiKeys) * * Returns a page of api keys owned by user. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for any authorized user. */ export declare const getUserApiKeys: (options: Options) => import("./client").RequestResult; /** * Get All Edge Entity Groups by entity type (getAllEdgeEntityGroups) * * Fetch the list of Entity Group Info objects based on the provided Entity Type and assigned to the provided Edge entity. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllEdgeEntityGroups: (options: Options) => import("./client").RequestResult; /** * Get All Alarms (getAllAlarms) * * Returns a page of alarms that belongs to the current user owner. If the user has the authority of 'Tenant Administrator', the server returns alarms that belongs to the tenant of current user. If the user has the authority of 'Customer User', the server returns alarms that belongs to the customer of current user. Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAllAlarms: (options: Options) => import("./client").RequestResult; /** * Get Alarms (getAlarms) * * Returns a page of alarms for the selected entity. Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAlarms: (options: Options) => import("./client").RequestResult; /** * Delete Alarm (deleteAlarm) * * Deletes the Alarm. Referencing non-existing Alarm Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteAlarm: (options: Options) => import("./client").RequestResult; /** * Get Alarm (getAlarmById) * * Fetch the Alarm object based on the provided Alarm Id. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAlarmById: (options: Options) => import("./client").RequestResult; /** * Get Alarm Types (getAlarmTypes) * * Returns a set of unique alarm types based on alarms that are either owned by the tenant or assigned to the customer which user is performing the request. */ export declare const getAlarmTypes: (options: Options) => import("./client").RequestResult; /** * Get Alarm Info (getAlarmInfoById) * * Fetch the Alarm Info object based on the provided Alarm Id. Alarm Info is an extension of the default Alarm object that also contains name of the alarm originator. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getAlarmInfoById: (options: Options) => import("./client").RequestResult; /** * Get Highest Alarm Severity (getHighestAlarmSeverity) * * Search the alarms by originator ('entityType' and entityId') and optional 'status' or 'searchStatus' filters and returns the highest AlarmSeverity(CRITICAL, MAJOR, MINOR, WARNING or INDETERMINATE). Specifying both parameters 'searchStatus' and 'status' at the same time will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). */ export declare const getHighestAlarmSeverity: (options: Options) => import("./client").RequestResult; /** * Delete AI model by ID (deleteAiModelById) * * Deletes the AI model record by its `id`. If a record with the specified `id` exists, the record is deleted and the endpoint returns `true`. If no such record exists, the endpoint returns `false`. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const deleteAiModelById: (options: Options) => import("./client").RequestResult; /** * Get AI model by ID (getAiModelById) * * Fetches an AI model record by its `id`. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const getAiModelById: (options: Options) => import("./client").RequestResult; /** * Check for new Platform Releases (checkUpdates) * * Check notifications about new platform releases. * * Available for users with 'SYS_ADMIN' authority. */ export declare const checkUpdates: (options?: Options) => import("./client").RequestResult; /** * Get system info (getSystemInfo) * * Get main information about system. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getSystemInfo: (options?: Options) => import("./client").RequestResult; /** * Get subscription info (getSubscriptionInfo) * * Get subscription info. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getSubscriptionInfo: (options?: Options) => import("./client").RequestResult; /** * Get the Administration Settings object using key (getAdminSettings) * * Get the Administration Settings object using specified string key. Referencing non-existing key will cause an error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. * * Security check is performed to verify that the user has 'READ' permission for the 'ADMIN_SETTINGS' (for 'SYS_ADMIN' authority) or 'WHITE_LABELING' (for 'TENANT_ADMIN' authority) resource. */ export declare const getAdminSettings: (options: Options) => import("./client").RequestResult; export declare const getRepositorySettingsInfo: (options?: Options) => import("./client").RequestResult; /** * Check repository settings exists (repositorySettingsExists) * * Check whether the repository settings exists. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const repositorySettingsExists: (options?: Options) => import("./client").RequestResult; /** * Get OAuth2 log in processing URL (getMailProcessingUrl) * * Returns the URL enclosed in double quotes. After successful authentication with OAuth2 provider and user consent for requested scope, it makes a redirect to this path so that the platform can do further log in processing and generating access tokens. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getMailProcessingUrl: (options?: Options) => import("./client").RequestResult; export declare const codeProcessingUrl: (options: Options) => import("./client").RequestResult; /** * Redirect user to mail provider login page. * * After user logged in and provided accessprovider sends authorization code to specified redirect uri.) */ export declare const getAuthorizationUrl: (options?: Options) => import("./client").RequestResult; /** * Get license usage info (getLicenseUsageInfo) * * Get license usage info. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getLicenseUsageInfo: (options?: Options) => import("./client").RequestResult; /** * Get features info (getFeaturesInfo) * * Get information about enabled/disabled features. * * Available for users with 'SYS_ADMIN' authority. */ export declare const getFeaturesInfo: (options?: Options) => import("./client").RequestResult; /** * Check auto commit settings exists (autoCommitSettingsExists) * * Check whether the auto commit settings exists. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const autoCommitSettingsExists: (options?: Options) => import("./client").RequestResult; /** * Get available 2FA providers (getAvailableTwoFaProviders) * * Get the list of provider types available for user to use (the ones configured by tenant or sysadmin). * Example of response: * ``` * [ * "TOTP", * "EMAIL", * "SMS" * ] * ``` * * Available for any authorized user. */ export declare const getAvailableTwoFaProviders1: (options?: Options) => import("./client").RequestResult; /** * Get account 2FA settings (getAccountTwoFaSettings) * * Get user's account 2FA configuration. Configuration contains configs for different 2FA providers. * * Example: * ``` * { * "configs": { * "EMAIL": { * "providerType": "EMAIL", * "useByDefault": true, * "email": "tenant@thingsboard.org" * }, * "TOTP": { * "providerType": "TOTP", * "useByDefault": false, * "authUrl": "otpauth://totp/TB%202FA:tenant@thingsboard.org?issuer=TB+2FA&secret=P6Z2TLYTASOGP6LCJZAD24ETT5DACNNX" * }, * "SMS": { * "providerType": "SMS", * "useByDefault": false, * "phoneNumber": "+380501253652" * } * } * } * ``` * * Available for any authorized user. */ export declare const getAccountTwoFaSettings: (options?: Options) => import("./client").RequestResult; /** * Get associated android applications (getAssetLinks) */ export declare const getAssetLinks: (options?: Options) => import("./client").RequestResult; /** * Get associated ios applications (getAppleAppSiteAssociation) */ export declare const getAppleAppSiteAssociation: (options?: Options) => import("./client").RequestResult; /** * Delete user settings (deleteUserSettings) * * Delete user settings by specifying list of json element xpaths. * Example: to delete B and C element in { "A": {"B": 5}, "C": 15} send A.B,C in jsonPaths request parameter */ export declare const deleteUserSettings: (options: Options) => import("./client").RequestResult; /** * Delete user settings (deleteUserSettings) * * Delete user settings by specifying list of json element xpaths. * Example: to delete B and C element in { "A": {"B": 5}, "C": 15} send A.B,C in jsonPaths request parameter */ export declare const deleteUserSettings1: (options: Options) => import("./client").RequestResult; /** * Delete specified key of Custom Translation (deleteCustomTranslationKey) * * The API call is designed to delete specified key of the custom translation and return as a result parent translation.(e.g. if tenant translation for key is 'value1' and customer translation is 'value2' then by deletinf key onn customer level you will get 'value1' in response) * * Security check is performed to verify that the user has 'WRITE' permission for the white labeling resource. */ export declare const deleteCustomTranslationKey: (options: Options) => import("./client").RequestResult; /** * Uninstall Solution Template (uninstallSolutionTemplate) * * Uninstall solution template based on the provided id * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const uninstallSolutionTemplate: (options: Options) => import("./client").RequestResult; /** * Delete secret by ID (deleteSecret) * * Deletes the secret. Referencing non-existing Secret Id will cause an error. * * Available for users with 'TENANT_ADMIN' authority. */ export declare const deleteSecret: (options: Options) => import("./client").RequestResult; /** * Delete entity time series data (deleteEntityTimeseries) * * Delete time series for selected entity based on entity id, entity type and keys. Use 'deleteAllDataForKeys' to delete all time series data. Use 'startTs' and 'endTs' to specify time-range instead. Use 'deleteLatest' to delete latest value (stored in separate table for performance) if the value's timestamp matches the time-range. Use 'rewriteLatestIfDeleted' to rewrite latest value (stored in separate table for performance) if the value's timestamp matches the time-range and 'deleteLatest' param is true. The replacement value will be fetched from the 'time series' table, and its timestamp will be the most recent one before the defined time-range. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const deleteEntityTimeseries: (options: Options) => import("./client").RequestResult; /** * Delete OAuth2 client registration template by id (deleteClientRegistrationTemplate) * * Available for users with 'SYS_ADMIN' authority. * * Client registration template is OAuth2 provider configuration template with default settings for registering new OAuth2 clients */ export declare const deleteClientRegistrationTemplate: (options: Options) => import("./client").RequestResult; /** * Delete notification (deleteNotification) * * Deletes notification by its id. * * Available for any authorized user. */ export declare const deleteNotification: (options: Options) => import("./client").RequestResult; /** * Delete Mobile App Bundle by ID (deleteMobileAppBundle) * * Deletes Mobile App Bundle by ID. Referencing non-existing mobile app bundle Id will cause an error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority. */ export declare const deleteMobileAppBundle: (options: Options) => import("./client").RequestResult; /** * Delete Domain by ID (deleteDomain) * * Deletes Domain by ID. Referencing non-existing domain Id will cause an error. * * Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const deleteDomain: (options: Options) => import("./client").RequestResult; export declare const deleteDeviceGroupOtaPackage: (options: Options) => import("./client").RequestResult; /** * Delete custom menu (deleteCustomMenu) * * Deletes the custom menu based on the provided Custom Menu Id. Referencing non-existing custom menu Id will cause an error. If the custom menu is assigned to the list of users or customers bad request is returned.To delete a custom menu that has assignee list set 'force' request param to true */ export declare const deleteCustomMenu: (options: Options) => import("./client").RequestResult; /** * Delete Blob Entity (deleteBlobEntity) * * Delete Blob entity based on the provided Blob entity Id. Referencing non-existing Blob entity Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. * * Security check is performed to verify that the user has 'DELETE' permission for the entity (entities). */ export declare const deleteBlobEntity: (options: Options) => import("./client").RequestResult; /** * Delete API key by ID (deleteApiKey) * * Deletes the API key. Referencing non-existing ApiKey Id will cause an error. * * Available for any authorized user. */ export declare const deleteApiKey: (options: Options) => import("./client").RequestResult; /** * Delete Alarm comment (deleteAlarmComment) * * Deletes the Alarm comment. Referencing non-existing Alarm comment Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const deleteAlarmComment: (options: Options) => import("./client").RequestResult; /** * Unassign Alarm (unassignAlarm) * * Unassign the Alarm. Once unassigned, the 'assign_ts' field will be set to current timestamp and special rule chain event 'ALARM_UNASSIGNED' will be generated. Referencing non-existing Alarm Id will cause an error. * * Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. */ export declare const unassignAlarm: (options: Options) => import("./client").RequestResult; export declare const handleError3: (options?: Options) => import("./client").RequestResult; export declare const handleError: (options?: Options) => import("./client").RequestResult; export declare const handleError5: (options?: Options) => import("./client").RequestResult; export declare const handleError6: (options?: Options) => import("./client").RequestResult; export declare const handleError4: (options?: Options) => import("./client").RequestResult; export declare const handleError1: (options?: Options) => import("./client").RequestResult; export declare const handleError2: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests3: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests5: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests6: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests4: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests1: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests2: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests10: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests7: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests12: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests13: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests11: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests8: (options?: Options) => import("./client").RequestResult; /** * Forward Unauthorized Requests to Trendz * * Forwards unauthorized requests (/apiTrendz/publicApi**, /trendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleUnauthorizedTrendzRequests9: (options?: Options) => import("./client").RequestResult; /** * Forward Authorized Requests to Trendz * * Forwards authorized requests (/apiTrendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleAuthorizedTrendzRequests3: (options?: Options) => import("./client").RequestResult; /** * Forward Authorized Requests to Trendz * * Forwards authorized requests (/apiTrendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleAuthorizedTrendzRequests: (options?: Options) => import("./client").RequestResult; /** * Forward Authorized Requests to Trendz * * Forwards authorized requests (/apiTrendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleAuthorizedTrendzRequests5: (options?: Options) => import("./client").RequestResult; /** * Forward Authorized Requests to Trendz * * Forwards authorized requests (/apiTrendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleAuthorizedTrendzRequests6: (options?: Options) => import("./client").RequestResult; /** * Forward Authorized Requests to Trendz * * Forwards authorized requests (/apiTrendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleAuthorizedTrendzRequests4: (options?: Options) => import("./client").RequestResult; /** * Forward Authorized Requests to Trendz * * Forwards authorized requests (/apiTrendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleAuthorizedTrendzRequests1: (options?: Options) => import("./client").RequestResult; /** * Forward Authorized Requests to Trendz * * Forwards authorized requests (/apiTrendz**) to Trendz using the Trendz internal URL. Can only be used if Trendz is already synchronized and integration is enabled. * * Available for any authorized user. */ export declare const handleAuthorizedTrendzRequests2: (options?: Options) => import("./client").RequestResult; //# sourceMappingURL=sdk.gen.d.ts.map