@epilot/app-client 0.3.4 → 0.3.6

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 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})})();
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","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":{}}},"/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})})();
@@ -44,6 +44,12 @@
44
44
  ],
45
45
  "get": {
46
46
  "operationId": "getPublicConfiguration",
47
+ "parameters": [
48
+ {
49
+ "name": "version",
50
+ "in": "query"
51
+ }
52
+ ],
47
53
  "responses": {}
48
54
  }
49
55
  },
package/dist/openapi.d.ts CHANGED
@@ -111,8 +111,32 @@ declare namespace Components {
111
111
  * Unique identifier for the component
112
112
  */
113
113
  id: string;
114
- name?: TranslatedString;
115
- description?: TranslatedString;
114
+ /**
115
+ * Name of the component
116
+ */
117
+ name?: {
118
+ /**
119
+ * English translation
120
+ */
121
+ en?: string | null;
122
+ /**
123
+ * German translation
124
+ */
125
+ de: string;
126
+ };
127
+ /**
128
+ * Description of the component
129
+ */
130
+ description?: {
131
+ /**
132
+ * English translation
133
+ */
134
+ en?: string | null;
135
+ /**
136
+ * German translation
137
+ */
138
+ de: string;
139
+ };
116
140
  /**
117
141
  * List of options for the app component
118
142
  */
@@ -126,11 +150,29 @@ declare namespace Components {
126
150
  /**
127
151
  * Name of the component
128
152
  */
129
- name?: TranslatedString;
153
+ name?: {
154
+ /**
155
+ * English translation
156
+ */
157
+ en?: string | null;
158
+ /**
159
+ * German translation
160
+ */
161
+ de: string;
162
+ };
130
163
  /**
131
164
  * Description of the component
132
165
  */
133
- description?: TranslatedString;
166
+ description?: {
167
+ /**
168
+ * English translation
169
+ */
170
+ en?: string | null;
171
+ /**
172
+ * German translation
173
+ */
174
+ de: string;
175
+ };
134
176
  /**
135
177
  * List of options for the app component
136
178
  */
@@ -211,8 +253,34 @@ declare namespace Components {
211
253
  * URL of the app documentation.
212
254
  */
213
255
  documentation_url?: string;
214
- description: TranslatedString;
215
- notifications?: NotificationConfig;
256
+ /**
257
+ * Markdown description of the app.
258
+ */
259
+ description: {
260
+ /**
261
+ * English translation
262
+ */
263
+ en?: string | null;
264
+ /**
265
+ * German translation
266
+ */
267
+ de: string;
268
+ };
269
+ /**
270
+ * Configuration for developer notifications
271
+ */
272
+ notifications?: {
273
+ /**
274
+ * Email address to receive notifications
275
+ * example:
276
+ * developer@example.com
277
+ */
278
+ email?: string; // email
279
+ /**
280
+ * List of events to subscribe to
281
+ */
282
+ events?: NotificationEvent[];
283
+ };
216
284
  /**
217
285
  * Organization ID of the app owner
218
286
  */
@@ -221,8 +289,34 @@ declare namespace Components {
221
289
  * Flag to indicate if the app is built by epilot.
222
290
  */
223
291
  internal?: boolean;
224
- pricing?: Pricing;
225
- configuration_audit?: Audit;
292
+ /**
293
+ * Pricing information for the app
294
+ */
295
+ pricing?: {
296
+ pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
297
+ billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
298
+ };
299
+ /**
300
+ * Audit information for the app
301
+ */
302
+ configuration_audit?: {
303
+ /**
304
+ * Timestamp of the creation
305
+ */
306
+ created_at?: string;
307
+ /**
308
+ * User ID of the creator
309
+ */
310
+ created_by?: string;
311
+ /**
312
+ * Timestamp of the last update
313
+ */
314
+ updated_at?: string;
315
+ /**
316
+ * User ID of the last updater
317
+ */
318
+ updated_by?: string;
319
+ };
226
320
  components: BaseComponent[];
227
321
  /**
228
322
  * Flag to indicate if the app is public.
@@ -320,11 +414,31 @@ declare namespace Components {
320
414
  /**
321
415
  * Markdown description of the app.
322
416
  */
323
- description: TranslatedString;
417
+ description: {
418
+ /**
419
+ * English translation
420
+ */
421
+ en?: string | null;
422
+ /**
423
+ * German translation
424
+ */
425
+ de: string;
426
+ };
324
427
  /**
325
428
  * Configuration for developer notifications
326
429
  */
327
- notifications?: NotificationConfig;
430
+ notifications?: {
431
+ /**
432
+ * Email address to receive notifications
433
+ * example:
434
+ * developer@example.com
435
+ */
436
+ email?: string; // email
437
+ /**
438
+ * List of events to subscribe to
439
+ */
440
+ events?: NotificationEvent[];
441
+ };
328
442
  /**
329
443
  * Organization ID of the app owner, required for private apps or sandbox accounts
330
444
  */
@@ -336,11 +450,31 @@ declare namespace Components {
336
450
  /**
337
451
  * Pricing information for the app
338
452
  */
339
- pricing?: Pricing;
453
+ pricing?: {
454
+ pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
455
+ billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
456
+ };
340
457
  /**
341
458
  * Audit information for the app
342
459
  */
343
- configuration_audit?: Audit;
460
+ configuration_audit?: {
461
+ /**
462
+ * Timestamp of the creation
463
+ */
464
+ created_at?: string;
465
+ /**
466
+ * User ID of the creator
467
+ */
468
+ created_by?: string;
469
+ /**
470
+ * Timestamp of the last update
471
+ */
472
+ updated_at?: string;
473
+ /**
474
+ * User ID of the last updater
475
+ */
476
+ updated_by?: string;
477
+ };
344
478
  }
345
479
  /**
346
480
  * Configuration data about your app which is versionable
@@ -425,7 +559,16 @@ declare namespace Components {
425
559
  /**
426
560
  * Display label for the option
427
561
  */
428
- label: TranslatedString;
562
+ label: {
563
+ /**
564
+ * English translation
565
+ */
566
+ en?: string | null;
567
+ /**
568
+ * German translation
569
+ */
570
+ de: string;
571
+ };
429
572
  },
430
573
  ...{
431
574
  /**
@@ -435,7 +578,16 @@ declare namespace Components {
435
578
  /**
436
579
  * Display label for the option
437
580
  */
438
- label: TranslatedString;
581
+ label: {
582
+ /**
583
+ * English translation
584
+ */
585
+ en?: string | null;
586
+ /**
587
+ * German translation
588
+ */
589
+ de: string;
590
+ };
439
591
  }[]
440
592
  ];
441
593
  }
@@ -471,7 +623,27 @@ declare namespace Components {
471
623
  * Version of the app that is installed
472
624
  */
473
625
  installed_version: string;
474
- installation_audit?: Audit;
626
+ /**
627
+ * Audit information for the app
628
+ */
629
+ installation_audit?: {
630
+ /**
631
+ * Timestamp of the creation
632
+ */
633
+ created_at?: string;
634
+ /**
635
+ * User ID of the creator
636
+ */
637
+ created_by?: string;
638
+ /**
639
+ * Timestamp of the last update
640
+ */
641
+ updated_at?: string;
642
+ /**
643
+ * User ID of the last updater
644
+ */
645
+ updated_by?: string;
646
+ };
475
647
  }
476
648
  export interface JourneyBlockComponent {
477
649
  component_type: "CUSTOM_JOURNEY_BLOCK";
@@ -487,8 +659,32 @@ declare namespace Components {
487
659
  * Flag to indicate if this option is required
488
660
  */
489
661
  required?: boolean;
490
- description?: TranslatedString;
491
- label: TranslatedString;
662
+ /**
663
+ * Description of what this component arg does
664
+ */
665
+ description?: {
666
+ /**
667
+ * English translation
668
+ */
669
+ en?: string | null;
670
+ /**
671
+ * German translation
672
+ */
673
+ de: string;
674
+ };
675
+ /**
676
+ * Human-readable label for the component arg
677
+ */
678
+ label: {
679
+ /**
680
+ * English translation
681
+ */
682
+ en?: string | null;
683
+ /**
684
+ * German translation
685
+ */
686
+ de: string;
687
+ };
492
688
  } & (TextArg | BooleanArg | EnumArg);
493
689
  export interface JourneyBlockConfig {
494
690
  /**
@@ -513,7 +709,7 @@ declare namespace Components {
513
709
  * Define data which is mapped to entity mapping ui blocks
514
710
  */
515
711
  component_mapping?: {
516
- [name: string]: "string" | "boolean" | "date" | "datetime";
712
+ [name: string]: "string" | "boolean" | "date" | "datetime" | "link" | "number";
517
713
  };
518
714
  }
519
715
  export interface NotificationConfig {
@@ -629,7 +825,7 @@ declare namespace Components {
629
825
  /**
630
826
  * ID of the app configuration
631
827
  */
632
- app_id?: string;
828
+ app_id: string;
633
829
  /**
634
830
  * Email address for support requests
635
831
  */
@@ -637,11 +833,11 @@ declare namespace Components {
637
833
  /**
638
834
  * Organization ID of the app owner
639
835
  */
640
- owner_org_id?: string;
836
+ owner_org_id: string;
641
837
  /**
642
838
  * Name of the app
643
839
  */
644
- name?: string;
840
+ name: string;
645
841
  author?: Author;
646
842
  /**
647
843
  * Category of the app.
@@ -658,12 +854,24 @@ declare namespace Components {
658
854
  /**
659
855
  * Markdown description of the app.
660
856
  */
661
- description?: TranslatedString;
857
+ description?: {
858
+ /**
859
+ * English translation
860
+ */
861
+ en?: string | null;
862
+ /**
863
+ * German translation
864
+ */
865
+ de: string;
866
+ };
662
867
  /**
663
868
  * Pricing information for the app
664
869
  */
665
- pricing?: Pricing;
666
- components?: BaseComponent[];
870
+ pricing?: {
871
+ pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
872
+ billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
873
+ };
874
+ components: BaseComponent[];
667
875
  /**
668
876
  * Flag to indicate if the app is in beta.
669
877
  */
@@ -675,7 +883,11 @@ declare namespace Components {
675
883
  /**
676
884
  * Version of the app that is installed
677
885
  */
678
- version?: string;
886
+ version: string;
887
+ /**
888
+ * Flag to indicate if the app is public.
889
+ */
890
+ public?: boolean;
679
891
  }
680
892
  export interface S3Reference {
681
893
  /**
@@ -704,12 +916,6 @@ declare namespace Components {
704
916
  */
705
917
  de: string;
706
918
  }
707
- export interface UploadFilePayload {
708
- /**
709
- * ID of the app configuration. Required for app updates.
710
- */
711
- app_id?: string;
712
- }
713
919
  }
714
920
  }
715
921
  declare namespace Paths {
@@ -886,6 +1092,12 @@ declare namespace Paths {
886
1092
  }
887
1093
  }
888
1094
  namespace GetPublicConfiguration {
1095
+ namespace Parameters {
1096
+ export type Version = string;
1097
+ }
1098
+ export interface QueryParameters {
1099
+ version?: Parameters.Version;
1100
+ }
889
1101
  namespace Responses {
890
1102
  export type $200 = /* Public configuration of the published app */ Components.Schemas.PublicConfiguration;
891
1103
  export interface $404 {
@@ -1119,7 +1331,7 @@ export interface OperationMethods {
1119
1331
  * Retrieve the public configuration of an app to install in your tenant
1120
1332
  */
1121
1333
  'getPublicConfiguration'(
1122
- parameters?: Parameters<Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
1334
+ parameters?: Parameters<Paths.GetPublicConfiguration.QueryParameters & Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
1123
1335
  data?: any,
1124
1336
  config?: AxiosRequestConfig
1125
1337
  ): OperationResponse<Paths.GetPublicConfiguration.Responses.$200>
@@ -1335,7 +1547,7 @@ export interface PathsDictionary {
1335
1547
  * Retrieve the public configuration of an app to install in your tenant
1336
1548
  */
1337
1549
  'get'(
1338
- parameters?: Parameters<Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
1550
+ parameters?: Parameters<Paths.GetPublicConfiguration.QueryParameters & Paths.V1AppConfigurationsPublic$AppId.PathParameters> | null,
1339
1551
  data?: any,
1340
1552
  config?: AxiosRequestConfig
1341
1553
  ): OperationResponse<Paths.GetPublicConfiguration.Responses.$200>
@@ -1575,4 +1787,3 @@ export type PublicConfiguration = Components.Schemas.PublicConfiguration;
1575
1787
  export type S3Reference = Components.Schemas.S3Reference;
1576
1788
  export type TextArg = Components.Schemas.TextArg;
1577
1789
  export type TranslatedString = Components.Schemas.TranslatedString;
1578
- export type UploadFilePayload = Components.Schemas.UploadFilePayload;
package/dist/openapi.json CHANGED
@@ -5,6 +5,16 @@
5
5
  "description": "API for managing app publishing and installed app.",
6
6
  "version": "1.0.0"
7
7
  },
8
+ "tags": [
9
+ {
10
+ "name": "App Configuration",
11
+ "description": "Create and manage app configurations"
12
+ },
13
+ {
14
+ "name": "App Installation",
15
+ "description": "Install and uninstall apps"
16
+ }
17
+ ],
8
18
  "servers": [
9
19
  {
10
20
  "url": "https://app.sls.epilot.io"
@@ -27,6 +37,9 @@
27
37
  "summary": "listConfigurations",
28
38
  "description": "List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.",
29
39
  "operationId": "listConfigurations",
40
+ "tags": [
41
+ "App Configuration"
42
+ ],
30
43
  "parameters": [
31
44
  {
32
45
  "name": "page",
@@ -86,6 +99,9 @@
86
99
  "summary": "createConfiguration",
87
100
  "description": "Create a new private app configuration. To make it public a verification process needs to be triggered",
88
101
  "operationId": "createConfiguration",
102
+ "tags": [
103
+ "App Configuration"
104
+ ],
89
105
  "requestBody": {
90
106
  "$ref": "#/components/requestBodies/CreateConfigRequest"
91
107
  },
@@ -127,6 +143,19 @@
127
143
  "summary": "getPublicConfiguration",
128
144
  "description": "Retrieve the public configuration of an app to install in your tenant",
129
145
  "operationId": "getPublicConfiguration",
146
+ "tags": [
147
+ "App Configuration"
148
+ ],
149
+ "parameters": [
150
+ {
151
+ "name": "version",
152
+ "in": "query",
153
+ "schema": {
154
+ "type": "string"
155
+ },
156
+ "description": "Version of the app configuration to retrieve"
157
+ }
158
+ ],
130
159
  "responses": {
131
160
  "200": {
132
161
  "description": "Successful response",
@@ -160,6 +189,9 @@
160
189
  "summary": "getConfiguration",
161
190
  "description": "Retrieve a specific app configuration",
162
191
  "operationId": "getConfiguration",
192
+ "tags": [
193
+ "App Configuration"
194
+ ],
163
195
  "parameters": [
164
196
  {
165
197
  "name": "version",
@@ -190,6 +222,9 @@
190
222
  "summary": "patchMetadata",
191
223
  "description": "Patch non-versioned configuration metadata of a given app configuration.",
192
224
  "operationId": "patchMetadata",
225
+ "tags": [
226
+ "App Configuration"
227
+ ],
193
228
  "requestBody": {
194
229
  "$ref": "#/components/requestBodies/PatchConfigMetadataRequest"
195
230
  },
@@ -208,6 +243,9 @@
208
243
  "summary": "createBundleUploadUrl",
209
244
  "description": "Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path",
210
245
  "operationId": "createBundleUploadUrl",
246
+ "tags": [
247
+ "App Configuration"
248
+ ],
211
249
  "parameters": [
212
250
  {
213
251
  "name": "appId",
@@ -280,6 +318,9 @@
280
318
  "summary": "createLogoUploadUrl",
281
319
  "description": "Generate a presigned URL for uploading app logo to /<app-id>/logo.png path",
282
320
  "operationId": "createLogoUploadUrl",
321
+ "tags": [
322
+ "App Configuration"
323
+ ],
283
324
  "requestBody": {
284
325
  "$ref": "#/components/requestBodies/CreateLogoPresignedRequest"
285
326
  },
@@ -320,6 +361,9 @@
320
361
  "summary": "deleteLogo",
321
362
  "description": "Delete the app logo from /<app-id>/logo.png path",
322
363
  "operationId": "deleteLogo",
364
+ "tags": [
365
+ "App Configuration"
366
+ ],
323
367
  "responses": {
324
368
  "204": {
325
369
  "description": "Logo deleted successfully"
@@ -335,6 +379,9 @@
335
379
  "summary": "listVersions",
336
380
  "description": "Retrieve a list of versions for an app configuration",
337
381
  "operationId": "listVersions",
382
+ "tags": [
383
+ "App Configuration"
384
+ ],
338
385
  "parameters": [
339
386
  {
340
387
  "name": "appId",
@@ -405,6 +452,9 @@
405
452
  "summary": "getVersion",
406
453
  "description": "Retrieve a specific version of an app configuration",
407
454
  "operationId": "getVersion",
455
+ "tags": [
456
+ "App Configuration"
457
+ ],
408
458
  "parameters": [
409
459
  {
410
460
  "name": "appId",
@@ -445,6 +495,9 @@
445
495
  "summary": "deleteVersion",
446
496
  "description": "Delete a specific version of an app configuration",
447
497
  "operationId": "deleteVersion",
498
+ "tags": [
499
+ "App Configuration"
500
+ ],
448
501
  "parameters": [
449
502
  {
450
503
  "name": "appId",
@@ -486,6 +539,9 @@
486
539
  "summary": "createComponent",
487
540
  "description": "Patch an existing app version to create/add a component",
488
541
  "operationId": "createComponent",
542
+ "tags": [
543
+ "App Configuration"
544
+ ],
489
545
  "parameters": [
490
546
  {
491
547
  "name": "appId",
@@ -527,6 +583,9 @@
527
583
  "summary": "patchComponent",
528
584
  "description": "Patch an existing app version to update its components",
529
585
  "operationId": "patchComponent",
586
+ "tags": [
587
+ "App Configuration"
588
+ ],
530
589
  "parameters": [
531
590
  {
532
591
  "name": "appId",
@@ -575,6 +634,9 @@
575
634
  "summary": "deleteComponent",
576
635
  "description": "Delete a specific component from an app version",
577
636
  "operationId": "deleteComponent",
637
+ "tags": [
638
+ "App Configuration"
639
+ ],
578
640
  "parameters": [
579
641
  {
580
642
  "name": "appId",
@@ -619,6 +681,9 @@
619
681
  "summary": "cloneVersion",
620
682
  "description": "Clone an existing app version to create a new version",
621
683
  "operationId": "cloneVersion",
684
+ "tags": [
685
+ "App Configuration"
686
+ ],
622
687
  "parameters": [
623
688
  {
624
689
  "name": "appId",
@@ -688,6 +753,9 @@
688
753
  "summary": "listInstallations",
689
754
  "description": "Retrieve a list of installed apps for the organization.",
690
755
  "operationId": "listInstallations",
756
+ "tags": [
757
+ "App Installation"
758
+ ],
691
759
  "parameters": [
692
760
  {
693
761
  "name": "componentType",
@@ -766,6 +834,9 @@
766
834
  "summary": "getInstallation",
767
835
  "description": "Retrieve details of an installed app by its ID.",
768
836
  "operationId": "getInstallation",
837
+ "tags": [
838
+ "App Installation"
839
+ ],
769
840
  "parameters": [
770
841
  {
771
842
  "name": "appId",
@@ -796,6 +867,9 @@
796
867
  "summary": "install",
797
868
  "description": "Upsert app installation by its ID.",
798
869
  "operationId": "install",
870
+ "tags": [
871
+ "App Installation"
872
+ ],
799
873
  "parameters": [
800
874
  {
801
875
  "name": "appId",
@@ -822,6 +896,9 @@
822
896
  "summary": "patchInstallation",
823
897
  "description": "Patch an installed app by its ID.",
824
898
  "operationId": "patchInstallation",
899
+ "tags": [
900
+ "App Installation"
901
+ ],
825
902
  "parameters": [
826
903
  {
827
904
  "name": "appId",
@@ -848,6 +925,9 @@
848
925
  "summary": "uninstall",
849
926
  "description": "Uninstall an app by its ID.",
850
927
  "operationId": "uninstall",
928
+ "tags": [
929
+ "App Installation"
930
+ ],
851
931
  "parameters": [
852
932
  {
853
933
  "name": "appId",
@@ -873,6 +953,9 @@
873
953
  "summary": "promoteVersion",
874
954
  "description": "Update an installed app to a new version",
875
955
  "operationId": "promoteVersion",
956
+ "tags": [
957
+ "App Installation"
958
+ ],
876
959
  "parameters": [
877
960
  {
878
961
  "name": "appId",
@@ -1156,15 +1239,6 @@
1156
1239
  }
1157
1240
  }
1158
1241
  },
1159
- "UploadFilePayload": {
1160
- "type": "object",
1161
- "properties": {
1162
- "app_id": {
1163
- "type": "string",
1164
- "description": "ID of the app configuration. Required for app updates."
1165
- }
1166
- }
1167
- },
1168
1242
  "S3Reference": {
1169
1243
  "type": "object",
1170
1244
  "properties": {
@@ -1252,12 +1326,24 @@
1252
1326
  "description": "Unique identifier for the component"
1253
1327
  },
1254
1328
  "name": {
1255
- "$ref": "#/components/schemas/TranslatedString",
1256
- "description": "Name of the component"
1329
+ "allOf": [
1330
+ {
1331
+ "description": "Name of the component"
1332
+ },
1333
+ {
1334
+ "$ref": "#/components/schemas/TranslatedString"
1335
+ }
1336
+ ]
1257
1337
  },
1258
1338
  "description": {
1259
- "$ref": "#/components/schemas/TranslatedString",
1260
- "description": "Description of the component"
1339
+ "allOf": [
1340
+ {
1341
+ "description": "Description of the component"
1342
+ },
1343
+ {
1344
+ "$ref": "#/components/schemas/TranslatedString"
1345
+ }
1346
+ ]
1261
1347
  },
1262
1348
  "options": {
1263
1349
  "type": "array",
@@ -1488,7 +1574,9 @@
1488
1574
  "string",
1489
1575
  "boolean",
1490
1576
  "date",
1491
- "datetime"
1577
+ "datetime",
1578
+ "link",
1579
+ "number"
1492
1580
  ]
1493
1581
  }
1494
1582
  }
@@ -1522,12 +1610,24 @@
1522
1610
  "default": false
1523
1611
  },
1524
1612
  "description": {
1525
- "description": "Description of what this component arg does",
1526
- "$ref": "#/components/schemas/TranslatedString"
1613
+ "allOf": [
1614
+ {
1615
+ "description": "Description of what this component arg does"
1616
+ },
1617
+ {
1618
+ "$ref": "#/components/schemas/TranslatedString"
1619
+ }
1620
+ ]
1527
1621
  },
1528
1622
  "label": {
1529
- "description": "Human-readable label for the component arg",
1530
- "$ref": "#/components/schemas/TranslatedString"
1623
+ "allOf": [
1624
+ {
1625
+ "description": "Human-readable label for the component arg"
1626
+ },
1627
+ {
1628
+ "$ref": "#/components/schemas/TranslatedString"
1629
+ }
1630
+ ]
1531
1631
  }
1532
1632
  }
1533
1633
  },
@@ -1610,8 +1710,14 @@
1610
1710
  "description": "Unique identifier for the option"
1611
1711
  },
1612
1712
  "label": {
1613
- "$ref": "#/components/schemas/TranslatedString",
1614
- "description": "Display label for the option"
1713
+ "allOf": [
1714
+ {
1715
+ "description": "Display label for the option"
1716
+ },
1717
+ {
1718
+ "$ref": "#/components/schemas/TranslatedString"
1719
+ }
1720
+ ]
1615
1721
  }
1616
1722
  }
1617
1723
  }
@@ -1733,12 +1839,24 @@
1733
1839
  "description": "URL of the app documentation."
1734
1840
  },
1735
1841
  "description": {
1736
- "$ref": "#/components/schemas/TranslatedString",
1737
- "description": "Markdown description of the app."
1842
+ "allOf": [
1843
+ {
1844
+ "description": "Markdown description of the app."
1845
+ },
1846
+ {
1847
+ "$ref": "#/components/schemas/TranslatedString"
1848
+ }
1849
+ ]
1738
1850
  },
1739
1851
  "notifications": {
1740
- "$ref": "#/components/schemas/NotificationConfig",
1741
- "description": "Configuration for developer notifications"
1852
+ "allOf": [
1853
+ {
1854
+ "description": "Configuration for developer notifications"
1855
+ },
1856
+ {
1857
+ "$ref": "#/components/schemas/NotificationConfig"
1858
+ }
1859
+ ]
1742
1860
  },
1743
1861
  "owner_org_id": {
1744
1862
  "type": "string",
@@ -1752,13 +1870,25 @@
1752
1870
  "readOnly": true
1753
1871
  },
1754
1872
  "pricing": {
1755
- "$ref": "#/components/schemas/Pricing",
1756
- "description": "Pricing information for the app"
1873
+ "allOf": [
1874
+ {
1875
+ "description": "Pricing information for the app"
1876
+ },
1877
+ {
1878
+ "$ref": "#/components/schemas/Pricing"
1879
+ }
1880
+ ]
1757
1881
  },
1758
1882
  "configuration_audit": {
1759
- "$ref": "#/components/schemas/Audit",
1760
- "description": "Audit information for the app",
1761
- "readOnly": true
1883
+ "readOnly": true,
1884
+ "allOf": [
1885
+ {
1886
+ "description": "Audit information for the app"
1887
+ },
1888
+ {
1889
+ "$ref": "#/components/schemas/Audit"
1890
+ }
1891
+ ]
1762
1892
  }
1763
1893
  }
1764
1894
  },
@@ -1910,14 +2040,28 @@
1910
2040
  "readOnly": true
1911
2041
  },
1912
2042
  "installation_audit": {
1913
- "$ref": "#/components/schemas/Audit",
1914
- "readOnly": true
2043
+ "readOnly": true,
2044
+ "allOf": [
2045
+ {
2046
+ "description": "Audit information for the app"
2047
+ },
2048
+ {
2049
+ "$ref": "#/components/schemas/Audit"
2050
+ }
2051
+ ]
1915
2052
  }
1916
2053
  }
1917
2054
  },
1918
2055
  "PublicConfiguration": {
1919
2056
  "description": "Public configuration of the published app",
1920
2057
  "type": "object",
2058
+ "required": [
2059
+ "version",
2060
+ "components",
2061
+ "owner_org_id",
2062
+ "app_id",
2063
+ "name"
2064
+ ],
1921
2065
  "properties": {
1922
2066
  "app_id": {
1923
2067
  "type": "string",
@@ -1951,12 +2095,24 @@
1951
2095
  "description": "URL of the app documentation."
1952
2096
  },
1953
2097
  "description": {
1954
- "$ref": "#/components/schemas/TranslatedString",
1955
- "description": "Markdown description of the app."
2098
+ "allOf": [
2099
+ {
2100
+ "description": "Markdown description of the app."
2101
+ },
2102
+ {
2103
+ "$ref": "#/components/schemas/TranslatedString"
2104
+ }
2105
+ ]
1956
2106
  },
1957
2107
  "pricing": {
1958
- "$ref": "#/components/schemas/Pricing",
1959
- "description": "Pricing information for the app"
2108
+ "allOf": [
2109
+ {
2110
+ "description": "Pricing information for the app"
2111
+ },
2112
+ {
2113
+ "$ref": "#/components/schemas/Pricing"
2114
+ }
2115
+ ]
1960
2116
  },
1961
2117
  "components": {
1962
2118
  "type": "array",
@@ -1978,6 +2134,12 @@
1978
2134
  "type": "string",
1979
2135
  "description": "Version of the app that is installed",
1980
2136
  "readOnly": true
2137
+ },
2138
+ "public": {
2139
+ "type": "boolean",
2140
+ "default": true,
2141
+ "description": "Flag to indicate if the app is public.",
2142
+ "readOnly": true
1981
2143
  }
1982
2144
  }
1983
2145
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/app-client",
3
- "version": "0.3.4",
3
+ "version": "0.3.6",
4
4
  "description": "JavaScript client library for the epilot App API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -73,4 +73,4 @@
73
73
  "webpack-cli": "^4.4.0"
74
74
  },
75
75
  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
76
- }
76
+ }