@epilot/app-client 0.0.21 → 0.1.1

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={187:function(e,r,t){var p=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=p(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listAppConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createAppConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getAppConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"patch":{"operationId":"patchConfigurationMetadata","requestBody":{"$ref":"#/components/requestBodies/PatchConfigMetadataRequest"},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","requestBody":{"$ref":"#/components/requestBodies/CreateLogoRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listAppVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getAppConfigurationVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpdateVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstalledApps","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstalledApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"put":{"operationId":"installApp","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallAppRequest"},"responses":{}},"delete":{"operationId":"uninstallApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoRequest":{"required":true,"content":{"application/json":{}}},"PatchConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"UpdateVersionRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallAppRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(p){var n=r[p];if(void 0!==n)return n.exports;var a=r[p]={exports:{}};return e[p].call(a.exports,a,a.exports,t),a.exports}(187),p=exports;for(var n in t)p[n]=t[n];t.__esModule&&Object.defineProperty(p,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={187:function(e,r,t){var p=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=p(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listAppConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createAppConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getAppConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"patch":{"operationId":"patchConfigurationMetadata","requestBody":{"$ref":"#/components/requestBodies/PatchConfigMetadataRequest"},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","requestBody":{"$ref":"#/components/requestBodies/CreateLogoRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listAppVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getAppConfigurationVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpdateVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstalledApps","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstalledApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"post":{"operationId":"installApp","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallAppRequest"},"responses":{}},"patch":{"operationId":"patchInstalledApp","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallAppRequest"},"responses":{}},"delete":{"operationId":"uninstallApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoRequest":{"required":true,"content":{"application/json":{}}},"PatchConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"UpdateVersionRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallAppRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(p){var n=r[p];if(void 0!==n)return n.exports;var a=r[p]={exports:{}};return e[p].call(a.exports,a,a.exports,t),a.exports}(187),p=exports;for(var n in t)p[n]=t[n];t.__esModule&&Object.defineProperty(p,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -214,7 +214,7 @@
         ],
         "responses": {}
       },
-      "put": {
+      "post": {
         "operationId": "installApp",
         "parameters": [
           {
@@ -228,6 +228,20 @@
         },
         "responses": {}
       },
+      "patch": {
+        "operationId": "patchInstalledApp",
+        "parameters": [
+          {
+            "name": "appId",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "$ref": "#/components/requestBodies/InstallAppRequest"
+        },
+        "responses": {}
+      },
       "delete": {
         "operationId": "uninstallApp",
         "parameters": [

package/dist/openapi.d.ts

@@ -44,7 +44,6 @@ declare namespace Components {
             description?: Schemas.TranslatedString;
             category?: string;
             documentation_url?: string;
-            homepage_url?: string;
             notifications?: Schemas.NotificationConfig;
             pricing?: Schemas.Pricing;
             /**
@@ -64,123 +63,105 @@ declare namespace Components {
         }
     }
     namespace Schemas {
-        /**
-         * Information about the installed app
-         */
-        export interface App {
-            app_id?: string;
-            name: TranslatedString;
-            author?: Author;
-            /**
-             * List of available versions of the app
-             */
-            versions?: string[];
-            /**
-             * Email address for support requests
-             */
-            support_email?: 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;
-            description: TranslatedString;
-            notifications?: NotificationConfig;
+        export interface Audit {
             /**
-             * 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;
-            pricing?: Pricing;
-            /**
-             * Timestamp of app creation
+             * Timestamp of the creation
              */
             created_at?: string;
             /**
-             * User ID of the user who created the app
+             * User ID of the creator
              */
             created_by?: string;
-            components?: BaseComponent[];
             /**
-             * Flag to indicate if the app is public.
+             * Timestamp of the last update
              */
-            public?: boolean;
+            updated_at?: string;
             /**
-             * Flag to indicate if the app is pending for verification
+             * User ID of the last updater
              */
-            pending?: boolean;
+            updated_by?: string;
+        }
+        export interface Author {
             /**
-             * Version of the app that is installed
+             * Name of the author
              */
-            version?: string;
+            name?: string;
             /**
-             * Timestamp of the last version update
+             * Company of the author
              */
-            versioned_at?: string;
+            company: string;
             /**
-             * User ID of the user who last updated the app
+             * Email of the author
              */
-            versioned_by?: string;
+            email?: string;
+        }
+        export type BaseComponent = {
             /**
-             * Flag to indicate if the app is in beta.
+             * Unique identifier for the component
              */
-            is_beta?: boolean;
+            id: string;
+            name?: TranslatedString;
             /**
-             * Timestamp of the last update
+             * List of options for the app component
              */
-            updated_at?: string;
+            options?: /* Options for the component configuration */ Options[];
+        } & (JourneyBlockComponent | PortalExtensionComponent);
+        export interface BaseComponentCommon {
             /**
-             * User ID of the user who last updated the app
+             * Unique identifier for the component
              */
-            updated_by?: string;
+            id: string;
             /**
-             * Unique identifier for the organization the app is installed in
+             * Name of the component
              */
-            org_id?: string;
+            name?: TranslatedString;
             /**
-             * Timestamp of app creation
+             * List of options for the app component
              */
-            installed_at?: string;
+            options?: /* Options for the component configuration */ Options[];
+        }
+        /**
+         * How often the subscription is billed
+         */
+        export type BillingFrequency = "MONTHLY" | "QUARTERLY" | "YEARLY" | "CUSTOM";
+        export interface BooleanArg {
+            type?: "boolean";
+        }
+        export interface CallerIdentity {
             /**
-             * User ID of the user who installed the app
+             * a human readable name of the caller (e.g. user name, token name or email address)
+             * example:
+             * manifest@epilot.cloud
              */
-            installed_by?: string;
+            name?: any;
             /**
-             * Flag to indicate if the app is enabled.
+             * epilot organization id
+             * example:
+             * 911690
              */
-            enabled?: boolean;
+            org_id: string;
             /**
-             * Configuration values for the app components options
+             * epilot user id, when called by a user
+             * example:
+             * 11001045
              */
-            option_values?: OptionsRef[];
+            user_id?: string;
             /**
-             * Version of the app that is installed
+             * token id, when called by API token
+             * example:
+             * api_5ZugdRXasLfWBypHi93Fk
              */
-            installed_version?: string;
+            token_id?: string;
         }
+        /**
+         * Type of app component
+         */
+        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION";
         /**
          * Configuration of the published app
          */
-        export interface AppConfiguration {
-            app_id?: string;
+        export interface Configuration {
+            app_id: string;
             name: TranslatedString;
             author?: Author;
             /**
@@ -194,7 +175,7 @@ declare namespace Components {
             /**
              * Latest version of the app
              */
-            latest_version?: string;
+            latest_version: string;
             /**
              * Category of the app.
              */
@@ -207,30 +188,19 @@ declare namespace Components {
              * URL of the app documentation.
              */
             documentation_url?: string;
-            /**
-             * URL of the app homepage.
-             */
-            homepage_url?: string;
             description: TranslatedString;
             notifications?: NotificationConfig;
             /**
-             * Organization ID of the app owner, required for private apps or sandbox accounts
+             * Organization ID of the app owner
              */
-            owner_org_id?: string;
+            owner_org_id: string;
             /**
              * Flag to indicate if the app is built by epilot.
              */
             internal?: boolean;
             pricing?: Pricing;
-            /**
-             * Timestamp of app creation
-             */
-            created_at?: string;
-            /**
-             * User ID of the user who created the app
-             */
-            created_by?: string;
-            components?: BaseComponent[];
+            configuration_audit?: Audit;
+            components: BaseComponent[];
             /**
              * Flag to indicate if the app is public.
              */
@@ -242,27 +212,55 @@ declare namespace Components {
             /**
              * Version of the app that is installed
              */
-            version?: string;
+            version: string;
             /**
-             * Timestamp of the last version update
+             * Flag to indicate if the app is in beta.
              */
-            versioned_at?: string;
+            is_beta?: boolean;
             /**
-             * User ID of the user who last updated the app
+             * Timestamp when the app version is deprecated
              */
-            versioned_by?: string;
+            deprecated_at?: string;
             /**
-             * Flag to indicate if the app is in beta.
+             * Changelog for the app version
              */
-            is_beta?: boolean;
-            updated_at?: string;
-            updated_by?: string;
+            changelog?: string;
+            /**
+             * Status of the review process
+             */
+            review_status?: "approved" | "rejected" | "pending";
+            version_audit: {
+                /**
+                 * Timestamp of the creation
+                 */
+                created_at?: string;
+                /**
+                 * User ID of the creator
+                 */
+                created_by?: string;
+                /**
+                 * Timestamp of the last update
+                 */
+                updated_at?: string;
+                /**
+                 * User ID of the last updater
+                 */
+                updated_by?: string;
+                /**
+                 * Timestamp of the last version update
+                 */
+                versioned_at?: string;
+                /**
+                 * User ID of the user who last updated the app
+                 */
+                versioned_by?: string;
+            };
         }
         /**
          * Basic metadata about your app configuration which does not get versioned
          */
-        export interface AppMetadata {
-            app_id?: string;
+        export interface ConfigurationMetadata {
+            app_id: string;
             name: TranslatedString;
             author?: Author;
             /**
@@ -276,7 +274,7 @@ declare namespace Components {
             /**
              * Latest version of the app
              */
-            latest_version?: string;
+            latest_version: string;
             /**
              * Category of the app.
              */
@@ -289,10 +287,6 @@ declare namespace Components {
              * URL of the app documentation.
              */
             documentation_url?: string;
-            /**
-             * URL of the app homepage.
-             */
-            homepage_url?: string;
             /**
              * Markdown description of the app.
              */
@@ -304,7 +298,7 @@ declare namespace Components {
             /**
              * Organization ID of the app owner, required for private apps or sandbox accounts
              */
-            owner_org_id?: string;
+            owner_org_id: string;
             /**
              * Flag to indicate if the app is built by epilot.
              */
@@ -314,19 +308,20 @@ declare namespace Components {
              */
             pricing?: Pricing;
             /**
-             * Timestamp of app creation
+             * Audit information for the app
              */
-            created_at?: string;
-            /**
-             * User ID of the user who created the app
-             */
-            created_by?: string;
+            configuration_audit?: Audit;
         }
         /**
          * Configuration data about your app which is versionable
          */
-        export interface AppVersioned {
-            components?: BaseComponent[];
+        export interface ConfigurationVersion {
+            app_id: string;
+            /**
+             * Organization ID of the app owner
+             */
+            owner_org_id: string;
+            components: BaseComponent[];
             /**
              * Flag to indicate if the app is public.
              */
@@ -338,96 +333,50 @@ declare namespace Components {
             /**
              * 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;
+            version: string;
             /**
              * Flag to indicate if the app is in beta.
              */
             is_beta?: boolean;
-        }
-        export interface Author {
-            /**
-             * Name of the author
-             */
-            name?: string;
-            /**
-             * Company of the author
-             */
-            company: string;
-            /**
-             * Email of the author
-             */
-            email?: string;
-        }
-        export type BaseComponent = {
             /**
-             * Unique identifier for the component
+             * Timestamp when the app version is deprecated
              */
-            id: string;
-            name?: TranslatedString;
+            deprecated_at?: string;
             /**
-             * List of options for the app component
+             * Changelog for the app version
              */
-            options?: /* Options for the component configuration */ Options[];
-        } & (JourneyBlockComponent | PortalExtensionComponent);
-        export interface BaseComponentCommon {
+            changelog?: string;
             /**
-             * Unique identifier for the component
+             * Status of the review process
              */
-            id: string;
-            /**
-             * Name of the component
-             */
-            name?: TranslatedString;
-            /**
-             * List of options for the app component
-             */
-            options?: /* Options for the component configuration */ Options[];
-        }
-        /**
-         * How often the subscription is billed
-         */
-        export type BillingFrequency = "MONTHLY" | "QUARTERLY" | "YEARLY" | "CUSTOM";
-        export interface BooleanArg {
-            type?: "boolean";
-        }
-        export interface CallerIdentity {
-            /**
-             * a human readable name of the caller (e.g. user name, token name or email address)
-             * example:
-             * manifest@epilot.cloud
-             */
-            name?: any;
-            /**
-             * epilot organization id
-             * example:
-             * 911690
-             */
-            org_id: string;
-            /**
-             * epilot user id, when called by a user
-             * example:
-             * 11001045
-             */
-            user_id?: string;
-            /**
-             * token id, when called by API token
-             * example:
-             * api_5ZugdRXasLfWBypHi93Fk
-             */
-            token_id?: string;
+            review_status?: "approved" | "rejected" | "pending";
+            version_audit: {
+                /**
+                 * Timestamp of the creation
+                 */
+                created_at?: string;
+                /**
+                 * User ID of the creator
+                 */
+                created_by?: string;
+                /**
+                 * Timestamp of the last update
+                 */
+                updated_at?: string;
+                /**
+                 * User ID of the last updater
+                 */
+                updated_by?: string;
+                /**
+                 * Timestamp of the last version update
+                 */
+                versioned_at?: string;
+                /**
+                 * User ID of the user who last updated the app
+                 */
+                versioned_by?: string;
+            };
         }
-        /**
-         * Type of app component
-         */
-        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION";
         export interface EnumArg {
             type?: "enum";
             /**
@@ -460,6 +409,40 @@ declare namespace Components {
                 }[]
             ];
         }
+        /**
+         * Information about the installed app. Has configuration data of the installed version
+         */
+        export interface Installation {
+            /**
+             * ID of the app configuration
+             */
+            app_id: string;
+            /**
+             * Unique identifier for the organization the app is installed in
+             */
+            installer_org_id: string;
+            /**
+             * Flag to indicate if the app is enabled. Enabled is set to true when required option values are set.
+             */
+            enabled: boolean;
+            /**
+             * Name of the app
+             */
+            name: TranslatedString;
+            /**
+             * Configuration values for the app components
+             */
+            option_values?: OptionsRef[];
+            /**
+             * List of component configurations for the installed version
+             */
+            components: BaseComponent[];
+            /**
+             * Version of the app that is installed
+             */
+            installed_version: string;
+            installation_audit?: Audit;
+        }
         export interface JourneyBlockComponent {
             component_type: "CUSTOM_JOURNEY_BLOCK";
             configuration: JourneyBlockConfig;
@@ -505,7 +488,7 @@ declare namespace Components {
              * example:
              * developer@example.com
              */
-            email?: string | null;
+            email?: string; // email
             /**
              * List of events to subscribe to
              */
@@ -726,7 +709,7 @@ declare namespace Paths {
             version?: Parameters.Version;
         }
         namespace Responses {
-            export type $200 = /* Configuration of the published app */ Components.Schemas.AppConfiguration;
+            export type $200 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
             export interface $404 {
             }
         }
@@ -741,7 +724,7 @@ declare namespace Paths {
             version: Parameters.Version;
         }
         namespace Responses {
-            export type $200 = /* Configuration of the published app */ Components.Schemas.AppConfiguration;
+            export type $200 = /* Configuration of the published app */ Components.Schemas.Configuration;
             export interface $404 {
             }
         }
@@ -754,7 +737,7 @@ declare namespace Paths {
             appId: Parameters.AppId;
         }
         namespace Responses {
-            export type $200 = /* Information about the installed app */ Components.Schemas.App;
+            export type $200 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
             export interface $404 {
             }
         }
@@ -785,7 +768,7 @@ declare namespace Paths {
         }
         namespace Responses {
             export interface $200 {
-                configurations?: /* Basic metadata about your app configuration which does not get versioned */ Components.Schemas.AppMetadata[];
+                configurations?: /* Basic metadata about your app configuration which does not get versioned */ Components.Schemas.ConfigurationMetadata[];
                 pagination?: {
                     total?: number;
                     page?: number;
@@ -809,7 +792,7 @@ declare namespace Paths {
         }
         namespace Responses {
             export interface $200 {
-                versions?: /* Configuration data about your app which is versionable */ Components.Schemas.AppVersioned[];
+                versions?: /* Configuration data about your app which is versionable */ Components.Schemas.ConfigurationVersion[];
                 pagination?: {
                     total?: number;
                     page?: number;
@@ -833,7 +816,7 @@ declare namespace Paths {
         }
         namespace Responses {
             export interface $200 {
-                apps?: /* Information about the installed app */ Components.Schemas.App[];
+                apps?: /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation[];
                 pagination?: {
                     total?: number;
                     page?: number;
@@ -851,6 +834,21 @@ declare namespace Paths {
             }
         }
     }
+    namespace PatchInstalledApp {
+        namespace Parameters {
+            export type AppId = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+        }
+        export type RequestBody = Components.RequestBodies.InstallAppRequest;
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $404 {
+            }
+        }
+    }
     namespace PromoteAppVersion {
         namespace Parameters {
             export type AppId = string;
@@ -861,7 +859,7 @@ declare namespace Paths {
             version: Parameters.Version;
         }
         namespace Responses {
-            export type $200 = /* Information about the installed app */ Components.Schemas.App;
+            export type $200 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
             export interface $400 {
             }
             export interface $404 {
@@ -1060,6 +1058,16 @@ export interface OperationMethods {
     data?: Paths.InstallApp.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.InstallApp.Responses.$204>
+  /**
+   * patchInstalledApp - patchInstalledApp
+   * 
+   * Patch an installed app by its ID.
+   */
+  'patchInstalledApp'(
+    parameters?: Parameters<Paths.PatchInstalledApp.PathParameters> | null,
+    data?: Paths.PatchInstalledApp.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PatchInstalledApp.Responses.$204>
   /**
    * uninstallApp - uninstallApp
    * 
@@ -1233,11 +1241,21 @@ export interface PathsDictionary {
      * 
      * Upsert app installation by its ID.
      */
-    'put'(
+    'post'(
       parameters?: Parameters<Paths.InstallApp.PathParameters> | null,
       data?: Paths.InstallApp.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.InstallApp.Responses.$204>
+    /**
+     * patchInstalledApp - patchInstalledApp
+     * 
+     * Patch an installed app by its ID.
+     */
+    'patch'(
+      parameters?: Parameters<Paths.PatchInstalledApp.PathParameters> | null,
+      data?: Paths.PatchInstalledApp.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PatchInstalledApp.Responses.$204>
     /**
      * uninstallApp - uninstallApp
      * 
@@ -1265,10 +1283,7 @@ export interface PathsDictionary {
 
 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 Audit = Components.Schemas.Audit;
 export type Author = Components.Schemas.Author;
 export type BaseComponent = Components.Schemas.BaseComponent;
 export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
@@ -1276,7 +1291,11 @@ export type BillingFrequency = Components.Schemas.BillingFrequency;
 export type BooleanArg = Components.Schemas.BooleanArg;
 export type CallerIdentity = Components.Schemas.CallerIdentity;
 export type ComponentType = Components.Schemas.ComponentType;
+export type Configuration = Components.Schemas.Configuration;
+export type ConfigurationMetadata = Components.Schemas.ConfigurationMetadata;
+export type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
 export type EnumArg = Components.Schemas.EnumArg;
+export type Installation = Components.Schemas.Installation;
 export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
 export type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
 export type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;

package/dist/openapi.json

@@ -58,7 +58,7 @@
                     "configurations": {
                       "type": "array",
                       "items": {
-                        "$ref": "#/components/schemas/AppMetadata"
+                        "$ref": "#/components/schemas/ConfigurationMetadata"
                       }
                     },
                     "pagination": {
@@ -143,7 +143,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/AppConfiguration"
+                  "$ref": "#/components/schemas/Installation"
                 }
               }
             }
@@ -281,7 +281,7 @@
                     "versions": {
                       "type": "array",
                       "items": {
-                        "$ref": "#/components/schemas/AppVersioned"
+                        "$ref": "#/components/schemas/ConfigurationVersion"
                       }
                     },
                     "pagination": {
@@ -337,7 +337,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/AppConfiguration"
+                  "$ref": "#/components/schemas/Configuration"
                 }
               }
             }
@@ -548,7 +548,7 @@
                     "apps": {
                       "type": "array",
                       "items": {
-                        "$ref": "#/components/schemas/App"
+                        "$ref": "#/components/schemas/Installation"
                       }
                     },
                     "pagination": {
@@ -590,21 +590,21 @@
         ],
         "responses": {
           "200": {
-            "description": "Details about installed app.",
+            "description": "Details about an app installation.",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/App"
+                  "$ref": "#/components/schemas/Installation"
                 }
               }
             }
           },
           "404": {
-            "description": "App not found."
+            "description": "Installation not found."
           }
         }
       },
-      "put": {
+      "post": {
         "summary": "installApp",
         "description": "Upsert app installation by its ID.",
         "operationId": "installApp",
@@ -623,7 +623,33 @@
         },
         "responses": {
           "204": {
-            "description": "App installation updated successfully."
+            "description": "App successfully installed."
+          },
+          "404": {
+            "description": "App not found."
+          }
+        }
+      },
+      "patch": {
+        "summary": "patchInstalledApp",
+        "description": "Patch an installed app by its ID.",
+        "operationId": "patchInstalledApp",
+        "parameters": [
+          {
+            "name": "appId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "$ref": "#/components/requestBodies/InstallAppRequest"
+        },
+        "responses": {
+          "204": {
+            "description": "App installation patched successfully."
           },
           "404": {
             "description": "App not found."
@@ -683,7 +709,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/App"
+                  "$ref": "#/components/schemas/Installation"
                 }
               }
             }
@@ -750,9 +776,6 @@
                 "documentation_url": {
                   "type": "string"
                 },
-                "homepage_url": {
-                  "type": "string"
-                },
                 "notifications": {
                   "$ref": "#/components/schemas/NotificationConfig"
                 },
@@ -976,15 +999,18 @@
         "properties": {
           "name": {
             "type": "string",
-            "description": "Name of the author"
+            "description": "Name of the author",
+            "maxLength": 50
           },
           "company": {
             "type": "string",
-            "description": "Company of the author"
+            "description": "Company of the author",
+            "maxLength": 30
           },
           "email": {
             "type": "string",
-            "description": "Email of the author"
+            "description": "Email of the author",
+            "maxLength": 30
           }
         }
       },
@@ -993,7 +1019,7 @@
         "properties": {
           "email": {
             "type": "string",
-            "nullable": true,
+            "format": "email",
             "description": "Email address to receive notifications",
             "example": "developer@example.com"
           },
@@ -1410,12 +1436,41 @@
           }
         }
       },
-      "AppMetadata": {
+      "Audit": {
+        "type": "object",
+        "properties": {
+          "created_at": {
+            "type": "string",
+            "description": "Timestamp of the creation",
+            "readOnly": true
+          },
+          "created_by": {
+            "type": "string",
+            "description": "User ID of the creator",
+            "readOnly": true
+          },
+          "updated_at": {
+            "type": "string",
+            "description": "Timestamp of the last update",
+            "readOnly": true
+          },
+          "updated_by": {
+            "type": "string",
+            "description": "User ID of the last updater",
+            "readOnly": true
+          }
+        }
+      },
+      "ConfigurationMetadata": {
         "description": "Basic metadata about your app configuration which does not get versioned",
         "type": "object",
         "required": [
           "name",
-          "description"
+          "description",
+          "latest_version",
+          "owner_org_id",
+          "has_public_version",
+          "app_id"
         ],
         "properties": {
           "app_id": {
@@ -1457,10 +1512,6 @@
             "type": "string",
             "description": "URL of the app documentation."
           },
-          "homepage_url": {
-            "type": "string",
-            "description": "URL of the app homepage."
-          },
           "description": {
             "$ref": "#/components/schemas/TranslatedString",
             "description": "Markdown description of the app."
@@ -1484,27 +1535,39 @@
             "$ref": "#/components/schemas/Pricing",
             "description": "Pricing information for the app"
           },
-          "created_at": {
-            "type": "string",
-            "description": "Timestamp of app creation",
-            "readOnly": true
-          },
-          "created_by": {
-            "type": "string",
-            "description": "User ID of the user who created the app",
+          "configuration_audit": {
+            "$ref": "#/components/schemas/Audit",
+            "description": "Audit information for the app",
             "readOnly": true
           }
         }
       },
-      "AppVersioned": {
+      "ConfigurationVersion": {
         "description": "Configuration data about your app which is versionable",
         "type": "object",
+        "required": [
+          "version",
+          "components",
+          "app_id",
+          "version_audit",
+          "owner_org_id"
+        ],
         "properties": {
+          "app_id": {
+            "type": "string",
+            "readOnly": true
+          },
+          "owner_org_id": {
+            "type": "string",
+            "description": "Organization ID of the app owner",
+            "readOnly": true
+          },
           "components": {
             "type": "array",
             "items": {
               "$ref": "#/components/schemas/BaseComponent"
-            }
+            },
+            "minItems": 0
           },
           "public": {
             "type": "boolean",
@@ -1521,107 +1584,127 @@
           "version": {
             "type": "string",
             "description": "Version of the app that is installed",
+            "readOnly": true,
+            "maxLength": 10
+          },
+          "is_beta": {
+            "type": "boolean",
+            "description": "Flag to indicate if the app is in beta.",
             "readOnly": true
           },
-          "versioned_at": {
+          "deprecated_at": {
             "type": "string",
-            "description": "Timestamp of the last version update",
-            "readOnly": true
+            "description": "Timestamp when the app version is deprecated"
           },
-          "versioned_by": {
+          "changelog": {
             "type": "string",
-            "description": "User ID of the user who last updated the app",
-            "readOnly": true
+            "description": "Changelog for the app version",
+            "maxLength": 250
           },
-          "is_beta": {
-            "type": "boolean",
-            "description": "Flag to indicate if the app is in beta."
+          "review_status": {
+            "type": "string",
+            "enum": [
+              "approved",
+              "rejected",
+              "pending"
+            ],
+            "description": "Status of the review process"
+          },
+          "version_audit": {
+            "readOnly": true,
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/Audit"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "versioned_at": {
+                    "type": "string",
+                    "description": "Timestamp of the last version update",
+                    "readOnly": true
+                  },
+                  "versioned_by": {
+                    "type": "string",
+                    "description": "User ID of the user who last updated the app",
+                    "readOnly": true
+                  }
+                }
+              }
+            ]
           }
         }
       },
-      "App": {
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/AppConfiguration"
-          }
-        ],
-        "description": "Information about the installed app",
+      "Installation": {
+        "description": "Information about the installed app. Has configuration data of the installed version",
         "type": "object",
+        "required": [
+          "app_id",
+          "installer_org_id",
+          "enabled",
+          "name",
+          "components",
+          "installed_version"
+        ],
         "properties": {
-          "org_id": {
-            "type": "string",
-            "description": "Unique identifier for the organization the app is installed in",
-            "readOnly": true
-          },
-          "installed_at": {
-            "type": "string",
-            "description": "Timestamp of app creation",
-            "readOnly": true
-          },
-          "installed_by": {
-            "type": "string",
-            "description": "User ID of the user who installed the app",
-            "readOnly": true
-          },
-          "updated_by": {
+          "app_id": {
             "type": "string",
-            "description": "User ID of the user who last updated the app",
+            "description": "ID of the app configuration",
             "readOnly": true
           },
-          "updated_at": {
+          "installer_org_id": {
             "type": "string",
-            "description": "Timestamp of the last update",
+            "description": "Unique identifier for the organization the app is installed in",
             "readOnly": true
           },
           "enabled": {
             "readOnly": true,
             "type": "boolean",
             "default": true,
-            "description": "Flag to indicate if the app is enabled."
+            "description": "Flag to indicate if the app is enabled. Enabled is set to true when required option values are set."
+          },
+          "name": {
+            "$ref": "#/components/schemas/TranslatedString",
+            "description": "Name of the app",
+            "readOnly": true
           },
           "option_values": {
-            "description": "Configuration values for the app components options",
             "type": "array",
             "items": {
               "$ref": "#/components/schemas/OptionsRef"
-            }
+            },
+            "description": "Configuration values for the app components"
+          },
+          "components": {
+            "description": "List of component configurations for the installed version",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/BaseComponent"
+            },
+            "minLength": 0,
+            "readOnly": true
           },
           "installed_version": {
             "type": "string",
             "description": "Version of the app that is installed",
             "readOnly": true
+          },
+          "installation_audit": {
+            "$ref": "#/components/schemas/Audit",
+            "readOnly": true
           }
         }
       },
-      "AppConfiguration": {
+      "Configuration": {
+        "description": "Configuration of the published app",
         "allOf": [
           {
-            "$ref": "#/components/schemas/AppMetadata"
+            "$ref": "#/components/schemas/ConfigurationMetadata"
           },
           {
-            "$ref": "#/components/schemas/AppVersioned"
-          }
-        ],
-        "type": "object",
-        "description": "Configuration of the published app",
-        "properties": {
-          "created_by": {
-            "type": "string",
-            "readOnly": true
-          },
-          "created_at": {
-            "type": "string",
-            "readOnly": true
-          },
-          "updated_at": {
-            "type": "string",
-            "readOnly": true
-          },
-          "updated_by": {
-            "type": "string",
-            "readOnly": true
+            "$ref": "#/components/schemas/ConfigurationVersion"
           }
-        }
+        ]
       },
       "TranslatedString": {
         "type": "object",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/app-client",
-  "version": "0.0.21",
+  "version": "0.1.1",
   "description": "JavaScript client library for the epilot App API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",