@espressif/rainmaker-admin-sdk 1.0.0

package/dist/types-cjs/types/secure_sign.d.cts

@@ -0,0 +1,102 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for signing an OTA image. */
+export interface SignImageRequest {
+    /** ID of the OTA image to sign. */
+    ota_image_id: string;
+    /** Names of the keys to use for signing. */
+    key_names: string[];
+    /** Whether to also sign the bootloader. */
+    sign_boot_loader?: boolean;
+}
+/** Parameters for retrieving signed images. */
+export interface GetSignedImagesParams {
+    /** Filter results by key name. */
+    key_name?: string;
+    /** Maximum number of records to return. */
+    num_records?: number;
+    /** Pagination cursor to start from. */
+    start_id?: string;
+}
+/** Parameters for retrieving signing keys associated with an image. */
+export interface GetSigningKeysParams {
+    /** ID of the image to get signing keys for. */
+    image_id: string;
+    /** Maximum number of records to return. */
+    num_records?: number;
+    /** Pagination cursor to start from. */
+    start_id?: string;
+}
+/** Response returned after initiating an image signing request. */
+export interface SignImageResponse {
+    /** Status of the signing operation. */
+    status: string;
+    /** Description of the operation result. */
+    description: string;
+    /** ID to track the signing request. */
+    request_id?: string;
+}
+/** Response containing the current status of a signing request. */
+export interface GetSigningStatusResponse {
+    /** ID of the signing request. */
+    request_id: string;
+    /** Current status of the signing operation. */
+    status: string;
+    /** Additional details about the signing status. */
+    description?: string;
+}
+/** Information about a signed image. */
+export interface SignedImageInfo {
+    /** ID of the original image. */
+    image_id?: string;
+    /** URL to download the signed image. */
+    signed_image_url?: string;
+    /** Unique identifier of the signed image. */
+    signed_image_id?: string;
+    /** Storage path / file id of the signed image artifact. */
+    signed_image_file_id?: string;
+    /** ID of the user who initiated the signing. */
+    user_id?: string;
+    /** Unix timestamp when the image was signed. */
+    timestamp?: number;
+    /** File type of the signed image. */
+    file_type?: string;
+    /** Key names associated with this signed image. */
+    all_associated_signing_key_names?: string[];
+}
+/** Response containing a list of signed images and associated keys. */
+export interface GetSignedImagesResponse {
+    /** Keys used for signing. */
+    keys?: Array<{
+        key_name: string;
+        public_key_digest?: string;
+    }>;
+    /** List of signed image details. */
+    images?: SignedImageInfo[];
+    /** Total number of signed images available. */
+    total?: number;
+    /** Cursor for the next page (`start_id`), when more results exist. */
+    next_id?: string;
+}
+/** Response containing signing keys and details for an OTA image. */
+export interface GetSigningKeysResponse {
+    /** ID of the OTA image. */
+    ota_image_id?: string;
+    /** List of signing detail entries for the image. */
+    signing_details?: Array<{
+        keys?: Array<{
+            key_name: string;
+            public_key_digest?: string;
+        }>;
+        signed_image_url?: string;
+        signed_image_file_id?: string;
+        timestamp?: number;
+        user_id?: string;
+        file_type?: string;
+    }>;
+    /** Total number of signing detail records available. */
+    total?: number;
+}

package/dist/types-cjs/types/sender_email.d.cts

@@ -0,0 +1,27 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Initiate sender email update by providing the new sender email. */
+export interface InitiateChangeSenderEmailRequest {
+    /** The email address to set as the new sender email. */
+    new_sender_email: string;
+}
+/** Confirm sender email update by providing both verification codes. */
+export interface ConfirmChangeSenderEmailRequest {
+    /** Verification code received by the current sender email. */
+    current_sender_mail_code: number;
+    /** Verification code received by the new sender email. */
+    new_sender_mail_code: number;
+}
+/**
+ * Legacy initiate payload kept for backwards compatibility.
+ * Prefer `new_sender_email`.
+ */
+export interface LegacyInitiateChangeSenderEmailRequest {
+    /** @deprecated Use `new_sender_email` instead. */
+    sender_email: string;
+}
+/** Request body for changing the sender email of the deployment. */
+export type ChangeSenderEmailRequest = InitiateChangeSenderEmailRequest | ConfirmChangeSenderEmailRequest | LegacyInitiateChangeSenderEmailRequest;

package/dist/types-cjs/types/statistical_service.d.cts

@@ -0,0 +1,63 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Query parameters for retrieving statistical service metrics. */
+export interface GetStatsInfoParams {
+    /** The name of the metric to retrieve. */
+    metric_name?: string;
+    /** The time duration for the query (e.g., 7d, 30d). */
+    duration?: string;
+    /** Start date for the query range. */
+    start_date?: string;
+    /** End date for the query range. */
+    end_date?: string;
+    /** Start month for monthly aggregation. */
+    start_month?: string;
+    /** End month for monthly aggregation. */
+    end_month?: string;
+    /** Start year for yearly aggregation. */
+    start_year?: string;
+    /** End year for yearly aggregation. */
+    end_year?: string;
+    /** Timezone for the statistics data. */
+    timezone?: string;
+    /** The type of statistics to retrieve. */
+    type?: string;
+    /** The device model to filter by. */
+    model?: string;
+}
+/** A single statistics count entry for a given time period. */
+export interface StatsCount {
+    /** The specific date for this count. */
+    date?: string;
+    /** Start date of the aggregation period. */
+    start_date?: string;
+    /** End date of the aggregation period. */
+    end_date?: string;
+    /** The month for monthly aggregation. */
+    month?: string;
+    /** The year for yearly aggregation. */
+    year?: string;
+    /** The daily count value. */
+    daily_count?: number;
+    /** The weekly count value. */
+    weekly_count?: number;
+    /** The monthly count value. */
+    monthly_count?: number;
+    /** The yearly count value. */
+    yearly_count?: number;
+}
+/** A statistics data object containing count entries and a total. */
+export interface StatsObject {
+    /** Array of count entries for the queried period. */
+    data?: StatsCount[];
+    /** The total count across all entries. */
+    total_count?: number;
+}
+/** Response containing statistical service metrics. */
+export interface GetStatsInfoResponse {
+    /** Dynamic key-value pairs representing statistics data. */
+    [key: string]: StatsObject | number | unknown;
+}

package/dist/types-cjs/types/storage.d.cts

@@ -0,0 +1,17 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Interface for a storage adapter used by the SDK to persist key-value data. */
+interface ESPRMStorageAdapterInterface {
+    /** Stores a value under the given key. */
+    setItem(name: string, value: string): Promise<void>;
+    /** Retrieves the value for the given key, or null if not found. */
+    getItem(name: string): Promise<string | null>;
+    /** Removes the value stored under the given key. */
+    removeItem(name: string): Promise<void>;
+    /** Clears all stored key-value pairs. */
+    clear(): Promise<void>;
+}
+export { ESPRMStorageAdapterInterface };

package/dist/types-cjs/types/super_admin.d.cts

@@ -0,0 +1,19 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Initiate super admin transfer by providing the new super admin email. */
+export interface InitiateChangeSuperAdminRequest {
+    /** The email address of the new super admin. */
+    new_super_admin: string;
+}
+/** Confirm super admin transfer by providing both verification codes. */
+export interface ConfirmChangeSuperAdminRequest {
+    /** Verification code received by the current super admin. */
+    current_super_admin_code: number;
+    /** Verification code received by the new super admin. */
+    new_super_admin_code: number;
+}
+/** Request body for changing the super admin of the deployment. */
+export type ChangeSuperAdminRequest = InitiateChangeSuperAdminRequest | ConfirmChangeSuperAdminRequest;

package/dist/types-cjs/types/tag.d.cts

@@ -0,0 +1,77 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Parameters for listing admin tags. */
+export interface GetAdminTagsParams {
+    /** Filter by tag name. */
+    tag_name?: string;
+    /** Filter by tag value. */
+    tag_value?: string;
+    /** Filter by resource type (e.g., "node", "group"). */
+    resource_type?: string;
+    /** Filter by resource ID. */
+    resource_id?: string;
+    /** Comma-separated tag filters. */
+    tags?: string;
+    /** Whether to include custom data in the response. */
+    custom_data?: boolean;
+    /** Maximum number of records to return. */
+    num_records?: string;
+    /** ID to start pagination from. */
+    start_id?: string;
+}
+/** Parameters for attaching or detaching tags from a resource. */
+export interface AttachDetachTagsParams {
+    /** Type of the resource (e.g., "node", "group"). */
+    resource_type: string;
+    /** ID of the resource to attach/detach tags to. */
+    resource_id: string;
+    /** List of tag strings to attach or detach. */
+    tags: string[];
+}
+/** Parameters for listing tag names. */
+export interface GetTagNamesParams {
+    /** Filter by tag name prefix. */
+    tag_name?: string;
+    /** Filter by resource type. */
+    resource_type?: string;
+    /** Maximum number of records to return. */
+    num_records?: string;
+    /** ID to start pagination from. */
+    start_id?: string;
+}
+/** Resource information associated with a tag. */
+export interface TagResourceInfo {
+    /** Tenant ID owning the resource. */
+    tenant_id?: string;
+    /** Type of the tagged resource. */
+    resource_type: string;
+    /** ID of the tagged resource. */
+    resource_id: string;
+    /** Admin ID associated with the resource. */
+    resource_admin_id?: string;
+    /** Additional resource properties. */
+    [key: string]: unknown;
+}
+/** Paginated response containing tagged resources. */
+export interface GetAdminTagsResponse {
+    /** List of tagged resource objects. */
+    resources?: TagResourceInfo[];
+    /** List of tag strings. */
+    tags?: string[];
+    /** Total number of results matching the query. */
+    total?: number;
+    /** ID to use for fetching the next page. */
+    next_id?: string;
+}
+/** Paginated response containing tag names. */
+export interface GetTagNamesResponse {
+    /** List of tag name strings. */
+    tags?: string[];
+    /** ID to use for fetching the next page. */
+    next_id?: string;
+    /** Total number of tag names matching the query. */
+    total?: number;
+}

package/dist/types-cjs/types/terms_policy.d.cts

@@ -0,0 +1,33 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for updating terms of use or privacy policy. */
+export interface UpdateTermsPolicyRequest {
+    /** The terms of use content or file URL. */
+    terms_of_use?: string;
+    /** The privacy policy content or file URL. */
+    privacy_policy?: string;
+}
+/** Query parameters for retrieving terms or privacy policy. */
+export interface GetTermsPolicyParams {
+    /** The type of policy to retrieve (e.g., terms_of_use, privacy_policy). */
+    type?: string;
+}
+/** Parameters for deleting a terms or privacy policy. */
+export interface DeleteTermsPolicyParams {
+    /** The type of policy to delete. */
+    type: string;
+}
+/** Response containing terms of use and privacy policy data. */
+export interface GetTermsPolicyResponse {
+    /** The terms of use content. */
+    terms_of_use?: unknown;
+    /** The privacy policy content. */
+    privacy_policy?: unknown;
+    /** The URL of the terms of use file. */
+    terms_of_use_file_url?: string;
+    /** The URL of the privacy policy file. */
+    privacy_policy_file_url?: string;
+}

package/dist/types-cjs/types/time_series.d.cts

@@ -0,0 +1,97 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Parameters for querying aggregated time series data. */
+export interface GetTimeSeriesDataParams {
+    /** Node ID to fetch time series data for. */
+    node_id: string;
+    /** Parameter name to query. */
+    param_name: string;
+    /** Aggregation function (e.g., "avg", "min", "max", "count"). */
+    aggregate?: string;
+    /** Interval for aggregation (e.g., "hour", "day", "week"). */
+    aggregation_interval?: string;
+    /** Whether to compute differential values. */
+    differential?: boolean;
+    /** Whether to reset accumulated value on negative deltas. */
+    reset_on_negative?: boolean;
+    /** Whether to return results in descending order. */
+    desc_order?: boolean;
+    /** Data type filter. */
+    type?: string;
+    /** Day the week starts on for weekly aggregation. */
+    week_start?: string;
+    /** Start of the time range (epoch seconds). */
+    start_time?: number;
+    /** End of the time range (epoch seconds). */
+    end_time?: number;
+    /** Number of aggregation intervals to return. */
+    num_intervals?: number;
+    /** ID to start pagination from. */
+    start_id?: string;
+    /** Maximum number of records to return. */
+    num_records?: number;
+    /** Timezone for aggregation boundaries. */
+    timezone?: string;
+}
+/** Parameters for querying raw time series data. */
+export interface GetSimpleTimeSeriesDataParams {
+    /** Node ID to fetch time series data for. */
+    node_id: string;
+    /** Parameter name to query. */
+    param_name: string;
+    /** Start of the time range (epoch seconds). */
+    start_time: number;
+    /** End of the time range (epoch seconds). */
+    end_time: number;
+    /**
+     * Expected data type of the parameter values (GET query param `type`,
+     * e.g. `int`, `float`).
+     */
+    type: string;
+    /** ID to start pagination from. */
+    start_id?: string;
+    /** Maximum number of records to return. */
+    num_records?: number;
+}
+/** Time series data for a single parameter. */
+export interface TimeSeriesParamData {
+    /** Name of the parameter. */
+    param_name: string;
+    /** Array of timestamp-value pairs. */
+    values?: Array<{
+        ts: number;
+        val: unknown;
+    }>;
+    /** Number of records returned. */
+    num_records?: number;
+}
+/** Time series data for a single node. */
+export interface TimeSeriesNodeData {
+    /** Node ID the data belongs to. */
+    node_id: string;
+    /** Parameter data arrays. */
+    params?: TimeSeriesParamData[];
+    /** ID to use for fetching the next page. */
+    next_id?: string;
+    /** Aggregation function applied. */
+    aggregate?: string;
+    /** Timezone used for aggregation. */
+    timezone?: string;
+    /** Whether differential computation was applied. */
+    differential?: boolean;
+    /** Whether negative delta resets were applied. */
+    reset_on_negative?: boolean;
+}
+/** Response containing aggregated time series data. */
+export interface GetTimeSeriesDataResponse {
+    /** List of time series data grouped by node. */
+    ts_data?: TimeSeriesNodeData[];
+}
+/** Response containing raw time series data. */
+export interface GetSimpleTimeSeriesDataResponse {
+    /** List of time series data grouped by node. */
+    ts_data?: TimeSeriesNodeData[];
+}

package/dist/types-cjs/types/user_node.d.cts

@@ -0,0 +1,48 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Parameters for listing nodes associated with an admin user. */
+export interface GetAdminUserNodesParams {
+    /** Filter by user ID. */
+    user_id?: string;
+    /** Filter by username. */
+    user_name?: string;
+    /** Filter by specific node ID. */
+    node_id?: string;
+    /** Filter by user role on the node. */
+    role?: string;
+    /** Whether to include detailed node information. */
+    node_details?: boolean;
+    /** Node ID to start pagination from. */
+    start_id?: string;
+    /** Maximum number of records to return. */
+    num_records?: string;
+}
+/** User association entry when the API returns users for a node (e.g. `node_id` query). */
+export interface AdminUserNodeAssociation {
+    user_id: string;
+    user_name?: string;
+}
+/** Primary or secondary bucket; fields present depend on query (e.g. `node_id` returns `users`). */
+export interface AdminUserNodesBucket {
+    /** Node IDs when listing associations for a user. */
+    nodes?: string[];
+    /** User rows when listing associations for a node (`node_id`). */
+    users?: AdminUserNodeAssociation[];
+    total?: number;
+}
+/** Response containing nodes associated with an admin user. */
+export interface AdminUserNodesResponse {
+    /** Nodes or users where the principal has primary access (shape depends on query). */
+    primary?: AdminUserNodesBucket;
+    /** Nodes or users where the principal has secondary access (shape depends on query). */
+    secondary?: AdminUserNodesBucket;
+    /** Total number of associated nodes. */
+    total?: number;
+    /** ID to use for fetching the next page. */
+    next_id?: string;
+    /** Additional response properties. */
+    [key: string]: unknown;
+}

package/dist/types-cjs/types/user_node_history.d.cts

@@ -0,0 +1,38 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Query parameters for `GET admin/user/nodes/history`. */
+export interface GetAdminUserNodeHistoryParams {
+    /** End-user ID whose node association history is requested. */
+    user_id: string;
+    /** Maximum number of records to return. */
+    num_records: string;
+    /** Cursor for the next page (from a previous response `next_id`). */
+    start_id?: string;
+}
+/** Node row returned inside {@link AdminUserNodeHistoryUserEntry.nodes}. */
+export interface AdminUserNodeHistoryNode {
+    node_id: string;
+    first_mapping_ts?: number;
+    last_updated_ts?: number;
+    mapping_count?: number;
+    node_type?: string;
+    status?: string;
+    type?: string;
+    model?: string;
+    subtype?: string;
+}
+/** User bucket in {@link AdminUserNodeHistoryResponse.users}. */
+export interface AdminUserNodeHistoryUserEntry {
+    user_id: string;
+    user_name?: string;
+    total?: number;
+    nodes?: AdminUserNodeHistoryNode[];
+}
+/** Response for `GET admin/user/nodes/history`. */
+export interface AdminUserNodeHistoryResponse {
+    users?: AdminUserNodeHistoryUserEntry[];
+    next_id?: string;
+}

package/dist/types-cjs/types/webhook.d.cts

@@ -0,0 +1,80 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for creating a webhook integration. */
+export interface CreateWebhookIntegrationRequest {
+    /** The name of the service to integrate with. */
+    service_name: string;
+    /** The endpoint name for the webhook. */
+    endpoint_name: string;
+    /** Whether the webhook integration is enabled. */
+    enabled: boolean;
+}
+/** Request body for updating a webhook integration. */
+export interface UpdateWebhookIntegrationRequest {
+    /** The name of the service to update. */
+    service_name: string;
+    /** The endpoint name for the webhook. */
+    endpoint_name: string;
+    /** Whether the webhook integration is enabled. */
+    enabled: boolean;
+}
+/** Query parameters for listing webhook integrations. */
+export interface GetWebhookIntegrationsParams {
+    /** Filter by service name. */
+    service_name?: string;
+}
+/** Parameters for deleting a webhook integration. */
+export interface DeleteWebhookIntegrationParams {
+    /** The service name of the webhook to delete. */
+    service_name: string;
+    /** The endpoint name of the webhook to delete. */
+    endpoint_name: string;
+}
+/** Request body for updating a webhook event mapping. */
+export interface UpdateWebhookEventMappingRequest {
+    /** The webhook name to map the event to. */
+    webhook_name: string;
+    /** The event name to map. */
+    event_name: string;
+}
+/** Query parameters for listing webhook event mappings. */
+export interface GetWebhookEventMappingParams {
+    /** Filter by webhook name. */
+    webhook_name?: string;
+}
+/** Parameters for deleting a webhook event mapping. */
+export interface DeleteWebhookEventMappingParams {
+    /** The webhook name of the mapping to delete. */
+    webhook_name: string;
+    /** The event name of the mapping to delete. */
+    event_name: string;
+}
+/** Details of a webhook integration. */
+export interface WebhookIntegrationInfo {
+    /** The name of the integrated service. */
+    service_name?: string;
+    /** The endpoint name for the webhook. */
+    endpoint_name?: string;
+    /** Whether the webhook integration is enabled. */
+    enabled?: boolean;
+}
+/** Response containing a list of webhook integrations. */
+export interface GetWebhookIntegrationsResponse {
+    /** Array of webhook integration details. */
+    webhooks_endpoints?: WebhookIntegrationInfo[];
+}
+/** Details of a webhook event mapping. */
+export interface WebhookEventMappingInfo {
+    /** The webhook name associated with this mapping. */
+    webhook_name?: string;
+    /** The event name associated with this mapping. */
+    event_name?: string;
+}
+/** Response containing a list of webhook event mappings. */
+export interface GetWebhookEventMappingResponse {
+    /** Array of webhook event mapping details. */
+    webhook_event_mappings?: WebhookEventMappingInfo[];
+}