@epilot/app-client 0.6.3 → 0.7.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 -2
- package/dist/openapi.d.ts +42 -26
- package/dist/openapi.json +61 -22
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/public
|
|
1
|
+
(()=>{"use strict";var e={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/{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}/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":{"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":{}}}}}}')},757: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}},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}(757),n=exports;for(var o in t)n[o]=t[o];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
|
|
@@ -10,9 +10,23 @@
|
|
|
10
10
|
}
|
|
11
11
|
],
|
|
12
12
|
"paths": {
|
|
13
|
-
"/v1/public
|
|
13
|
+
"/v1/public/app/{appId}/components/{componentId}": {
|
|
14
|
+
"parameters": [
|
|
15
|
+
{
|
|
16
|
+
"name": "appId",
|
|
17
|
+
"in": "path",
|
|
18
|
+
"required": true,
|
|
19
|
+
"description": "ID of the app configuration to install"
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"name": "componentId",
|
|
23
|
+
"in": "path",
|
|
24
|
+
"required": true,
|
|
25
|
+
"description": "ID of the component to retrieve"
|
|
26
|
+
}
|
|
27
|
+
],
|
|
14
28
|
"get": {
|
|
15
|
-
"operationId": "
|
|
29
|
+
"operationId": "getPublicFacingComponent",
|
|
16
30
|
"responses": {}
|
|
17
31
|
}
|
|
18
32
|
},
|
package/dist/openapi.d.ts
CHANGED
|
@@ -80,6 +80,10 @@ declare namespace Components {
|
|
|
80
80
|
dev_mode?: boolean;
|
|
81
81
|
}
|
|
82
82
|
export interface PatchVersionRequest {
|
|
83
|
+
/**
|
|
84
|
+
* ID of the manifest to use for this version
|
|
85
|
+
*/
|
|
86
|
+
manifest_id?: string;
|
|
83
87
|
/**
|
|
84
88
|
* Name of the role
|
|
85
89
|
*/
|
|
@@ -383,6 +387,16 @@ declare namespace Components {
|
|
|
383
387
|
* How often the subscription is billed
|
|
384
388
|
*/
|
|
385
389
|
export type BillingFrequency = "MONTHLY" | "QUARTERLY" | "YEARLY" | "CUSTOM";
|
|
390
|
+
export interface BlueprintRef {
|
|
391
|
+
/**
|
|
392
|
+
* ID of the blueprint
|
|
393
|
+
*/
|
|
394
|
+
manifest_id?: string;
|
|
395
|
+
/**
|
|
396
|
+
* ID of the job that created the blueprint
|
|
397
|
+
*/
|
|
398
|
+
job_id?: string;
|
|
399
|
+
}
|
|
386
400
|
export interface BooleanArg {
|
|
387
401
|
type?: "boolean";
|
|
388
402
|
}
|
|
@@ -552,6 +566,7 @@ declare namespace Components {
|
|
|
552
566
|
*/
|
|
553
567
|
review_status?: "approved" | "rejected" | "pending";
|
|
554
568
|
role?: Role;
|
|
569
|
+
blueprint_ref?: BlueprintRef;
|
|
555
570
|
version_audit: {
|
|
556
571
|
/**
|
|
557
572
|
* Timestamp of the creation
|
|
@@ -725,6 +740,7 @@ declare namespace Components {
|
|
|
725
740
|
*/
|
|
726
741
|
review_status?: "approved" | "rejected" | "pending";
|
|
727
742
|
role?: Role;
|
|
743
|
+
blueprint_ref?: BlueprintRef;
|
|
728
744
|
version_audit: {
|
|
729
745
|
/**
|
|
730
746
|
* Timestamp of the creation
|
|
@@ -954,6 +970,7 @@ declare namespace Components {
|
|
|
954
970
|
* The name of the role the app can use to access APIs
|
|
955
971
|
*/
|
|
956
972
|
role?: string;
|
|
973
|
+
blueprint_ref?: BlueprintRef;
|
|
957
974
|
/**
|
|
958
975
|
* Audit information for the app
|
|
959
976
|
*/
|
|
@@ -1236,6 +1253,7 @@ declare namespace Components {
|
|
|
1236
1253
|
*/
|
|
1237
1254
|
version: string;
|
|
1238
1255
|
role?: Role;
|
|
1256
|
+
blueprint_ref?: BlueprintRef;
|
|
1239
1257
|
/**
|
|
1240
1258
|
* Latest version of the app
|
|
1241
1259
|
*/
|
|
@@ -1518,23 +1536,10 @@ declare namespace Paths {
|
|
|
1518
1536
|
}
|
|
1519
1537
|
}
|
|
1520
1538
|
}
|
|
1521
|
-
namespace
|
|
1539
|
+
namespace GetPublicFacingComponent {
|
|
1522
1540
|
namespace Responses {
|
|
1523
|
-
export
|
|
1524
|
-
|
|
1525
|
-
* example:
|
|
1526
|
-
* rsa-sha256
|
|
1527
|
-
*/
|
|
1528
|
-
algorithm?: string;
|
|
1529
|
-
/**
|
|
1530
|
-
* PEM-formatted RSA public key
|
|
1531
|
-
*/
|
|
1532
|
-
public_key?: string;
|
|
1533
|
-
/**
|
|
1534
|
-
* example:
|
|
1535
|
-
* epilot
|
|
1536
|
-
*/
|
|
1537
|
-
issuer?: string;
|
|
1541
|
+
export type $200 = Components.Schemas.BaseComponent;
|
|
1542
|
+
export interface $404 {
|
|
1538
1543
|
}
|
|
1539
1544
|
}
|
|
1540
1545
|
}
|
|
@@ -1781,20 +1786,30 @@ declare namespace Paths {
|
|
|
1781
1786
|
appId: Parameters.AppId;
|
|
1782
1787
|
}
|
|
1783
1788
|
}
|
|
1789
|
+
namespace V1PublicApp$AppIdComponents$ComponentId {
|
|
1790
|
+
namespace Parameters {
|
|
1791
|
+
export type AppId = string;
|
|
1792
|
+
export type ComponentId = string;
|
|
1793
|
+
}
|
|
1794
|
+
export interface PathParameters {
|
|
1795
|
+
appId: Parameters.AppId;
|
|
1796
|
+
componentId: Parameters.ComponentId;
|
|
1797
|
+
}
|
|
1798
|
+
}
|
|
1784
1799
|
}
|
|
1785
1800
|
|
|
1786
1801
|
|
|
1787
1802
|
export interface OperationMethods {
|
|
1788
1803
|
/**
|
|
1789
|
-
*
|
|
1804
|
+
* getPublicFacingComponent - getPublicFacingComponent
|
|
1790
1805
|
*
|
|
1791
|
-
* Retrieve
|
|
1806
|
+
* Retrieve public facing components for an installed app
|
|
1792
1807
|
*/
|
|
1793
|
-
'
|
|
1794
|
-
parameters?: Parameters<
|
|
1808
|
+
'getPublicFacingComponent'(
|
|
1809
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdComponents$ComponentId.PathParameters> | null,
|
|
1795
1810
|
data?: any,
|
|
1796
1811
|
config?: AxiosRequestConfig
|
|
1797
|
-
): OperationResponse<Paths.
|
|
1812
|
+
): OperationResponse<Paths.GetPublicFacingComponent.Responses.$200>
|
|
1798
1813
|
/**
|
|
1799
1814
|
* listConfigurations - listConfigurations
|
|
1800
1815
|
*
|
|
@@ -2059,17 +2074,17 @@ export interface OperationMethods {
|
|
|
2059
2074
|
}
|
|
2060
2075
|
|
|
2061
2076
|
export interface PathsDictionary {
|
|
2062
|
-
['/v1/public
|
|
2077
|
+
['/v1/public/app/{appId}/components/{componentId}']: {
|
|
2063
2078
|
/**
|
|
2064
|
-
*
|
|
2079
|
+
* getPublicFacingComponent - getPublicFacingComponent
|
|
2065
2080
|
*
|
|
2066
|
-
* Retrieve
|
|
2081
|
+
* Retrieve public facing components for an installed app
|
|
2067
2082
|
*/
|
|
2068
2083
|
'get'(
|
|
2069
|
-
parameters?: Parameters<
|
|
2084
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdComponents$ComponentId.PathParameters> | null,
|
|
2070
2085
|
data?: any,
|
|
2071
2086
|
config?: AxiosRequestConfig
|
|
2072
|
-
): OperationResponse<Paths.
|
|
2087
|
+
): OperationResponse<Paths.GetPublicFacingComponent.Responses.$200>
|
|
2073
2088
|
}
|
|
2074
2089
|
['/v1/app-configurations']: {
|
|
2075
2090
|
/**
|
|
@@ -2380,6 +2395,7 @@ export type BaseComponentCommon = Components.Schemas.BaseComponentCommon;
|
|
|
2380
2395
|
export type BaseCustomActionConfig = Components.Schemas.BaseCustomActionConfig;
|
|
2381
2396
|
export type BatchEventRequest = Components.Schemas.BatchEventRequest;
|
|
2382
2397
|
export type BillingFrequency = Components.Schemas.BillingFrequency;
|
|
2398
|
+
export type BlueprintRef = Components.Schemas.BlueprintRef;
|
|
2383
2399
|
export type BooleanArg = Components.Schemas.BooleanArg;
|
|
2384
2400
|
export type CallerIdentity = Components.Schemas.CallerIdentity;
|
|
2385
2401
|
export type ComponentType = Components.Schemas.ComponentType;
|
package/dist/openapi.json
CHANGED
|
@@ -36,39 +36,52 @@
|
|
|
36
36
|
}
|
|
37
37
|
],
|
|
38
38
|
"paths": {
|
|
39
|
-
"/v1/public
|
|
39
|
+
"/v1/public/app/{appId}/components/{componentId}": {
|
|
40
|
+
"parameters": [
|
|
41
|
+
{
|
|
42
|
+
"name": "appId",
|
|
43
|
+
"in": "path",
|
|
44
|
+
"required": true,
|
|
45
|
+
"schema": {
|
|
46
|
+
"type": "string"
|
|
47
|
+
},
|
|
48
|
+
"description": "ID of the app configuration to install"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"name": "componentId",
|
|
52
|
+
"in": "path",
|
|
53
|
+
"required": true,
|
|
54
|
+
"schema": {
|
|
55
|
+
"type": "string"
|
|
56
|
+
},
|
|
57
|
+
"description": "ID of the component to retrieve"
|
|
58
|
+
}
|
|
59
|
+
],
|
|
40
60
|
"get": {
|
|
41
|
-
"security": [
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
61
|
+
"security": [
|
|
62
|
+
{
|
|
63
|
+
"EpilotAuth": []
|
|
64
|
+
}
|
|
65
|
+
],
|
|
66
|
+
"summary": "getPublicFacingComponent",
|
|
67
|
+
"description": "Retrieve public facing components for an installed app",
|
|
68
|
+
"operationId": "getPublicFacingComponent",
|
|
45
69
|
"tags": [
|
|
46
|
-
"App
|
|
70
|
+
"App Installation"
|
|
47
71
|
],
|
|
48
72
|
"responses": {
|
|
49
73
|
"200": {
|
|
50
|
-
"description": "
|
|
74
|
+
"description": "Successful response with public app component details",
|
|
51
75
|
"content": {
|
|
52
76
|
"application/json": {
|
|
53
77
|
"schema": {
|
|
54
|
-
"
|
|
55
|
-
"properties": {
|
|
56
|
-
"algorithm": {
|
|
57
|
-
"type": "string",
|
|
58
|
-
"example": "rsa-sha256"
|
|
59
|
-
},
|
|
60
|
-
"public_key": {
|
|
61
|
-
"type": "string",
|
|
62
|
-
"description": "PEM-formatted RSA public key"
|
|
63
|
-
},
|
|
64
|
-
"issuer": {
|
|
65
|
-
"type": "string",
|
|
66
|
-
"example": "epilot"
|
|
67
|
-
}
|
|
68
|
-
}
|
|
78
|
+
"$ref": "#/components/schemas/BaseComponent"
|
|
69
79
|
}
|
|
70
80
|
}
|
|
71
81
|
}
|
|
82
|
+
},
|
|
83
|
+
"404": {
|
|
84
|
+
"description": "App Installation not found"
|
|
72
85
|
}
|
|
73
86
|
}
|
|
74
87
|
}
|
|
@@ -1380,6 +1393,10 @@
|
|
|
1380
1393
|
"schema": {
|
|
1381
1394
|
"type": "object",
|
|
1382
1395
|
"properties": {
|
|
1396
|
+
"manifest_id": {
|
|
1397
|
+
"type": "string",
|
|
1398
|
+
"description": "ID of the manifest to use for this version"
|
|
1399
|
+
},
|
|
1383
1400
|
"role_id": {
|
|
1384
1401
|
"nullable": true,
|
|
1385
1402
|
"type": "string",
|
|
@@ -2455,6 +2472,9 @@
|
|
|
2455
2472
|
"role": {
|
|
2456
2473
|
"$ref": "#/components/schemas/Role"
|
|
2457
2474
|
},
|
|
2475
|
+
"blueprint_ref": {
|
|
2476
|
+
"$ref": "#/components/schemas/BlueprintRef"
|
|
2477
|
+
},
|
|
2458
2478
|
"version_audit": {
|
|
2459
2479
|
"readOnly": true,
|
|
2460
2480
|
"allOf": [
|
|
@@ -2500,6 +2520,19 @@
|
|
|
2500
2520
|
}
|
|
2501
2521
|
}
|
|
2502
2522
|
},
|
|
2523
|
+
"BlueprintRef": {
|
|
2524
|
+
"type": "object",
|
|
2525
|
+
"properties": {
|
|
2526
|
+
"manifest_id": {
|
|
2527
|
+
"type": "string",
|
|
2528
|
+
"description": "ID of the blueprint"
|
|
2529
|
+
},
|
|
2530
|
+
"job_id": {
|
|
2531
|
+
"type": "string",
|
|
2532
|
+
"description": "ID of the job that created the blueprint"
|
|
2533
|
+
}
|
|
2534
|
+
}
|
|
2535
|
+
},
|
|
2503
2536
|
"Installation": {
|
|
2504
2537
|
"description": "Information about the installed app. Has configuration data of the installed version",
|
|
2505
2538
|
"type": "object",
|
|
@@ -2563,6 +2596,9 @@
|
|
|
2563
2596
|
"type": "string",
|
|
2564
2597
|
"description": "The name of the role the app can use to access APIs"
|
|
2565
2598
|
},
|
|
2599
|
+
"blueprint_ref": {
|
|
2600
|
+
"$ref": "#/components/schemas/BlueprintRef"
|
|
2601
|
+
},
|
|
2566
2602
|
"installation_audit": {
|
|
2567
2603
|
"readOnly": true,
|
|
2568
2604
|
"allOf": [
|
|
@@ -2675,6 +2711,9 @@
|
|
|
2675
2711
|
"role": {
|
|
2676
2712
|
"$ref": "#/components/schemas/Role"
|
|
2677
2713
|
},
|
|
2714
|
+
"blueprint_ref": {
|
|
2715
|
+
"$ref": "#/components/schemas/BlueprintRef"
|
|
2716
|
+
},
|
|
2678
2717
|
"latest_version": {
|
|
2679
2718
|
"type": "string",
|
|
2680
2719
|
"description": "Latest version of the app",
|