@epilot/app-client 0.0.16 → 0.0.18

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={187:function(e,r,p){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=t(p(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":{}},"put":{"operationId":"updateAppConfigurationMetadata","requestBody":{"$ref":"#/components/requestBodies/UpdateConfigMetadataRequest"},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","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":{"UpdateConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"UpdateVersionRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallAppRequest":{"content":{"application/json":{}}}}}}')}},r={},p=function p(t){var n=r[t];if(void 0!==n)return n.exports;var a=r[t]={exports:{}};return e[t].call(a.exports,a,a.exports,p),a.exports}(187),t=exports;for(var n in p)t[n]=p[n];p.__esModule&&Object.defineProperty(t,"__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":{}},"put":{"operationId":"updateAppConfigurationMetadata","requestBody":{"$ref":"#/components/requestBodies/UpdateConfigMetadataRequest"},"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":{}}},"UpdateConfigMetadataRequest":{"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

@@ -71,6 +71,9 @@
       ],
       "post": {
         "operationId": "createLogoUploadUrl",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/CreateLogoRequest"
+        },
         "responses": {}
       },
       "delete": {
@@ -258,6 +261,12 @@
   },
   "components": {
     "requestBodies": {
+      "CreateLogoRequest": {
+        "required": true,
+        "content": {
+          "application/json": {}
+        }
+      },
       "UpdateConfigMetadataRequest": {
         "required": true,
         "content": {

package/dist/openapi.d.ts

@@ -14,6 +14,24 @@ declare namespace Components {
             name: Schemas.TranslatedString;
             description: Schemas.TranslatedString;
             category?: string;
+            /**
+             * S3 key of the logo file
+             */
+            logo_url_key?: string;
+        }
+        export interface CreateLogoRequest {
+            /**
+             * Original filename of the logo
+             * example:
+             * company-logo.png
+             */
+            filename: string;
+            /**
+             * MIME type of the logo file
+             * example:
+             * image/png
+             */
+            mime_type: "image/png" | "image/jpeg" | "image/jpg";
         }
         export interface InstallAppRequest {
             /**
@@ -28,6 +46,15 @@ declare namespace Components {
             documentation_url?: string;
             homepage_url?: string;
             notifications?: Schemas.NotificationConfig;
+            pricing?: Schemas.Pricing;
+            /**
+             * S3 key of the logo file
+             */
+            logo_url_key?: string;
+            /**
+             * Email address for support requests
+             */
+            support_email?: string;
         }
         export interface UpdateVersionRequest {
             /**
@@ -48,6 +75,10 @@ declare namespace Components {
              * List of available versions of the app
              */
             versions?: string[];
+            /**
+             * Email address for support requests
+             */
+            support_email?: string;
             /**
              * Latest version of the app
              */
@@ -78,6 +109,7 @@ declare namespace Components {
              * Flag to indicate if the app is built by epilot.
              */
             internal?: boolean;
+            pricing?: Pricing;
             /**
              * Timestamp of app creation
              */
@@ -155,6 +187,10 @@ declare namespace Components {
              * List of available versions of the app
              */
             versions?: string[];
+            /**
+             * Email address for support requests
+             */
+            support_email?: string;
             /**
              * Latest version of the app
              */
@@ -185,6 +221,7 @@ declare namespace Components {
              * Flag to indicate if the app is built by epilot.
              */
             internal?: boolean;
+            pricing?: Pricing;
             /**
              * Timestamp of app creation
              */
@@ -232,6 +269,10 @@ declare namespace Components {
              * List of available versions of the app
              */
             versions?: string[];
+            /**
+             * Email address for support requests
+             */
+            support_email?: string;
             /**
              * Latest version of the app
              */
@@ -268,6 +309,10 @@ declare namespace Components {
              * Flag to indicate if the app is built by epilot.
              */
             internal?: boolean;
+            /**
+             * Pricing information for the app
+             */
+            pricing?: Pricing;
             /**
              * Timestamp of app creation
              */
@@ -346,6 +391,10 @@ declare namespace Components {
              */
             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";
         }
@@ -411,6 +460,9 @@ declare namespace Components {
                 }[]
             ];
         }
+        export interface FreePricing {
+            pricing_type: "FREE";
+        }
         export interface JourneyBlockComponent {
             component_type: "CUSTOM_JOURNEY_BLOCK";
             configuration: JourneyBlockConfig;
@@ -456,7 +508,7 @@ declare namespace Components {
              * example:
              * developer@example.com
              */
-            email: string; // email
+            email?: string | null;
             /**
              * List of events to subscribe to
              */
@@ -552,6 +604,7 @@ declare namespace Components {
                 };
             }[];
         }
+        export type Pricing = FreePricing | SubscriptionPricing | UsageBasedPricing;
         export interface S3Reference {
             /**
              * The name of the S3 bucket where the JSON file for import is stored.
@@ -566,6 +619,10 @@ declare namespace Components {
              */
             key: string;
         }
+        export interface SubscriptionPricing {
+            pricing_type: "SUBSCRIPTION";
+            billing_frequency: /* How often the subscription is billed */ BillingFrequency;
+        }
         export interface TextArg {
             type?: "text";
         }
@@ -585,6 +642,9 @@ declare namespace Components {
              */
             app_id?: string;
         }
+        export interface UsageBasedPricing {
+            pricing_type: "USAGE_BASED";
+        }
     }
 }
 declare namespace Paths {
@@ -620,12 +680,14 @@ declare namespace Paths {
         }
     }
     namespace CreateLogoUploadUrl {
+        export type RequestBody = Components.RequestBodies.CreateLogoRequest;
         namespace Responses {
             export interface $200 {
                 /**
                  * Presigned S3 URL for uploading the logo
                  */
                 upload_url: string;
+                s3ref?: Components.Schemas.S3Reference;
                 /**
                  * Timestamp when the upload URL expires
                  */
@@ -912,7 +974,7 @@ export interface OperationMethods {
    */
   'createLogoUploadUrl'(
     parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
-    data?: any,
+    data?: Paths.CreateLogoUploadUrl.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CreateLogoUploadUrl.Responses.$200>
   /**
@@ -1080,7 +1142,7 @@ export interface PathsDictionary {
      */
     'post'(
       parameters?: Parameters<Paths.V1AppConfigurations$AppIdLogo.PathParameters> | null,
-      data?: any,
+      data?: Paths.CreateLogoUploadUrl.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.CreateLogoUploadUrl.Responses.$200>
     /**
@@ -1217,10 +1279,12 @@ export type AppVersioned = Components.Schemas.AppVersioned;
 export type Author = Components.Schemas.Author;
 export type BaseComponent = Components.Schemas.BaseComponent;
 export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
+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 EnumArg = Components.Schemas.EnumArg;
+export type FreePricing = Components.Schemas.FreePricing;
 export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
 export type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
 export type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;
@@ -1232,7 +1296,10 @@ export type OptionsRef = Components.Schemas.OptionsRef;
 export type PortalAuth = Components.Schemas.PortalAuth;
 export type PortalExtensionComponent = Components.Schemas.PortalExtensionComponent;
 export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
+export type Pricing = Components.Schemas.Pricing;
 export type S3Reference = Components.Schemas.S3Reference;
+export type SubscriptionPricing = Components.Schemas.SubscriptionPricing;
 export type TextArg = Components.Schemas.TextArg;
 export type TranslatedString = Components.Schemas.TranslatedString;
 export type UploadFilePayload = Components.Schemas.UploadFilePayload;
+export type UsageBasedPricing = Components.Schemas.UsageBasedPricing;

package/dist/openapi.json

@@ -186,6 +186,9 @@
         "summary": "createLogoUploadUrl",
         "description": "Generate a presigned URL for uploading app logo to /<app-id>/logo.png path",
         "operationId": "createLogoUploadUrl",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/CreateLogoRequest"
+        },
         "responses": {
           "200": {
             "description": "Upload URL generated successfully",
@@ -201,6 +204,9 @@
                       "type": "string",
                       "description": "Presigned S3 URL for uploading the logo"
                     },
+                    "s3ref": {
+                      "$ref": "#/components/schemas/S3Reference"
+                    },
                     "expires_at": {
                       "type": "string",
                       "format": "date-time",
@@ -694,6 +700,37 @@
   },
   "components": {
     "requestBodies": {
+      "CreateLogoRequest": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "required": [
+                "filename",
+                "mime_type"
+              ],
+              "properties": {
+                "filename": {
+                  "type": "string",
+                  "description": "Original filename of the logo",
+                  "example": "company-logo.png"
+                },
+                "mime_type": {
+                  "type": "string",
+                  "description": "MIME type of the logo file",
+                  "enum": [
+                    "image/png",
+                    "image/jpeg",
+                    "image/jpg"
+                  ],
+                  "example": "image/png"
+                }
+              }
+            }
+          }
+        }
+      },
       "UpdateConfigMetadataRequest": {
         "required": true,
         "content": {
@@ -722,6 +759,17 @@
                 },
                 "notifications": {
                   "$ref": "#/components/schemas/NotificationConfig"
+                },
+                "pricing": {
+                  "$ref": "#/components/schemas/Pricing"
+                },
+                "logo_url_key": {
+                  "type": "string",
+                  "description": "S3 key of the logo file"
+                },
+                "support_email": {
+                  "type": "string",
+                  "description": "Email address for support requests"
                 }
               }
             }
@@ -769,6 +817,10 @@
                 },
                 "category": {
                   "type": "string"
+                },
+                "logo_url_key": {
+                  "type": "string",
+                  "description": "S3 key of the logo file"
                 }
               }
             }
@@ -942,13 +994,10 @@
       },
       "NotificationConfig": {
         "type": "object",
-        "required": [
-          "email"
-        ],
         "properties": {
           "email": {
             "type": "string",
-            "format": "email",
+            "nullable": true,
             "description": "Email address to receive notifications",
             "example": "developer@example.com"
           },
@@ -1336,6 +1385,84 @@
           }
         }
       },
+      "BillingFrequency": {
+        "type": "string",
+        "enum": [
+          "MONTHLY",
+          "QUARTERLY",
+          "YEARLY",
+          "CUSTOM"
+        ],
+        "description": "How often the subscription is billed"
+      },
+      "Pricing": {
+        "type": "object",
+        "discriminator": {
+          "propertyName": "pricing_type",
+          "mapping": {
+            "FREE": "#/components/schemas/FreePricing",
+            "SUBSCRIPTION": "#/components/schemas/SubscriptionPricing",
+            "USAGE_BASED": "#/components/schemas/UsageBasedPricing"
+          }
+        },
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/FreePricing"
+          },
+          {
+            "$ref": "#/components/schemas/SubscriptionPricing"
+          },
+          {
+            "$ref": "#/components/schemas/UsageBasedPricing"
+          }
+        ]
+      },
+      "FreePricing": {
+        "type": "object",
+        "properties": {
+          "pricing_type": {
+            "type": "string",
+            "enum": [
+              "FREE"
+            ]
+          }
+        },
+        "required": [
+          "pricing_type"
+        ]
+      },
+      "SubscriptionPricing": {
+        "type": "object",
+        "properties": {
+          "pricing_type": {
+            "type": "string",
+            "enum": [
+              "SUBSCRIPTION"
+            ]
+          },
+          "billing_frequency": {
+            "$ref": "#/components/schemas/BillingFrequency"
+          }
+        },
+        "required": [
+          "pricing_type",
+          "billing_frequency"
+        ]
+      },
+      "UsageBasedPricing": {
+        "type": "object",
+        "properties": {
+          "pricing_type": {
+            "type": "string",
+            "enum": [
+              "USAGE_BASED"
+            ]
+          }
+        },
+        "required": [
+          "pricing_type"
+        ]
+      },
       "AppMetadata": {
         "description": "Basic metadata about your app configuration which does not get versioned",
         "type": "object",
@@ -1362,6 +1489,10 @@
             "description": "List of available versions of the app",
             "readOnly": true
           },
+          "support_email": {
+            "type": "string",
+            "description": "Email address for support requests"
+          },
           "latest_version": {
             "type": "string",
             "description": "Latest version of the app",
@@ -1402,6 +1533,10 @@
             "description": "Flag to indicate if the app is built by epilot.",
             "readOnly": true
           },
+          "pricing": {
+            "$ref": "#/components/schemas/Pricing",
+            "description": "Pricing information for the app"
+          },
           "created_at": {
             "type": "string",
             "description": "Timestamp of app creation",

package/package.json

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