@espressif/rainmaker-admin-sdk 1.0.0

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

@@ -0,0 +1,386 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for creating a new OTA image. */
+export interface CreateOTAImageRequest {
+    /** Name of the OTA image. */
+    image_name: string;
+    /** Node type this image targets. */
+    type: string;
+    /** Node model this image targets. */
+    model: string;
+    /** Firmware version of this image. */
+    fw_version: string;
+    /** Base URL for the image file location. */
+    base_url?: string;
+}
+/** Parameters for listing OTA images. */
+export interface GetOTAImagesParams {
+    /** Filter by specific OTA image ID. */
+    ota_image_id?: string;
+    /** Filter by image name. */
+    image_name?: string;
+    /** Filter by node type. */
+    type?: string;
+    /** Filter by node model. */
+    model?: string;
+    /** Filter by firmware version. */
+    fw_version?: string;
+    /** Maximum number of records to return. */
+    num_records?: string;
+    /** Image ID to start pagination from. */
+    start_id?: string;
+    /** Substring filter for image name. */
+    contains?: string;
+    /** Filter by archived status. */
+    archived?: boolean;
+}
+/** Parameters for archiving or unarchiving an OTA image. */
+export interface ArchiveOTAImageParams {
+    /** ID of the OTA image to archive or unarchive. */
+    ota_image_id: string;
+    /** Whether to archive (true) or unarchive (false). */
+    archive: boolean;
+}
+/** Time window (minutes past midnight) during which the node may apply the OTA. */
+export interface OtaJobDownloadWindow {
+    /** Window start, in minutes past midnight (0-1439). */
+    start: number;
+    /** Window end, in minutes past midnight (0-1439). */
+    end: number;
+}
+/** Validity range for an OTA job, expressed as Unix epoch seconds. */
+export interface OtaJobValidity {
+    /** Validity start, as Unix epoch seconds. */
+    start: number;
+    /** Validity end, as Unix epoch seconds. */
+    end: number;
+}
+/** Metadata attached to an OTA job. Supports well-known keys plus arbitrary extras. */
+export interface OtaJobMetadata {
+    /** Optional apply window (device time, in minutes past midnight). */
+    download_window?: OtaJobDownloadWindow;
+    /** Optional validity window (Unix epoch seconds). */
+    validity?: OtaJobValidity;
+    /** Marks the OTA target as the host MCU (requires firmware support). */
+    "esp.ota.target"?: "host_mcu";
+    /** Additional user-provided metadata entries. */
+    [key: string]: unknown;
+}
+/** Secure boot signing options for an OTA job. */
+export interface OtaSecureBoot {
+    /** Explicit key names to sign the OTA image with (manual mode). */
+    key_names?: string[];
+    /** When true, the backend picks the correct signing key based on node digests. */
+    auto_select_key?: boolean;
+}
+/** Network serialisation options for constrained network deliveries. */
+export interface OtaNetworkSerialisation {
+    /** Estimated seconds a node takes to process this OTA (download → reboot → report). */
+    ota_task_duration: number;
+    /** Minimum retry wait (seconds) when a slot cannot be acquired. */
+    min_wait?: number;
+    /** Maximum retry wait (seconds) when a slot cannot be acquired. */
+    max_wait?: number;
+}
+/** Request body for creating a new OTA job. */
+export interface CreateOTAJobRequest {
+    /** Name of the OTA job (required). */
+    ota_job_name: string;
+    /** Optional human-readable description, surfaced to end users on user-approval jobs. */
+    description?: string;
+    /** ID of the OTA image to deploy (mutually exclusive with `ota_image_url`). */
+    ota_image_id?: string;
+    /** Image URL to deploy (mutually exclusive with `ota_image_id`). */
+    ota_image_url?: string;
+    /** Target node IDs. */
+    nodes?: string[];
+    /** Target group IDs. */
+    groups?: string[];
+    /** Job priority, 1 (highest) to 10 (lowest). */
+    priority?: number;
+    /** Timeout in seconds after which the job expires. */
+    timeout?: number;
+    /** Node type filter (Dynamic OTA jobs). */
+    node_type?: string;
+    /** Node model filter (Dynamic OTA jobs). */
+    node_model?: string;
+    /** Node firmware version filter (Dynamic OTA jobs). */
+    node_fw_version?: string;
+    /** Optional job metadata (download window, validity, target MCU, custom keys). */
+    metadata?: OtaJobMetadata;
+    /** Secure boot signing options. */
+    secure_boot?: OtaSecureBoot;
+    /** Network serialisation options. */
+    network_serialisation?: OtaNetworkSerialisation;
+    /**
+     * Grant end users access to the firmware binary URL on user-approval OTA jobs.
+     * Note: the property name is intentionally misspelt to match the backend contract.
+     */
+    user_ota_image_acccess?: boolean;
+}
+/** Query-string flags for the create OTA job endpoint. */
+export interface CreateOTAJobQueryOptions {
+    /** Force push the update to target nodes immediately. */
+    force_push?: boolean;
+    /** Require user approval before applying. */
+    user_approval?: boolean;
+    /** Notify users about the update (requires `user_approval`). */
+    notify?: boolean;
+    /** Keep the job active after all target nodes finish (useful for groups that may grow). */
+    continuous?: boolean;
+    /** Serialise OTA delivery per local network. */
+    network_serialised?: boolean;
+}
+/** Parameters for listing OTA jobs. */
+export interface GetOTAJobParams {
+    /** Filter by specific OTA job ID. */
+    ota_job_id?: string;
+    /** Maximum number of records to return. */
+    num_records?: string;
+    /** Job ID to start pagination from. */
+    start_id?: string;
+}
+/** Parameters for updating an OTA job. */
+export interface UpdateOTAJobParams {
+    /** ID of the OTA job to update. */
+    ota_job_id: string;
+    /** Additional update fields. */
+    [key: string]: unknown;
+}
+/** Parameters for fetching OTA job status. */
+export interface GetOTAJobStatusParams {
+    /** ID of the OTA job to check status for. */
+    ota_job_id: string;
+    /** Filter status by specific node ID. */
+    node_id?: string;
+    /** Maximum number of records to return. */
+    num_records?: string;
+    /** ID to start pagination from. */
+    start_id?: string;
+}
+/** Parameters for fetching OTA job node status counts (summary). */
+export interface GetOTAJobStatusSummaryParams {
+    /** ID of the OTA job. */
+    ota_job_id: string;
+}
+/**
+ * Per-node OTA status counts for a job (GET admin/otajob/status/summary).
+ * Individual counts may be omitted by the server; treat missing as zero in UI.
+ */
+export interface OTAJobStatusSummaryResponse {
+    in_progress?: number;
+    triggered?: number;
+    started?: number;
+    rejected?: number;
+    delayed?: number;
+    success?: number;
+    failed?: number;
+    total?: number;
+}
+/** Request body for retriggering a failed OTA job. */
+export interface RetriggerOTAJobRequest {
+    /** ID of the OTA job to retrigger. */
+    ota_job_id: string;
+    /** List of node IDs to retrigger the job for. */
+    node_ids?: string[];
+}
+/** Related artifact bundled with an OTA image (e.g. bootloader). */
+export interface OTAImageRelatedFile {
+    /** Server path or identifier for the file. */
+    file_id: string;
+    /** Display name for the file. */
+    file_name: string;
+    /** Kind of related file (e.g. bootloader). */
+    file_type: string;
+    /** MD5 checksum of the file. */
+    file_md5: string;
+}
+/** OTA image response. */
+export interface OTAImageInfo {
+    /** Unique identifier of the OTA image. */
+    ota_image_id: string;
+    /** Name of the OTA image. */
+    image_name: string;
+    /** Node type this image targets. */
+    type: string;
+    /** Node model this image targets. */
+    model: string;
+    /** Firmware version of this image. */
+    fw_version: string;
+    /** Size of the image file in bytes. */
+    file_size?: number;
+    /** Current status of the image. */
+    status?: string;
+    /** Timestamp when the image was created. */
+    timestamp?: number;
+    /** Whether the image is archived. */
+    archived?: boolean;
+    /** Presigned or public URL for the main firmware binary (detail responses). */
+    image_url?: string;
+    /** MD5 checksum of the main image file (detail responses). */
+    file_md5?: string;
+    /** Stream identifier associated with the image (detail responses). */
+    stream_id?: string;
+    /** Upload or last-modified time as Unix epoch seconds (detail responses). */
+    upload_timestamp?: number;
+    /** Additional files shipped with this image (e.g. bootloader). */
+    related_files?: OTAImageRelatedFile[];
+}
+/** Response returned after creating an OTA image. */
+export interface OTAImageCreateResponse {
+    /** ID assigned to the newly created image. */
+    ota_image_id: string;
+    /** Name of the created image. */
+    image_name: string;
+    /** Status of the creation operation. */
+    status: string;
+    /** Human-readable description of the result. */
+    description: string;
+    /** Presigned URL for uploading the image file. */
+    image_url?: string;
+}
+/** Paginated response containing a list of OTA images. */
+export interface GetOTAImagesResponse {
+    /** List of OTA image objects. */
+    ota_images?: OTAImageInfo[];
+    /** ID to use for fetching the next page. */
+    next_id?: string;
+    /** Total number of images matching the query. */
+    total?: number;
+}
+/** OTA job response. */
+export interface OTAJobInfo {
+    /** Unique identifier of the OTA job. */
+    ota_job_id: string;
+    /** ID of the OTA image used by this job. */
+    ota_image_id: string;
+    /** Current status of the job. */
+    status: string;
+    /** Timestamp when the job was created. */
+    timestamp?: number;
+    /** Scheduling priority (1–10), when returned by the API. */
+    priority?: number;
+    /** Stream identifier associated with the job, when returned by the API. */
+    stream_id?: string;
+    /** Human-readable additional status text from the backend. */
+    additional_info?: string;
+    /** Whether the job is continuous / recurring when returned by the API. */
+    continuous?: boolean;
+    /** Additional job properties. */
+    [key: string]: unknown;
+}
+/** Response returned after creating an OTA job. */
+export interface OTAJobCreateResponse {
+    /** ID assigned to the newly created job. */
+    ota_job_id: string;
+    /** Status of the creation operation. */
+    status: string;
+    /** Human-readable description of the result. */
+    description: string;
+}
+/** Paginated response containing a list of OTA jobs. */
+export interface GetOTAJobsResponse {
+    /** List of OTA job objects. */
+    ota_update_jobs?: OTAJobInfo[];
+    /** ID to use for fetching the next page. */
+    next_id?: string;
+    /** Total number of jobs matching the query. */
+    total?: number;
+}
+/** Per-node OTA status row (GET admin/otajob/status). */
+export interface NodeOTAJobStatusEntry {
+    /** Target node identifier. */
+    node_id: string;
+    /** Current OTA phase for this node (API-specific string). */
+    status?: string;
+    /** Additional human-readable detail from the backend. */
+    additional_info?: string;
+    /** Timestamp associated with this status entry (typically Unix epoch seconds). */
+    timestamp?: number;
+    /** Source label for `timestamp` (e.g. CLOUD). */
+    ts_source?: string;
+}
+/** Response containing per-node OTA status rows for a job (GET admin/otajob/status). */
+export interface OTAJobStatusResponse {
+    /** Ordered list of node status rows returned for this query. */
+    node_ota_status?: NodeOTAJobStatusEntry[];
+    /** Cursor for the next page when paginating list results. */
+    next_id?: string;
+    /** Total matching rows when reported by the server. */
+    total?: number;
+}
+/** Parameters for requesting a pre-signed OTA image upload URL. */
+export interface GetOTAImageUploadUrlParams {
+    /** Name of the image file. */
+    image_name: string;
+    /** Set to "raw" when uploading the image as raw. */
+    image_type?: "raw";
+}
+/** Response containing a pre-signed URL for OTA image upload. */
+export interface OTAImageUploadUrlResponse {
+    /** Pre-signed URL to upload the image file to. */
+    upload_url: string;
+    /** ID assigned to the OTA image. */
+    ota_image_id: string;
+    /** Status of the request. */
+    status: string;
+}
+/** Request body for confirming an OTA image upload. */
+export interface ConfirmOTAImageUploadRequest {
+    /** ID of the OTA image to confirm. */
+    ota_image_id: string;
+    /** Firmware version of the uploaded image. */
+    fw_version?: string;
+    /** Node type this image targets. */
+    type?: string;
+    /** Node model this image targets. */
+    model?: string;
+    /** Set to "raw" when the image was uploaded as raw. */
+    image_type?: "raw";
+}
+/** Response returned after confirming an OTA image upload. */
+export interface ConfirmOTAImageUploadResponse {
+    /** ID of the confirmed OTA image. */
+    ota_image_id: string;
+    /** Permanent URL of the uploaded image. */
+    image_url: string;
+    /** Status of the confirmation. */
+    status: string;
+}
+/** Parameters for requesting a pre-signed OTA package upload URL. */
+export interface GetOTAPackageUploadUrlParams {
+    /** Name of the package file. */
+    file_name: string;
+}
+/** Response containing a pre-signed URL for OTA package upload. */
+export interface OTAPackageUploadUrlResponse {
+    /** Pre-signed URL to upload the package file to. */
+    url: string;
+    /** Status of the request. */
+    status: string;
+}
+/** Request body for confirming an OTA package upload. */
+export interface ConfirmOTAPackageUploadRequest {
+    /** Path of the uploaded package file. */
+    file_path: string;
+    /** Name of the OTA image. */
+    image_name: string;
+    /** Firmware version. */
+    fw_version?: string;
+    /** Node type this package targets. */
+    type?: string;
+    /** Node model this package targets. */
+    model?: string;
+}
+/** Response returned after confirming an OTA package upload. */
+export interface ConfirmOTAPackageUploadResponse {
+    /** ID of the created OTA image. */
+    ota_image_id?: string;
+    /** Status of the confirmation. */
+    status: string;
+    /** Human-readable description of the result. */
+    description?: string;
+}

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

@@ -0,0 +1,49 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export type { ESPAPIError, ESPAPISuccessResponse } from "./api.cjs";
+export type { LoginWithPasswordResponse, ExtendSessionResponse, LoginWithoutPasswordResponse, GetUserInfoResponse, } from "./auth.cjs";
+export type { AdminUserInfo, GetAdminUsersResponse } from "./admin_user.cjs";
+export type { AdminNodeInfo, AdminNodeListResponse, GetNodeTagsResponse, NodeStatusSummaryResponse, } from "./node.cjs";
+export type { OTAImageInfo, OTAImageRelatedFile, OTAImageCreateResponse, GetOTAImagesResponse, OTAImageUploadUrlResponse, ConfirmOTAImageUploadResponse, OTAPackageUploadUrlResponse, ConfirmOTAPackageUploadResponse, OTAJobInfo, OTAJobCreateResponse, GetOTAJobsResponse, NodeOTAJobStatusEntry, OTAJobStatusResponse, OTAJobStatusSummaryResponse, } from "./ota.cjs";
+export type { AdminGroupInfo, CreateAdminGroupResponse, GetAdminGroupsResponse, } from "./group.cjs";
+export type { TagResourceInfo, GetAdminTagsResponse, GetTagNamesResponse, } from "./tag.cjs";
+export type { CommandRequestInfo, GetCommandRequestsResponse, AddCommandRequestResponse, } from "./command_response.cjs";
+export type { EventFilterInfo, GetEventFiltersResponse } from "./event_filter.cjs";
+export type { TimeSeriesParamData, TimeSeriesNodeData, GetTimeSeriesDataResponse, GetSimpleTimeSeriesDataResponse, } from "./time_series.cjs";
+export type { CustomDataResponse } from "./custom_data.cjs";
+export type { RoleInfo, GetRolesResponse, PolicyJson, PolicyInfo, GetPoliciesResponse, GetUserRolesResponse, } from "./rbac.cjs";
+export type { KeyInfo, CreateKeyResponse, GetKeysResponse, } from "./key.cjs";
+export type { SignImageResponse, GetSigningStatusResponse, SignedImageInfo, GetSignedImagesResponse, GetSigningKeysResponse, } from "./secure_sign.cjs";
+export type { FileUploadUrlResponse, ConfirmFileUploadResponse, FileDetailInfo, GetFilesResponse, } from "./file.cjs";
+export type { AdminUserNodeAssociation, AdminUserNodesBucket, AdminUserNodesResponse, } from "./user_node.cjs";
+export type { AdminUserNodeHistoryNode, AdminUserNodeHistoryResponse, AdminUserNodeHistoryUserEntry, } from "./user_node_history.cjs";
+export type { APIPathInfo, GetAPIPathsResponse } from "./api_info.cjs";
+export type { CognitoAppClientInfo, GetCognitoAppClientsResponse, } from "./cognito_app_client.cjs";
+export type { GetCognitoDomainResponse } from "./cognito_domain.cjs";
+export type { GetIdentityProvidersResponse } from "./identity_provider.cjs";
+export type { MessageTemplateInfo, GetMessageTemplatesResponse, GetVerifiedEmailsResponse, } from "./message_template.cjs";
+export type { GetDashboardUpdateStatusResponse, GetDashboardVersionMappingResponse, } from "./dashboard.cjs";
+export type { LicenseFileInfo, GetLicenseFileResponse, GetLicenseQuotaResponse, } from "./license.cjs";
+export type { GenerateNodeIdsResponse, GetNodeIdsResponse, NodeCertificateInfo, GetNodeCertificatesResponse, NodeCertificateRegistrationStatusResponse, GetMQTTHostResponse, } from "./node_registration.cjs";
+export type { GetDeploymentDetailsResponse } from "./deployment_details.cjs";
+export type { GetCommonCustomDataResponse } from "./common_custom_data.cjs";
+export type { GetDeploymentSettingsResponse, GetRbacDeploymentSettingResponse, RbacConfigurationValue, } from "./deployment_setting.cjs";
+export type { GetNotificationsResponse } from "./configuration.cjs";
+export type { GetIoTDeviceRateRuleResponse } from "./iot_device_rate_limit.cjs";
+export type { GetAPIRateLimitResponse } from "./api_rate_limit.cjs";
+export type { CustomMessageTemplateInfo, GetCustomMessageTemplatesResponse, } from "./custom_message_template.cjs";
+export type { MobilePlatformInfo, CreateMobilePlatformResponse, GetMobilePlatformsResponse, } from "./mobile_platform.cjs";
+export type { PassthroughConfigInfo, CreatePassthroughConfigResponse, GetPassthroughConfigResponse, } from "./passthrough.cjs";
+export type { GetNodeCACertificateResponse } from "./node_certificate_ca.cjs";
+export type { WebhookIntegrationInfo, GetWebhookIntegrationsResponse, WebhookEventMappingInfo, GetWebhookEventMappingResponse, } from "./webhook.cjs";
+export type { StatsCount, StatsObject, GetStatsInfoResponse, } from "./statistical_service.cjs";
+export type { MailFailureInfo, GetMailFailuresResponse } from "./mail_failure.cjs";
+export type { GetTermsPolicyResponse } from "./terms_policy.cjs";
+export type { DeploymentCapabilityInfo, GetDeploymentCapabilitiesResponse, } from "./deployment_capability.cjs";
+export type { GetAPIStatisticsResponse } from "./api_statistics.cjs";
+export type { GetMQTTStatisticsRawResponse, GetMQTTStatisticsResponse, } from "./mqtt_statistics.cjs";
+export type { MatterAuthKeyResponse, MatterAuthKeyInfo, GetMatterAuthResponse, MatterBatchInfo, GetMatterBatchResponse, MatterBatchNodeInfo, GetMatterBatchNodesResponse, } from "./matter.cjs";
+export type { GetNodeParamsResponse } from "./node_params.cjs";

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

@@ -0,0 +1,89 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for creating a passthrough service configuration. */
+export interface CreatePassthroughConfigRequest {
+    /** The name of the passthrough service. */
+    service_name: string;
+    /** The API URL for the passthrough service. */
+    api_url: string;
+    /** The authentication type (e.g., api_key, token, login). */
+    auth_type?: string;
+    /** The API key used for authentication. */
+    api_key?: string;
+    /** The auth token used for authentication. */
+    auth_token?: string;
+    /** The login API URL for token-based authentication. */
+    login_api_url?: string;
+    /** Credentials payload sent to the login API. */
+    login_credentials?: Record<string, unknown>;
+    /** The field name in the login response that contains the auth token. */
+    auth_field_name_in_resp?: string;
+    /** How the auth credential is sent (e.g., header, query). */
+    auth_send_medium?: string;
+    /** The HTTP method used for the login API request. */
+    login_api_request_type?: string;
+    /** How the auth credential is sent in the login API request. */
+    login_api_auth_send_medium?: string;
+}
+/** Request body for updating a passthrough service configuration. */
+export interface UpdatePassthroughConfigRequest {
+    /** The name of the passthrough service. */
+    service_name?: string;
+    /** The API URL for the passthrough service. */
+    api_url?: string;
+    /** The authentication type (e.g., api_key, token, login). */
+    auth_type?: string;
+    /** The API key used for authentication. */
+    api_key?: string;
+    /** The auth token used for authentication. */
+    auth_token?: string;
+    /** The login API URL for token-based authentication. */
+    login_api_url?: string;
+    /** Credentials payload sent to the login API. */
+    login_credentials?: Record<string, unknown>;
+    /** The field name in the login response that contains the auth token. */
+    auth_field_name_in_resp?: string;
+    /** How the auth credential is sent (e.g., header, query). */
+    auth_send_medium?: string;
+}
+/** Query parameters for listing passthrough configurations. */
+export interface GetPassthroughConfigParams {
+    /** Filter by service ID. */
+    service_id?: string;
+    /** Filter by service name. */
+    service_name?: string;
+    /** Pagination cursor for the starting record. */
+    start_id?: string;
+    /** Maximum number of records to return. */
+    num_records?: number;
+}
+/** Details of a passthrough service configuration. */
+export interface PassthroughConfigInfo {
+    /** The unique identifier of the service. */
+    service_id?: string;
+    /** The name of the passthrough service. */
+    service_name?: string;
+    /** The API URL for the passthrough service. */
+    api_url?: string;
+    /** The authentication type configured for this service. */
+    auth_type?: string;
+    /** Additional dynamic properties. */
+    [key: string]: unknown;
+}
+/** Response returned after creating a passthrough configuration. */
+export interface CreatePassthroughConfigResponse {
+    /** The generated service ID. */
+    service_id?: string;
+    /** The status of the creation request. */
+    status?: string;
+}
+/** Response containing a list of passthrough configurations. */
+export interface GetPassthroughConfigResponse {
+    /** Array of passthrough service configurations. */
+    services?: PassthroughConfigInfo[];
+    /** Pagination cursor for the next page of results. */
+    next_id?: string;
+}

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

@@ -0,0 +1,27 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for publishing a push notification message. */
+export interface PublishMessageRequest {
+    /** The notification title. */
+    message_title: string;
+    /** The notification body content. */
+    message_body: string;
+    /** The target user's email address. */
+    email?: string;
+    /** The target user's ID. */
+    user_id?: string;
+    /** Whether to publish to all users. */
+    publish_to_all_users?: boolean;
+    /** The notification type. */
+    type?: string;
+    /** Additional metadata for the notification. */
+    additional_info?: Record<string, unknown>;
+}
+/** Query parameters for publishing a push notification message. */
+export interface PublishMessageQueryParams {
+    /** When true, GCM messages are sent in the data field instead of notification. */
+    send_data_only?: boolean;
+}

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

@@ -0,0 +1,136 @@
+/*
+ * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/** Request body for creating a new role. */
+export interface CreateRoleRequest {
+    /** Name of the role. */
+    role_name: string;
+    /** List of policy names to attach to this role. */
+    policies: string[];
+    /** Privilege level of the role (lower is more privileged). */
+    role_level?: number;
+}
+/** Parameters for updating a role. */
+export interface UpdateRoleParams {
+    /** Name of the role to update. */
+    role_name: string;
+    /** Operation to perform (e.g., "add" or "remove"). */
+    operation: string;
+}
+/** Request body for updating a role's properties. */
+export interface UpdateRoleRequest {
+    /** Updated list of policy names. */
+    policies?: string[];
+    /** Updated privilege level. */
+    role_level?: number;
+}
+/** Parameters for listing roles. */
+export interface GetRolesParams {
+    /** Filter by specific role name. */
+    role_name?: string;
+}
+/** Request body for creating a new policy. */
+export interface CreatePolicyRequest {
+    /** Name of the policy. */
+    policy_name: string;
+    /** JSON document defining the policy rules. */
+    policy_json: Record<string, unknown>;
+}
+/** Request body for updating a policy. */
+export interface UpdatePolicyRequest {
+    /** Updated JSON document defining the policy rules. */
+    policy_json: Record<string, unknown>;
+}
+/** Parameters for listing policies. */
+export interface GetPoliciesParams {
+    /** Filter by specific policy name. */
+    policy_name?: string;
+    /** Maximum number of records per page. */
+    num_records?: string | number;
+    /** Pagination cursor from the previous response's `next_id`. */
+    start_id?: string;
+}
+/** Parameters for updating a user's role assignment. */
+export interface UpdateUserRoleParams {
+    /** Username to update roles for. */
+    user_name: string;
+    /** User ID to update roles for. */
+    user_id?: string;
+    /** Operation to perform (e.g., "add" or "remove"). */
+    operation: string;
+}
+/** Request body for updating a user's roles. */
+export interface UpdateUserRoleRequest {
+    /** List of role names to assign. */
+    roles: string[];
+}
+/** Parameters for listing user role assignments. */
+export interface GetUserRolesParams {
+    /** Filter by username. */
+    user_name?: string;
+    /** Filter by user ID. */
+    user_id?: string;
+    /** Filter by role name. */
+    role_name?: string;
+}
+/** Role information returned by the API. */
+export interface RoleInfo {
+    /** Name of the role. */
+    role_name: string;
+    /** Policies attached to this role. */
+    policies?: string[];
+    /** Privilege level of the role. */
+    role_level?: number;
+}
+/** Response containing a list of roles. */
+export interface GetRolesResponse {
+    /** List of role objects. */
+    roles?: RoleInfo[];
+}
+/** Structured policy document. */
+export interface PolicyJson {
+    /** Version of the policy schema. */
+    version?: string;
+    /** RBAC 2.x service this policy applies to. */
+    service_name?: string;
+    /** Filter rules applied by this policy. */
+    filters?: Array<{
+        type: string;
+        rules: Record<string, unknown>;
+    }>;
+    /** Permission statements defining allowed or denied actions. */
+    statement?: Array<{
+        effect?: string;
+        action?: string[];
+        resource?: string[];
+        [key: string]: unknown;
+    }>;
+    /** Additional policy fields (permissions, conditions, etc.). */
+    [key: string]: unknown;
+}
+/** Policy information returned by the API. */
+export interface PolicyInfo {
+    /** Name of the policy. */
+    policy_name: string;
+    /** Policy document defining the rules. */
+    policy_json?: PolicyJson;
+}
+/** Response containing a list of policies. */
+export interface GetPoliciesResponse {
+    /** List of policy objects. */
+    policies?: PolicyInfo[];
+    /** Pagination cursor for the next page. */
+    next_id?: string;
+}
+/** Response containing user role assignments. */
+export interface GetUserRolesResponse {
+    /** Roles assigned to the queried user. */
+    roles?: string[];
+    /**
+     * Users assigned to the queried role — typically an array of username strings
+     * (`GET admin/user_role?role_name=...`).
+     */
+    users?: string[];
+}