@epilot/app-client 0.11.0 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +35 -2
- package/dist/openapi.json +61 -2
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={
|
|
1
|
+
(()=>{"use strict";var e={390: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/public/app/{appId}/components/{componentId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration to install"},{"name":"componentId","in":"path","required":true,"description":"ID of the component to retrieve"}],"get":{"operationId":"getPublicFacingComponent","responses":{}}},"/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":{"get":{"operationId":"listPublicConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"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":{}},"delete":{"operationId":"deleteConfiguration","responses":{}}},"/v1/app-configurations/{appId}/events":{"post":{"operationId":"queryEvents","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"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}/zip":{"post":{"operationId":"createZipUploadUrl","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"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}/review":{"get":{"operationId":"getReview","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"post":{"operationId":"createReview","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/CreateReviewRequest"},"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":{}}},"/v1/app-events":{"post":{"operationId":"ingestEvent","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"requestBodies":{"CreateReviewRequest":{"required":true,"content":{"application/json":{}}},"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 p=r[n]={exports:{}};return e[n].call(p.exports,p,p.exports,t),p.exports}(390),n=exports;for(var o in t)n[o]=t[o];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -247,7 +247,7 @@ declare namespace Components {
|
|
|
247
247
|
surfaces?: {
|
|
248
248
|
[key: string]: any;
|
|
249
249
|
};
|
|
250
|
-
} & (JourneyBlockComponent | PortalBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent | CustomCapabilityComponent | ExternalProductCatalogComponent);
|
|
250
|
+
} & (JourneyBlockComponent | PortalBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent | CustomCapabilityComponent | ExternalProductCatalogComponent | CustomPageComponent);
|
|
251
251
|
export interface BaseComponentCommon {
|
|
252
252
|
/**
|
|
253
253
|
* Unique identifier for the component
|
|
@@ -451,7 +451,7 @@ declare namespace Components {
|
|
|
451
451
|
/**
|
|
452
452
|
* Type of app component
|
|
453
453
|
*/
|
|
454
|
-
export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG";
|
|
454
|
+
export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE";
|
|
455
455
|
/**
|
|
456
456
|
* Configuration of the published app
|
|
457
457
|
*/
|
|
@@ -822,6 +822,37 @@ declare namespace Components {
|
|
|
822
822
|
};
|
|
823
823
|
}
|
|
824
824
|
export type CustomFlowConfig = ExternalIntegrationCustomActionConfig | SandboxCustomActionConfig;
|
|
825
|
+
export interface CustomPageComponent {
|
|
826
|
+
component_type: "CUSTOM_PAGE";
|
|
827
|
+
configuration: CustomPageConfig;
|
|
828
|
+
surfaces?: {
|
|
829
|
+
page?: AppBridgeSurfaceConfig;
|
|
830
|
+
};
|
|
831
|
+
}
|
|
832
|
+
export interface CustomPageConfig {
|
|
833
|
+
/**
|
|
834
|
+
* URL slug for the page route. Must be unique per organization.
|
|
835
|
+
* example:
|
|
836
|
+
* zapier
|
|
837
|
+
*/
|
|
838
|
+
slug: string; // ^[a-z0-9][a-z0-9-]*[a-z0-9]$
|
|
839
|
+
/**
|
|
840
|
+
* Display label in the navigation sidebar.
|
|
841
|
+
* example:
|
|
842
|
+
* Zapier
|
|
843
|
+
*/
|
|
844
|
+
nav_label?: string;
|
|
845
|
+
/**
|
|
846
|
+
* Icon identifier for the navigation item.
|
|
847
|
+
* example:
|
|
848
|
+
* zap
|
|
849
|
+
*/
|
|
850
|
+
nav_icon?: string;
|
|
851
|
+
/**
|
|
852
|
+
* Optional tooltip or description for the navigation item.
|
|
853
|
+
*/
|
|
854
|
+
nav_description?: string;
|
|
855
|
+
}
|
|
825
856
|
export interface EnumArg {
|
|
826
857
|
type?: "enum";
|
|
827
858
|
/**
|
|
@@ -3292,6 +3323,8 @@ export type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
|
|
|
3292
3323
|
export type CustomCapabilityComponent = Components.Schemas.CustomCapabilityComponent;
|
|
3293
3324
|
export type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
|
|
3294
3325
|
export type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
|
|
3326
|
+
export type CustomPageComponent = Components.Schemas.CustomPageComponent;
|
|
3327
|
+
export type CustomPageConfig = Components.Schemas.CustomPageConfig;
|
|
3295
3328
|
export type EnumArg = Components.Schemas.EnumArg;
|
|
3296
3329
|
export type ErpInformToolkitComponent = Components.Schemas.ErpInformToolkitComponent;
|
|
3297
3330
|
export type EventsQuery = Components.Schemas.EventsQuery;
|
package/dist/openapi.json
CHANGED
|
@@ -1831,7 +1831,8 @@
|
|
|
1831
1831
|
"CUSTOM_FLOW_ACTION",
|
|
1832
1832
|
"ERP_INFORM_TOOLKIT",
|
|
1833
1833
|
"CUSTOM_CAPABILITY",
|
|
1834
|
-
"EXTERNAL_PRODUCT_CATALOG"
|
|
1834
|
+
"EXTERNAL_PRODUCT_CATALOG",
|
|
1835
|
+
"CUSTOM_PAGE"
|
|
1835
1836
|
],
|
|
1836
1837
|
"description": "Type of app component"
|
|
1837
1838
|
},
|
|
@@ -1942,7 +1943,8 @@
|
|
|
1942
1943
|
"CUSTOM_FLOW_ACTION": "#/components/schemas/CustomFlowActionComponent",
|
|
1943
1944
|
"ERP_INFORM_TOOLKIT": "#/components/schemas/ErpInformToolkitComponent",
|
|
1944
1945
|
"CUSTOM_CAPABILITY": "#/components/schemas/CustomCapabilityComponent",
|
|
1945
|
-
"EXTERNAL_PRODUCT_CATALOG": "#/components/schemas/ExternalProductCatalogComponent"
|
|
1946
|
+
"EXTERNAL_PRODUCT_CATALOG": "#/components/schemas/ExternalProductCatalogComponent",
|
|
1947
|
+
"CUSTOM_PAGE": "#/components/schemas/CustomPageComponent"
|
|
1946
1948
|
}
|
|
1947
1949
|
},
|
|
1948
1950
|
"oneOf": [
|
|
@@ -1966,6 +1968,9 @@
|
|
|
1966
1968
|
},
|
|
1967
1969
|
{
|
|
1968
1970
|
"$ref": "#/components/schemas/ExternalProductCatalogComponent"
|
|
1971
|
+
},
|
|
1972
|
+
{
|
|
1973
|
+
"$ref": "#/components/schemas/CustomPageComponent"
|
|
1969
1974
|
}
|
|
1970
1975
|
]
|
|
1971
1976
|
}
|
|
@@ -2016,6 +2021,60 @@
|
|
|
2016
2021
|
}
|
|
2017
2022
|
}
|
|
2018
2023
|
},
|
|
2024
|
+
"CustomPageComponent": {
|
|
2025
|
+
"type": "object",
|
|
2026
|
+
"required": [
|
|
2027
|
+
"component_type",
|
|
2028
|
+
"configuration"
|
|
2029
|
+
],
|
|
2030
|
+
"properties": {
|
|
2031
|
+
"component_type": {
|
|
2032
|
+
"type": "string",
|
|
2033
|
+
"enum": [
|
|
2034
|
+
"CUSTOM_PAGE"
|
|
2035
|
+
]
|
|
2036
|
+
},
|
|
2037
|
+
"configuration": {
|
|
2038
|
+
"$ref": "#/components/schemas/CustomPageConfig"
|
|
2039
|
+
},
|
|
2040
|
+
"surfaces": {
|
|
2041
|
+
"type": "object",
|
|
2042
|
+
"properties": {
|
|
2043
|
+
"page": {
|
|
2044
|
+
"$ref": "#/components/schemas/AppBridgeSurfaceConfig"
|
|
2045
|
+
}
|
|
2046
|
+
}
|
|
2047
|
+
}
|
|
2048
|
+
}
|
|
2049
|
+
},
|
|
2050
|
+
"CustomPageConfig": {
|
|
2051
|
+
"type": "object",
|
|
2052
|
+
"required": [
|
|
2053
|
+
"slug"
|
|
2054
|
+
],
|
|
2055
|
+
"properties": {
|
|
2056
|
+
"slug": {
|
|
2057
|
+
"type": "string",
|
|
2058
|
+
"description": "URL slug for the page route. Must be unique per organization.",
|
|
2059
|
+
"pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$",
|
|
2060
|
+
"example": "zapier"
|
|
2061
|
+
},
|
|
2062
|
+
"nav_label": {
|
|
2063
|
+
"type": "string",
|
|
2064
|
+
"description": "Display label in the navigation sidebar.",
|
|
2065
|
+
"example": "Zapier"
|
|
2066
|
+
},
|
|
2067
|
+
"nav_icon": {
|
|
2068
|
+
"type": "string",
|
|
2069
|
+
"description": "Icon identifier for the navigation item.",
|
|
2070
|
+
"example": "zap"
|
|
2071
|
+
},
|
|
2072
|
+
"nav_description": {
|
|
2073
|
+
"type": "string",
|
|
2074
|
+
"description": "Optional tooltip or description for the navigation item."
|
|
2075
|
+
}
|
|
2076
|
+
}
|
|
2077
|
+
},
|
|
2019
2078
|
"JourneyBlockComponent": {
|
|
2020
2079
|
"type": "object",
|
|
2021
2080
|
"required": [
|