@epilot/app-client 0.0.17 → 0.0.19

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":{}},"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})})();
+(()=>{"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 a=p(t(466));r.default=a.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":{}},"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":{}}},"PatchConfigMetadataRequest":{"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 a=r[p];if(void 0!==a)return a.exports;var n=r[p]={exports:{}};return e[p].call(n.exports,n,n.exports,t),n.exports}(187),p=exports;for(var a in t)p[a]=t[a];t.__esModule&&Object.defineProperty(p,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -52,6 +52,13 @@
         ],
         "responses": {}
       },
+      "patch": {
+        "operationId": "patchConfigurationMetadata",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/PatchConfigMetadataRequest"
+        },
+        "responses": {}
+      },
       "put": {
         "operationId": "updateAppConfigurationMetadata",
         "requestBody": {
@@ -267,6 +274,12 @@
           "application/json": {}
         }
       },
+      "PatchConfigMetadataRequest": {
+        "required": true,
+        "content": {
+          "application/json": {}
+        }
+      },
       "UpdateConfigMetadataRequest": {
         "required": true,
         "content": {

package/dist/openapi.d.ts

@@ -39,6 +39,23 @@ declare namespace Components {
              */
             option_values?: Schemas.OptionsRef[];
         }
+        export interface PatchConfigMetadataRequest {
+            name?: Schemas.TranslatedString;
+            description?: Schemas.TranslatedString;
+            category?: string;
+            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 UpdateConfigMetadataRequest {
             name: Schemas.TranslatedString;
             description: Schemas.TranslatedString;
@@ -46,10 +63,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 {
             /**
@@ -70,6 +92,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
              */
@@ -100,6 +126,7 @@ declare namespace Components {
              * Flag to indicate if the app is built by epilot.
              */
             internal?: boolean;
+            pricing?: Pricing;
             /**
              * Timestamp of app creation
              */
@@ -177,6 +204,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
              */
@@ -207,6 +238,7 @@ declare namespace Components {
              * Flag to indicate if the app is built by epilot.
              */
             internal?: boolean;
+            pricing?: Pricing;
             /**
              * Timestamp of app creation
              */
@@ -254,6 +286,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
              */
@@ -290,6 +326,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
              */
@@ -368,6 +408,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";
         }
@@ -433,6 +477,9 @@ declare namespace Components {
                 }[]
             ];
         }
+        export interface FreePricing {
+            pricing_type: "FREE";
+        }
         export interface JourneyBlockComponent {
             component_type: "CUSTOM_JOURNEY_BLOCK";
             configuration: JourneyBlockConfig;
@@ -478,7 +525,7 @@ declare namespace Components {
              * example:
              * developer@example.com
              */
-            email: string; // email
+            email?: string | null;
             /**
              * List of events to subscribe to
              */
@@ -574,6 +621,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.
@@ -588,6 +636,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";
         }
@@ -607,6 +659,9 @@ declare namespace Components {
              */
             app_id?: string;
         }
+        export interface UsageBasedPricing {
+            pricing_type: "USAGE_BASED";
+        }
     }
 }
 declare namespace Paths {
@@ -811,6 +866,15 @@ declare namespace Paths {
             }
         }
     }
+    namespace PatchConfigurationMetadata {
+        export type RequestBody = Components.RequestBodies.PatchConfigMetadataRequest;
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $404 {
+            }
+        }
+    }
     namespace PromoteAppVersion {
         namespace Parameters {
             export type AppId = string;
@@ -929,6 +993,16 @@ export interface OperationMethods {
     data?: Paths.UpdateAppConfigurationMetadata.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UpdateAppConfigurationMetadata.Responses.$204>
+  /**
+   * patchConfigurationMetadata - patchConfigurationMetadata
+   * 
+   * Patch non-versioned configuration metadata of a given app configuration.
+   */
+  'patchConfigurationMetadata'(
+    parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
+    data?: Paths.PatchConfigurationMetadata.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PatchConfigurationMetadata.Responses.$204>
   /**
    * createLogoUploadUrl - createLogoUploadUrl
    * 
@@ -1085,6 +1159,16 @@ export interface PathsDictionary {
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
+    /**
+     * patchConfigurationMetadata - patchConfigurationMetadata
+     * 
+     * Patch non-versioned configuration metadata of a given app configuration.
+     */
+    'patch'(
+      parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
+      data?: Paths.PatchConfigurationMetadata.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PatchConfigurationMetadata.Responses.$204>
     /**
      * updateAppConfigurationMetadata - updateAppConfigurationMetadata
      * 
@@ -1241,10 +1325,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;
@@ -1256,7 +1342,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

@@ -153,6 +153,22 @@
           }
         }
       },
+      "patch": {
+        "summary": "patchConfigurationMetadata",
+        "description": "Patch non-versioned configuration metadata of a given app configuration.",
+        "operationId": "patchConfigurationMetadata",
+        "requestBody": {
+          "$ref": "#/components/requestBodies/PatchConfigMetadataRequest"
+        },
+        "responses": {
+          "204": {
+            "description": "Configuration patched successfully"
+          },
+          "404": {
+            "description": "App configuration not found"
+          }
+        }
+      },
       "put": {
         "summary": "updateAppConfigurationMetadata",
         "description": "Update non-versioned configuration metadata of a given app configuration.",
@@ -731,6 +747,47 @@
           }
         }
       },
+      "PatchConfigMetadataRequest": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "$ref": "#/components/schemas/TranslatedString"
+                },
+                "description": {
+                  "$ref": "#/components/schemas/TranslatedString"
+                },
+                "category": {
+                  "type": "string"
+                },
+                "documentation_url": {
+                  "type": "string"
+                },
+                "homepage_url": {
+                  "type": "string"
+                },
+                "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"
+                }
+              }
+            }
+          }
+        }
+      },
       "UpdateConfigMetadataRequest": {
         "required": true,
         "content": {
@@ -760,9 +817,16 @@
                 "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"
                 }
               }
             }
@@ -987,13 +1051,10 @@
       },
       "NotificationConfig": {
         "type": "object",
-        "required": [
-          "email"
-        ],
         "properties": {
           "email": {
             "type": "string",
-            "format": "email",
+            "nullable": true,
             "description": "Email address to receive notifications",
             "example": "developer@example.com"
           },
@@ -1381,6 +1442,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",
@@ -1407,6 +1546,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",
@@ -1447,6 +1590,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.17",
+  "version": "0.0.19",
   "description": "JavaScript client library for the epilot App API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",