@epilot/app-client 0.5.2 → 0.5.3

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={187:function(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var o=n(t(466));r.default=o.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":"listConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/public/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"}],"get":{"operationId":"getPublicConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"patch":{"operationId":"patchMetadata","requestBody":{"$ref":"#/components/requestBodies/PatchConfigMetadataRequest"},"responses":{}}},"/v1/app-configurations/{appId}/bundle":{"post":{"operationId":"createBundleUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/CreateBundlePresignedRequest"},"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/CreateLogoPresignedRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components":{"post":{"operationId":"createComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components/{componentId}":{"patch":{"operationId":"patchComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}},"delete":{"operationId":"deleteComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstallations","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstallation","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"post":{"operationId":"install","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"patch":{"operationId":"patchInstallation","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"delete":{"operationId":"uninstall","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoPresignedRequest":{"required":true,"content":{"application/json":{}}},"CreateBundlePresignedRequest":{"required":true,"content":{"application/json":{}}},"PatchConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"UpsertComponentRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(n){var o=r[n];if(void 0!==o)return o.exports;var a=r[n]={exports:{}};return e[n].call(a.exports,a,a.exports,t),a.exports}(187),n=exports;for(var o in t)n[o]=t[o];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={187:function(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var o=n(t(466));r.default=o.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/public/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"}],"get":{"operationId":"getPublicConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"patch":{"operationId":"patchMetadata","requestBody":{"$ref":"#/components/requestBodies/PatchConfigMetadataRequest"},"responses":{}}},"/v1/app-configurations/{appId}/bundle":{"post":{"operationId":"createBundleUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/CreateBundlePresignedRequest"},"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/CreateLogoPresignedRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"patch":{"operationId":"patchVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/PatchVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components":{"post":{"operationId":"createComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}/components/{componentId}":{"patch":{"operationId":"patchComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpsertComponentRequest"},"responses":{}},"delete":{"operationId":"deleteComponent","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true},{"name":"componentId","in":"path","required":true}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstallations","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstallation","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"post":{"operationId":"install","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"patch":{"operationId":"patchInstallation","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallRequest"},"responses":{}},"delete":{"operationId":"uninstall","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoPresignedRequest":{"required":true,"content":{"application/json":{}}},"CreateBundlePresignedRequest":{"required":true,"content":{"application/json":{}}},"PatchConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"PatchVersionRequest":{"required":true,"content":{"application/json":{}}},"UpsertComponentRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(n){var o=r[n];if(void 0!==o)return o.exports;var a=r[n]={exports:{}};return e[n].call(a.exports,a,a.exports,t),a.exports}(187),n=exports;for(var o in t)n[o]=t[o];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
   "info": {
     "title": "",
     "version": ""
@@ -170,6 +170,25 @@
           }
         ],
         "responses": {}
+      },
+      "patch": {
+        "operationId": "patchVersion",
+        "parameters": [
+          {
+            "name": "appId",
+            "in": "path",
+            "required": true
+          },
+          {
+            "name": "version",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "$ref": "#/components/requestBodies/PatchVersionRequest"
+        },
+        "responses": {}
       }
     },
     "/v1/app-configurations/{appId}/versions/{version}/components": {
@@ -378,6 +397,12 @@
           "application/json": {}
         }
       },
+      "PatchVersionRequest": {
+        "required": true,
+        "content": {
+          "application/json": {}
+        }
+      },
       "UpsertComponentRequest": {
         "required": true,
         "content": {

package/dist/openapi.d.ts

@@ -71,6 +71,13 @@ declare namespace Components {
              */
             support_email?: string;
         }
+        export interface PatchVersionRequest {
+            /**
+             * Name of the role
+             */
+            role_id?: string | null;
+            grants?: /* Required grants for the app in order to call APIs for the installing tenant */ Schemas.Grants;
+        }
         export type UpsertComponentRequest = Schemas.BaseComponent;
     }
     namespace Schemas {
@@ -368,6 +375,7 @@ declare namespace Components {
              * Status of the review process
              */
             review_status?: "approved" | "rejected" | "pending";
+            role?: Role;
             version_audit: {
                 /**
                  * Timestamp of the creation
@@ -536,6 +544,7 @@ declare namespace Components {
              * Status of the review process
              */
             review_status?: "approved" | "rejected" | "pending";
+            role?: Role;
             version_audit: {
                 /**
                  * Timestamp of the creation
@@ -654,6 +663,19 @@ declare namespace Components {
                 auth_token_ref?: string;
             };
         }
+        /**
+         * Required grants for the app in order to call APIs for the installing tenant
+         */
+        export type Grants = {
+            /**
+             * The action the app can perform
+             */
+            action: string;
+            /**
+             * The resource the app can access
+             */
+            resource?: string;
+        }[];
         /**
          * Information about the installed app. Has configuration data of the installed version
          */
@@ -686,6 +708,10 @@ declare namespace Components {
              * Version of the app that is installed
              */
             installed_version: string;
+            /**
+             * The name of the role the app can use to access APIs
+             */
+            role?: string;
             /**
              * Audit information for the app
              */
@@ -947,6 +973,7 @@ declare namespace Components {
              * Version of the app that is installed
              */
             version: string;
+            role?: Role;
             /**
              * Flag to indicate if the app is public.
              */
@@ -956,6 +983,13 @@ declare namespace Components {
              */
             versions?: /* Configuration data about your app which is versionable */ ConfigurationVersion[];
         }
+        export interface Role {
+            /**
+             * Name of the role
+             */
+            id?: string;
+            grants?: /* Required grants for the app in order to call APIs for the installing tenant */ Grants;
+        }
         export interface S3Reference {
             /**
              * The name of the S3 bucket where the JSON file for import is stored.
@@ -1316,6 +1350,25 @@ declare namespace Paths {
             }
         }
     }
+    namespace PatchVersion {
+        namespace Parameters {
+            export type AppId = string;
+            export type Version = string;
+        }
+        export interface PathParameters {
+            appId: Parameters.AppId;
+            version: Parameters.Version;
+        }
+        export type RequestBody = Components.RequestBodies.PatchVersionRequest;
+        namespace Responses {
+            export interface $204 {
+            }
+            export interface $400 {
+            }
+            export interface $404 {
+            }
+        }
+    }
     namespace PromoteVersion {
         namespace Parameters {
             export type AppId = string;
@@ -1474,6 +1527,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetVersion.Responses.$200>
+  /**
+   * patchVersion - patchVersion
+   * 
+   * Patch an existing app version
+   */
+  'patchVersion'(
+    parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
+    data?: Paths.PatchVersion.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PatchVersion.Responses.$204>
   /**
    * deleteVersion - deleteVersion
    * 
@@ -1710,6 +1773,16 @@ export interface PathsDictionary {
       data?: any,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteVersion.Responses.$204>
+    /**
+     * patchVersion - patchVersion
+     * 
+     * Patch an existing app version
+     */
+    'patch'(
+      parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
+      data?: Paths.PatchVersion.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PatchVersion.Responses.$204>
   }
   ['/v1/app-configurations/{appId}/versions/{version}/components']: {
     /**
@@ -1843,6 +1916,7 @@ export type CustomFlowActionComponent = Components.Schemas.CustomFlowActionCompo
 export type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
 export type EnumArg = Components.Schemas.EnumArg;
 export type ExternalIntegrationCustomActionConfig = Components.Schemas.ExternalIntegrationCustomActionConfig;
+export type Grants = Components.Schemas.Grants;
 export type Installation = Components.Schemas.Installation;
 export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
 export type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
@@ -1857,6 +1931,7 @@ export type PortalExtensionComponent = Components.Schemas.PortalExtensionCompone
 export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
 export type Pricing = Components.Schemas.Pricing;
 export type PublicConfiguration = Components.Schemas.PublicConfiguration;
+export type Role = Components.Schemas.Role;
 export type S3Reference = Components.Schemas.S3Reference;
 export type TextArg = Components.Schemas.TextArg;
 export type TranslatedString = Components.Schemas.TranslatedString;

package/dist/openapi.json

@@ -1,5 +1,5 @@
 {
-  "openapi": "3.0.3",
+  "openapi": "3.1.0",
   "info": {
     "title": "App API",
     "description": "API for managing app publishing and installed app.",
@@ -535,6 +535,48 @@
             "description": "Version is in use by installations"
           }
         }
+      },
+      "patch": {
+        "summary": "patchVersion",
+        "description": "Patch an existing app version",
+        "operationId": "patchVersion",
+        "tags": [
+          "App Configuration"
+        ],
+        "parameters": [
+          {
+            "name": "appId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "ID of the app configuration"
+          },
+          {
+            "name": "version",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "Version to update"
+          }
+        ],
+        "requestBody": {
+          "$ref": "#/components/requestBodies/PatchVersionRequest"
+        },
+        "responses": {
+          "204": {
+            "description": "Version patched successfully"
+          },
+          "400": {
+            "description": "Invalid version format"
+          },
+          "404": {
+            "description": "Version not found"
+          }
+        }
       }
     },
     "/v1/app-configurations/{appId}/versions/{version}/components": {
@@ -1093,6 +1135,26 @@
           }
         }
       },
+      "PatchVersionRequest": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "role_id": {
+                  "nullable": true,
+                  "type": "string",
+                  "description": "Name of the role"
+                },
+                "grants": {
+                  "$ref": "#/components/schemas/Grants"
+                }
+              }
+            }
+          }
+        }
+      },
       "UpsertComponentRequest": {
         "required": true,
         "content": {
@@ -1167,6 +1229,18 @@
       }
     },
     "schemas": {
+      "Role": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Name of the role"
+          },
+          "grants": {
+            "$ref": "#/components/schemas/Grants"
+          }
+        }
+      },
       "Options": {
         "type": "object",
         "description": "Options for the component configuration",
@@ -2065,6 +2139,9 @@
             ],
             "description": "Status of the review process"
           },
+          "role": {
+            "$ref": "#/components/schemas/Role"
+          },
           "version_audit": {
             "readOnly": true,
             "allOf": [
@@ -2090,6 +2167,26 @@
           }
         }
       },
+      "Grants": {
+        "type": "array",
+        "description": "Required grants for the app in order to call APIs for the installing tenant",
+        "items": {
+          "type": "object",
+          "required": [
+            "action"
+          ],
+          "properties": {
+            "action": {
+              "type": "string",
+              "description": "The action the app can perform"
+            },
+            "resource": {
+              "type": "string",
+              "description": "The resource the app can access"
+            }
+          }
+        }
+      },
       "Installation": {
         "description": "Information about the installed app. Has configuration data of the installed version",
         "type": "object",
@@ -2144,6 +2241,10 @@
             "description": "Version of the app that is installed",
             "readOnly": true
           },
+          "role": {
+            "type": "string",
+            "description": "The name of the role the app can use to access APIs"
+          },
           "installation_audit": {
             "readOnly": true,
             "allOf": [
@@ -2240,6 +2341,9 @@
             "description": "Version of the app that is installed",
             "readOnly": true
           },
+          "role": {
+            "$ref": "#/components/schemas/Role"
+          },
           "public": {
             "type": "boolean",
             "default": true,

package/package.json

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