@epilot/app-client 0.10.5 → 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-runtime.json +16 -0
- package/dist/openapi.d.ts +85 -10
- package/dist/openapi.json +129 -6
- 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})})();
|
|
@@ -53,6 +53,22 @@
|
|
|
53
53
|
"responses": {}
|
|
54
54
|
}
|
|
55
55
|
},
|
|
56
|
+
"/v1/app-configurations/public": {
|
|
57
|
+
"get": {
|
|
58
|
+
"operationId": "listPublicConfigurations",
|
|
59
|
+
"parameters": [
|
|
60
|
+
{
|
|
61
|
+
"name": "page",
|
|
62
|
+
"in": "query"
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "pageSize",
|
|
66
|
+
"in": "query"
|
|
67
|
+
}
|
|
68
|
+
],
|
|
69
|
+
"responses": {}
|
|
70
|
+
}
|
|
71
|
+
},
|
|
56
72
|
"/v1/app-configurations/public/{appId}": {
|
|
57
73
|
"parameters": [
|
|
58
74
|
{
|
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
|
/**
|
|
@@ -1008,19 +1039,19 @@ declare namespace Components {
|
|
|
1008
1039
|
* Hook for getting product recommendations from an external catalog. This hook makes a call to retrieve product recommendations from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
|
|
1009
1040
|
*
|
|
1010
1041
|
*/
|
|
1011
|
-
|
|
1042
|
+
ExternalProductCatalogHookProductRecommendations)[];
|
|
1012
1043
|
}
|
|
1013
1044
|
/**
|
|
1014
|
-
* Hook for getting
|
|
1045
|
+
* Hook for getting product recommendations from an external catalog. This hook makes a call to retrieve product recommendations from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
|
|
1015
1046
|
*
|
|
1016
1047
|
*/
|
|
1017
|
-
export interface
|
|
1048
|
+
export interface ExternalProductCatalogHookProductRecommendations {
|
|
1018
1049
|
/**
|
|
1019
1050
|
* Identifier of the hook. Should not change between updates.
|
|
1020
1051
|
*/
|
|
1021
1052
|
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1022
1053
|
name?: TranslatedString;
|
|
1023
|
-
type: "
|
|
1054
|
+
type: "product-recommendations";
|
|
1024
1055
|
auth?: ExternalProductCatalogAuthBlock;
|
|
1025
1056
|
call: {
|
|
1026
1057
|
/**
|
|
@@ -1052,16 +1083,16 @@ declare namespace Components {
|
|
|
1052
1083
|
};
|
|
1053
1084
|
}
|
|
1054
1085
|
/**
|
|
1055
|
-
* Hook for getting
|
|
1086
|
+
* Hook for getting products from an external catalog. This hook makes a call to retrieve product data from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.
|
|
1056
1087
|
*
|
|
1057
1088
|
*/
|
|
1058
|
-
export interface
|
|
1089
|
+
export interface ExternalProductCatalogHookProducts {
|
|
1059
1090
|
/**
|
|
1060
1091
|
* Identifier of the hook. Should not change between updates.
|
|
1061
1092
|
*/
|
|
1062
1093
|
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1063
1094
|
name?: TranslatedString;
|
|
1064
|
-
type: "products
|
|
1095
|
+
type: "products";
|
|
1065
1096
|
auth?: ExternalProductCatalogAuthBlock;
|
|
1066
1097
|
call: {
|
|
1067
1098
|
/**
|
|
@@ -2428,6 +2459,26 @@ declare namespace Paths {
|
|
|
2428
2459
|
}
|
|
2429
2460
|
}
|
|
2430
2461
|
}
|
|
2462
|
+
namespace ListPublicConfigurations {
|
|
2463
|
+
namespace Parameters {
|
|
2464
|
+
export type Page = number;
|
|
2465
|
+
export type PageSize = number;
|
|
2466
|
+
}
|
|
2467
|
+
export interface QueryParameters {
|
|
2468
|
+
page?: Parameters.Page;
|
|
2469
|
+
pageSize?: Parameters.PageSize;
|
|
2470
|
+
}
|
|
2471
|
+
namespace Responses {
|
|
2472
|
+
export interface $200 {
|
|
2473
|
+
configurations?: /* Basic metadata about your app configuration which does not get versioned */ Components.Schemas.ConfigurationMetadata[];
|
|
2474
|
+
pagination?: {
|
|
2475
|
+
total?: number;
|
|
2476
|
+
page?: number;
|
|
2477
|
+
pageSize?: number;
|
|
2478
|
+
};
|
|
2479
|
+
}
|
|
2480
|
+
}
|
|
2481
|
+
}
|
|
2431
2482
|
namespace ListVersions {
|
|
2432
2483
|
namespace Parameters {
|
|
2433
2484
|
export type AppId = string;
|
|
@@ -2633,6 +2684,16 @@ export interface OperationMethods {
|
|
|
2633
2684
|
data?: Paths.CreateConfiguration.RequestBody,
|
|
2634
2685
|
config?: AxiosRequestConfig
|
|
2635
2686
|
): OperationResponse<Paths.CreateConfiguration.Responses.$201>
|
|
2687
|
+
/**
|
|
2688
|
+
* listPublicConfigurations - listPublicConfigurations
|
|
2689
|
+
*
|
|
2690
|
+
* List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.
|
|
2691
|
+
*/
|
|
2692
|
+
'listPublicConfigurations'(
|
|
2693
|
+
parameters?: Parameters<Paths.ListPublicConfigurations.QueryParameters> | null,
|
|
2694
|
+
data?: any,
|
|
2695
|
+
config?: AxiosRequestConfig
|
|
2696
|
+
): OperationResponse<Paths.ListPublicConfigurations.Responses.$200>
|
|
2636
2697
|
/**
|
|
2637
2698
|
* getPublicConfiguration - getPublicConfiguration
|
|
2638
2699
|
*
|
|
@@ -2931,6 +2992,18 @@ export interface PathsDictionary {
|
|
|
2931
2992
|
config?: AxiosRequestConfig
|
|
2932
2993
|
): OperationResponse<Paths.CreateConfiguration.Responses.$201>
|
|
2933
2994
|
}
|
|
2995
|
+
['/v1/app-configurations/public']: {
|
|
2996
|
+
/**
|
|
2997
|
+
* listPublicConfigurations - listPublicConfigurations
|
|
2998
|
+
*
|
|
2999
|
+
* List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.
|
|
3000
|
+
*/
|
|
3001
|
+
'get'(
|
|
3002
|
+
parameters?: Parameters<Paths.ListPublicConfigurations.QueryParameters> | null,
|
|
3003
|
+
data?: any,
|
|
3004
|
+
config?: AxiosRequestConfig
|
|
3005
|
+
): OperationResponse<Paths.ListPublicConfigurations.Responses.$200>
|
|
3006
|
+
}
|
|
2934
3007
|
['/v1/app-configurations/public/{appId}']: {
|
|
2935
3008
|
/**
|
|
2936
3009
|
* getPublicConfiguration - getPublicConfiguration
|
|
@@ -3250,6 +3323,8 @@ export type ConfigurationVersion = Components.Schemas.ConfigurationVersion;
|
|
|
3250
3323
|
export type CustomCapabilityComponent = Components.Schemas.CustomCapabilityComponent;
|
|
3251
3324
|
export type CustomFlowActionComponent = Components.Schemas.CustomFlowActionComponent;
|
|
3252
3325
|
export type CustomFlowConfig = Components.Schemas.CustomFlowConfig;
|
|
3326
|
+
export type CustomPageComponent = Components.Schemas.CustomPageComponent;
|
|
3327
|
+
export type CustomPageConfig = Components.Schemas.CustomPageConfig;
|
|
3253
3328
|
export type EnumArg = Components.Schemas.EnumArg;
|
|
3254
3329
|
export type ErpInformToolkitComponent = Components.Schemas.ErpInformToolkitComponent;
|
|
3255
3330
|
export type EventsQuery = Components.Schemas.EventsQuery;
|
|
@@ -3258,8 +3333,8 @@ export type ExternalIntegrationCustomActionConfig = Components.Schemas.ExternalI
|
|
|
3258
3333
|
export type ExternalProductCatalogAuthBlock = Components.Schemas.ExternalProductCatalogAuthBlock;
|
|
3259
3334
|
export type ExternalProductCatalogComponent = Components.Schemas.ExternalProductCatalogComponent;
|
|
3260
3335
|
export type ExternalProductCatalogConfig = Components.Schemas.ExternalProductCatalogConfig;
|
|
3336
|
+
export type ExternalProductCatalogHookProductRecommendations = Components.Schemas.ExternalProductCatalogHookProductRecommendations;
|
|
3261
3337
|
export type ExternalProductCatalogHookProducts = Components.Schemas.ExternalProductCatalogHookProducts;
|
|
3262
|
-
export type ExternalProductCatalogHookProductsRecommendation = Components.Schemas.ExternalProductCatalogHookProductsRecommendation;
|
|
3263
3338
|
export type Grants = Components.Schemas.Grants;
|
|
3264
3339
|
export type Installation = Components.Schemas.Installation;
|
|
3265
3340
|
export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
|
package/dist/openapi.json
CHANGED
|
@@ -183,6 +183,70 @@
|
|
|
183
183
|
}
|
|
184
184
|
}
|
|
185
185
|
},
|
|
186
|
+
"/v1/app-configurations/public": {
|
|
187
|
+
"get": {
|
|
188
|
+
"summary": "listPublicConfigurations",
|
|
189
|
+
"description": "List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.",
|
|
190
|
+
"operationId": "listPublicConfigurations",
|
|
191
|
+
"tags": [
|
|
192
|
+
"App Configuration"
|
|
193
|
+
],
|
|
194
|
+
"parameters": [
|
|
195
|
+
{
|
|
196
|
+
"name": "page",
|
|
197
|
+
"in": "query",
|
|
198
|
+
"schema": {
|
|
199
|
+
"type": "integer",
|
|
200
|
+
"default": 1
|
|
201
|
+
},
|
|
202
|
+
"description": "Page number for pagination"
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"name": "pageSize",
|
|
206
|
+
"in": "query",
|
|
207
|
+
"schema": {
|
|
208
|
+
"type": "integer",
|
|
209
|
+
"default": 20
|
|
210
|
+
},
|
|
211
|
+
"description": "Number of items per page"
|
|
212
|
+
}
|
|
213
|
+
],
|
|
214
|
+
"responses": {
|
|
215
|
+
"200": {
|
|
216
|
+
"description": "List of public app configurations",
|
|
217
|
+
"content": {
|
|
218
|
+
"application/json": {
|
|
219
|
+
"schema": {
|
|
220
|
+
"type": "object",
|
|
221
|
+
"properties": {
|
|
222
|
+
"configurations": {
|
|
223
|
+
"type": "array",
|
|
224
|
+
"items": {
|
|
225
|
+
"$ref": "#/components/schemas/ConfigurationMetadata"
|
|
226
|
+
}
|
|
227
|
+
},
|
|
228
|
+
"pagination": {
|
|
229
|
+
"type": "object",
|
|
230
|
+
"properties": {
|
|
231
|
+
"total": {
|
|
232
|
+
"type": "integer"
|
|
233
|
+
},
|
|
234
|
+
"page": {
|
|
235
|
+
"type": "integer"
|
|
236
|
+
},
|
|
237
|
+
"pageSize": {
|
|
238
|
+
"type": "integer"
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
},
|
|
186
250
|
"/v1/app-configurations/public/{appId}": {
|
|
187
251
|
"parameters": [
|
|
188
252
|
{
|
|
@@ -1767,7 +1831,8 @@
|
|
|
1767
1831
|
"CUSTOM_FLOW_ACTION",
|
|
1768
1832
|
"ERP_INFORM_TOOLKIT",
|
|
1769
1833
|
"CUSTOM_CAPABILITY",
|
|
1770
|
-
"EXTERNAL_PRODUCT_CATALOG"
|
|
1834
|
+
"EXTERNAL_PRODUCT_CATALOG",
|
|
1835
|
+
"CUSTOM_PAGE"
|
|
1771
1836
|
],
|
|
1772
1837
|
"description": "Type of app component"
|
|
1773
1838
|
},
|
|
@@ -1878,7 +1943,8 @@
|
|
|
1878
1943
|
"CUSTOM_FLOW_ACTION": "#/components/schemas/CustomFlowActionComponent",
|
|
1879
1944
|
"ERP_INFORM_TOOLKIT": "#/components/schemas/ErpInformToolkitComponent",
|
|
1880
1945
|
"CUSTOM_CAPABILITY": "#/components/schemas/CustomCapabilityComponent",
|
|
1881
|
-
"EXTERNAL_PRODUCT_CATALOG": "#/components/schemas/ExternalProductCatalogComponent"
|
|
1946
|
+
"EXTERNAL_PRODUCT_CATALOG": "#/components/schemas/ExternalProductCatalogComponent",
|
|
1947
|
+
"CUSTOM_PAGE": "#/components/schemas/CustomPageComponent"
|
|
1882
1948
|
}
|
|
1883
1949
|
},
|
|
1884
1950
|
"oneOf": [
|
|
@@ -1902,6 +1968,9 @@
|
|
|
1902
1968
|
},
|
|
1903
1969
|
{
|
|
1904
1970
|
"$ref": "#/components/schemas/ExternalProductCatalogComponent"
|
|
1971
|
+
},
|
|
1972
|
+
{
|
|
1973
|
+
"$ref": "#/components/schemas/CustomPageComponent"
|
|
1905
1974
|
}
|
|
1906
1975
|
]
|
|
1907
1976
|
}
|
|
@@ -1952,6 +2021,60 @@
|
|
|
1952
2021
|
}
|
|
1953
2022
|
}
|
|
1954
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
|
+
},
|
|
1955
2078
|
"JourneyBlockComponent": {
|
|
1956
2079
|
"type": "object",
|
|
1957
2080
|
"required": [
|
|
@@ -2181,7 +2304,7 @@
|
|
|
2181
2304
|
"propertyName": "type",
|
|
2182
2305
|
"mapping": {
|
|
2183
2306
|
"products": "#/components/schemas/ExternalProductCatalogHookProducts",
|
|
2184
|
-
"
|
|
2307
|
+
"product-recommendations": "#/components/schemas/ExternalProductCatalogHookProductRecommendations"
|
|
2185
2308
|
}
|
|
2186
2309
|
},
|
|
2187
2310
|
"oneOf": [
|
|
@@ -2189,7 +2312,7 @@
|
|
|
2189
2312
|
"$ref": "#/components/schemas/ExternalProductCatalogHookProducts"
|
|
2190
2313
|
},
|
|
2191
2314
|
{
|
|
2192
|
-
"$ref": "#/components/schemas/
|
|
2315
|
+
"$ref": "#/components/schemas/ExternalProductCatalogHookProductRecommendations"
|
|
2193
2316
|
}
|
|
2194
2317
|
]
|
|
2195
2318
|
}
|
|
@@ -2265,7 +2388,7 @@
|
|
|
2265
2388
|
],
|
|
2266
2389
|
"additionalProperties": false
|
|
2267
2390
|
},
|
|
2268
|
-
"
|
|
2391
|
+
"ExternalProductCatalogHookProductRecommendations": {
|
|
2269
2392
|
"description": "Hook for getting product recommendations from an external catalog. This hook makes a call to retrieve product recommendations from an external source. Check the docs or the response API call contract https://docs.api.epilot.io/pricing-api-external-catalog for more details.\n",
|
|
2270
2393
|
"type": "object",
|
|
2271
2394
|
"properties": {
|
|
@@ -2280,7 +2403,7 @@
|
|
|
2280
2403
|
"type": {
|
|
2281
2404
|
"type": "string",
|
|
2282
2405
|
"enum": [
|
|
2283
|
-
"
|
|
2406
|
+
"product-recommendations"
|
|
2284
2407
|
]
|
|
2285
2408
|
},
|
|
2286
2409
|
"auth": {
|