@smplkit/sdk 3.0.30 → 3.0.31

package/dist/index.d.cts

@@ -439,6 +439,11 @@ interface components$1 {
         };
         /**
          * LogGroup
+         * @description A named collection of loggers that share a level configuration.
+         *
+         *     Assigning a logger to a group ties the logger's effective level to
+         *     the group's level (and per-environment overrides). Loggers can move
+         *     between groups or be detached from a group entirely.
          * @example {
          *       "created_at": "2026-04-01T10:00:00Z",
          *       "environments": {
@@ -452,28 +457,61 @@ interface components$1 {
          *     }
          */
         LogGroup: {
-            /** Name */
+            /**
+             * Name
+             * @description Human-readable label for the group.
+             */
             name: string;
-            /** Level */
-            level?: string | null;
-            /** Parent Id */
+            /**
+             * Level
+             * @description Default level applied to every logger in the group. `null` leaves member loggers to inherit from elsewhere.
+             */
+            level?: ("TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL" | "SILENT") | null;
+            /**
+             * Parent Id
+             * @description Reserved for nested groups. Must be `null` in this version; nested groups are not yet supported.
+             */
             parent_id?: string | null;
-            /** Environments */
+            /**
+             * Environments
+             * @description Per-environment level overrides keyed by environment name. Each value is an object with an optional `level` field, e.g. `{"production": {"level": "ERROR"}}`. Member loggers inherit the per-environment level unless they set their own override.
+             */
             environments?: {
                 [key: string]: unknown;
             } | null;
-            /** Created At */
+            /**
+             * Created At
+             * @description When the group was created.
+             */
             readonly created_at?: string | null;
-            /** Updated At */
+            /**
+             * Updated At
+             * @description When the group was last modified.
+             */
             readonly updated_at?: string | null;
         };
-        /** LogGroupListResponse */
+        /**
+         * LogGroupListResponse
+         * @description JSON:API collection response for log groups.
+         */
         LogGroupListResponse: {
             /** Data */
             data: components$1["schemas"]["LogGroupResource"][];
         };
+        /**
+         * LogGroupRequest
+         * @description JSON:API request envelope for creating or updating a log group.
+         */
+        LogGroupRequest: {
+            data: components$1["schemas"]["LogGroupResource"];
+        };
         /**
          * LogGroupResource
+         * @description JSON:API resource envelope for a log group.
+         *
+         *     `id` is the group's key (e.g. `database-loggers`). On a create
+         *     request the id may be supplied; if omitted, the server generates
+         *     one from `name`.
          * @example {
          *       "attributes": {
          *         "created_at": "2026-04-01T10:00:00Z",
@@ -500,12 +538,22 @@ interface components$1 {
             type: "log_group";
             attributes: components$1["schemas"]["LogGroup"];
         };
-        /** LogGroupResponse */
+        /**
+         * LogGroupResponse
+         * @description JSON:API single-resource response envelope for a log group.
+         */
         LogGroupResponse: {
             data: components$1["schemas"]["LogGroupResource"];
         };
         /**
          * Logger
+         * @description A logger configured for the account.
+         *
+         *     Loggers are organized by dot-separated key (for example, `sqlalchemy.engine`),
+         *     matching the hierarchical naming convention used by most logging
+         *     frameworks. A managed logger applies the configured level to every
+         *     runtime where the logger appears; unmanaged loggers are tracked only
+         *     as observations from SDKs.
          * @example {
          *       "created_at": "2026-04-01T10:00:00Z",
          *       "environments": {
@@ -524,33 +572,61 @@ interface components$1 {
          *     }
          */
         Logger: {
-            /** Name */
+            /**
+             * Name
+             * @description Human-readable label for the logger.
+             */
             name: string;
-            /** Level */
-            level?: string | null;
-            /** Group */
+            /**
+             * Level
+             * @description Account-wide log level applied to this logger. `null` means no override at the logger level — the level is inherited from the logger's group or the framework default.
+             */
+            level?: ("TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL" | "SILENT") | null;
+            /**
+             * Group
+             * @description Key of the log group this logger belongs to, or `null` if the logger is not grouped. Assigning a logger to a group promotes it to managed; assigning a group cascades to unmanaged descendants by clearing their group reference.
+             */
             group?: string | null;
-            /** Managed */
+            /**
+             * Managed
+             * @description When `true`, the logger is part of the account's managed configuration and counts toward the managed-loggers usage counter. Setting `level`, `group`, or `environments` on an unmanaged logger promotes it to managed automatically.
+             */
             managed?: boolean | null;
-            /** Sources */
+            /**
+             * Sources
+             * @description Service / environment observations reported by SDKs for this logger. Each entry carries the service name, environment, the level the SDK saw, the resolved level after framework inheritance, and timestamps for the first and most recent sighting.
+             */
             readonly sources?: {
                 [key: string]: unknown;
             }[] | null;
-            /** Environments */
+            /**
+             * Environments
+             * @description Per-environment level overrides keyed by environment name. Each value is an object with an optional `level` field, e.g. `{"production": {"level": "WARN"}}`. An environment may be present with no `level` to record that the logger applies there without changing the resolved level.
+             */
             environments?: {
                 [key: string]: unknown;
             } | null;
-            /** Effective Levels */
+            /**
+             * Effective Levels
+             * @description Per-environment summary of what runtimes are reporting for this logger. Keyed by environment name; each entry is one of `{"status": "none"}`, `{"status": "agrees", "level": "<LEVEL>"}`, or `{"status": "varies"}`. `agrees` means every observed source in that environment reports the same resolved level; `varies` means at least two sources disagree.
+             */
             readonly effective_levels?: {
                 [key: string]: unknown;
             } | null;
-            /** Created At */
+            /**
+             * Created At
+             * @description When the logger was first created or discovered.
+             */
             readonly created_at?: string | null;
-            /** Updated At */
+            /**
+             * Updated At
+             * @description When the logger was last modified.
+             */
             readonly updated_at?: string | null;
         };
         /**
          * LoggerBulkItem
+         * @description One logger discovered by an SDK during a bulk registration call.
          * @example {
          *       "environment": "production",
          *       "id": "sqlalchemy.engine",
@@ -562,32 +638,33 @@ interface components$1 {
         LoggerBulkItem: {
             /**
              * Id
-             * @description Normalized logger name
+             * @description Dot-separated logger key as the SDK saw it.
              */
             id: string;
             /**
              * Level
-             * @description The explicitly-set level on this logger. Null if inherited.
+             * @description Level explicitly set on the logger by application code. `null` when the level is inherited.
              */
             level?: string | null;
             /**
              * Resolved Level
-             * @description The effective level after framework inheritance. Never null in compliant SDKs.
+             * @description Effective level after framework inheritance. SDKs should always report this; the server falls back to `level` when `resolved_level` is missing.
              */
             resolved_level?: string | null;
             /**
              * Service
-             * @description Service name that discovered this logger
+             * @description Service name that observed the logger.
              */
             service?: string | null;
             /**
              * Environment
-             * @description Environment where this logger was observed
+             * @description Environment where the logger was observed.
              */
             environment?: string | null;
         };
         /**
          * LoggerBulkRequest
+         * @description Payload for bulk registration of loggers discovered by an SDK.
          * @example {
          *       "loggers": [
          *         {
@@ -606,26 +683,48 @@ interface components$1 {
          *     }
          */
         LoggerBulkRequest: {
-            /** Loggers */
+            /**
+             * Loggers
+             * @description Loggers to register or refresh observations for.
+             */
             loggers: components$1["schemas"]["LoggerBulkItem"][];
         };
         /**
          * LoggerBulkResponse
+         * @description Result of a bulk registration call.
          * @example {
          *       "registered": 5
          *     }
          */
         LoggerBulkResponse: {
-            /** Registered */
+            /**
+             * Registered
+             * @description Number of loggers that were created or had a source observation refreshed.
+             */
             registered: number;
         };
-        /** LoggerListResponse */
+        /**
+         * LoggerListResponse
+         * @description JSON:API collection response for loggers.
+         */
         LoggerListResponse: {
             /** Data */
             data: components$1["schemas"]["LoggerResource"][];
         };
+        /**
+         * LoggerRequest
+         * @description JSON:API request envelope for creating or updating a logger.
+         */
+        LoggerRequest: {
+            data: components$1["schemas"]["LoggerResource"];
+        };
         /**
          * LoggerResource
+         * @description JSON:API resource envelope for a logger.
+         *
+         *     `id` is the logger's dot-separated key (e.g. `sqlalchemy.engine`).
+         *     On a `PUT /api/v1/loggers/{id}` create, the id is taken from the URL
+         *     path; on update, an `id` in the body renames the logger.
          * @example {
          *       "attributes": {
          *         "created_at": "2026-04-01T10:00:00Z",
@@ -657,12 +756,20 @@ interface components$1 {
             type: "logger";
             attributes: components$1["schemas"]["Logger"];
         };
-        /** LoggerResponse */
+        /**
+         * LoggerResponse
+         * @description JSON:API single-resource response envelope for a logger.
+         */
         LoggerResponse: {
             data: components$1["schemas"]["LoggerResource"];
         };
         /**
          * LoggerSource
+         * @description A single service / environment observation of a logger.
+         *
+         *     A source row exists for every (service, environment) pair that has
+         *     reported the logger via the bulk registration endpoint. The row's
+         *     levels reflect what the SDK saw on the most recent report.
          * @example {
          *       "created_at": "2026-04-01T10:00:00Z",
          *       "environment": "production",
@@ -674,30 +781,58 @@ interface components$1 {
          *     }
          */
         LoggerSource: {
-            /** Service */
+            /**
+             * Service
+             * @description Service that reported the logger.
+             */
             readonly service?: string;
-            /** Environment */
+            /**
+             * Environment
+             * @description Environment the service was running in when it reported the logger.
+             */
             readonly environment?: string;
-            /** Level */
+            /**
+             * Level
+             * @description Level explicitly set on the logger in the source runtime. `null` when the runtime inherits its level.
+             */
             readonly level?: string | null;
-            /** Resolved Level */
+            /**
+             * Resolved Level
+             * @description Effective level the runtime resolved for the logger.
+             */
             readonly resolved_level?: string;
-            /** First Observed */
+            /**
+             * First Observed
+             * @description When this service / environment combination first reported the logger.
+             */
             readonly first_observed?: string | null;
-            /** Last Seen */
+            /**
+             * Last Seen
+             * @description Most recent report received for this service / environment combination.
+             */
             readonly last_seen?: string | null;
-            /** Created At */
+            /**
+             * Created At
+             * @description When the source row was created.
+             */
             readonly created_at?: string | null;
-            /** Updated At */
+            /**
+             * Updated At
+             * @description When the source row was last refreshed.
+             */
             readonly updated_at?: string | null;
         };
-        /** LoggerSourceListResponse */
+        /**
+         * LoggerSourceListResponse
+         * @description JSON:API collection response for logger sources.
+         */
         LoggerSourceListResponse: {
             /** Data */
             data: components$1["schemas"]["LoggerSourceResource"][];
         };
         /**
          * LoggerSourceResource
+         * @description JSON:API resource envelope for a logger source observation.
          * @example {
          *       "attributes": {
          *         "created_at": "2026-04-01T10:00:00Z",
@@ -722,15 +857,27 @@ interface components$1 {
             type: "logger_source";
             attributes: components$1["schemas"]["LoggerSource"];
         };
-        /** ServiceAttributes */
+        /**
+         * ServiceAttributes
+         * @description A discovered service has no attributes beyond its name (the `id`).
+         */
         ServiceAttributes: Record<string, never>;
-        /** ServiceListResponse */
+        /**
+         * ServiceListResponse
+         * @description JSON:API collection response for discovered services.
+         */
         ServiceListResponse: {
             /** Data */
             data: components$1["schemas"]["ServiceResource"][];
         };
         /**
          * ServiceResource
+         * @description JSON:API resource envelope for a discovered service.
+         *
+         *     `id` is the service name as reported by an SDK during bulk
+         *     registration. The resource carries no additional attributes — it
+         *     represents the existence of the service in the account's
+         *     observations, nothing more.
          * @example {
          *       "attributes": {},
          *       "id": "api-gateway",
@@ -748,17 +895,30 @@ interface components$1 {
             /** @default {} */
             attributes: components$1["schemas"]["ServiceAttributes"];
         };
-        /** UsageAttributes */
+        /**
+         * UsageAttributes
+         * @description Usage counter for a single metered limit.
+         */
         UsageAttributes: {
-            /** Limit Key */
+            /**
+             * Limit Key
+             * @description Identifier of the metered limit, e.g. `logging.managed_loggers` or `logging.groups`.
+             */
             limit_key: string;
-            /** Period */
+            /**
+             * Period
+             * @description Period the counter covers. `current` is the only supported value.
+             */
             period: string;
-            /** Value */
+            /**
+             * Value
+             * @description Count for the period.
+             */
             value: number;
         };
         /**
          * UsageListResponse
+         * @description JSON:API collection response for usage counters.
          * @example {
          *       "data": [
          *         {
@@ -788,6 +948,7 @@ interface components$1 {
         };
         /**
          * UsageResource
+         * @description JSON:API resource envelope for a single usage counter.
          * @example {
          *       "attributes": {
          *         "limit_key": "logging.managed_loggers",

package/dist/index.d.ts

@@ -439,6 +439,11 @@ interface components$1 {
         };
         /**
          * LogGroup
+         * @description A named collection of loggers that share a level configuration.
+         *
+         *     Assigning a logger to a group ties the logger's effective level to
+         *     the group's level (and per-environment overrides). Loggers can move
+         *     between groups or be detached from a group entirely.
          * @example {
          *       "created_at": "2026-04-01T10:00:00Z",
          *       "environments": {
@@ -452,28 +457,61 @@ interface components$1 {
          *     }
          */
         LogGroup: {
-            /** Name */
+            /**
+             * Name
+             * @description Human-readable label for the group.
+             */
             name: string;
-            /** Level */
-            level?: string | null;
-            /** Parent Id */
+            /**
+             * Level
+             * @description Default level applied to every logger in the group. `null` leaves member loggers to inherit from elsewhere.
+             */
+            level?: ("TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL" | "SILENT") | null;
+            /**
+             * Parent Id
+             * @description Reserved for nested groups. Must be `null` in this version; nested groups are not yet supported.
+             */
             parent_id?: string | null;
-            /** Environments */
+            /**
+             * Environments
+             * @description Per-environment level overrides keyed by environment name. Each value is an object with an optional `level` field, e.g. `{"production": {"level": "ERROR"}}`. Member loggers inherit the per-environment level unless they set their own override.
+             */
             environments?: {
                 [key: string]: unknown;
             } | null;
-            /** Created At */
+            /**
+             * Created At
+             * @description When the group was created.
+             */
             readonly created_at?: string | null;
-            /** Updated At */
+            /**
+             * Updated At
+             * @description When the group was last modified.
+             */
             readonly updated_at?: string | null;
         };
-        /** LogGroupListResponse */
+        /**
+         * LogGroupListResponse
+         * @description JSON:API collection response for log groups.
+         */
         LogGroupListResponse: {
             /** Data */
             data: components$1["schemas"]["LogGroupResource"][];
         };
+        /**
+         * LogGroupRequest
+         * @description JSON:API request envelope for creating or updating a log group.
+         */
+        LogGroupRequest: {
+            data: components$1["schemas"]["LogGroupResource"];
+        };
         /**
          * LogGroupResource
+         * @description JSON:API resource envelope for a log group.
+         *
+         *     `id` is the group's key (e.g. `database-loggers`). On a create
+         *     request the id may be supplied; if omitted, the server generates
+         *     one from `name`.
          * @example {
          *       "attributes": {
          *         "created_at": "2026-04-01T10:00:00Z",
@@ -500,12 +538,22 @@ interface components$1 {
             type: "log_group";
             attributes: components$1["schemas"]["LogGroup"];
         };
-        /** LogGroupResponse */
+        /**
+         * LogGroupResponse
+         * @description JSON:API single-resource response envelope for a log group.
+         */
         LogGroupResponse: {
             data: components$1["schemas"]["LogGroupResource"];
         };
         /**
          * Logger
+         * @description A logger configured for the account.
+         *
+         *     Loggers are organized by dot-separated key (for example, `sqlalchemy.engine`),
+         *     matching the hierarchical naming convention used by most logging
+         *     frameworks. A managed logger applies the configured level to every
+         *     runtime where the logger appears; unmanaged loggers are tracked only
+         *     as observations from SDKs.
          * @example {
          *       "created_at": "2026-04-01T10:00:00Z",
          *       "environments": {
@@ -524,33 +572,61 @@ interface components$1 {
          *     }
          */
         Logger: {
-            /** Name */
+            /**
+             * Name
+             * @description Human-readable label for the logger.
+             */
             name: string;
-            /** Level */
-            level?: string | null;
-            /** Group */
+            /**
+             * Level
+             * @description Account-wide log level applied to this logger. `null` means no override at the logger level — the level is inherited from the logger's group or the framework default.
+             */
+            level?: ("TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR" | "FATAL" | "SILENT") | null;
+            /**
+             * Group
+             * @description Key of the log group this logger belongs to, or `null` if the logger is not grouped. Assigning a logger to a group promotes it to managed; assigning a group cascades to unmanaged descendants by clearing their group reference.
+             */
             group?: string | null;
-            /** Managed */
+            /**
+             * Managed
+             * @description When `true`, the logger is part of the account's managed configuration and counts toward the managed-loggers usage counter. Setting `level`, `group`, or `environments` on an unmanaged logger promotes it to managed automatically.
+             */
             managed?: boolean | null;
-            /** Sources */
+            /**
+             * Sources
+             * @description Service / environment observations reported by SDKs for this logger. Each entry carries the service name, environment, the level the SDK saw, the resolved level after framework inheritance, and timestamps for the first and most recent sighting.
+             */
             readonly sources?: {
                 [key: string]: unknown;
             }[] | null;
-            /** Environments */
+            /**
+             * Environments
+             * @description Per-environment level overrides keyed by environment name. Each value is an object with an optional `level` field, e.g. `{"production": {"level": "WARN"}}`. An environment may be present with no `level` to record that the logger applies there without changing the resolved level.
+             */
             environments?: {
                 [key: string]: unknown;
             } | null;
-            /** Effective Levels */
+            /**
+             * Effective Levels
+             * @description Per-environment summary of what runtimes are reporting for this logger. Keyed by environment name; each entry is one of `{"status": "none"}`, `{"status": "agrees", "level": "<LEVEL>"}`, or `{"status": "varies"}`. `agrees` means every observed source in that environment reports the same resolved level; `varies` means at least two sources disagree.
+             */
             readonly effective_levels?: {
                 [key: string]: unknown;
             } | null;
-            /** Created At */
+            /**
+             * Created At
+             * @description When the logger was first created or discovered.
+             */
             readonly created_at?: string | null;
-            /** Updated At */
+            /**
+             * Updated At
+             * @description When the logger was last modified.
+             */
             readonly updated_at?: string | null;
         };
         /**
          * LoggerBulkItem
+         * @description One logger discovered by an SDK during a bulk registration call.
          * @example {
          *       "environment": "production",
          *       "id": "sqlalchemy.engine",
@@ -562,32 +638,33 @@ interface components$1 {
         LoggerBulkItem: {
             /**
              * Id
-             * @description Normalized logger name
+             * @description Dot-separated logger key as the SDK saw it.
              */
             id: string;
             /**
              * Level
-             * @description The explicitly-set level on this logger. Null if inherited.
+             * @description Level explicitly set on the logger by application code. `null` when the level is inherited.
              */
             level?: string | null;
             /**
              * Resolved Level
-             * @description The effective level after framework inheritance. Never null in compliant SDKs.
+             * @description Effective level after framework inheritance. SDKs should always report this; the server falls back to `level` when `resolved_level` is missing.
              */
             resolved_level?: string | null;
             /**
              * Service
-             * @description Service name that discovered this logger
+             * @description Service name that observed the logger.
              */
             service?: string | null;
             /**
              * Environment
-             * @description Environment where this logger was observed
+             * @description Environment where the logger was observed.
              */
             environment?: string | null;
         };
         /**
          * LoggerBulkRequest
+         * @description Payload for bulk registration of loggers discovered by an SDK.
          * @example {
          *       "loggers": [
          *         {
@@ -606,26 +683,48 @@ interface components$1 {
          *     }
          */
         LoggerBulkRequest: {
-            /** Loggers */
+            /**
+             * Loggers
+             * @description Loggers to register or refresh observations for.
+             */
             loggers: components$1["schemas"]["LoggerBulkItem"][];
         };
         /**
          * LoggerBulkResponse
+         * @description Result of a bulk registration call.
          * @example {
          *       "registered": 5
          *     }
          */
         LoggerBulkResponse: {
-            /** Registered */
+            /**
+             * Registered
+             * @description Number of loggers that were created or had a source observation refreshed.
+             */
             registered: number;
         };
-        /** LoggerListResponse */
+        /**
+         * LoggerListResponse
+         * @description JSON:API collection response for loggers.
+         */
         LoggerListResponse: {
             /** Data */
             data: components$1["schemas"]["LoggerResource"][];
         };
+        /**
+         * LoggerRequest
+         * @description JSON:API request envelope for creating or updating a logger.
+         */
+        LoggerRequest: {
+            data: components$1["schemas"]["LoggerResource"];
+        };
         /**
          * LoggerResource
+         * @description JSON:API resource envelope for a logger.
+         *
+         *     `id` is the logger's dot-separated key (e.g. `sqlalchemy.engine`).
+         *     On a `PUT /api/v1/loggers/{id}` create, the id is taken from the URL
+         *     path; on update, an `id` in the body renames the logger.
          * @example {
          *       "attributes": {
          *         "created_at": "2026-04-01T10:00:00Z",
@@ -657,12 +756,20 @@ interface components$1 {
             type: "logger";
             attributes: components$1["schemas"]["Logger"];
         };
-        /** LoggerResponse */
+        /**
+         * LoggerResponse
+         * @description JSON:API single-resource response envelope for a logger.
+         */
         LoggerResponse: {
             data: components$1["schemas"]["LoggerResource"];
         };
         /**
          * LoggerSource
+         * @description A single service / environment observation of a logger.
+         *
+         *     A source row exists for every (service, environment) pair that has
+         *     reported the logger via the bulk registration endpoint. The row's
+         *     levels reflect what the SDK saw on the most recent report.
          * @example {
          *       "created_at": "2026-04-01T10:00:00Z",
          *       "environment": "production",
@@ -674,30 +781,58 @@ interface components$1 {
          *     }
          */
         LoggerSource: {
-            /** Service */
+            /**
+             * Service
+             * @description Service that reported the logger.
+             */
             readonly service?: string;
-            /** Environment */
+            /**
+             * Environment
+             * @description Environment the service was running in when it reported the logger.
+             */
             readonly environment?: string;
-            /** Level */
+            /**
+             * Level
+             * @description Level explicitly set on the logger in the source runtime. `null` when the runtime inherits its level.
+             */
             readonly level?: string | null;
-            /** Resolved Level */
+            /**
+             * Resolved Level
+             * @description Effective level the runtime resolved for the logger.
+             */
             readonly resolved_level?: string;
-            /** First Observed */
+            /**
+             * First Observed
+             * @description When this service / environment combination first reported the logger.
+             */
             readonly first_observed?: string | null;
-            /** Last Seen */
+            /**
+             * Last Seen
+             * @description Most recent report received for this service / environment combination.
+             */
             readonly last_seen?: string | null;
-            /** Created At */
+            /**
+             * Created At
+             * @description When the source row was created.
+             */
             readonly created_at?: string | null;
-            /** Updated At */
+            /**
+             * Updated At
+             * @description When the source row was last refreshed.
+             */
             readonly updated_at?: string | null;
         };
-        /** LoggerSourceListResponse */
+        /**
+         * LoggerSourceListResponse
+         * @description JSON:API collection response for logger sources.
+         */
         LoggerSourceListResponse: {
             /** Data */
             data: components$1["schemas"]["LoggerSourceResource"][];
         };
         /**
          * LoggerSourceResource
+         * @description JSON:API resource envelope for a logger source observation.
          * @example {
          *       "attributes": {
          *         "created_at": "2026-04-01T10:00:00Z",
@@ -722,15 +857,27 @@ interface components$1 {
             type: "logger_source";
             attributes: components$1["schemas"]["LoggerSource"];
         };
-        /** ServiceAttributes */
+        /**
+         * ServiceAttributes
+         * @description A discovered service has no attributes beyond its name (the `id`).
+         */
         ServiceAttributes: Record<string, never>;
-        /** ServiceListResponse */
+        /**
+         * ServiceListResponse
+         * @description JSON:API collection response for discovered services.
+         */
         ServiceListResponse: {
             /** Data */
             data: components$1["schemas"]["ServiceResource"][];
         };
         /**
          * ServiceResource
+         * @description JSON:API resource envelope for a discovered service.
+         *
+         *     `id` is the service name as reported by an SDK during bulk
+         *     registration. The resource carries no additional attributes — it
+         *     represents the existence of the service in the account's
+         *     observations, nothing more.
          * @example {
          *       "attributes": {},
          *       "id": "api-gateway",
@@ -748,17 +895,30 @@ interface components$1 {
             /** @default {} */
             attributes: components$1["schemas"]["ServiceAttributes"];
         };
-        /** UsageAttributes */
+        /**
+         * UsageAttributes
+         * @description Usage counter for a single metered limit.
+         */
         UsageAttributes: {
-            /** Limit Key */
+            /**
+             * Limit Key
+             * @description Identifier of the metered limit, e.g. `logging.managed_loggers` or `logging.groups`.
+             */
             limit_key: string;
-            /** Period */
+            /**
+             * Period
+             * @description Period the counter covers. `current` is the only supported value.
+             */
             period: string;
-            /** Value */
+            /**
+             * Value
+             * @description Count for the period.
+             */
             value: number;
         };
         /**
          * UsageListResponse
+         * @description JSON:API collection response for usage counters.
          * @example {
          *       "data": [
          *         {
@@ -788,6 +948,7 @@ interface components$1 {
         };
         /**
          * UsageResource
+         * @description JSON:API resource envelope for a single usage counter.
          * @example {
          *       "attributes": {
          *         "limit_key": "logging.managed_loggers",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smplkit/sdk",
-  "version": "3.0.30",
+  "version": "3.0.31",
   "type": "module",
   "description": "Official TypeScript SDK for the smplkit platform",
   "main": "./dist/index.cjs",