@epilot/app-client 0.10.5 → 0.11.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 +50 -8
- package/dist/openapi.json +68 -4
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={330
|
|
1
|
+
(()=>{"use strict";var e={330(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}(330),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
|
@@ -1008,19 +1008,19 @@ declare namespace Components {
|
|
|
1008
1008
|
* 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
1009
|
*
|
|
1010
1010
|
*/
|
|
1011
|
-
|
|
1011
|
+
ExternalProductCatalogHookProductRecommendations)[];
|
|
1012
1012
|
}
|
|
1013
1013
|
/**
|
|
1014
|
-
* Hook for getting
|
|
1014
|
+
* 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
1015
|
*
|
|
1016
1016
|
*/
|
|
1017
|
-
export interface
|
|
1017
|
+
export interface ExternalProductCatalogHookProductRecommendations {
|
|
1018
1018
|
/**
|
|
1019
1019
|
* Identifier of the hook. Should not change between updates.
|
|
1020
1020
|
*/
|
|
1021
1021
|
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1022
1022
|
name?: TranslatedString;
|
|
1023
|
-
type: "
|
|
1023
|
+
type: "product-recommendations";
|
|
1024
1024
|
auth?: ExternalProductCatalogAuthBlock;
|
|
1025
1025
|
call: {
|
|
1026
1026
|
/**
|
|
@@ -1052,16 +1052,16 @@ declare namespace Components {
|
|
|
1052
1052
|
};
|
|
1053
1053
|
}
|
|
1054
1054
|
/**
|
|
1055
|
-
* Hook for getting
|
|
1055
|
+
* 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
1056
|
*
|
|
1057
1057
|
*/
|
|
1058
|
-
export interface
|
|
1058
|
+
export interface ExternalProductCatalogHookProducts {
|
|
1059
1059
|
/**
|
|
1060
1060
|
* Identifier of the hook. Should not change between updates.
|
|
1061
1061
|
*/
|
|
1062
1062
|
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1063
1063
|
name?: TranslatedString;
|
|
1064
|
-
type: "products
|
|
1064
|
+
type: "products";
|
|
1065
1065
|
auth?: ExternalProductCatalogAuthBlock;
|
|
1066
1066
|
call: {
|
|
1067
1067
|
/**
|
|
@@ -2428,6 +2428,26 @@ declare namespace Paths {
|
|
|
2428
2428
|
}
|
|
2429
2429
|
}
|
|
2430
2430
|
}
|
|
2431
|
+
namespace ListPublicConfigurations {
|
|
2432
|
+
namespace Parameters {
|
|
2433
|
+
export type Page = number;
|
|
2434
|
+
export type PageSize = number;
|
|
2435
|
+
}
|
|
2436
|
+
export interface QueryParameters {
|
|
2437
|
+
page?: Parameters.Page;
|
|
2438
|
+
pageSize?: Parameters.PageSize;
|
|
2439
|
+
}
|
|
2440
|
+
namespace Responses {
|
|
2441
|
+
export interface $200 {
|
|
2442
|
+
configurations?: /* Basic metadata about your app configuration which does not get versioned */ Components.Schemas.ConfigurationMetadata[];
|
|
2443
|
+
pagination?: {
|
|
2444
|
+
total?: number;
|
|
2445
|
+
page?: number;
|
|
2446
|
+
pageSize?: number;
|
|
2447
|
+
};
|
|
2448
|
+
}
|
|
2449
|
+
}
|
|
2450
|
+
}
|
|
2431
2451
|
namespace ListVersions {
|
|
2432
2452
|
namespace Parameters {
|
|
2433
2453
|
export type AppId = string;
|
|
@@ -2633,6 +2653,16 @@ export interface OperationMethods {
|
|
|
2633
2653
|
data?: Paths.CreateConfiguration.RequestBody,
|
|
2634
2654
|
config?: AxiosRequestConfig
|
|
2635
2655
|
): OperationResponse<Paths.CreateConfiguration.Responses.$201>
|
|
2656
|
+
/**
|
|
2657
|
+
* listPublicConfigurations - listPublicConfigurations
|
|
2658
|
+
*
|
|
2659
|
+
* List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.
|
|
2660
|
+
*/
|
|
2661
|
+
'listPublicConfigurations'(
|
|
2662
|
+
parameters?: Parameters<Paths.ListPublicConfigurations.QueryParameters> | null,
|
|
2663
|
+
data?: any,
|
|
2664
|
+
config?: AxiosRequestConfig
|
|
2665
|
+
): OperationResponse<Paths.ListPublicConfigurations.Responses.$200>
|
|
2636
2666
|
/**
|
|
2637
2667
|
* getPublicConfiguration - getPublicConfiguration
|
|
2638
2668
|
*
|
|
@@ -2931,6 +2961,18 @@ export interface PathsDictionary {
|
|
|
2931
2961
|
config?: AxiosRequestConfig
|
|
2932
2962
|
): OperationResponse<Paths.CreateConfiguration.Responses.$201>
|
|
2933
2963
|
}
|
|
2964
|
+
['/v1/app-configurations/public']: {
|
|
2965
|
+
/**
|
|
2966
|
+
* listPublicConfigurations - listPublicConfigurations
|
|
2967
|
+
*
|
|
2968
|
+
* List all publicly available app configurations that can be installed. This endpoint returns apps that have at least one public version.
|
|
2969
|
+
*/
|
|
2970
|
+
'get'(
|
|
2971
|
+
parameters?: Parameters<Paths.ListPublicConfigurations.QueryParameters> | null,
|
|
2972
|
+
data?: any,
|
|
2973
|
+
config?: AxiosRequestConfig
|
|
2974
|
+
): OperationResponse<Paths.ListPublicConfigurations.Responses.$200>
|
|
2975
|
+
}
|
|
2934
2976
|
['/v1/app-configurations/public/{appId}']: {
|
|
2935
2977
|
/**
|
|
2936
2978
|
* getPublicConfiguration - getPublicConfiguration
|
|
@@ -3258,8 +3300,8 @@ export type ExternalIntegrationCustomActionConfig = Components.Schemas.ExternalI
|
|
|
3258
3300
|
export type ExternalProductCatalogAuthBlock = Components.Schemas.ExternalProductCatalogAuthBlock;
|
|
3259
3301
|
export type ExternalProductCatalogComponent = Components.Schemas.ExternalProductCatalogComponent;
|
|
3260
3302
|
export type ExternalProductCatalogConfig = Components.Schemas.ExternalProductCatalogConfig;
|
|
3303
|
+
export type ExternalProductCatalogHookProductRecommendations = Components.Schemas.ExternalProductCatalogHookProductRecommendations;
|
|
3261
3304
|
export type ExternalProductCatalogHookProducts = Components.Schemas.ExternalProductCatalogHookProducts;
|
|
3262
|
-
export type ExternalProductCatalogHookProductsRecommendation = Components.Schemas.ExternalProductCatalogHookProductsRecommendation;
|
|
3263
3305
|
export type Grants = Components.Schemas.Grants;
|
|
3264
3306
|
export type Installation = Components.Schemas.Installation;
|
|
3265
3307
|
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
|
{
|
|
@@ -2181,7 +2245,7 @@
|
|
|
2181
2245
|
"propertyName": "type",
|
|
2182
2246
|
"mapping": {
|
|
2183
2247
|
"products": "#/components/schemas/ExternalProductCatalogHookProducts",
|
|
2184
|
-
"
|
|
2248
|
+
"product-recommendations": "#/components/schemas/ExternalProductCatalogHookProductRecommendations"
|
|
2185
2249
|
}
|
|
2186
2250
|
},
|
|
2187
2251
|
"oneOf": [
|
|
@@ -2189,7 +2253,7 @@
|
|
|
2189
2253
|
"$ref": "#/components/schemas/ExternalProductCatalogHookProducts"
|
|
2190
2254
|
},
|
|
2191
2255
|
{
|
|
2192
|
-
"$ref": "#/components/schemas/
|
|
2256
|
+
"$ref": "#/components/schemas/ExternalProductCatalogHookProductRecommendations"
|
|
2193
2257
|
}
|
|
2194
2258
|
]
|
|
2195
2259
|
}
|
|
@@ -2265,7 +2329,7 @@
|
|
|
2265
2329
|
],
|
|
2266
2330
|
"additionalProperties": false
|
|
2267
2331
|
},
|
|
2268
|
-
"
|
|
2332
|
+
"ExternalProductCatalogHookProductRecommendations": {
|
|
2269
2333
|
"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
2334
|
"type": "object",
|
|
2271
2335
|
"properties": {
|
|
@@ -2280,7 +2344,7 @@
|
|
|
2280
2344
|
"type": {
|
|
2281
2345
|
"type": "string",
|
|
2282
2346
|
"enum": [
|
|
2283
|
-
"
|
|
2347
|
+
"product-recommendations"
|
|
2284
2348
|
]
|
|
2285
2349
|
},
|
|
2286
2350
|
"auth": {
|