@epilot/app-client 0.1.2 → 0.2.0

package/dist/openapi.json

@@ -24,9 +24,9 @@
   "paths": {
     "/v1/app-configurations": {
       "get": {
-        "summary": "listAppConfigurations",
+        "summary": "listConfigurations",
         "description": "List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.",
-        "operationId": "listAppConfigurations",
+        "operationId": "listConfigurations",
         "parameters": [
           {
             "name": "page",
@@ -83,9 +83,9 @@
         }
       },
       "post": {
-        "summary": "createAppConfiguration",
+        "summary": "createConfiguration",
         "description": "Create a new private app configuration. To make it public a verification process needs to be triggered",
-        "operationId": "createAppConfiguration",
+        "operationId": "createConfiguration",
         "requestBody": {
           "$ref": "#/components/requestBodies/CreateConfigRequest"
         },
@@ -124,9 +124,9 @@
         }
       ],
       "get": {
-        "summary": "getAppConfiguration",
+        "summary": "getConfiguration",
         "description": "Retrieve a specific app configuration",
-        "operationId": "getAppConfiguration",
+        "operationId": "getConfiguration",
         "parameters": [
           {
             "name": "version",
@@ -154,9 +154,9 @@
         }
       },
       "patch": {
-        "summary": "patchConfigurationMetadata",
+        "summary": "patchMetadata",
         "description": "Patch non-versioned configuration metadata of a given app configuration.",
-        "operationId": "patchConfigurationMetadata",
+        "operationId": "patchMetadata",
         "requestBody": {
           "$ref": "#/components/requestBodies/PatchConfigMetadataRequest"
         },
@@ -170,6 +170,59 @@
         }
       }
     },
+    "/v1/app-configurations/{appId}/bundle": {
+      "post": {
+        "summary": "createBundleUploadUrl",
+        "description": "Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path",
+        "operationId": "createBundleUploadUrl",
+        "parameters": [
+          {
+            "name": "appId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID of the app configuration"
+          }
+        ],
+        "requestBody": {
+          "$ref": "#/components/requestBodies/CreateBundlePresignedRequest"
+        },
+        "responses": {
+          "200": {
+            "description": "Upload URL generated successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "upload_url"
+                  ],
+                  "properties": {
+                    "upload_url": {
+                      "type": "string",
+                      "description": "Presigned S3 URL for uploading the bundle"
+                    },
+                    "s3ref": {
+                      "$ref": "#/components/schemas/S3Reference"
+                    },
+                    "expires_at": {
+                      "type": "string",
+                      "format": "date-time",
+                      "description": "Timestamp when the upload URL expires"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "App configuration not found"
+          }
+        }
+      }
+    },
     "/v1/app-configurations/{appId}/logo": {
       "parameters": [
         {
@@ -187,7 +240,7 @@
         "description": "Generate a presigned URL for uploading app logo to /<app-id>/logo.png path",
         "operationId": "createLogoUploadUrl",
         "requestBody": {
-          "$ref": "#/components/requestBodies/CreateLogoRequest"
+          "$ref": "#/components/requestBodies/CreateLogoPresignedRequest"
         },
         "responses": {
           "200": {
@@ -238,7 +291,7 @@
     },
     "/v1/app-configurations/{appId}/versions": {
       "get": {
-        "summary": "listAppVersions",
+        "summary": "listVersions",
         "description": "Retrieve a list of versions for an app configuration",
         "operationId": "listAppVersions",
         "parameters": [
@@ -308,9 +361,9 @@
     },
     "/v1/app-configurations/{appId}/versions/{version}": {
       "get": {
-        "summary": "getAppConfigurationVersion",
+        "summary": "getVersion",
         "description": "Retrieve a specific version of an app configuration",
-        "operationId": "getAppConfigurationVersion",
+        "operationId": "getVersion",
         "parameters": [
           {
             "name": "appId",
@@ -348,9 +401,9 @@
         }
       },
       "delete": {
-        "summary": "deleteAppVersion",
+        "summary": "deleteVersion",
         "description": "Delete a specific version of an app configuration",
-        "operationId": "deleteAppVersion",
+        "operationId": "deleteVersion",
         "parameters": [
           {
             "name": "appId",
@@ -386,10 +439,10 @@
           }
         }
       },
-      "put": {
-        "summary": "updateAppVersion",
-        "description": "Update configuration data of a given app version",
-        "operationId": "updateAppVersion",
+      "patch": {
+        "summary": "patchVersion",
+        "description": "Patch version specific data of a configuration",
+        "operationId": "patchVersion",
         "parameters": [
           {
             "name": "appId",
@@ -411,7 +464,7 @@
           }
         ],
         "requestBody": {
-          "$ref": "#/components/requestBodies/UpdateVersionRequest"
+          "$ref": "#/components/requestBodies/PatchVersionRequest"
         },
         "responses": {
           "204": {
@@ -428,9 +481,9 @@
     },
     "/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}": {
       "post": {
-        "summary": "cloneAppVersion",
+        "summary": "cloneVersion",
         "description": "Clone an existing app version to create a new version",
-        "operationId": "cloneAppVersion",
+        "operationId": "cloneVersion",
         "parameters": [
           {
             "name": "appId",
@@ -497,9 +550,9 @@
     },
     "/v1/app": {
       "get": {
-        "summary": "listInstalledApps",
+        "summary": "listInstallations",
         "description": "Retrieve a list of installed apps for the organization.",
-        "operationId": "listInstalledApps",
+        "operationId": "listInstallations",
         "parameters": [
           {
             "name": "componentType",
@@ -575,9 +628,9 @@
     },
     "/v1/app/{appId}": {
       "get": {
-        "summary": "getInstalledApp",
+        "summary": "getInstallation",
         "description": "Retrieve details of an installed app by its ID.",
-        "operationId": "getInstalledApp",
+        "operationId": "getInstallation",
         "parameters": [
           {
             "name": "appId",
@@ -605,9 +658,9 @@
         }
       },
       "post": {
-        "summary": "installApp",
+        "summary": "install",
         "description": "Upsert app installation by its ID.",
-        "operationId": "installApp",
+        "operationId": "install",
         "parameters": [
           {
             "name": "appId",
@@ -619,7 +672,7 @@
           }
         ],
         "requestBody": {
-          "$ref": "#/components/requestBodies/InstallAppRequest"
+          "$ref": "#/components/requestBodies/InstallRequest"
         },
         "responses": {
           "204": {
@@ -631,9 +684,9 @@
         }
       },
       "patch": {
-        "summary": "patchInstalledApp",
+        "summary": "patchInstallation",
         "description": "Patch an installed app by its ID.",
-        "operationId": "patchInstalledApp",
+        "operationId": "patchInstallation",
         "parameters": [
           {
             "name": "appId",
@@ -645,7 +698,7 @@
           }
         ],
         "requestBody": {
-          "$ref": "#/components/requestBodies/InstallAppRequest"
+          "$ref": "#/components/requestBodies/InstallRequest"
         },
         "responses": {
           "204": {
@@ -657,9 +710,9 @@
         }
       },
       "delete": {
-        "summary": "uninstallApp",
+        "summary": "uninstall",
         "description": "Uninstall an app by its ID.",
-        "operationId": "uninstallApp",
+        "operationId": "uninstall",
         "parameters": [
           {
             "name": "appId",
@@ -682,9 +735,9 @@
     },
     "/v1/app/{appId}/promote-to/{version}": {
       "post": {
-        "summary": "promoteAppVersion",
+        "summary": "promoteVersion",
         "description": "Update an installed app to a new version",
-        "operationId": "promoteAppVersion",
+        "operationId": "promoteVersion",
         "parameters": [
           {
             "name": "appId",
@@ -726,7 +779,7 @@
   },
   "components": {
     "requestBodies": {
-      "CreateLogoRequest": {
+      "CreateLogoPresignedRequest": {
         "required": true,
         "content": {
           "application/json": {
@@ -757,6 +810,29 @@
           }
         }
       },
+      "CreateBundlePresignedRequest": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "required": [
+                "version"
+              ],
+              "properties": {
+                "version": {
+                  "type": "string",
+                  "description": "Version of the app"
+                },
+                "component_id": {
+                  "type": "string",
+                  "description": "ID of the journye block component"
+                }
+              }
+            }
+          }
+        }
+      },
       "PatchConfigMetadataRequest": {
         "required": true,
         "content": {
@@ -765,7 +841,8 @@
               "type": "object",
               "properties": {
                 "name": {
-                  "$ref": "#/components/schemas/TranslatedString"
+                  "type": "string",
+                  "description": "Name of the app"
                 },
                 "description": {
                   "$ref": "#/components/schemas/TranslatedString"
@@ -795,7 +872,7 @@
           }
         }
       },
-      "UpdateVersionRequest": {
+      "PatchVersionRequest": {
         "required": true,
         "content": {
           "application/json": {
@@ -829,7 +906,8 @@
               ],
               "properties": {
                 "name": {
-                  "$ref": "#/components/schemas/TranslatedString"
+                  "type": "string",
+                  "description": "Name of the app"
                 },
                 "description": {
                   "$ref": "#/components/schemas/TranslatedString"
@@ -846,7 +924,7 @@
           }
         }
       },
-      "InstallAppRequest": {
+      "InstallRequest": {
         "content": {
           "application/json": {
             "schema": {
@@ -1255,7 +1333,8 @@
           "component_url": {
             "type": "string",
             "description": "URL of the web component object",
-            "example": "https://cdn.apps.com/123/v1.0.0/bundle.js"
+            "example": "https://cdn.apps.com/123/v1.0.0/bundle.js",
+            "readOnly": true
           },
           "component_tag": {
             "type": "string",
@@ -1268,6 +1347,11 @@
               "$ref": "#/components/schemas/JourneyBlockComponentArgs"
             }
           },
+          "component_size": {
+            "type": "number",
+            "description": "Size of the bundle in bytes",
+            "readOnly": true
+          },
           "component_mapping": {
             "description": "Define data which is mapped to entity mapping ui blocks",
             "type": "object",
@@ -1470,7 +1554,8 @@
           "latest_version",
           "owner_org_id",
           "has_public_version",
-          "app_id"
+          "app_id",
+          "versions"
         ],
         "properties": {
           "app_id": {
@@ -1478,7 +1563,8 @@
             "readOnly": true
           },
           "name": {
-            "$ref": "#/components/schemas/TranslatedString"
+            "type": "string",
+            "description": "Name of the app"
           },
           "author": {
             "$ref": "#/components/schemas/Author"
@@ -1491,6 +1577,14 @@
             "description": "List of available versions of the app",
             "readOnly": true
           },
+          "public_versions": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "List of available public versions of the app",
+            "readOnly": true
+          },
           "support_email": {
             "type": "string",
             "description": "Email address for support requests"
@@ -1664,7 +1758,7 @@
             "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",
+            "type": "string",
             "description": "Name of the app",
             "readOnly": true
           },

package/package.json

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