@epilot/app-client 0.0.2 → 0.0.3

package/dist/openapi.d.ts

@@ -14,7 +14,7 @@ declare namespace Components {
             /**
              * Configuration values for the app components
              */
-            config_values?: Schemas.ComponentConfigValues[];
+            option_values?: Schemas.OptionsRef[];
         }
     }
     namespace Schemas {
@@ -38,7 +38,14 @@ declare namespace Components {
             description?: string;
             created_by?: string;
             created_at?: string;
+            /**
+             * Timestamp of the last update
+             */
             updated_at?: string;
+            /**
+             * User ID of the user who last updated the app
+             */
+            updated_by?: string;
             version?: string;
             author?: Author;
             status?: "published" | "pending";
@@ -76,9 +83,9 @@ declare namespace Components {
              */
             enabled?: boolean;
             /**
-             * Configuration values for the app components
+             * Configuration values for the app components options
              */
-            config_values?: ComponentConfigValues[];
+            option_values?: OptionsRef[];
         }
         /**
          * Configuration of the published app
@@ -101,6 +108,7 @@ declare namespace Components {
             created_by?: string;
             created_at?: string;
             updated_at?: string;
+            updated_by?: string;
             version?: string;
             author?: Author;
             status?: "published" | "pending";
@@ -144,20 +152,21 @@ declare namespace Components {
              */
             id: string;
             /**
-             * List of required options for the app component
+             * List of options for the app component
              */
-            config_options?: /* Options for the component configuration */ ConfigurationOptions[];
+            options?: /* Options for the component configuration */ Options[];
         } | {
             component_type?: "PORTAL_EXTENSION";
+            origin?: "END_CUSTOMER_PORTAL" | "INSTALLER_PORTAL";
             configuration: PortalExtensionConfig;
             /**
              * Unique identifier for the component
              */
             id: string;
             /**
-             * List of required options for the app component
+             * List of options for the app component
              */
-            config_options?: /* Options for the component configuration */ ConfigurationOptions[];
+            options?: /* Options for the component configuration */ Options[];
         };
         export interface BaseComponentCommon {
             /**
@@ -165,9 +174,9 @@ declare namespace Components {
              */
             id: string;
             /**
-             * List of required options for the app component
+             * List of options for the app component
              */
-            config_options?: /* Options for the component configuration */ ConfigurationOptions[];
+            options?: /* Options for the component configuration */ Options[];
         }
         export interface CallerIdentity {
             /**
@@ -195,7 +204,21 @@ declare namespace Components {
              */
             token_id?: string;
         }
-        export interface ComponentConfigValue {
+        /**
+         * Type of app component
+         */
+        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION";
+        export interface JourneyBlockConfig {
+            /**
+             * URL of the web component object
+             */
+            component_url: string;
+            /**
+             * Custom element tag for the component
+             */
+            component_tag?: string;
+        }
+        export interface Option {
             /**
              * Key matching a config_option from the component
              */
@@ -205,21 +228,10 @@ declare namespace Components {
              */
             value: string;
         }
-        export interface ComponentConfigValues {
-            /**
-             * ID of the component these values are for
-             */
-            component_id: string;
-            options: ComponentConfigValue[];
-        }
-        /**
-         * Type of app component
-         */
-        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "PORTAL_EXTENSION";
         /**
          * Options for the component configuration
          */
-        export interface ConfigurationOptions {
+        export interface Options {
             /**
              * Unique identifier for this configuration option
              */
@@ -228,21 +240,22 @@ declare namespace Components {
              * Human-readable label for the configuration option
              */
             label?: string;
+            /**
+             * Flag to indicate if this option is required
+             */
+            required?: boolean;
             /**
              * Detailed description of what this configuration option does
              */
             description?: string;
             type: "string" | "number" | "boolean" | "secret";
         }
-        export interface JourneyBlockConfig {
-            /**
-             * URL of the web component object
-             */
-            object_url: string;
+        export interface OptionsRef {
             /**
-             * Custom element tag for the component
+             * ID of the component these values are for
              */
-            component_tag?: string;
+            component_id: string;
+            options: Option[];
         }
         export interface PortalAuth {
             type?: string;
@@ -424,7 +437,7 @@ export interface OperationMethods {
   /**
    * installApp - installApp
    * 
-   * Update assets of a specific installed app by its ID.
+   * Upsert app installation by its ID.
    */
   'installApp'(
     parameters?: Parameters<Paths.InstallApp.PathParameters> | null,
@@ -482,7 +495,7 @@ export interface PathsDictionary {
     /**
      * installApp - installApp
      * 
-     * Update assets of a specific installed app by its ID.
+     * Upsert app installation by its ID.
      */
     'put'(
       parameters?: Parameters<Paths.InstallApp.PathParameters> | null,
@@ -510,11 +523,11 @@ export type Author = Components.Schemas.Author;
 export type BaseComponent = Components.Schemas.BaseComponent;
 export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
 export type CallerIdentity = Components.Schemas.CallerIdentity;
-export type ComponentConfigValue = Components.Schemas.ComponentConfigValue;
-export type ComponentConfigValues = Components.Schemas.ComponentConfigValues;
 export type ComponentType = Components.Schemas.ComponentType;
-export type ConfigurationOptions = Components.Schemas.ConfigurationOptions;
 export type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;
+export type Option = Components.Schemas.Option;
+export type Options = Components.Schemas.Options;
+export type OptionsRef = Components.Schemas.OptionsRef;
 export type PortalAuth = Components.Schemas.PortalAuth;
 export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
 export type S3Reference = Components.Schemas.S3Reference;

package/dist/openapi.json

@@ -158,7 +158,7 @@
       },
       "put": {
         "summary": "installApp",
-        "description": "Update assets of a specific installed app by its ID.",
+        "description": "Upsert app installation by its ID.",
         "operationId": "installApp",
         "parameters": [
           {
@@ -215,10 +215,10 @@
             "schema": {
               "type": "object",
               "properties": {
-                "config_values": {
+                "option_values": {
                   "type": "array",
                   "items": {
-                    "$ref": "#/components/schemas/ComponentConfigValues"
+                    "$ref": "#/components/schemas/OptionsRef"
                   },
                   "description": "Configuration values for the app components"
                 }
@@ -243,7 +243,7 @@
       }
     },
     "schemas": {
-      "ConfigurationOptions": {
+      "Options": {
         "type": "object",
         "description": "Options for the component configuration",
         "required": [
@@ -259,6 +259,10 @@
             "type": "string",
             "description": "Human-readable label for the configuration option"
           },
+          "required": {
+            "type": "boolean",
+            "description": "Flag to indicate if this option is required"
+          },
           "description": {
             "type": "string",
             "description": "Detailed description of what this configuration option does"
@@ -274,7 +278,7 @@
           }
         }
       },
-      "ComponentConfigValue": {
+      "Option": {
         "type": "object",
         "required": [
           "key",
@@ -291,7 +295,7 @@
           }
         }
       },
-      "ComponentConfigValues": {
+      "OptionsRef": {
         "type": "object",
         "required": [
           "component_id",
@@ -305,7 +309,7 @@
           "options": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/ComponentConfigValue"
+              "$ref": "#/components/schemas/Option"
             }
           }
         }
@@ -384,12 +388,12 @@
             "type": "string",
             "description": "Unique identifier for the component"
           },
-          "config_options": {
+          "options": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/ConfigurationOptions"
+              "$ref": "#/components/schemas/Options"
             },
-            "description": "List of required options for the app component"
+            "description": "List of options for the app component"
           }
         }
       },
@@ -431,6 +435,13 @@
                       "PORTAL_EXTENSION"
                     ]
                   },
+                  "origin": {
+                    "type": "string",
+                    "enum": [
+                      "END_CUSTOMER_PORTAL",
+                      "INSTALLER_PORTAL"
+                    ]
+                  },
                   "configuration": {
                     "$ref": "#/components/schemas/PortalExtensionConfig"
                   }
@@ -564,11 +575,11 @@
       "JourneyBlockConfig": {
         "type": "object",
         "required": [
-          "object_url",
+          "component_url",
           "componentTag"
         ],
         "properties": {
-          "object_url": {
+          "component_url": {
             "type": "string",
             "description": "URL of the web component object"
           },
@@ -607,17 +618,27 @@
             "description": "User ID of the user who installed the app",
             "readOnly": true
           },
+          "updated_by": {
+            "type": "string",
+            "description": "User ID of the user who last updated the app",
+            "readOnly": true
+          },
+          "updated_at": {
+            "type": "string",
+            "description": "Timestamp of the last update",
+            "readOnly": true
+          },
           "enabled": {
             "readOnly": true,
             "type": "boolean",
             "default": true,
             "description": "Flag to indicate if the app is enabled."
           },
-          "config_values": {
-            "description": "Configuration values for the app components",
+          "option_values": {
+            "description": "Configuration values for the app components options",
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/ComponentConfigValues"
+              "$ref": "#/components/schemas/OptionsRef"
             }
           }
         }
@@ -656,6 +677,10 @@
             "type": "string",
             "readOnly": true
           },
+          "updated_by": {
+            "type": "string",
+            "readOnly": true
+          },
           "version": {
             "type": "string",
             "readOnly": true

package/package.json

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