@espressif/rainmaker-admin-sdk
Enumerations
Section titled “Enumerations”Classes
Section titled “Classes”- ESPBaseError
- ESPRMAdminAPIGateway
- ESPRMAdminAPIInfo
- ESPRMAdminAPIRateLimit
- ESPRMAdminAPIStatistics
- ESPRMAdminCloudwatchLog
- ESPRMAdminCognitoAppClient
- ESPRMAdminCognitoDomain
- ESPRMAdminCommonCustomData
- ESPRMAdminConfiguration
- ESPRMAdminCustomData
- ESPRMAdminCustomMessageTemplate
- ESPRMAdminDashboard
- ESPRMAdminDeploymentCapability
- ESPRMAdminDeploymentDetails
- ESPRMAdminDeploymentSetting
- ESPRMAdminEventFilter
- ESPRMAdminFile
- ESPRMAdminGroup
- ESPRMAdminIdentityProvider
- ESPRMAdminIoTDeviceRateLimit
- ESPRMAdminKey
- ESPRMAdminLicense
- ESPRMAdminLogConfig
- ESPRMAdminMailFailure
- ESPRMAdminMatter
- ESPRMAdminMessageTemplate
- ESPRMAdminMobilePlatform
- ESPRMAdminMQTTStatistics
- ESPRMAdminNode
- ESPRMAdminNodeCertificateCA
- ESPRMAdminNodeParams
- ESPRMAdminNodeRegistration
- ESPRMAdminOTAImage
- ESPRMAdminOTAJob
- ESPRMAdminPassthrough
- ESPRMAdminPolicy
- ESPRMAdminPublishMessage
- ESPRMAdminRole
- ESPRMAdminSecureSign
- ESPRMAdminSenderEmail
- ESPRMAdminStatisticalService
- ESPRMAdminSuperAdmin
- ESPRMAdminTag
- ESPRMAdminTermsPolicy
- ESPRMAdminUser
- ESPRMAdminUserRole
- ESPRMAdminWebhook
- ESPRMAPIManager
- ESPRMAuth
- ESPRMBase
- ESPRMStorage
- ESPRMUser
Interfaces
Section titled “Interfaces”- ActivateDeactivateNodesParams
- AddCloudwatchLogUserRequest
- AddCommandRequestBody
- AddCommandRequestResponse
- AdminGroupInfo
- AdminNodeInfo
- AdminNodeListResponse
- AdminUserInfo
- AdminUserNodeAssociation
- AdminUserNodeHistoryNode
- AdminUserNodeHistoryResponse
- AdminUserNodeHistoryUserEntry
- AdminUserNodesBucket
- AdminUserNodesResponse
- APIPathInfo
- APIStatisticsBucket
- APIStatisticsSeries
- APIStatisticsValuePoint
- ArchiveOTAImageParams
- AttachDetachTagsParams
- ChangePasswordRequest
- CognitoAppClientInfo
- CommandRequestInfo
- ConfirmChangeSenderEmailRequest
- ConfirmChangeSuperAdminRequest
- ConfirmFileUploadRequest
- ConfirmFileUploadResponse
- ConfirmOTAImageUploadRequest
- ConfirmOTAImageUploadResponse
- ConfirmOTAPackageUploadRequest
- ConfirmOTAPackageUploadResponse
- ConfirmUserRequest
- CreateAdminGroupRequest
- CreateAdminGroupResponse
- CreateAdminUserRequest
- CreateCognitoAppClientRequest
- CreateCognitoDomainRequest
- CreateCustomMessageTemplateRequest
- CreateEventFilterRequest
- CreateIdentityProviderRequest
- CreateKeyRequest
- CreateKeyResponse
- CreateMatterAuthRequest
- CreateMatterBatchRequest
- CreateMessageTemplateRequest
- CreateMobilePlatformRequest
- CreateMobilePlatformResponse
- CreateOTAImageRequest
- CreateOTAJobQueryOptions
- CreateOTAJobRequest
- CreatePassthroughConfigRequest
- CreatePassthroughConfigResponse
- CreatePolicyRequest
- CreateRoleRequest
- CreateWebhookIntegrationRequest
- CustomDataResponse
- CustomMessageTemplateInfo
- DeleteAccountParams
- DeleteAdminUserParams
- DeleteCognitoDomainParams
- DeleteCustomMessageTemplateParams
- DeleteEventFilterRequest
- DeleteIdentityProviderParams
- DeleteMessageTemplateParams
- DeleteMobilePlatformParams
- DeleteTermsPolicyParams
- DeleteWebhookEventMappingParams
- DeleteWebhookIntegrationParams
- DeploymentCapabilityInfo
- ESPAPIError
- ESPAPISuccessResponse
- ESPRMAPIManagerConfig
- ESPRMBaseConfig
- ESPRMRequestConfig
- ESPRMStorageAdapterInterface
- EventFilterInfo
- ExtendSessionResponse
- FileDetailInfo
- FileUploadUrlResponse
- ForgotPasswordConfirmRequest
- ForgotPasswordRequest
- GenerateNodeIdsRequest
- GenerateNodeIdsResponse
- GetAdminCustomDataParams
- GetAdminGroupsParams
- GetAdminGroupsResponse
- GetAdminNodesParams
- GetAdminTagsParams
- GetAdminTagsResponse
- GetAdminUserNodeHistoryParams
- GetAdminUserNodesParams
- GetAdminUsersParams
- GetAdminUsersResponse
- GetAdminUserSummaryParams
- GetAdminUserSummaryResponse
- GetAPIPathsParams
- GetAPIRateLimitResponse
- GetAPIStatisticsParams
- GetAPIStatisticsResponse
- GetCognitoAppClientsParams
- GetCognitoDomainParams
- GetCognitoDomainResponse
- GetCommandRequestsParams
- GetCommandRequestsResponse
- GetCommonCustomDataParams
- GetCommonCustomDataResponse
- GetCustomMessageTemplatesParams
- GetCustomMessageTemplatesResponse
- GetDashboardUpdateStatusResponse
- GetDashboardVersionMappingResponse
- GetDeploymentCapabilitiesResponse
- GetDeploymentDetailsParams
- GetDeploymentDetailsResponse
- GetDeploymentSettingsResponse
- GetEventFiltersParams
- GetEventFiltersResponse
- GetFilesParams
- GetFilesResponse
- GetFileUploadUrlParams
- GetIdentityProvidersParams
- GetIdentityProvidersResponse
- GetIoTDeviceRateRuleResponse
- GetKeysParams
- GetKeysResponse
- GetLicenseFileParams
- GetLicenseFileResponse
- GetLicenseQuotaResponse
- GetMailFailuresParams
- GetMailFailuresResponse
- GetMatterBatchNodesParams
- GetMatterBatchNodesResponse
- GetMatterBatchParams
- GetMessageTemplatesParams
- GetMobilePlatformsResponse
- GetMQTTHostResponse
- GetMQTTStatisticsParams
- GetMQTTStatisticsRawResponse
- GetMQTTStatisticsResponse
- GetNodeCACertificateResponse
- GetNodeCertificateRegistrationParams
- GetNodeCertificatesParams
- GetNodeCertificatesResponse
- GetNodeIdsParams
- GetNodeIdsResponse
- GetNodeParamsParams
- GetNodeParamsResponse
- GetNodeTagsParams
- GetNodeTagsResponse
- GetNotificationsParams
- GetNotificationsResponse
- GetOTAImagesParams
- GetOTAImagesResponse
- GetOTAImageUploadUrlParams
- GetOTAJobParams
- GetOTAJobsResponse
- GetOTAJobStatusParams
- GetOTAJobStatusSummaryParams
- GetOTAPackageUploadUrlParams
- GetPassthroughConfigParams
- GetPassthroughConfigResponse
- GetPoliciesParams
- GetPoliciesResponse
- GetRbacDeploymentSettingResponse
- GetRolesParams
- GetRolesResponse
- GetSignedImagesParams
- GetSignedImagesResponse
- GetSigningKeysParams
- GetSigningKeysResponse
- GetSigningStatusResponse
- GetSimpleTimeSeriesDataParams
- GetSimpleTimeSeriesDataResponse
- GetStatsInfoParams
- GetStatsInfoResponse
- GetTagNamesParams
- GetTagNamesResponse
- GetTermsPolicyParams
- GetTermsPolicyResponse
- GetTimeSeriesDataParams
- GetTimeSeriesDataResponse
- GetUserInfoResponse
- GetUserRolesParams
- GetUserRolesResponse
- GetVerifiedEmailsResponse
- GetWebhookEventMappingParams
- GetWebhookEventMappingResponse
- GetWebhookIntegrationsParams
- GetWebhookIntegrationsResponse
- InitiateChangeSenderEmailRequest
- InitiateChangeSuperAdminRequest
- KeyInfo
- LegacyInitiateChangeSenderEmailRequest
- LicenseFileInfo
- LoginWithoutPasswordResponse
- LoginWithPasswordResponse
- LogoutRequest
- MailFailureInfo
- MatterAuthKeyInfo
- MatterAuthKeyResponse
- MatterBatchInfo
- MatterBatchNodeInfo
- MessageTemplateInfo
- MobilePlatformInfo
- MQTTStatisticsBucket
- MQTTStatisticsRawBucket
- MQTTStatisticsRawSeries
- MQTTStatisticsRawValuePoint
- MQTTStatisticsSeries
- MQTTStatisticsValuePoint
- NodeAttachTagsRequest
- NodeCertificateInfo
- NodeCertificateRegistrationStatusResponse
- NodeOTAJobStatusEntry
- NodeStatusSummaryResponse
- OTAImageCreateResponse
- OTAImageInfo
- OTAImageRelatedFile
- OTAImageUploadUrlResponse
- OTAJobCreateResponse
- OtaJobDownloadWindow
- OTAJobInfo
- OtaJobMetadata
- OTAJobStatusResponse
- OTAJobStatusSummaryResponse
- OtaJobValidity
- OtaNetworkSerialisation
- OTAPackageUploadUrlResponse
- OtaSecureBoot
- PaginationFields
- PassthroughConfigInfo
- PolicyInfo
- PolicyJson
- PublishMessageQueryParams
- PublishMessageRequest
- RainmakerPreRequisiteDetails
- RainmakerSnsConfiguration
- RainmakerStackDeploymentDetail
- RbacConfigurationValue
- RegisterNodeCertificatesRequest
- RetriggerOTAJobRequest
- RoleInfo
- SetAdminCustomDataParams
- SetCommonCustomDataRequest
- SignedImageInfo
- SignImageRequest
- SignImageResponse
- SignUpRequest
- StatsCount
- StatsObject
- TagResourceInfo
- TimeSeriesNodeData
- TimeSeriesParamData
- UpdateAdminGroupRequest
- UpdateAdminUserRequest
- UpdateAPIGatewayRequest
- UpdateAPIRateLimitRequest
- UpdateCognitoAppClientParams
- UpdateCognitoAppClientRequest
- UpdateCustomMessageTemplateBody
- UpdateCustomMessageTemplateRequest
- UpdateDashboardRequest
- UpdateDeploymentCapabilityRequest
- UpdateDeploymentConfigRequest
- UpdateEventFilterRequest
- UpdateIdentityProviderRequest
- UpdateIoTDeviceRateRuleRequest
- UpdateLogConfigRequest
- UpdateMatterBatchRequest
- UpdateMessageTemplateRequest
- UpdateMobilePlatformRequest
- UpdateNodeCACertificateRequest
- UpdateNodeParamsRequest
- UpdateNotificationsRequest
- UpdateOTAJobParams
- UpdatePassthroughConfigRequest
- UpdatePolicyRequest
- UpdateRoleParams
- UpdateRoleRequest
- UpdateTermsPolicyRequest
- UpdateUserProfileRequest
- UpdateUserRoleParams
- UpdateUserRoleRequest
- UpdateWebhookEventMappingRequest
- UpdateWebhookIntegrationRequest
- UploadLicenseFileRequest
- UserTokensData
- WebhookEventMappingInfo
- WebhookIntegrationInfo
Type Aliases
Section titled “Type Aliases”- ChangeSenderEmailRequest
- ChangeSuperAdminRequest
- GetAPIPathsResponse
- GetCognitoAppClientsResponse
- GetMatterAuthResponse
- GetMatterBatchResponse
- GetMessageTemplatesResponse
- KeySpec
- RainmakerDeploymentDetails
Variables
Section titled “Variables”- AdditionalInfo
- APICallValidationErrorCodes
- APIEndpoints
- APIErrorCodes
- ConfigErrorCodes
- DEFAULT_REQUEST_TIMEOUT_MS
- DEFAULT_REST_API_VERSION
- ErrorLabels
- HTTPMethods
- HTTPStatusCodes
- StorageAdapterErrorCodes
- StorageKeys
- TOKEN_EXPIRY_MARGIN_SECONDS
- TokenErrorCodes
- ValidationErrorCodes