@epilot/app-client 0.0.10 → 0.0.12

package/dist/openapi.d.ts

@@ -10,18 +10,17 @@ import type {
 
 declare namespace Components {
     namespace RequestBodies {
+        export interface CreateAppRequest {
+            name: Schemas.TranslatedString;
+            description: Schemas.TranslatedString;
+            category?: string;
+        }
         export interface InstallAppRequest {
             /**
              * Configuration values for the app components
              */
             option_values?: Schemas.OptionsRef[];
         }
-        export interface PublishAppRequest {
-            s3_reference: Schemas.S3Reference;
-            metadata?: {
-                access_level?: "public" | "private";
-            };
-        }
     }
     namespace Schemas {
         /**
@@ -30,6 +29,19 @@ declare namespace Components {
         export interface App {
             app_id?: string;
             name?: TranslatedString;
+            author?: Author;
+            /**
+             * List of available versions of the app
+             */
+            versions?: string[];
+            /**
+             * Latest version of the app
+             */
+            latest_version?: string;
+            /**
+             * Category of the app.
+             */
+            category?: string;
             /**
              * URL of the app icon.
              */
@@ -38,42 +50,65 @@ declare namespace Components {
              * URL of the app documentation.
              */
             documentation_url?: string;
+            /**
+             * URL of the app homepage.
+             */
+            homepage_url?: string;
             description?: TranslatedString;
             notifications?: NotificationConfig;
-            created_by?: string;
+            /**
+             * Organization ID of the app owner, required for private apps or sandbox accounts
+             */
+            owner_org_id?: string;
+            /**
+             * Flag to indicate if the app is built by epilot.
+             */
+            internal?: boolean;
+            /**
+             * Timestamp of app creation
+             */
             created_at?: string;
             /**
-             * Timestamp of the last update
+             * User ID of the user who created the app
              */
-            updated_at?: string;
+            created_by?: string;
+            components?: BaseComponent[];
             /**
-             * User ID of the user who last updated the app
+             * Flag to indicate if the app is public.
+             */
+            public?: boolean;
+            /**
+             * Flag to indicate if the app is pending for verification
+             */
+            pending?: boolean;
+            /**
+             * Version of the app that is installed
              */
-            updated_by?: string;
             version?: string;
-            author?: Author;
-            status?: "published" | "pending";
-            components?: BaseComponent[];
             /**
-             * Flag to indicate if the app is built by epilot.
+             * Timestamp of the last version update
              */
-            internal?: boolean;
+            versioned_at?: string;
             /**
-             * Organization ID of the app owner, required for private apps
+             * User ID of the user who last updated the app
              */
-            owner_org_id?: string;
+            versioned_by?: string;
             /**
-             * Access level of the app.
+             * Flag to indicate if the app is in beta.
              */
-            access_level?: "public" | "private";
+            is_beta?: boolean;
             /**
-             * Unique identifier for the app installation
+             * Timestamp of the last update
              */
-            installation_id?: string;
+            updated_at?: string;
+            /**
+             * User ID of the user who last updated the app
+             */
+            updated_by?: string;
             /**
              * Unique identifier for the organization the app is installed in
              */
-            organization_id?: string;
+            org_id?: string;
             /**
              * Timestamp of app creation
              */
@@ -90,6 +125,10 @@ declare namespace Components {
              * Configuration values for the app components options
              */
             option_values?: OptionsRef[];
+            /**
+             * Version of the app that is installed
+             */
+            installed_version?: string;
         }
         /**
          * Configuration of the published app
@@ -97,6 +136,19 @@ declare namespace Components {
         export interface AppConfiguration {
             app_id?: string;
             name?: TranslatedString;
+            author?: Author;
+            /**
+             * List of available versions of the app
+             */
+            versions?: string[];
+            /**
+             * Latest version of the app
+             */
+            latest_version?: string;
+            /**
+             * Category of the app.
+             */
+            category?: string;
             /**
              * URL of the app icon.
              */
@@ -106,33 +158,140 @@ declare namespace Components {
              */
             documentation_url?: string;
             /**
-             * Markdown description of the app.
+             * URL of the app homepage.
              */
+            homepage_url?: string;
             description?: TranslatedString;
+            notifications?: NotificationConfig;
             /**
-             * Configuration for developer notifications
+             * Organization ID of the app owner, required for private apps or sandbox accounts
+             */
+            owner_org_id?: string;
+            /**
+             * Flag to indicate if the app is built by epilot.
+             */
+            internal?: boolean;
+            /**
+             * Timestamp of app creation
              */
-            notifications?: NotificationConfig;
-            created_by?: string;
             created_at?: string;
+            /**
+             * User ID of the user who created the app
+             */
+            created_by?: string;
+            components?: BaseComponent[];
+            /**
+             * Flag to indicate if the app is public.
+             */
+            public?: boolean;
+            /**
+             * Flag to indicate if the app is pending for verification
+             */
+            pending?: boolean;
+            /**
+             * Version of the app that is installed
+             */
+            version?: string;
+            /**
+             * Timestamp of the last version update
+             */
+            versioned_at?: string;
+            /**
+             * User ID of the user who last updated the app
+             */
+            versioned_by?: string;
+            /**
+             * Flag to indicate if the app is in beta.
+             */
+            is_beta?: boolean;
             updated_at?: string;
             updated_by?: string;
-            version?: string;
+        }
+        /**
+         * Basic metadata about your app configuration which does not get versioned
+         */
+        export interface AppMetadata {
+            app_id?: string;
+            name?: TranslatedString;
             author?: Author;
-            status?: "published" | "pending";
-            components?: BaseComponent[];
+            /**
+             * List of available versions of the app
+             */
+            versions?: string[];
+            /**
+             * Latest version of the app
+             */
+            latest_version?: string;
+            /**
+             * Category of the app.
+             */
+            category?: string;
+            /**
+             * URL of the app icon.
+             */
+            icon_url?: string;
+            /**
+             * URL of the app documentation.
+             */
+            documentation_url?: string;
+            /**
+             * URL of the app homepage.
+             */
+            homepage_url?: string;
+            /**
+             * Markdown description of the app.
+             */
+            description?: TranslatedString;
+            /**
+             * Configuration for developer notifications
+             */
+            notifications?: NotificationConfig;
+            /**
+             * Organization ID of the app owner, required for private apps or sandbox accounts
+             */
+            owner_org_id?: string;
             /**
              * Flag to indicate if the app is built by epilot.
              */
             internal?: boolean;
             /**
-             * Organization ID of the app owner, required for private apps
+             * Timestamp of app creation
              */
-            owner_org_id?: string;
+            created_at?: string;
+            /**
+             * User ID of the user who created the app
+             */
+            created_by?: string;
+        }
+        /**
+         * Configuration data about your app which is versionable
+         */
+        export interface AppVersioned {
+            components?: BaseComponent[];
+            /**
+             * Flag to indicate if the app is public.
+             */
+            public?: boolean;
+            /**
+             * Flag to indicate if the app is pending for verification
+             */
+            pending?: boolean;
+            /**
+             * Version of the app that is installed
+             */
+            version?: string;
+            /**
+             * Timestamp of the last version update
+             */
+            versioned_at?: string;
+            /**
+             * User ID of the user who last updated the app
+             */
+            versioned_by?: string;
             /**
-             * Access level of the app.
+             * Flag to indicate if the app is in beta.
              */
-            access_level?: "public" | "private";
+            is_beta?: boolean;
         }
         export interface Author {
             /**
@@ -418,6 +577,81 @@ declare namespace Components {
     }
 }
 declare namespace Paths {
+    namespace CloneAppVersion {
+        namespace Parameters {
+            export type AppId = string;
+            export type SourceVersion = string;
+            export type TargetVersion = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+            sourceVersion: Parameters.SourceVersion;
+            targetVersion: Parameters.TargetVersion;
+        }
+        namespace Responses {
+            export interface $201 {
+                app_id?: string;
+                version?: string;
+                status?: "pending" | "published";
+            }
+            export interface $400 {
+            }
+            export interface $404 {
+            }
+        }
+    }
+    namespace CreateAppConfiguration {
+        export type RequestBody = Components.RequestBodies.CreateAppRequest;
+        namespace Responses {
+            export interface $202 {
+                app_id: string;
+            }
+        }
+    }
+    namespace CreateLogoUploadUrl {
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * Presigned S3 URL for uploading the logo
+                 */
+                upload_url: string;
+                /**
+                 * Timestamp when the upload URL expires
+                 */
+                expires_at?: string; // date-time
+            }
+            export interface $404 {
+            }
+        }
+    }
+    namespace DeleteAppVersion {
+        namespace Parameters {
+            export type AppId = string;
+            export type Version = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+            version: Parameters.Version;
+        }
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $400 {
+            }
+            export interface $404 {
+            }
+            export interface $409 {
+            }
+        }
+    }
+    namespace DeleteLogo {
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $404 {
+            }
+        }
+    }
     namespace GetAppConfiguration {
         namespace Responses {
             export type $200 = /* Configuration of the published app */ Components.Schemas.AppConfiguration;
@@ -425,6 +659,21 @@ declare namespace Paths {
             }
         }
     }
+    namespace GetAppConfigurationVersion {
+        namespace Parameters {
+            export type AppId = string;
+            export type Version = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+            version: Parameters.Version;
+        }
+        namespace Responses {
+            export type $200 = /* Configuration of the published app */ Components.Schemas.AppConfiguration;
+            export interface $404 {
+            }
+        }
+    }
     namespace GetInstalledApp {
         namespace Parameters {
             export type AppId = string;
@@ -453,6 +702,50 @@ declare namespace Paths {
             }
         }
     }
+    namespace ListAppConfigurations {
+        namespace Parameters {
+            export type Page = number;
+            export type PageSize = number;
+        }
+        export interface QueryParameters {
+            page?: Parameters.Page;
+            pageSize?: Parameters.PageSize;
+        }
+        namespace Responses {
+            export interface $200 {
+                configurations?: /* Basic metadata about your app configuration which does not get versioned */ Components.Schemas.AppMetadata[];
+                pagination?: {
+                    total?: number;
+                    page?: number;
+                    pageSize?: number;
+                };
+            }
+        }
+    }
+    namespace ListAppVersions {
+        namespace Parameters {
+            export type AppId = string;
+            export type Page = number;
+            export type PageSize = number;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+        }
+        export interface QueryParameters {
+            page?: Parameters.Page;
+            pageSize?: Parameters.PageSize;
+        }
+        namespace Responses {
+            export interface $200 {
+                versions?: string[];
+                pagination?: {
+                    total?: number;
+                    page?: number;
+                    pageSize?: number;
+                };
+            }
+        }
+    }
     namespace ListInstalledApps {
         namespace Parameters {
             export type ComponentType = /* Type of app component */ Components.Schemas.ComponentType;
@@ -477,6 +770,23 @@ declare namespace Paths {
             }
         }
     }
+    namespace PromoteAppVersion {
+        namespace Parameters {
+            export type AppId = string;
+            export type Version = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+            version: Parameters.Version;
+        }
+        namespace Responses {
+            export type $200 = /* Information about the installed app */ Components.Schemas.App;
+            export interface $400 {
+            }
+            export interface $404 {
+            }
+        }
+    }
     namespace UninstallApp {
         namespace Parameters {
             export type AppId = string;
@@ -492,6 +802,18 @@ declare namespace Paths {
         }
     }
     namespace V1AppConfigurations$AppId {
+        namespace Parameters {
+            export type AppId = string;
+            export type Version = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+        }
+        export interface QueryParameters {
+            version?: Parameters.Version;
+        }
+    }
+    namespace V1AppConfigurations$AppIdLogo {
         namespace Parameters {
             export type AppId = string;
         }
@@ -502,16 +824,96 @@ declare namespace Paths {
 }
 
 export interface OperationMethods {
+  /**
+   * listAppConfigurations - listAppConfigurations
+   * 
+   * List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.
+   */
+  'listAppConfigurations'(
+    parameters?: Parameters<Paths.ListAppConfigurations.QueryParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListAppConfigurations.Responses.$200>
+  /**
+   * createAppConfiguration - createAppConfiguration
+   * 
+   * Create a new private app configuration. To make it public a verification process needs to be triggered
+   */
+  'createAppConfiguration'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreateAppConfiguration.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateAppConfiguration.Responses.$202>
   /**
    * getAppConfiguration - getAppConfiguration
    * 
    * Retrieve a specific app configuration
    */
   'getAppConfiguration'(
-    parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
+    parameters?: Parameters<Paths.V1AppConfigurations$AppId.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
+  /**
+   * createLogoUploadUrl - createLogoUploadUrl
+   * 
+   * Generate a presigned URL for uploading app logo to /<app-id>/logo.png path
+   */
+  'createLogoUploadUrl'(
+    parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateLogoUploadUrl.Responses.$200>
+  /**
+   * deleteLogo - deleteLogo
+   * 
+   * Delete the app logo from /<app-id>/logo.png path
+   */
+  'deleteLogo'(
+    parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteLogo.Responses.$204>
+  /**
+   * listAppVersions - listAppVersions
+   * 
+   * Retrieve a list of versions for an app configuration
+   */
+  'listAppVersions'(
+    parameters?: Parameters<Paths.ListAppVersions.QueryParameters & Paths.ListAppVersions.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListAppVersions.Responses.$200>
+  /**
+   * getAppConfigurationVersion - getAppConfigurationVersion
+   * 
+   * Retrieve a specific version of an app configuration
+   */
+  'getAppConfigurationVersion'(
+    parameters?: Parameters<Paths.GetAppConfigurationVersion.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetAppConfigurationVersion.Responses.$200>
+  /**
+   * deleteAppVersion - deleteAppVersion
+   * 
+   * Delete a specific version of an app configuration
+   */
+  'deleteAppVersion'(
+    parameters?: Parameters<Paths.DeleteAppVersion.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteAppVersion.Responses.$204>
+  /**
+   * cloneAppVersion - cloneAppVersion
+   * 
+   * Clone an existing app version to create a new version
+   */
+  'cloneAppVersion'(
+    parameters?: Parameters<Paths.CloneAppVersion.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CloneAppVersion.Responses.$201>
   /**
    * listInstalledApps - listInstalledApps
    * 
@@ -552,9 +954,41 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UninstallApp.Responses.$204>
+  /**
+   * promoteAppVersion - promoteAppVersion
+   * 
+   * Update an installed app to a new version
+   */
+  'promoteAppVersion'(
+    parameters?: Parameters<Paths.PromoteAppVersion.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PromoteAppVersion.Responses.$200>
 }
 
 export interface PathsDictionary {
+  ['/v1/app-configurations']: {
+    /**
+     * listAppConfigurations - listAppConfigurations
+     * 
+     * List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.
+     */
+    'get'(
+      parameters?: Parameters<Paths.ListAppConfigurations.QueryParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListAppConfigurations.Responses.$200>
+    /**
+     * createAppConfiguration - createAppConfiguration
+     * 
+     * Create a new private app configuration. To make it public a verification process needs to be triggered
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CreateAppConfiguration.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateAppConfiguration.Responses.$202>
+  }
   ['/v1/app-configurations/{appId}']: {
     /**
      * getAppConfiguration - getAppConfiguration
@@ -562,11 +996,79 @@ export interface PathsDictionary {
      * Retrieve a specific app configuration
      */
     'get'(
-      parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
+      parameters?: Parameters<Paths.V1AppConfigurations$AppId.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
   }
+  ['/v1/app-configurations/{appId}/logo']: {
+    /**
+     * createLogoUploadUrl - createLogoUploadUrl
+     * 
+     * Generate a presigned URL for uploading app logo to /<app-id>/logo.png path
+     */
+    'post'(
+      parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateLogoUploadUrl.Responses.$200>
+    /**
+     * deleteLogo - deleteLogo
+     * 
+     * Delete the app logo from /<app-id>/logo.png path
+     */
+    'delete'(
+      parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteLogo.Responses.$204>
+  }
+  ['/v1/app-configurations/{appId}/versions']: {
+    /**
+     * listAppVersions - listAppVersions
+     * 
+     * Retrieve a list of versions for an app configuration
+     */
+    'get'(
+      parameters?: Parameters<Paths.ListAppVersions.QueryParameters & Paths.ListAppVersions.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListAppVersions.Responses.$200>
+  }
+  ['/v1/app-configurations/{appId}/versions/{version}']: {
+    /**
+     * getAppConfigurationVersion - getAppConfigurationVersion
+     * 
+     * Retrieve a specific version of an app configuration
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetAppConfigurationVersion.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetAppConfigurationVersion.Responses.$200>
+    /**
+     * deleteAppVersion - deleteAppVersion
+     * 
+     * Delete a specific version of an app configuration
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteAppVersion.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteAppVersion.Responses.$204>
+  }
+  ['/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}']: {
+    /**
+     * cloneAppVersion - cloneAppVersion
+     * 
+     * Clone an existing app version to create a new version
+     */
+    'post'(
+      parameters?: Parameters<Paths.CloneAppVersion.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CloneAppVersion.Responses.$201>
+  }
   ['/v1/app']: {
     /**
      * listInstalledApps - listInstalledApps
@@ -611,12 +1113,26 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.UninstallApp.Responses.$204>
   }
+  ['/v1/app/{appId}/promote-to/{version}']: {
+    /**
+     * promoteAppVersion - promoteAppVersion
+     * 
+     * Update an installed app to a new version
+     */
+    'post'(
+      parameters?: Parameters<Paths.PromoteAppVersion.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PromoteAppVersion.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 export type App = Components.Schemas.App;
 export type AppConfiguration = Components.Schemas.AppConfiguration;
+export type AppMetadata = Components.Schemas.AppMetadata;
+export type AppVersioned = Components.Schemas.AppVersioned;
 export type Author = Components.Schemas.Author;
 export type BaseComponent = Components.Schemas.BaseComponent;
 export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;