@epilot/sdk 2.19.9 → 2.19.11-alpha.0

package/dist/{environments.d-BvqvN-PD.d.cts → environments.d-CP2gV7vw.d.cts}

@@ -17,44 +17,120 @@ declare namespace Components {
         export interface EnvironmentGroupUpsertRequest {
             description?: string;
         }
-        export type EnvironmentValueType = "String" | "SecretString";
+        /**
+         * A variable's value. The JSON type corresponds to the variable's `type`:
+         * `String`, `SecretString` and `Text` are strings, `Number` is a number,
+         * `Boolean` is a boolean, and `Map` is an object. Numbers are IEEE 754
+         * doubles; integers above 2^53 may lose precision on round-trip.
+         *
+         */
+        export type EnvironmentValue = /**
+         * A variable's value. The JSON type corresponds to the variable's `type`:
+         * `String`, `SecretString` and `Text` are strings, `Number` is a number,
+         * `Boolean` is a boolean, and `Map` is an object. Numbers are IEEE 754
+         * doubles; integers above 2^53 may lose precision on round-trip.
+         *
+         */
+        string | number | boolean | MapValue;
+        /**
+         * The structure a variable's value holds. `SecretString` is encrypted at rest and
+         * its value is never returned. `Text`, `Number`, `Boolean` and `Map` may be
+         * served to browser-facing consumers; `String` and `SecretString` may not.
+         *
+         */
+        export type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map";
         export interface EnvironmentVariable {
             key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
-            type: EnvironmentValueType;
+            type: /**
+             * The structure a variable's value holds. `SecretString` is encrypted at rest and
+             * its value is never returned. `Text`, `Number`, `Boolean` and `Map` may be
+             * served to browser-facing consumers; `String` and `SecretString` may not.
+             *
+             */
+            EnvironmentValueType;
             description?: string;
             /**
              * Optional group name for organising variables in the UI
              */
             group?: string;
             /**
-             * Value is returned for String type, omitted for SecretString
+             * Returned for non-secret types, omitted for SecretString. Also omitted when
+             * the variable has been created without a value — for example by a blueprint
+             * install, which syncs a variable's key and type but never its value.
+             *
+             */
+            value?: /**
+             * Returned for non-secret types, omitted for SecretString. Also omitted when
+             * the variable has been created without a value — for example by a blueprint
+             * install, which syncs a variable's key and type but never its value.
+             *
              */
-            value?: string;
+            string | number | boolean | MapValue;
+            /**
+             * Whether the variable is protected from editing
+             */
+            protected?: boolean;
             created_at: string; // date-time
             updated_at: string; // date-time
         }
         export interface EnvironmentVariableCreateRequest {
             key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
-            type: EnvironmentValueType;
+            type: /**
+             * The structure a variable's value holds. `SecretString` is encrypted at rest and
+             * its value is never returned. `Text`, `Number`, `Boolean` and `Map` may be
+             * served to browser-facing consumers; `String` and `SecretString` may not.
+             *
+             */
+            EnvironmentValueType;
             description?: string;
             group?: string;
-            value?: string;
+            value?: /**
+             * A variable's value. The JSON type corresponds to the variable's `type`:
+             * `String`, `SecretString` and `Text` are strings, `Number` is a number,
+             * `Boolean` is a boolean, and `Map` is an object. Numbers are IEEE 754
+             * doubles; integers above 2^53 may lose precision on round-trip.
+             *
+             */
+            EnvironmentValue;
+            /**
+             * Whether the variable is protected from editing
+             */
+            protected?: boolean;
         }
         export interface EnvironmentVariableList {
             items: EnvironmentVariableListItem[];
         }
         export interface EnvironmentVariableListItem {
             key: string;
-            type: EnvironmentValueType;
+            type: /**
+             * The structure a variable's value holds. `SecretString` is encrypted at rest and
+             * its value is never returned. `Text`, `Number`, `Boolean` and `Map` may be
+             * served to browser-facing consumers; `String` and `SecretString` may not.
+             *
+             */
+            EnvironmentValueType;
             description?: string;
             /**
              * Optional group name for organising variables in the UI
              */
             group?: string;
             /**
-             * Value is returned for String type, omitted for SecretString
+             * Returned for non-secret types, omitted for SecretString. Also omitted when
+             * the variable has been created without a value — for example by a blueprint
+             * install, which syncs a variable's key and type but never its value.
+             *
+             */
+            value?: /**
+             * Returned for non-secret types, omitted for SecretString. Also omitted when
+             * the variable has been created without a value — for example by a blueprint
+             * install, which syncs a variable's key and type but never its value.
+             *
+             */
+            string | number | boolean | MapValue;
+            /**
+             * Whether the variable is protected from editing
              */
-            value?: string;
+            protected?: boolean;
             created_at: string; // date-time
             updated_at: string; // date-time
         }
@@ -62,10 +138,37 @@ declare namespace Components {
             /**
              * Type of variable. Used when creating a new variable. Defaults to String.
              */
-            type?: "String" | "SecretString";
-            value?: string;
+            type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map";
+            value?: /**
+             * A variable's value. The JSON type corresponds to the variable's `type`:
+             * `String`, `SecretString` and `Text` are strings, `Number` is a number,
+             * `Boolean` is a boolean, and `Map` is an object. Numbers are IEEE 754
+             * doubles; integers above 2^53 may lose precision on round-trip.
+             *
+             */
+            EnvironmentValue;
             description?: string;
             group?: string;
+            /**
+             * Whether the variable is protected from editing
+             */
+            protected?: boolean;
+        }
+        export type MapEntry = {
+            value: string;
+            label: string;
+        } | {
+            value: string;
+            labels: {
+                [name: string]: string;
+            };
+        };
+        export interface MapValue {
+            fallbackLanguage?: string;
+            options: [
+                MapEntry,
+                ...MapEntry[]
+            ];
         }
     }
 }
@@ -173,6 +276,8 @@ declare namespace Paths {
             }
             export interface $403 {
             }
+            export interface $409 {
+            }
             export interface $500 {
             }
         }
@@ -198,7 +303,7 @@ declare namespace Paths {
 
 interface OperationMethods {
   /**
-   * listEnvironmentVariables - List environment variables
+   * listEnvironmentVariables - listEnvironmentVariables
    * 
    * List all environment variables for the organization. Returns metadata only, no secret values.
    */
@@ -208,9 +313,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ListEnvironmentVariables.Responses.$200>
   /**
-   * createEnvironmentVariable - Create environment variable
+   * createEnvironmentVariable - createEnvironmentVariable
    * 
-   * Create a new environment variable or secret for the organization.
+   * Create a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.
    */
   'createEnvironmentVariable'(
     parameters?: Parameters<UnknownParamsObject> | null,
@@ -218,7 +323,7 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CreateEnvironmentVariable.Responses.$201>
   /**
-   * listEnvironmentGroups - List environment groups
+   * listEnvironmentGroups - listEnvironmentGroups
    * 
    * List all environment groups for the organization.
    */
@@ -229,6 +334,8 @@ interface OperationMethods {
   ): OperationResponse<Paths.ListEnvironmentGroups.Responses.$200>
   /**
    * putEnvironmentGroup - putEnvironmentGroup
+   * 
+   * Create or update an environment group by name. Acts as an upsert — creates the group if it does not exist.
    */
   'putEnvironmentGroup'(
     parameters?: Parameters<Paths.V1EnvironmentsGroups$Name.PathParameters> | null,
@@ -236,7 +343,7 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.PutEnvironmentGroup.Responses.$200 | Paths.PutEnvironmentGroup.Responses.$201>
   /**
-   * deleteEnvironmentGroup - Delete an environment group
+   * deleteEnvironmentGroup - deleteEnvironmentGroup
    * 
    * Deletes a group. Variables assigned to this group become ungrouped.
    */
@@ -246,9 +353,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteEnvironmentGroup.Responses.$204>
   /**
-   * getEnvironmentVariable - Get environment variable
+   * getEnvironmentVariable - getEnvironmentVariable
    * 
-   * Get an environment variable by key. Returns value only for String type, omitted for SecretString.
+   * Get an environment variable by key. Returns value for non-secret types, omitted for SecretString.
    */
   'getEnvironmentVariable'(
     parameters?: Parameters<Paths.V1Environments$Key.PathParameters> | null,
@@ -256,9 +363,9 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetEnvironmentVariable.Responses.$200>
   /**
-   * updateEnvironmentVariable - Update environment variable
+   * updateEnvironmentVariable - updateEnvironmentVariable
    * 
-   * Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist.
+   * Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.
    */
   'updateEnvironmentVariable'(
     parameters?: Parameters<Paths.V1Environments$Key.PathParameters> | null,
@@ -266,7 +373,7 @@ interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UpdateEnvironmentVariable.Responses.$200 | Paths.UpdateEnvironmentVariable.Responses.$201>
   /**
-   * deleteEnvironmentVariable - Delete environment variable
+   * deleteEnvironmentVariable - deleteEnvironmentVariable
    * 
    * Delete an environment variable by key.
    */
@@ -280,7 +387,7 @@ interface OperationMethods {
 interface PathsDictionary {
   ['/v1/environments']: {
     /**
-     * listEnvironmentVariables - List environment variables
+     * listEnvironmentVariables - listEnvironmentVariables
      * 
      * List all environment variables for the organization. Returns metadata only, no secret values.
      */
@@ -290,9 +397,9 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ListEnvironmentVariables.Responses.$200>
     /**
-     * createEnvironmentVariable - Create environment variable
+     * createEnvironmentVariable - createEnvironmentVariable
      * 
-     * Create a new environment variable or secret for the organization.
+     * Create a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.
      */
     'post'(
       parameters?: Parameters<UnknownParamsObject> | null,
@@ -302,7 +409,7 @@ interface PathsDictionary {
   }
   ['/v1/environments/groups']: {
     /**
-     * listEnvironmentGroups - List environment groups
+     * listEnvironmentGroups - listEnvironmentGroups
      * 
      * List all environment groups for the organization.
      */
@@ -315,6 +422,8 @@ interface PathsDictionary {
   ['/v1/environments/groups/{name}']: {
     /**
      * putEnvironmentGroup - putEnvironmentGroup
+     * 
+     * Create or update an environment group by name. Acts as an upsert — creates the group if it does not exist.
      */
     'put'(
       parameters?: Parameters<Paths.V1EnvironmentsGroups$Name.PathParameters> | null,
@@ -322,7 +431,7 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.PutEnvironmentGroup.Responses.$200 | Paths.PutEnvironmentGroup.Responses.$201>
     /**
-     * deleteEnvironmentGroup - Delete an environment group
+     * deleteEnvironmentGroup - deleteEnvironmentGroup
      * 
      * Deletes a group. Variables assigned to this group become ungrouped.
      */
@@ -334,9 +443,9 @@ interface PathsDictionary {
   }
   ['/v1/environments/{key}']: {
     /**
-     * getEnvironmentVariable - Get environment variable
+     * getEnvironmentVariable - getEnvironmentVariable
      * 
-     * Get an environment variable by key. Returns value only for String type, omitted for SecretString.
+     * Get an environment variable by key. Returns value for non-secret types, omitted for SecretString.
      */
     'get'(
       parameters?: Parameters<Paths.V1Environments$Key.PathParameters> | null,
@@ -344,9 +453,9 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetEnvironmentVariable.Responses.$200>
     /**
-     * updateEnvironmentVariable - Update environment variable
+     * updateEnvironmentVariable - updateEnvironmentVariable
      * 
-     * Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist.
+     * Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.
      */
     'put'(
       parameters?: Parameters<Paths.V1Environments$Key.PathParameters> | null,
@@ -354,7 +463,7 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.UpdateEnvironmentVariable.Responses.$200 | Paths.UpdateEnvironmentVariable.Responses.$201>
     /**
-     * deleteEnvironmentVariable - Delete environment variable
+     * deleteEnvironmentVariable - deleteEnvironmentVariable
      * 
      * Delete an environment variable by key.
      */
@@ -372,11 +481,14 @@ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 type EnvironmentGroup = Components.Schemas.EnvironmentGroup;
 type EnvironmentGroupList = Components.Schemas.EnvironmentGroupList;
 type EnvironmentGroupUpsertRequest = Components.Schemas.EnvironmentGroupUpsertRequest;
+type EnvironmentValue = Components.Schemas.EnvironmentValue;
 type EnvironmentValueType = Components.Schemas.EnvironmentValueType;
 type EnvironmentVariable = Components.Schemas.EnvironmentVariable;
 type EnvironmentVariableCreateRequest = Components.Schemas.EnvironmentVariableCreateRequest;
 type EnvironmentVariableList = Components.Schemas.EnvironmentVariableList;
 type EnvironmentVariableListItem = Components.Schemas.EnvironmentVariableListItem;
 type EnvironmentVariableUpdateRequest = Components.Schemas.EnvironmentVariableUpdateRequest;
+type MapEntry = Components.Schemas.MapEntry;
+type MapValue = Components.Schemas.MapValue;
 
-export { type Client as C, type EnvironmentGroup as E, type OperationMethods as O, Paths as P, Components as a, type PathsDictionary as b, type EnvironmentGroupList as c, type EnvironmentGroupUpsertRequest as d, type EnvironmentValueType as e, type EnvironmentVariable as f, type EnvironmentVariableCreateRequest as g, type EnvironmentVariableList as h, type EnvironmentVariableListItem as i, type EnvironmentVariableUpdateRequest as j };
+export { type Client as C, type EnvironmentGroup as E, type MapEntry as M, type OperationMethods as O, Paths as P, Components as a, type PathsDictionary as b, type EnvironmentGroupList as c, type EnvironmentGroupUpsertRequest as d, type EnvironmentValue as e, type EnvironmentValueType as f, type EnvironmentVariable as g, type EnvironmentVariableCreateRequest as h, type EnvironmentVariableList as i, type EnvironmentVariableListItem as j, type EnvironmentVariableUpdateRequest as k, type MapValue as l };