@smplkit/sdk 3.0.47 → 3.0.49

package/dist/index.d.cts

@@ -1239,6 +1239,7 @@ interface components {
         FlagListResponse: {
             /** Data */
             data: components["schemas"]["FlagResource"][];
+            meta: components["schemas"]["ListMeta"];
         };
         /**
          * FlagRequest
@@ -1399,6 +1400,7 @@ interface components {
         FlagSourceListResponse: {
             /** Data */
             data: components["schemas"]["FlagSourceResource"][];
+            meta: components["schemas"]["ListMeta"];
         };
         /**
          * FlagSourceResource
@@ -1448,6 +1450,13 @@ interface components {
              */
             value: unknown;
         };
+        /**
+         * ListMeta
+         * @description Top-level ``meta`` block included on every JSON:API list response.
+         */
+        ListMeta: {
+            pagination: components["schemas"]["PaginationMeta"];
+        };
         /**
          * ManualReviewItem
          * @description A flag rule that could not be safely modified by the bulk
@@ -1475,6 +1484,37 @@ interface components {
              */
             reason: string;
         };
+        /**
+         * PaginationMeta
+         * @description Pagination block returned inside ``meta`` on every list response.
+         *
+         *     ``page`` and ``size`` are always present and echo the parameters that
+         *     served the response (their defaults when the client omitted them).
+         *     ``total`` and ``total_pages`` are present only when the request included
+         *     ``meta[total]=true``.
+         */
+        PaginationMeta: {
+            /**
+             * Page
+             * @description 1-based page number returned.
+             */
+            page: number;
+            /**
+             * Size
+             * @description Number of items per page.
+             */
+            size: number;
+            /**
+             * Total
+             * @description Total number of matching items across all pages. Present only when the request included `meta[total]=true`.
+             */
+            total?: number | null;
+            /**
+             * Total Pages
+             * @description Total number of pages at the requested page size. Present only when the request included `meta[total]=true`.
+             */
+            total_pages?: number | null;
+        };
         /**
          * RemoveReferencesAttributes
          * @description Counts and follow-ups returned by the remove-references action.
@@ -1594,6 +1634,7 @@ interface components {
         UsageListResponse: {
             /** Data */
             data: components["schemas"]["UsageResource"][];
+            meta: components["schemas"]["ListMeta"];
         };
         /**
          * UsageResource
@@ -2093,8 +2134,18 @@ declare class ManagementConfigClient {
         description?: string;
         parent?: string | Config | null;
     }): Config;
-    /** List all configs. */
-    list(): Promise<Config[]>;
+    /**
+     * List configs.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<Config[]>;
     /** Fetch a config by id. */
     get(id: string): Promise<Config>;
     /** Delete a config by id. */
@@ -2530,8 +2581,18 @@ declare class ManagementFlagsClient {
     }): JsonFlag;
     /** Fetch a flag by id. */
     get(id: string): Promise<Flag>;
-    /** List all flags. */
-    list(): Promise<Flag[]>;
+    /**
+     * List flags.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<Flag[]>;
     /** Delete a flag by id. */
     delete(id: string): Promise<void>;
     /** @internal — called by `Flag.delete()`. */
@@ -2798,7 +2859,18 @@ declare class LoggersClient {
     new(id: string, options?: {
         managed?: boolean;
     }): Logger;
-    list(): Promise<Logger[]>;
+    /**
+     * List loggers.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<Logger[]>;
     get(id: string): Promise<Logger>;
     delete(id: string): Promise<void>;
     /** @internal — called by `Logger.delete()`. */
@@ -2826,7 +2898,18 @@ declare class LogGroupsClient {
         name?: string;
         group?: string;
     }): LogGroup;
-    list(): Promise<LogGroup[]>;
+    /**
+     * List log groups.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<LogGroup[]>;
     get(id: string): Promise<LogGroup>;
     delete(id: string): Promise<void>;
     /** @internal — called by `LogGroup.delete()`. */
@@ -2897,7 +2980,18 @@ declare class EnvironmentsClient {
         color?: Color | string | null;
         classification?: EnvironmentClassification;
     }): Environment;
-    list(): Promise<Environment[]>;
+    /**
+     * List environments.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<Environment[]>;
     get(id: string): Promise<Environment>;
     delete(id: string): Promise<void>;
     /** @internal */
@@ -2919,7 +3013,18 @@ declare class ContextTypesClient {
         name?: string;
         attributes?: Record<string, Record<string, any>>;
     }): ContextType;
-    list(): Promise<ContextType[]>;
+    /**
+     * List context types.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<ContextType[]>;
     get(id: string): Promise<ContextType>;
     delete(id: string): Promise<void>;
     /** @internal */
@@ -2965,8 +3070,18 @@ declare class ContextsClient {
     flush(): Promise<void>;
     /** Number of contexts awaiting flush. */
     get pendingCount(): number;
-    /** List all contexts of a given type. */
-    list(type: string): Promise<Context[]>;
+    /**
+     * List contexts of a given type.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(type: string, params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<Context[]>;
     /** Fetch a context by composite id (`"type:key"`) or by separate type and key. */
     get(idOrType: string, key?: string): Promise<Context>;
     /** Delete a context by composite id (`"type:key"`) or by separate type and key. */
@@ -3159,6 +3274,10 @@ declare class ConfigClient {
      * (set via `_resolveManagement`) so runtime + management share one HTTP
      * client; falls back to a direct GET when running without `SmplClient`
      * bootstrap (e.g. unit tests that construct `ConfigClient` directly).
+     *
+     * Pages through the server until a short page (less than the requested
+     * size) is returned — accounts with more than 1000 configs would
+     * otherwise silently lose everything past page one.
      */
     private _listConfigs;
     /**
@@ -3260,6 +3379,10 @@ declare class LoggingClient {
      * (set via `_resolveManagement`); falls back to a direct GET when running
      * without `SmplClient` bootstrap (e.g. unit tests that construct
      * `LoggingClient` directly).
+     *
+     * Pages through the server until a short page (less than the requested
+     * size) is returned — accounts with more than 1000 loggers would
+     * otherwise silently lose everything past page one.
      */
     private _listLoggers;
     /** @internal — see {@link _listLoggers}. */

package/dist/index.d.ts

@@ -1239,6 +1239,7 @@ interface components {
         FlagListResponse: {
             /** Data */
             data: components["schemas"]["FlagResource"][];
+            meta: components["schemas"]["ListMeta"];
         };
         /**
          * FlagRequest
@@ -1399,6 +1400,7 @@ interface components {
         FlagSourceListResponse: {
             /** Data */
             data: components["schemas"]["FlagSourceResource"][];
+            meta: components["schemas"]["ListMeta"];
         };
         /**
          * FlagSourceResource
@@ -1448,6 +1450,13 @@ interface components {
              */
             value: unknown;
         };
+        /**
+         * ListMeta
+         * @description Top-level ``meta`` block included on every JSON:API list response.
+         */
+        ListMeta: {
+            pagination: components["schemas"]["PaginationMeta"];
+        };
         /**
          * ManualReviewItem
          * @description A flag rule that could not be safely modified by the bulk
@@ -1475,6 +1484,37 @@ interface components {
              */
             reason: string;
         };
+        /**
+         * PaginationMeta
+         * @description Pagination block returned inside ``meta`` on every list response.
+         *
+         *     ``page`` and ``size`` are always present and echo the parameters that
+         *     served the response (their defaults when the client omitted them).
+         *     ``total`` and ``total_pages`` are present only when the request included
+         *     ``meta[total]=true``.
+         */
+        PaginationMeta: {
+            /**
+             * Page
+             * @description 1-based page number returned.
+             */
+            page: number;
+            /**
+             * Size
+             * @description Number of items per page.
+             */
+            size: number;
+            /**
+             * Total
+             * @description Total number of matching items across all pages. Present only when the request included `meta[total]=true`.
+             */
+            total?: number | null;
+            /**
+             * Total Pages
+             * @description Total number of pages at the requested page size. Present only when the request included `meta[total]=true`.
+             */
+            total_pages?: number | null;
+        };
         /**
          * RemoveReferencesAttributes
          * @description Counts and follow-ups returned by the remove-references action.
@@ -1594,6 +1634,7 @@ interface components {
         UsageListResponse: {
             /** Data */
             data: components["schemas"]["UsageResource"][];
+            meta: components["schemas"]["ListMeta"];
         };
         /**
          * UsageResource
@@ -2093,8 +2134,18 @@ declare class ManagementConfigClient {
         description?: string;
         parent?: string | Config | null;
     }): Config;
-    /** List all configs. */
-    list(): Promise<Config[]>;
+    /**
+     * List configs.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<Config[]>;
     /** Fetch a config by id. */
     get(id: string): Promise<Config>;
     /** Delete a config by id. */
@@ -2530,8 +2581,18 @@ declare class ManagementFlagsClient {
     }): JsonFlag;
     /** Fetch a flag by id. */
     get(id: string): Promise<Flag>;
-    /** List all flags. */
-    list(): Promise<Flag[]>;
+    /**
+     * List flags.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<Flag[]>;
     /** Delete a flag by id. */
     delete(id: string): Promise<void>;
     /** @internal — called by `Flag.delete()`. */
@@ -2798,7 +2859,18 @@ declare class LoggersClient {
     new(id: string, options?: {
         managed?: boolean;
     }): Logger;
-    list(): Promise<Logger[]>;
+    /**
+     * List loggers.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<Logger[]>;
     get(id: string): Promise<Logger>;
     delete(id: string): Promise<void>;
     /** @internal — called by `Logger.delete()`. */
@@ -2826,7 +2898,18 @@ declare class LogGroupsClient {
         name?: string;
         group?: string;
     }): LogGroup;
-    list(): Promise<LogGroup[]>;
+    /**
+     * List log groups.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<LogGroup[]>;
     get(id: string): Promise<LogGroup>;
     delete(id: string): Promise<void>;
     /** @internal — called by `LogGroup.delete()`. */
@@ -2897,7 +2980,18 @@ declare class EnvironmentsClient {
         color?: Color | string | null;
         classification?: EnvironmentClassification;
     }): Environment;
-    list(): Promise<Environment[]>;
+    /**
+     * List environments.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<Environment[]>;
     get(id: string): Promise<Environment>;
     delete(id: string): Promise<void>;
     /** @internal */
@@ -2919,7 +3013,18 @@ declare class ContextTypesClient {
         name?: string;
         attributes?: Record<string, Record<string, any>>;
     }): ContextType;
-    list(): Promise<ContextType[]>;
+    /**
+     * List context types.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<ContextType[]>;
     get(id: string): Promise<ContextType>;
     delete(id: string): Promise<void>;
     /** @internal */
@@ -2965,8 +3070,18 @@ declare class ContextsClient {
     flush(): Promise<void>;
     /** Number of contexts awaiting flush. */
     get pendingCount(): number;
-    /** List all contexts of a given type. */
-    list(type: string): Promise<Context[]>;
+    /**
+     * List contexts of a given type.
+     *
+     * Server defaults are `pageNumber=1`, `pageSize=1000` (capped at 1000).
+     * Omit both to fetch the first page; pass them through to walk further
+     * pages. The wrapper does not loop on the customer's behalf — the
+     * customer chooses how to paginate.
+     */
+    list(type: string, params?: {
+        pageNumber?: number;
+        pageSize?: number;
+    }): Promise<Context[]>;
     /** Fetch a context by composite id (`"type:key"`) or by separate type and key. */
     get(idOrType: string, key?: string): Promise<Context>;
     /** Delete a context by composite id (`"type:key"`) or by separate type and key. */
@@ -3159,6 +3274,10 @@ declare class ConfigClient {
      * (set via `_resolveManagement`) so runtime + management share one HTTP
      * client; falls back to a direct GET when running without `SmplClient`
      * bootstrap (e.g. unit tests that construct `ConfigClient` directly).
+     *
+     * Pages through the server until a short page (less than the requested
+     * size) is returned — accounts with more than 1000 configs would
+     * otherwise silently lose everything past page one.
      */
     private _listConfigs;
     /**
@@ -3260,6 +3379,10 @@ declare class LoggingClient {
      * (set via `_resolveManagement`); falls back to a direct GET when running
      * without `SmplClient` bootstrap (e.g. unit tests that construct
      * `LoggingClient` directly).
+     *
+     * Pages through the server until a short page (less than the requested
+     * size) is returned — accounts with more than 1000 loggers would
+     * otherwise silently lose everything past page one.
      */
     private _listLoggers;
     /** @internal — see {@link _listLoggers}. */