@espressif/rainmaker-admin-sdk 1.0.0

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

@@ -0,0 +1,149 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for creating a Matter authentication key. */
+export interface CreateMatterAuthRequest {
+    /** The name for the authentication key. */
+    auth_key_name: string;
+}
+/** Request body for creating a Matter batch. */
+export interface CreateMatterBatchRequest {
+    /** The unique identifier for the batch. */
+    batch_id: string;
+    /** The vendor name for the batch. */
+    vendor_name?: string;
+    /** The product name for the batch. */
+    product_name?: string;
+    /** The product finish type. */
+    product_finish?: string;
+    /** The product color. */
+    product_color?: string;
+    /** The product label. */
+    product_label?: string;
+    /** The product URL. */
+    product_url?: string;
+    /** The part number for the product. */
+    part_number?: string;
+}
+/** Request body for updating a Matter batch. */
+export interface UpdateMatterBatchRequest {
+    /** The vendor name for the batch. */
+    vendor_name?: string;
+    /** The product name for the batch. */
+    product_name?: string;
+    /** The product finish type. */
+    product_finish?: string;
+    /** The product color. */
+    product_color?: string;
+    /** The product label. */
+    product_label?: string;
+    /** The product URL. */
+    product_url?: string;
+    /** The part number for the product. */
+    part_number?: string;
+}
+/** Query parameters for listing Matter batches. */
+export interface GetMatterBatchParams {
+    /** Filter by batch ID. */
+    batch_id?: string;
+    /** Pagination cursor for the starting record. */
+    start_id?: string;
+    /** Maximum number of records to return. */
+    num_records?: number;
+}
+/** Query parameters for listing nodes in a Matter batch. */
+export interface GetMatterBatchNodesParams {
+    /** The batch ID to query nodes for. */
+    batch_id: string;
+    /** Filter by a specific node ID. */
+    node_id?: string;
+    /** Whether to include detailed node information. */
+    node_details?: boolean;
+    /** Pagination cursor for the starting record. */
+    start_id?: string;
+    /** Maximum number of records to return. */
+    num_records?: number;
+}
+/** Response returned after creating a Matter authentication key. */
+export interface MatterAuthKeyResponse {
+    /** The status of the creation request. */
+    status?: string;
+    /** The generated public key. */
+    public_key?: string;
+}
+/** Details of a Matter authentication key. */
+export interface MatterAuthKeyInfo {
+    /** The name of the authentication key. */
+    key_name?: string;
+    /** The public key value. */
+    public_key?: string;
+}
+/** Response containing a list of Matter authentication keys. */
+export type GetMatterAuthResponse = MatterAuthKeyInfo[];
+/** Details of a Matter batch. */
+export interface MatterBatchInfo {
+    /** The unique identifier for the batch. */
+    batch_id?: string;
+    /** The vendor name. */
+    vendor_name?: string;
+    /** The product name. */
+    product_name?: string;
+    /** The product finish type. */
+    product_finish?: string;
+    /** The product color. */
+    product_color?: string;
+    /** The product label. */
+    product_label?: string;
+    /** The product URL. */
+    product_url?: string;
+    /** The part number. */
+    part_number?: string;
+    /** The current status of the batch. */
+    status?: string;
+    /** The vendor ID. */
+    vid?: string;
+    /** The product ID. */
+    pid?: string;
+    /** The DAC issuance limit. */
+    dac_limit?: number;
+    /** The remaining DAC issuance count. */
+    dac_remaining?: number;
+    /** The Product Attestation Authority certificate. */
+    paa?: string;
+    /** The Product Attestation Intermediate certificate. */
+    pai?: string;
+    /** Whether the batch is archived. */
+    archived?: boolean;
+    /** Whether the batch is disabled. */
+    disabled?: boolean;
+}
+/** Response containing a list of Matter batches. */
+export type GetMatterBatchResponse = MatterBatchInfo[];
+/** Details of a node within a Matter batch. */
+export interface MatterBatchNodeInfo {
+    /** The node ID. */
+    node_id?: string;
+    /** The batch ID the node belongs to. */
+    batch_id?: string;
+    /** Custom data associated with the node. */
+    custom_data?: Record<string, unknown>;
+    /** The Product Attestation Intermediate certificate. */
+    pai?: string;
+    /** The Device Attestation Certificate. */
+    dac?: string;
+    /** The current status of the node. */
+    status?: string;
+    /** Error message if the node encountered an issue. */
+    error_message?: string;
+}
+/** Response containing nodes in a Matter batch. */
+export interface GetMatterBatchNodesResponse {
+    /** Array of node IDs. */
+    nodes?: string[];
+    /** Array of detailed node information. */
+    node_details?: MatterBatchNodeInfo[];
+    /** Pagination cursor for the next page of results. */
+    next_id?: string;
+}

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

@@ -0,0 +1,78 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for creating a deployment message template. */
+export interface CreateMessageTemplateRequest {
+    /** Message template type identifier. */
+    template_type?: string;
+    /** Locale identifier for this template entry (for example: no_locale). */
+    locale?: string;
+    /** Subject text of the message template. */
+    message_subject?: string;
+    /** Body text/HTML of the message template. */
+    message_text?: string;
+    /** Whether this locale row is the default template. */
+    default?: boolean;
+    /** @deprecated Legacy event-based field retained for backward compatibility. */
+    event_name?: string;
+    /** @deprecated Legacy event-based payload retained for backward compatibility. */
+    message_template?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+/** Request body for updating a deployment message template. */
+export interface UpdateMessageTemplateRequest {
+    /** Message template type identifier. */
+    template_type?: string;
+    /** Locale identifier for this template entry (for example: no_locale). */
+    locale?: string;
+    /** Updated subject text of the template. */
+    message_subject?: string;
+    /** Updated body text/HTML of the template. */
+    message_text?: string;
+    /** Whether this locale row is the default template. */
+    default?: boolean;
+    /** @deprecated Legacy event-based field retained for backward compatibility. */
+    event_name?: string;
+    /** @deprecated Legacy event-based payload retained for backward compatibility. */
+    message_template?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+/** Parameters for retrieving message templates. */
+export interface GetMessageTemplatesParams {
+    /** Filter by deployment message template type. */
+    template_type?: string;
+    /** @deprecated Legacy event-based filter retained for backward compatibility. */
+    event_name?: string;
+}
+/** Parameters for deleting a message template. */
+export interface DeleteMessageTemplateParams {
+    /** The event name of the template to delete. */
+    event_name: string;
+}
+/** Information about a message template. */
+export interface MessageTemplateInfo {
+    /** Message template type identifier. */
+    template_type?: string;
+    /** Locale identifier for this template entry. */
+    locale?: string;
+    /** Subject text of the template. */
+    message_subject?: string;
+    /** Body text/HTML of the template. */
+    message_text?: string;
+    /** Whether this locale row is the default template. */
+    default?: boolean;
+    /** @deprecated Legacy event-based field retained for backward compatibility. */
+    event_name?: string;
+    /** @deprecated Legacy event-based payload retained for backward compatibility. */
+    message_template?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+/** Response containing a list of message templates. */
+export type GetMessageTemplatesResponse = MessageTemplateInfo[];
+/** Response containing verified email addresses. */
+export interface GetVerifiedEmailsResponse {
+    /** List of verified email addresses. */
+    verified_email?: string[];
+}

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

@@ -0,0 +1,61 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for creating a mobile platform configuration. */
+export interface CreateMobilePlatformRequest {
+    /** The platform type (e.g., GCM, APNS). */
+    platform: string;
+    /** The name of the mobile platform. */
+    name?: string;
+    /** The API key for push notifications. */
+    api_key?: string;
+    /** The SSL certificate for APNS. */
+    ssl_certificate?: string;
+    /** The private key for APNS. */
+    private_key?: string;
+}
+/** Request body for updating a mobile platform configuration. */
+export interface UpdateMobilePlatformRequest {
+    /** The platform type (e.g., GCM, APNS). */
+    platform: string;
+    /** The name of the mobile platform. */
+    name?: string;
+    /** The API key for push notifications. */
+    api_key?: string;
+    /** The SSL certificate for APNS. */
+    ssl_certificate?: string;
+    /** The private key for APNS. */
+    private_key?: string;
+}
+/** Parameters for deleting a mobile platform configuration. */
+export interface DeleteMobilePlatformParams {
+    /** The ARN of the platform application to delete. */
+    platform_application_arn: string;
+}
+/** Information about a mobile platform configuration. */
+export interface MobilePlatformInfo {
+    /** The ARN of the platform application. */
+    platform_application_arn?: string;
+    /** The name of the mobile platform. */
+    name?: string;
+    /** The platform type. */
+    platform?: string;
+    /** Additional platform attributes (API lowercase). */
+    attributes?: Record<string, string>;
+    /** @deprecated Use `attributes`. Kept for backward compatibility. */
+    Attributes?: Record<string, string>;
+}
+/** Response returned after creating a mobile platform. */
+export interface CreateMobilePlatformResponse {
+    /** The status of the creation request. */
+    status?: string;
+    /** The ARN of the created platform application. */
+    platform_application_arn?: string;
+}
+/** Response containing registered mobile platforms. */
+export interface GetMobilePlatformsResponse {
+    /** List of mobile platform configurations. */
+    platform_applications?: MobilePlatformInfo[];
+}

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

@@ -0,0 +1,102 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Single time-bucket value in MQTT usage statistics. */
+export interface MQTTStatisticsValuePoint {
+    /** Unix timestamp (seconds) for the bucket start. */
+    ts: number;
+    val: number;
+    /** Present when the request used `group_by: "topic_name"`. */
+    topic_name?: string;
+    /** Present when the request used `group_by: "node_id"`. */
+    node_id?: string;
+}
+/** Single raw MQTT message payload point when `aggregate=raw`. */
+export interface MQTTStatisticsRawValuePoint {
+    /** Unix timestamp (seconds) associated with the message. */
+    ts: number;
+    /** Raw MQTT message payload as serialized text. */
+    message_data: string;
+    /** Present when filtering/grouping by `topic_name`. */
+    topic_name?: string;
+    /** Present when filtering/grouping by `node_id`. */
+    node_id?: string;
+}
+/** One stats payload block (typically one row of aggregated series). */
+export interface MQTTStatisticsSeries {
+    values: MQTTStatisticsValuePoint[];
+    num_records: number;
+    /** Echoed when filtering by `topic_name`. */
+    topic_name?: string;
+    /** Echoed when filtering by `node_id`. */
+    node_id?: string;
+}
+/** One stats payload block when `aggregate=raw`. */
+export interface MQTTStatisticsRawSeries {
+    values: MQTTStatisticsRawValuePoint[];
+    num_records: number;
+    /** Echoed when filtering by `topic_name`. */
+    topic_name?: string;
+    /** Echoed when filtering by `node_id`. */
+    node_id?: string;
+}
+/** Aggregated slice returned for one query (possibly paginated). */
+export interface MQTTStatisticsBucket {
+    stats: MQTTStatisticsSeries[];
+    aggregate: string;
+    aggregation_interval: string;
+    /** Set when the request used `group_by` (e.g. `topic_name`, `node_id`). */
+    group_by?: string;
+    /** Pagination cursor for the next request (`start_id`). */
+    next_id?: string;
+}
+/** Raw-message slice returned for one query (possibly paginated). */
+export interface MQTTStatisticsRawBucket {
+    stats: MQTTStatisticsRawSeries[];
+    aggregate: string;
+    /** Raw query responses may omit aggregation interval. */
+    aggregation_interval?: string;
+    /** Set when the request used `group_by` (e.g. `topic_name`, `node_id`). */
+    group_by?: string;
+    /** Pagination cursor for the next request (`start_id`). */
+    next_id?: string;
+}
+/** Query parameters for retrieving MQTT usage statistics. */
+export interface GetMQTTStatisticsParams {
+    /**
+     * Filter by MQTT topic pattern for `GET /admin/mqtt_stats` (query key `topic_name`).
+     */
+    topic_name?: string;
+    /**
+     * Filter by node id for `GET /admin/mqtt_stats` (query key `node_id`).
+     */
+    node_id?: string;
+    /** Filter by node firmware version. */
+    fw_version?: string;
+    /** Aggregation measure (e.g. `count`). */
+    aggregate?: string;
+    /** Aggregation interval aligned with dashboard stats (e.g. `day`, `week`). */
+    aggregation_interval?: string;
+    /** Maximum number of records to return per page. */
+    num_records?: string | number;
+    /** Pagination cursor from the previous response (`next_id`). */
+    start_id?: string;
+    /** Start of the time range as a Unix timestamp (seconds). */
+    start_time?: number;
+    /** End of the time range as a Unix timestamp (seconds). */
+    end_time?: number;
+    /** Timezone for the statistics data. */
+    timezone?: string;
+    /** Group results (e.g. `topic_name`, `node_id`). */
+    group_by?: string;
+}
+/** Response from GET /admin/mqtt_stats. */
+export interface GetMQTTStatisticsResponse {
+    mqtt_stats: MQTTStatisticsBucket[];
+}
+/** Raw response from GET /admin/mqtt_stats when `aggregate=raw`. */
+export interface GetMQTTStatisticsRawResponse {
+    mqtt_stats: MQTTStatisticsRawBucket[];
+}

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

@@ -0,0 +1,136 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Parameters for listing admin nodes. */
+export interface GetAdminNodesParams {
+    /** Maximum number of records to return. */
+    num_records?: string;
+    /** Node ID to start pagination from. */
+    start_id?: string;
+    /** Filter by specific node ID. */
+    node_id?: string;
+    /** Filter by node type. */
+    type?: string;
+    /** Filter by node model. */
+    model?: string;
+    /** Filter by firmware version. */
+    fw_version?: string;
+    /** Comma-separated tag names to filter by. */
+    tags?: string;
+    /** Filter by node status. */
+    node_status?: string;
+    /** Filter by node subtype. */
+    subtype?: string;
+    /** Filter by project name. */
+    project_name?: string;
+    /** Whether to return only summary info. */
+    summary?: boolean;
+    /** When true with `node_id`, returns full node details (config, params, etc.). */
+    node_details?: boolean;
+    /** Filter nodes registered after this timestamp. */
+    start_time?: number;
+}
+/** Parameters for activating or deactivating nodes. */
+export interface ActivateDeactivateNodesParams {
+    /** ID of the node to activate or deactivate. */
+    node_id: string;
+    /** Whether to activate (true) or deactivate (false) the node. */
+    activate: boolean;
+}
+/** Parameters for listing node tags or tag values. */
+export interface GetNodeTagsParams {
+    /** Filter by tag name to retrieve its associated tag values. */
+    tag_name?: string;
+    /** Maximum number of records to return. */
+    num_records?: string;
+    /** ID to start pagination from. */
+    start_id?: string;
+}
+/** Response from GET /admin/nodes/tags. */
+export interface GetNodeTagsResponse {
+    /** List of tag names (returned when tag_name is not specified). */
+    tags?: string[];
+    /** List of tag values for a specific tag name (returned when tag_name is specified). */
+    tag_values?: string[];
+    /** Pagination cursor for the next page. */
+    next_id?: string;
+    /** Total number of records matching the query. */
+    total?: number;
+}
+/** Request body for attaching tags to a node. */
+export interface NodeAttachTagsRequest {
+    /** List of tag strings to attach. */
+    tags: string[];
+}
+/** Admin node info returned by GET /admin/nodes. */
+export interface AdminNodeInfo {
+    /** Unique identifier of the node. */
+    node_id: string;
+    /** Human-readable name of the node. */
+    name?: string;
+    /** Firmware version running on the node. */
+    fw_version?: string;
+    /** Type classification of the node. */
+    type?: string;
+    /** Hardware model of the node. */
+    model?: string;
+    /** Subtype classification of the node. */
+    subtype?: string;
+    /** Project name the node belongs to. */
+    project_name?: string;
+    /** Current status of the node. */
+    node_status?: string;
+    /** Timestamp when the node was registered. */
+    registration_timestamp?: number;
+    /** Tags associated with the node. */
+    tags?: string[];
+    /** Arbitrary metadata attached to the node. */
+    metadata?: Record<string, unknown>;
+    /** Admin access level granted to this node. */
+    granted_admin_access?: string;
+    /** Network ID the node belongs to. */
+    network_id?: string;
+    /** Connectivity status of the node. */
+    status?: {
+        connectivity?: {
+            connected?: boolean;
+            timestamp?: number;
+        };
+    };
+    /** Node configuration data. */
+    config?: Record<string, unknown>;
+    /** Node parameter values. */
+    params?: Record<string, unknown>;
+    /** Timestamp when the node was activated. */
+    activation_timestamp?: number;
+    /** Timestamp of the last status update. */
+    laststatusupdate_timestamp?: number;
+    /** Timestamp of the last config update. */
+    last_config_update_timestamp?: number;
+    /** Timestamp of the last activity. */
+    last_activity_timestamp?: number;
+}
+/** Paginated response containing a list of admin nodes. */
+export interface AdminNodeListResponse {
+    /** List of node IDs. */
+    nodes?: string[];
+    /** Detailed node information objects. */
+    node_info?: AdminNodeInfo[];
+    /** ID to use for fetching the next page. */
+    next_id?: string;
+    /** Total number of nodes matching the query. */
+    total?: number;
+    /** Node quota for the admin. */
+    quota?: number;
+}
+/** Summary counts of node statuses. */
+export interface NodeStatusSummaryResponse {
+    /** Number of active nodes. */
+    active_count: number;
+    /** Number of inactive nodes. */
+    inactive_count: number;
+    /** Number of nodes that have not been activated. */
+    not_activated_count: number;
+}

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

@@ -0,0 +1,15 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for updating the node CA certificate. */
+export interface UpdateNodeCACertificateRequest {
+    /** The CA certificate content. */
+    ca_certificate: string;
+    [key: string]: unknown;
+}
+/** Response containing the node CA certificate. */
+export interface GetNodeCACertificateResponse {
+    [key: string]: unknown;
+}

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

@@ -0,0 +1,24 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for updating node parameters. */
+export interface UpdateNodeParamsRequest {
+    /** The ID of the node to update. */
+    node_id: string;
+    /** The parameter payload to set on the node. */
+    payload: Record<string, unknown>;
+}
+/** Query parameters for retrieving node parameters. */
+export interface GetNodeParamsParams {
+    /** The ID of the node to query. */
+    node_id: string;
+    /** Additional dynamic query parameters. */
+    [key: string]: unknown;
+}
+/** Response containing node parameters. */
+export interface GetNodeParamsResponse {
+    /** Dynamic key-value pairs representing node parameters. */
+    [key: string]: unknown;
+}

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

@@ -0,0 +1,101 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for generating node IDs. */
+export interface GenerateNodeIdsRequest {
+    /** The number of node IDs to generate. */
+    count: number;
+    /** Tags to associate with the generated nodes. */
+    tags?: string[];
+    /** The node subtype. */
+    subtype?: string;
+    /** The node model. */
+    model?: string;
+    /** The node type. */
+    type?: string;
+    /** The group ID to associate with the nodes. */
+    group_id?: string;
+}
+/** Parameters for retrieving node IDs. */
+export interface GetNodeIdsParams {
+    /** The starting node ID for pagination. */
+    start_id?: string;
+    /** The maximum number of records to return. */
+    num_records?: number;
+}
+/** Parameters for retrieving node certificates. */
+export interface GetNodeCertificatesParams {
+    /** The node ID to filter by. */
+    node_id?: string;
+    /** The starting ID for pagination. */
+    start_id?: string;
+    /** The maximum number of records to return. */
+    num_records?: number;
+}
+/** Request body for registering node certificates. */
+export interface RegisterNodeCertificatesRequest {
+    /** List of node IDs to register certificates for. */
+    node_ids: string[];
+    /** List of certificates corresponding to the node IDs. */
+    certs: string[];
+    [key: string]: unknown;
+}
+/** Parameters for checking node certificate registration status. */
+export interface GetNodeCertificateRegistrationParams {
+    /** The registration request ID. */
+    request_id: string;
+}
+/** Response returned after generating node IDs. */
+export interface GenerateNodeIdsResponse {
+    /** The status of the generation request. */
+    status?: string;
+    /** The request ID for tracking. */
+    request_id?: string;
+    /** The list of generated node IDs. */
+    node_ids?: string[];
+    [key: string]: unknown;
+}
+/** Response containing a list of node IDs. */
+export interface GetNodeIdsResponse {
+    /** The list of node IDs. */
+    node_ids?: string[];
+    /** The next ID for pagination. */
+    next_id?: string;
+    /** The total number of node IDs. */
+    total?: number;
+}
+/** Information about a node certificate. */
+export interface NodeCertificateInfo {
+    /** The node ID. */
+    node_id?: string;
+    /** The certificate content. */
+    certificate?: string;
+    /** The certificate status. */
+    status?: string;
+    [key: string]: unknown;
+}
+/** Response containing node certificates. */
+export interface GetNodeCertificatesResponse {
+    /** List of node certificate records. */
+    certificates?: NodeCertificateInfo[];
+    /** The next ID for pagination. */
+    next_id?: string;
+    /** The total number of certificates. */
+    total?: number;
+}
+/** Response containing node certificate registration status. */
+export interface NodeCertificateRegistrationStatusResponse {
+    /** The registration request ID. */
+    request_id?: string;
+    /** The registration status. */
+    status?: string;
+    [key: string]: unknown;
+}
+/** Response containing the MQTT host endpoint. */
+export interface GetMQTTHostResponse {
+    /** The MQTT broker host address. */
+    mqtt_host?: string;
+    [key: string]: unknown;
+}