@epilot/app-client 0.3.1 → 0.3.3

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.
@@ -1 +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 a=n(t(466));r.default=a.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/{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/{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":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(n){var a=r[n];if(void 0!==a)return a.exports;var o=r[n]={exports:{}};return e[n].call(o.exports,o,o.exports,t),o.exports}(187),n=exports;for(var a in t)n[a]=t[a];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
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","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})})();
@@ -33,6 +33,20 @@
33
33
  "responses": {}
34
34
  }
35
35
  },
36
+ "/v1/app-configurations/public/{appId}": {
37
+ "parameters": [
38
+ {
39
+ "name": "appId",
40
+ "in": "path",
41
+ "required": true,
42
+ "description": "ID of the app configuration to install"
43
+ }
44
+ ],
45
+ "get": {
46
+ "operationId": "getPublicConfiguration",
47
+ "responses": {}
48
+ }
49
+ },
36
50
  "/v1/app-configurations/{appId}": {
37
51
  "parameters": [
38
52
  {
@@ -150,9 +164,32 @@
150
164
  }
151
165
  ],
152
166
  "responses": {}
153
- },
167
+ }
168
+ },
169
+ "/v1/app-configurations/{appId}/versions/{version}/components": {
170
+ "post": {
171
+ "operationId": "createComponent",
172
+ "parameters": [
173
+ {
174
+ "name": "appId",
175
+ "in": "path",
176
+ "required": true
177
+ },
178
+ {
179
+ "name": "version",
180
+ "in": "path",
181
+ "required": true
182
+ }
183
+ ],
184
+ "requestBody": {
185
+ "$ref": "#/components/requestBodies/UpsertComponentRequest"
186
+ },
187
+ "responses": {}
188
+ }
189
+ },
190
+ "/v1/app-configurations/{appId}/versions/{version}/components/{componentId}": {
154
191
  "patch": {
155
- "operationId": "patchVersion",
192
+ "operationId": "patchComponent",
156
193
  "parameters": [
157
194
  {
158
195
  "name": "appId",
@@ -163,12 +200,38 @@
163
200
  "name": "version",
164
201
  "in": "path",
165
202
  "required": true
203
+ },
204
+ {
205
+ "name": "componentId",
206
+ "in": "path",
207
+ "required": true
166
208
  }
167
209
  ],
168
210
  "requestBody": {
169
- "$ref": "#/components/requestBodies/PatchVersionRequest"
211
+ "$ref": "#/components/requestBodies/UpsertComponentRequest"
170
212
  },
171
213
  "responses": {}
214
+ },
215
+ "delete": {
216
+ "operationId": "deleteComponent",
217
+ "parameters": [
218
+ {
219
+ "name": "appId",
220
+ "in": "path",
221
+ "required": true
222
+ },
223
+ {
224
+ "name": "version",
225
+ "in": "path",
226
+ "required": true
227
+ },
228
+ {
229
+ "name": "componentId",
230
+ "in": "path",
231
+ "required": true
232
+ }
233
+ ],
234
+ "responses": {}
172
235
  }
173
236
  },
174
237
  "/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}": {
@@ -309,7 +372,7 @@
309
372
  "application/json": {}
310
373
  }
311
374
  },
312
- "PatchVersionRequest": {
375
+ "UpsertComponentRequest": {
313
376
  "required": true,
314
377
  "content": {
315
378
  "application/json": {}
package/dist/openapi.d.ts CHANGED
@@ -71,12 +71,7 @@ declare namespace Components {
71
71
  */
72
72
  support_email?: string;
73
73
  }
74
- export interface PatchVersionRequest {
75
- /**
76
- * Updated full list of app components
77
- */
78
- components: Schemas.BaseComponent[];
79
- }
74
+ export type UpsertComponentRequest = Schemas.BaseComponent;
80
75
  }
81
76
  namespace Schemas {
82
77
  export interface Audit {
@@ -117,6 +112,7 @@ declare namespace Components {
117
112
  */
118
113
  id: string;
119
114
  name?: TranslatedString;
115
+ description?: TranslatedString;
120
116
  /**
121
117
  * List of options for the app component
122
118
  */
@@ -131,6 +127,10 @@ declare namespace Components {
131
127
  * Name of the component
132
128
  */
133
129
  name?: TranslatedString;
130
+ /**
131
+ * Description of the component
132
+ */
133
+ description?: TranslatedString;
134
134
  /**
135
135
  * List of options for the app component
136
136
  */
@@ -622,6 +622,57 @@ declare namespace Components {
622
622
  pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
623
623
  billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
624
624
  }
625
+ /**
626
+ * Public configuration of the published app
627
+ */
628
+ export interface PublicConfiguration {
629
+ /**
630
+ * ID of the app configuration
631
+ */
632
+ app_id?: string;
633
+ /**
634
+ * Organization ID of the app owner
635
+ */
636
+ owner_org_id?: string;
637
+ /**
638
+ * Name of the app
639
+ */
640
+ name?: string;
641
+ author?: Author;
642
+ /**
643
+ * Category of the app.
644
+ */
645
+ category?: string;
646
+ /**
647
+ * URL of the app icon.
648
+ */
649
+ icon_url?: string;
650
+ /**
651
+ * URL of the app documentation.
652
+ */
653
+ documentation_url?: string;
654
+ /**
655
+ * Markdown description of the app.
656
+ */
657
+ description?: TranslatedString;
658
+ /**
659
+ * Pricing information for the app
660
+ */
661
+ pricing?: Pricing;
662
+ components?: BaseComponent[];
663
+ /**
664
+ * Flag to indicate if the app is in beta.
665
+ */
666
+ is_beta?: boolean;
667
+ /**
668
+ * Timestamp when the app version is deprecated
669
+ */
670
+ deprecated_at?: string;
671
+ /**
672
+ * Version of the app that is installed
673
+ */
674
+ version?: string;
675
+ }
625
676
  export interface S3Reference {
626
677
  /**
627
678
  * The name of the S3 bucket where the JSON file for import is stored.
@@ -691,6 +742,14 @@ declare namespace Paths {
691
742
  export type RequestBody = Components.RequestBodies.CreateBundlePresignedRequest;
692
743
  namespace Responses {
693
744
  export interface $200 {
745
+ /**
746
+ * ID of the journye block component
747
+ */
748
+ component_id?: string;
749
+ /**
750
+ * URL of the web component object
751
+ */
752
+ component_url?: string;
694
753
  /**
695
754
  * Presigned S3 URL for uploading the bundle
696
755
  */
@@ -705,10 +764,29 @@ declare namespace Paths {
705
764
  }
706
765
  }
707
766
  }
767
+ namespace CreateComponent {
768
+ namespace Parameters {
769
+ export type AppId = string;
770
+ export type Version = string;
771
+ }
772
+ export interface PathParameters {
773
+ appId: Parameters.AppId;
774
+ version: Parameters.Version;
775
+ }
776
+ export type RequestBody = Components.RequestBodies.UpsertComponentRequest;
777
+ namespace Responses {
778
+ export interface $204 {
779
+ }
780
+ export interface $400 {
781
+ }
782
+ export interface $404 {
783
+ }
784
+ }
785
+ }
708
786
  namespace CreateConfiguration {
709
787
  export type RequestBody = Components.RequestBodies.CreateConfigRequest;
710
788
  namespace Responses {
711
- export interface $202 {
789
+ export interface $201 {
712
790
  app_id: string;
713
791
  }
714
792
  }
@@ -731,6 +809,24 @@ declare namespace Paths {
731
809
  }
732
810
  }
733
811
  }
812
+ namespace DeleteComponent {
813
+ namespace Parameters {
814
+ export type AppId = string;
815
+ export type ComponentId = string;
816
+ export type Version = string;
817
+ }
818
+ export interface PathParameters {
819
+ appId: Parameters.AppId;
820
+ version: Parameters.Version;
821
+ componentId: Parameters.ComponentId;
822
+ }
823
+ namespace Responses {
824
+ export interface $204 {
825
+ }
826
+ export interface $404 {
827
+ }
828
+ }
829
+ }
734
830
  namespace DeleteLogo {
735
831
  namespace Responses {
736
832
  export interface $204 {
@@ -785,6 +881,13 @@ declare namespace Paths {
785
881
  }
786
882
  }
787
883
  }
884
+ namespace GetPublicConfiguration {
885
+ namespace Responses {
886
+ export type $200 = /* Public configuration of the published app */ Components.Schemas.PublicConfiguration;
887
+ export interface $404 {
888
+ }
889
+ }
890
+ }
788
891
  namespace GetVersion {
789
892
  namespace Parameters {
790
893
  export type AppId = string;
@@ -883,44 +986,46 @@ declare namespace Paths {
883
986
  }
884
987
  }
885
988
  }
886
- namespace PatchInstallation {
989
+ namespace PatchComponent {
887
990
  namespace Parameters {
888
991
  export type AppId = string;
992
+ export type ComponentId = string;
993
+ export type Version = string;
889
994
  }
890
995
  export interface PathParameters {
891
996
  appId: Parameters.AppId;
997
+ version: Parameters.Version;
998
+ componentId: Parameters.ComponentId;
892
999
  }
893
- export type RequestBody = Components.RequestBodies.InstallRequest;
1000
+ export type RequestBody = Components.RequestBodies.UpsertComponentRequest;
894
1001
  namespace Responses {
895
1002
  export interface $204 {
896
1003
  }
897
- export interface $404 {
898
- }
899
- }
900
- }
901
- namespace PatchMetadata {
902
- export type RequestBody = Components.RequestBodies.PatchConfigMetadataRequest;
903
- namespace Responses {
904
- export interface $204 {
1004
+ export interface $400 {
905
1005
  }
906
1006
  export interface $404 {
907
1007
  }
908
1008
  }
909
1009
  }
910
- namespace PatchVersion {
1010
+ namespace PatchInstallation {
911
1011
  namespace Parameters {
912
1012
  export type AppId = string;
913
- export type Version = string;
914
1013
  }
915
1014
  export interface PathParameters {
916
1015
  appId: Parameters.AppId;
917
- version: Parameters.Version;
918
1016
  }
919
- export type RequestBody = Components.RequestBodies.PatchVersionRequest;
1017
+ export type RequestBody = Components.RequestBodies.InstallRequest;
920
1018
  namespace Responses {
921
1019
  export interface $204 {
922
1020
  }
923
- export interface $400 {
1021
+ export interface $404 {
1022
+ }
1023
+ }
1024
+ }
1025
+ namespace PatchMetadata {
1026
+ export type RequestBody = Components.RequestBodies.PatchConfigMetadataRequest;
1027
+ namespace Responses {
1028
+ export interface $204 {
924
1029
  }
925
1030
  export interface $404 {
926
1031
  }
@@ -973,6 +1078,14 @@ declare namespace Paths {
973
1078
  appId: Parameters.AppId;
974
1079
  }
975
1080
  }
1081
+ namespace V1AppConfigurationsPublic$AppId {
1082
+ namespace Parameters {
1083
+ export type AppId = string;
1084
+ }
1085
+ export interface PathParameters {
1086
+ appId: Parameters.AppId;
1087
+ }
1088
+ }
976
1089
  }
977
1090
 
978
1091
  export interface OperationMethods {
@@ -995,7 +1108,17 @@ export interface OperationMethods {
995
1108
  parameters?: Parameters<UnknownParamsObject> | null,
996
1109
  data?: Paths.CreateConfiguration.RequestBody,
997
1110
  config?: AxiosRequestConfig
998
- ): OperationResponse<Paths.CreateConfiguration.Responses.$202>
1111
+ ): OperationResponse<Paths.CreateConfiguration.Responses.$201>
1112
+ /**
1113
+ * getPublicConfiguration - getPublicConfiguration
1114
+ *
1115
+ * Retrieve the public configuration of an app to install in your tenant
1116
+ */
1117
+ 'getPublicConfiguration'(
1118
+ parameters?: Parameters<Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
1119
+ data?: any,
1120
+ config?: AxiosRequestConfig
1121
+ ): OperationResponse<Paths.GetPublicConfiguration.Responses.$200>
999
1122
  /**
1000
1123
  * getConfiguration - getConfiguration
1001
1124
  *
@@ -1066,16 +1189,6 @@ export interface OperationMethods {
1066
1189
  data?: any,
1067
1190
  config?: AxiosRequestConfig
1068
1191
  ): OperationResponse<Paths.GetVersion.Responses.$200>
1069
- /**
1070
- * patchVersion - patchVersion
1071
- *
1072
- * Patch version specific data of a configuration
1073
- */
1074
- 'patchVersion'(
1075
- parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
1076
- data?: Paths.PatchVersion.RequestBody,
1077
- config?: AxiosRequestConfig
1078
- ): OperationResponse<Paths.PatchVersion.Responses.$204>
1079
1192
  /**
1080
1193
  * deleteVersion - deleteVersion
1081
1194
  *
@@ -1086,6 +1199,36 @@ export interface OperationMethods {
1086
1199
  data?: any,
1087
1200
  config?: AxiosRequestConfig
1088
1201
  ): OperationResponse<Paths.DeleteVersion.Responses.$204>
1202
+ /**
1203
+ * createComponent - createComponent
1204
+ *
1205
+ * Patch an existing app version to create/add a component
1206
+ */
1207
+ 'createComponent'(
1208
+ parameters?: Parameters<Paths.CreateComponent.PathParameters> | null,
1209
+ data?: Paths.CreateComponent.RequestBody,
1210
+ config?: AxiosRequestConfig
1211
+ ): OperationResponse<Paths.CreateComponent.Responses.$204>
1212
+ /**
1213
+ * patchComponent - patchComponent
1214
+ *
1215
+ * Patch an existing app version to update its components
1216
+ */
1217
+ 'patchComponent'(
1218
+ parameters?: Parameters<Paths.PatchComponent.PathParameters> | null,
1219
+ data?: Paths.PatchComponent.RequestBody,
1220
+ config?: AxiosRequestConfig
1221
+ ): OperationResponse<Paths.PatchComponent.Responses.$204>
1222
+ /**
1223
+ * deleteComponent - deleteComponent
1224
+ *
1225
+ * Delete a specific component from an app version
1226
+ */
1227
+ 'deleteComponent'(
1228
+ parameters?: Parameters<Paths.DeleteComponent.PathParameters> | null,
1229
+ data?: any,
1230
+ config?: AxiosRequestConfig
1231
+ ): OperationResponse<Paths.DeleteComponent.Responses.$204>
1089
1232
  /**
1090
1233
  * cloneVersion - cloneVersion
1091
1234
  *
@@ -1179,7 +1322,19 @@ export interface PathsDictionary {
1179
1322
  parameters?: Parameters<UnknownParamsObject> | null,
1180
1323
  data?: Paths.CreateConfiguration.RequestBody,
1181
1324
  config?: AxiosRequestConfig
1182
- ): OperationResponse<Paths.CreateConfiguration.Responses.$202>
1325
+ ): OperationResponse<Paths.CreateConfiguration.Responses.$201>
1326
+ }
1327
+ ['/v1/app-configurations/public/{appId}']: {
1328
+ /**
1329
+ * getPublicConfiguration - getPublicConfiguration
1330
+ *
1331
+ * Retrieve the public configuration of an app to install in your tenant
1332
+ */
1333
+ 'get'(
1334
+ parameters?: Parameters<Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
1335
+ data?: any,
1336
+ config?: AxiosRequestConfig
1337
+ ): OperationResponse<Paths.GetPublicConfiguration.Responses.$200>
1183
1338
  }
1184
1339
  ['/v1/app-configurations/{appId}']: {
1185
1340
  /**
@@ -1270,16 +1425,40 @@ export interface PathsDictionary {
1270
1425
  data?: any,
1271
1426
  config?: AxiosRequestConfig
1272
1427
  ): OperationResponse<Paths.DeleteVersion.Responses.$204>
1428
+ }
1429
+ ['/v1/app-configurations/{appId}/versions/{version}/components']: {
1273
1430
  /**
1274
- * patchVersion - patchVersion
1431
+ * createComponent - createComponent
1275
1432
  *
1276
- * Patch version specific data of a configuration
1433
+ * Patch an existing app version to create/add a component
1434
+ */
1435
+ 'post'(
1436
+ parameters?: Parameters<Paths.CreateComponent.PathParameters> | null,
1437
+ data?: Paths.CreateComponent.RequestBody,
1438
+ config?: AxiosRequestConfig
1439
+ ): OperationResponse<Paths.CreateComponent.Responses.$204>
1440
+ }
1441
+ ['/v1/app-configurations/{appId}/versions/{version}/components/{componentId}']: {
1442
+ /**
1443
+ * patchComponent - patchComponent
1444
+ *
1445
+ * Patch an existing app version to update its components
1277
1446
  */
1278
1447
  'patch'(
1279
- parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
1280
- data?: Paths.PatchVersion.RequestBody,
1448
+ parameters?: Parameters<Paths.PatchComponent.PathParameters> | null,
1449
+ data?: Paths.PatchComponent.RequestBody,
1450
+ config?: AxiosRequestConfig
1451
+ ): OperationResponse<Paths.PatchComponent.Responses.$204>
1452
+ /**
1453
+ * deleteComponent - deleteComponent
1454
+ *
1455
+ * Delete a specific component from an app version
1456
+ */
1457
+ 'delete'(
1458
+ parameters?: Parameters<Paths.DeleteComponent.PathParameters> | null,
1459
+ data?: any,
1281
1460
  config?: AxiosRequestConfig
1282
- ): OperationResponse<Paths.PatchVersion.Responses.$204>
1461
+ ): OperationResponse<Paths.DeleteComponent.Responses.$204>
1283
1462
  }
1284
1463
  ['/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}']: {
1285
1464
  /**
@@ -1388,6 +1567,7 @@ export type PortalAuth = Components.Schemas.PortalAuth;
1388
1567
  export type PortalExtensionComponent = Components.Schemas.PortalExtensionComponent;
1389
1568
  export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
1390
1569
  export type Pricing = Components.Schemas.Pricing;
1570
+ export type PublicConfiguration = Components.Schemas.PublicConfiguration;
1391
1571
  export type S3Reference = Components.Schemas.S3Reference;
1392
1572
  export type TextArg = Components.Schemas.TextArg;
1393
1573
  export type TranslatedString = Components.Schemas.TranslatedString;
package/dist/openapi.json CHANGED
@@ -90,7 +90,7 @@
90
90
  "$ref": "#/components/requestBodies/CreateConfigRequest"
91
91
  },
92
92
  "responses": {
93
- "202": {
93
+ "201": {
94
94
  "description": "App configuration created successfully",
95
95
  "content": {
96
96
  "application/json": {
@@ -111,6 +111,39 @@
111
111
  }
112
112
  }
113
113
  },
114
+ "/v1/app-configurations/public/{appId}": {
115
+ "parameters": [
116
+ {
117
+ "name": "appId",
118
+ "in": "path",
119
+ "required": true,
120
+ "schema": {
121
+ "type": "string"
122
+ },
123
+ "description": "ID of the app configuration to install"
124
+ }
125
+ ],
126
+ "get": {
127
+ "summary": "getPublicConfiguration",
128
+ "description": "Retrieve the public configuration of an app to install in your tenant",
129
+ "operationId": "getPublicConfiguration",
130
+ "responses": {
131
+ "200": {
132
+ "description": "Successful response",
133
+ "content": {
134
+ "application/json": {
135
+ "schema": {
136
+ "$ref": "#/components/schemas/PublicConfiguration"
137
+ }
138
+ }
139
+ }
140
+ },
141
+ "404": {
142
+ "description": "App configuration not found"
143
+ }
144
+ }
145
+ }
146
+ },
114
147
  "/v1/app-configurations/{appId}": {
115
148
  "parameters": [
116
149
  {
@@ -200,6 +233,14 @@
200
233
  "upload_url"
201
234
  ],
202
235
  "properties": {
236
+ "component_id": {
237
+ "type": "string",
238
+ "description": "ID of the journye block component"
239
+ },
240
+ "component_url": {
241
+ "type": "string",
242
+ "description": "URL of the web component object"
243
+ },
203
244
  "upload_url": {
204
245
  "type": "string",
205
246
  "description": "Presigned S3 URL for uploading the bundle"
@@ -438,11 +479,13 @@
438
479
  "description": "Version is in use by installations"
439
480
  }
440
481
  }
441
- },
442
- "patch": {
443
- "summary": "patchVersion",
444
- "description": "Patch version specific data of a configuration",
445
- "operationId": "patchVersion",
482
+ }
483
+ },
484
+ "/v1/app-configurations/{appId}/versions/{version}/components": {
485
+ "post": {
486
+ "summary": "createComponent",
487
+ "description": "Patch an existing app version to create/add a component",
488
+ "operationId": "createComponent",
446
489
  "parameters": [
447
490
  {
448
491
  "name": "appId",
@@ -464,11 +507,11 @@
464
507
  }
465
508
  ],
466
509
  "requestBody": {
467
- "$ref": "#/components/requestBodies/PatchVersionRequest"
510
+ "$ref": "#/components/requestBodies/UpsertComponentRequest"
468
511
  },
469
512
  "responses": {
470
513
  "204": {
471
- "description": "Version updated successfully"
514
+ "description": "Component created successfully"
472
515
  },
473
516
  "400": {
474
517
  "description": "Invalid version format"
@@ -479,6 +522,98 @@
479
522
  }
480
523
  }
481
524
  },
525
+ "/v1/app-configurations/{appId}/versions/{version}/components/{componentId}": {
526
+ "patch": {
527
+ "summary": "patchComponent",
528
+ "description": "Patch an existing app version to update its components",
529
+ "operationId": "patchComponent",
530
+ "parameters": [
531
+ {
532
+ "name": "appId",
533
+ "in": "path",
534
+ "required": true,
535
+ "schema": {
536
+ "type": "string"
537
+ },
538
+ "description": "ID of the app configuration"
539
+ },
540
+ {
541
+ "name": "version",
542
+ "in": "path",
543
+ "required": true,
544
+ "schema": {
545
+ "type": "string"
546
+ },
547
+ "description": "Version to update"
548
+ },
549
+ {
550
+ "name": "componentId",
551
+ "in": "path",
552
+ "required": true,
553
+ "schema": {
554
+ "type": "string"
555
+ },
556
+ "description": "ID of the component to update"
557
+ }
558
+ ],
559
+ "requestBody": {
560
+ "$ref": "#/components/requestBodies/UpsertComponentRequest"
561
+ },
562
+ "responses": {
563
+ "204": {
564
+ "description": "Component patched successfully"
565
+ },
566
+ "400": {
567
+ "description": "Invalid version format"
568
+ },
569
+ "404": {
570
+ "description": "Version or component not found"
571
+ }
572
+ }
573
+ },
574
+ "delete": {
575
+ "summary": "deleteComponent",
576
+ "description": "Delete a specific component from an app version",
577
+ "operationId": "deleteComponent",
578
+ "parameters": [
579
+ {
580
+ "name": "appId",
581
+ "in": "path",
582
+ "required": true,
583
+ "schema": {
584
+ "type": "string"
585
+ },
586
+ "description": "ID of the app configuration"
587
+ },
588
+ {
589
+ "name": "version",
590
+ "in": "path",
591
+ "required": true,
592
+ "schema": {
593
+ "type": "string"
594
+ },
595
+ "description": "Version to update"
596
+ },
597
+ {
598
+ "name": "componentId",
599
+ "in": "path",
600
+ "required": true,
601
+ "schema": {
602
+ "type": "string"
603
+ },
604
+ "description": "ID of the component to delete"
605
+ }
606
+ ],
607
+ "responses": {
608
+ "204": {
609
+ "description": "Component deleted successfully"
610
+ },
611
+ "404": {
612
+ "description": "Version or component not found"
613
+ }
614
+ }
615
+ }
616
+ },
482
617
  "/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}": {
483
618
  "post": {
484
619
  "summary": "cloneVersion",
@@ -872,24 +1007,12 @@
872
1007
  }
873
1008
  }
874
1009
  },
875
- "PatchVersionRequest": {
1010
+ "UpsertComponentRequest": {
876
1011
  "required": true,
877
1012
  "content": {
878
1013
  "application/json": {
879
1014
  "schema": {
880
- "type": "object",
881
- "required": [
882
- "components"
883
- ],
884
- "properties": {
885
- "components": {
886
- "type": "array",
887
- "items": {
888
- "$ref": "#/components/schemas/BaseComponent"
889
- },
890
- "description": "Updated full list of app components"
891
- }
892
- }
1015
+ "$ref": "#/components/schemas/BaseComponent"
893
1016
  }
894
1017
  }
895
1018
  }
@@ -1132,6 +1255,10 @@
1132
1255
  "$ref": "#/components/schemas/TranslatedString",
1133
1256
  "description": "Name of the component"
1134
1257
  },
1258
+ "description": {
1259
+ "$ref": "#/components/schemas/TranslatedString",
1260
+ "description": "Description of the component"
1261
+ },
1135
1262
  "options": {
1136
1263
  "type": "array",
1137
1264
  "items": {
@@ -1553,7 +1680,6 @@
1553
1680
  "description",
1554
1681
  "latest_version",
1555
1682
  "owner_org_id",
1556
- "has_public_version",
1557
1683
  "app_id",
1558
1684
  "versions"
1559
1685
  ],
@@ -1789,6 +1915,68 @@
1789
1915
  }
1790
1916
  }
1791
1917
  },
1918
+ "PublicConfiguration": {
1919
+ "description": "Public configuration of the published app",
1920
+ "type": "object",
1921
+ "properties": {
1922
+ "app_id": {
1923
+ "type": "string",
1924
+ "description": "ID of the app configuration"
1925
+ },
1926
+ "owner_org_id": {
1927
+ "type": "string",
1928
+ "description": "Organization ID of the app owner"
1929
+ },
1930
+ "name": {
1931
+ "type": "string",
1932
+ "description": "Name of the app"
1933
+ },
1934
+ "author": {
1935
+ "$ref": "#/components/schemas/Author"
1936
+ },
1937
+ "category": {
1938
+ "type": "string",
1939
+ "description": "Category of the app."
1940
+ },
1941
+ "icon_url": {
1942
+ "type": "string",
1943
+ "description": "URL of the app icon."
1944
+ },
1945
+ "documentation_url": {
1946
+ "type": "string",
1947
+ "description": "URL of the app documentation."
1948
+ },
1949
+ "description": {
1950
+ "$ref": "#/components/schemas/TranslatedString",
1951
+ "description": "Markdown description of the app."
1952
+ },
1953
+ "pricing": {
1954
+ "$ref": "#/components/schemas/Pricing",
1955
+ "description": "Pricing information for the app"
1956
+ },
1957
+ "components": {
1958
+ "type": "array",
1959
+ "items": {
1960
+ "$ref": "#/components/schemas/BaseComponent"
1961
+ },
1962
+ "minItems": 0
1963
+ },
1964
+ "is_beta": {
1965
+ "type": "boolean",
1966
+ "description": "Flag to indicate if the app is in beta.",
1967
+ "readOnly": true
1968
+ },
1969
+ "deprecated_at": {
1970
+ "type": "string",
1971
+ "description": "Timestamp when the app version is deprecated"
1972
+ },
1973
+ "version": {
1974
+ "type": "string",
1975
+ "description": "Version of the app that is installed",
1976
+ "readOnly": true
1977
+ }
1978
+ }
1979
+ },
1792
1980
  "Configuration": {
1793
1981
  "description": "Configuration of the published app",
1794
1982
  "allOf": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/app-client",
3
- "version": "0.3.1",
3
+ "version": "0.3.3",
4
4
  "description": "JavaScript client library for the epilot App API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",