@epilot/app-client 0.3.5 → 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.
- package/dist/openapi.d.ts +232 -27
- package/dist/openapi.json +179 -35
- package/package.json +1 -1
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
|
-
|
|
115
|
-
|
|
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?:
|
|
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?:
|
|
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
|
-
|
|
215
|
-
|
|
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
|
-
|
|
225
|
-
|
|
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:
|
|
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?:
|
|
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?:
|
|
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?:
|
|
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:
|
|
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:
|
|
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
|
-
|
|
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
|
-
|
|
491
|
-
|
|
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" | "link";
|
|
712
|
+
[name: string]: "string" | "boolean" | "date" | "datetime" | "link" | "number";
|
|
517
713
|
};
|
|
518
714
|
}
|
|
519
715
|
export interface NotificationConfig {
|
|
@@ -658,11 +854,23 @@ declare namespace Components {
|
|
|
658
854
|
/**
|
|
659
855
|
* Markdown description of the app.
|
|
660
856
|
*/
|
|
661
|
-
description?:
|
|
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?:
|
|
870
|
+
pricing?: {
|
|
871
|
+
pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED" | "ONE_TIME" | "CUSTOM" | "UNKNOWN";
|
|
872
|
+
billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
|
|
873
|
+
};
|
|
666
874
|
components: BaseComponent[];
|
|
667
875
|
/**
|
|
668
876
|
* Flag to indicate if the app is in beta.
|
|
@@ -676,6 +884,10 @@ declare namespace Components {
|
|
|
676
884
|
* Version of the app that is installed
|
|
677
885
|
*/
|
|
678
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 {
|
|
@@ -1581,4 +1787,3 @@ export type PublicConfiguration = Components.Schemas.PublicConfiguration;
|
|
|
1581
1787
|
export type S3Reference = Components.Schemas.S3Reference;
|
|
1582
1788
|
export type TextArg = Components.Schemas.TextArg;
|
|
1583
1789
|
export type TranslatedString = Components.Schemas.TranslatedString;
|
|
1584
|
-
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,9 @@
|
|
|
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
|
+
],
|
|
130
149
|
"parameters": [
|
|
131
150
|
{
|
|
132
151
|
"name": "version",
|
|
@@ -170,6 +189,9 @@
|
|
|
170
189
|
"summary": "getConfiguration",
|
|
171
190
|
"description": "Retrieve a specific app configuration",
|
|
172
191
|
"operationId": "getConfiguration",
|
|
192
|
+
"tags": [
|
|
193
|
+
"App Configuration"
|
|
194
|
+
],
|
|
173
195
|
"parameters": [
|
|
174
196
|
{
|
|
175
197
|
"name": "version",
|
|
@@ -200,6 +222,9 @@
|
|
|
200
222
|
"summary": "patchMetadata",
|
|
201
223
|
"description": "Patch non-versioned configuration metadata of a given app configuration.",
|
|
202
224
|
"operationId": "patchMetadata",
|
|
225
|
+
"tags": [
|
|
226
|
+
"App Configuration"
|
|
227
|
+
],
|
|
203
228
|
"requestBody": {
|
|
204
229
|
"$ref": "#/components/requestBodies/PatchConfigMetadataRequest"
|
|
205
230
|
},
|
|
@@ -218,6 +243,9 @@
|
|
|
218
243
|
"summary": "createBundleUploadUrl",
|
|
219
244
|
"description": "Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path",
|
|
220
245
|
"operationId": "createBundleUploadUrl",
|
|
246
|
+
"tags": [
|
|
247
|
+
"App Configuration"
|
|
248
|
+
],
|
|
221
249
|
"parameters": [
|
|
222
250
|
{
|
|
223
251
|
"name": "appId",
|
|
@@ -290,6 +318,9 @@
|
|
|
290
318
|
"summary": "createLogoUploadUrl",
|
|
291
319
|
"description": "Generate a presigned URL for uploading app logo to /<app-id>/logo.png path",
|
|
292
320
|
"operationId": "createLogoUploadUrl",
|
|
321
|
+
"tags": [
|
|
322
|
+
"App Configuration"
|
|
323
|
+
],
|
|
293
324
|
"requestBody": {
|
|
294
325
|
"$ref": "#/components/requestBodies/CreateLogoPresignedRequest"
|
|
295
326
|
},
|
|
@@ -330,6 +361,9 @@
|
|
|
330
361
|
"summary": "deleteLogo",
|
|
331
362
|
"description": "Delete the app logo from /<app-id>/logo.png path",
|
|
332
363
|
"operationId": "deleteLogo",
|
|
364
|
+
"tags": [
|
|
365
|
+
"App Configuration"
|
|
366
|
+
],
|
|
333
367
|
"responses": {
|
|
334
368
|
"204": {
|
|
335
369
|
"description": "Logo deleted successfully"
|
|
@@ -345,6 +379,9 @@
|
|
|
345
379
|
"summary": "listVersions",
|
|
346
380
|
"description": "Retrieve a list of versions for an app configuration",
|
|
347
381
|
"operationId": "listVersions",
|
|
382
|
+
"tags": [
|
|
383
|
+
"App Configuration"
|
|
384
|
+
],
|
|
348
385
|
"parameters": [
|
|
349
386
|
{
|
|
350
387
|
"name": "appId",
|
|
@@ -415,6 +452,9 @@
|
|
|
415
452
|
"summary": "getVersion",
|
|
416
453
|
"description": "Retrieve a specific version of an app configuration",
|
|
417
454
|
"operationId": "getVersion",
|
|
455
|
+
"tags": [
|
|
456
|
+
"App Configuration"
|
|
457
|
+
],
|
|
418
458
|
"parameters": [
|
|
419
459
|
{
|
|
420
460
|
"name": "appId",
|
|
@@ -455,6 +495,9 @@
|
|
|
455
495
|
"summary": "deleteVersion",
|
|
456
496
|
"description": "Delete a specific version of an app configuration",
|
|
457
497
|
"operationId": "deleteVersion",
|
|
498
|
+
"tags": [
|
|
499
|
+
"App Configuration"
|
|
500
|
+
],
|
|
458
501
|
"parameters": [
|
|
459
502
|
{
|
|
460
503
|
"name": "appId",
|
|
@@ -496,6 +539,9 @@
|
|
|
496
539
|
"summary": "createComponent",
|
|
497
540
|
"description": "Patch an existing app version to create/add a component",
|
|
498
541
|
"operationId": "createComponent",
|
|
542
|
+
"tags": [
|
|
543
|
+
"App Configuration"
|
|
544
|
+
],
|
|
499
545
|
"parameters": [
|
|
500
546
|
{
|
|
501
547
|
"name": "appId",
|
|
@@ -537,6 +583,9 @@
|
|
|
537
583
|
"summary": "patchComponent",
|
|
538
584
|
"description": "Patch an existing app version to update its components",
|
|
539
585
|
"operationId": "patchComponent",
|
|
586
|
+
"tags": [
|
|
587
|
+
"App Configuration"
|
|
588
|
+
],
|
|
540
589
|
"parameters": [
|
|
541
590
|
{
|
|
542
591
|
"name": "appId",
|
|
@@ -585,6 +634,9 @@
|
|
|
585
634
|
"summary": "deleteComponent",
|
|
586
635
|
"description": "Delete a specific component from an app version",
|
|
587
636
|
"operationId": "deleteComponent",
|
|
637
|
+
"tags": [
|
|
638
|
+
"App Configuration"
|
|
639
|
+
],
|
|
588
640
|
"parameters": [
|
|
589
641
|
{
|
|
590
642
|
"name": "appId",
|
|
@@ -629,6 +681,9 @@
|
|
|
629
681
|
"summary": "cloneVersion",
|
|
630
682
|
"description": "Clone an existing app version to create a new version",
|
|
631
683
|
"operationId": "cloneVersion",
|
|
684
|
+
"tags": [
|
|
685
|
+
"App Configuration"
|
|
686
|
+
],
|
|
632
687
|
"parameters": [
|
|
633
688
|
{
|
|
634
689
|
"name": "appId",
|
|
@@ -698,6 +753,9 @@
|
|
|
698
753
|
"summary": "listInstallations",
|
|
699
754
|
"description": "Retrieve a list of installed apps for the organization.",
|
|
700
755
|
"operationId": "listInstallations",
|
|
756
|
+
"tags": [
|
|
757
|
+
"App Installation"
|
|
758
|
+
],
|
|
701
759
|
"parameters": [
|
|
702
760
|
{
|
|
703
761
|
"name": "componentType",
|
|
@@ -776,6 +834,9 @@
|
|
|
776
834
|
"summary": "getInstallation",
|
|
777
835
|
"description": "Retrieve details of an installed app by its ID.",
|
|
778
836
|
"operationId": "getInstallation",
|
|
837
|
+
"tags": [
|
|
838
|
+
"App Installation"
|
|
839
|
+
],
|
|
779
840
|
"parameters": [
|
|
780
841
|
{
|
|
781
842
|
"name": "appId",
|
|
@@ -806,6 +867,9 @@
|
|
|
806
867
|
"summary": "install",
|
|
807
868
|
"description": "Upsert app installation by its ID.",
|
|
808
869
|
"operationId": "install",
|
|
870
|
+
"tags": [
|
|
871
|
+
"App Installation"
|
|
872
|
+
],
|
|
809
873
|
"parameters": [
|
|
810
874
|
{
|
|
811
875
|
"name": "appId",
|
|
@@ -832,6 +896,9 @@
|
|
|
832
896
|
"summary": "patchInstallation",
|
|
833
897
|
"description": "Patch an installed app by its ID.",
|
|
834
898
|
"operationId": "patchInstallation",
|
|
899
|
+
"tags": [
|
|
900
|
+
"App Installation"
|
|
901
|
+
],
|
|
835
902
|
"parameters": [
|
|
836
903
|
{
|
|
837
904
|
"name": "appId",
|
|
@@ -858,6 +925,9 @@
|
|
|
858
925
|
"summary": "uninstall",
|
|
859
926
|
"description": "Uninstall an app by its ID.",
|
|
860
927
|
"operationId": "uninstall",
|
|
928
|
+
"tags": [
|
|
929
|
+
"App Installation"
|
|
930
|
+
],
|
|
861
931
|
"parameters": [
|
|
862
932
|
{
|
|
863
933
|
"name": "appId",
|
|
@@ -883,6 +953,9 @@
|
|
|
883
953
|
"summary": "promoteVersion",
|
|
884
954
|
"description": "Update an installed app to a new version",
|
|
885
955
|
"operationId": "promoteVersion",
|
|
956
|
+
"tags": [
|
|
957
|
+
"App Installation"
|
|
958
|
+
],
|
|
886
959
|
"parameters": [
|
|
887
960
|
{
|
|
888
961
|
"name": "appId",
|
|
@@ -1166,15 +1239,6 @@
|
|
|
1166
1239
|
}
|
|
1167
1240
|
}
|
|
1168
1241
|
},
|
|
1169
|
-
"UploadFilePayload": {
|
|
1170
|
-
"type": "object",
|
|
1171
|
-
"properties": {
|
|
1172
|
-
"app_id": {
|
|
1173
|
-
"type": "string",
|
|
1174
|
-
"description": "ID of the app configuration. Required for app updates."
|
|
1175
|
-
}
|
|
1176
|
-
}
|
|
1177
|
-
},
|
|
1178
1242
|
"S3Reference": {
|
|
1179
1243
|
"type": "object",
|
|
1180
1244
|
"properties": {
|
|
@@ -1262,12 +1326,24 @@
|
|
|
1262
1326
|
"description": "Unique identifier for the component"
|
|
1263
1327
|
},
|
|
1264
1328
|
"name": {
|
|
1265
|
-
"
|
|
1266
|
-
|
|
1329
|
+
"allOf": [
|
|
1330
|
+
{
|
|
1331
|
+
"description": "Name of the component"
|
|
1332
|
+
},
|
|
1333
|
+
{
|
|
1334
|
+
"$ref": "#/components/schemas/TranslatedString"
|
|
1335
|
+
}
|
|
1336
|
+
]
|
|
1267
1337
|
},
|
|
1268
1338
|
"description": {
|
|
1269
|
-
"
|
|
1270
|
-
|
|
1339
|
+
"allOf": [
|
|
1340
|
+
{
|
|
1341
|
+
"description": "Description of the component"
|
|
1342
|
+
},
|
|
1343
|
+
{
|
|
1344
|
+
"$ref": "#/components/schemas/TranslatedString"
|
|
1345
|
+
}
|
|
1346
|
+
]
|
|
1271
1347
|
},
|
|
1272
1348
|
"options": {
|
|
1273
1349
|
"type": "array",
|
|
@@ -1499,7 +1575,8 @@
|
|
|
1499
1575
|
"boolean",
|
|
1500
1576
|
"date",
|
|
1501
1577
|
"datetime",
|
|
1502
|
-
"link"
|
|
1578
|
+
"link",
|
|
1579
|
+
"number"
|
|
1503
1580
|
]
|
|
1504
1581
|
}
|
|
1505
1582
|
}
|
|
@@ -1533,12 +1610,24 @@
|
|
|
1533
1610
|
"default": false
|
|
1534
1611
|
},
|
|
1535
1612
|
"description": {
|
|
1536
|
-
"
|
|
1537
|
-
|
|
1613
|
+
"allOf": [
|
|
1614
|
+
{
|
|
1615
|
+
"description": "Description of what this component arg does"
|
|
1616
|
+
},
|
|
1617
|
+
{
|
|
1618
|
+
"$ref": "#/components/schemas/TranslatedString"
|
|
1619
|
+
}
|
|
1620
|
+
]
|
|
1538
1621
|
},
|
|
1539
1622
|
"label": {
|
|
1540
|
-
"
|
|
1541
|
-
|
|
1623
|
+
"allOf": [
|
|
1624
|
+
{
|
|
1625
|
+
"description": "Human-readable label for the component arg"
|
|
1626
|
+
},
|
|
1627
|
+
{
|
|
1628
|
+
"$ref": "#/components/schemas/TranslatedString"
|
|
1629
|
+
}
|
|
1630
|
+
]
|
|
1542
1631
|
}
|
|
1543
1632
|
}
|
|
1544
1633
|
},
|
|
@@ -1621,8 +1710,14 @@
|
|
|
1621
1710
|
"description": "Unique identifier for the option"
|
|
1622
1711
|
},
|
|
1623
1712
|
"label": {
|
|
1624
|
-
"
|
|
1625
|
-
|
|
1713
|
+
"allOf": [
|
|
1714
|
+
{
|
|
1715
|
+
"description": "Display label for the option"
|
|
1716
|
+
},
|
|
1717
|
+
{
|
|
1718
|
+
"$ref": "#/components/schemas/TranslatedString"
|
|
1719
|
+
}
|
|
1720
|
+
]
|
|
1626
1721
|
}
|
|
1627
1722
|
}
|
|
1628
1723
|
}
|
|
@@ -1744,12 +1839,24 @@
|
|
|
1744
1839
|
"description": "URL of the app documentation."
|
|
1745
1840
|
},
|
|
1746
1841
|
"description": {
|
|
1747
|
-
"
|
|
1748
|
-
|
|
1842
|
+
"allOf": [
|
|
1843
|
+
{
|
|
1844
|
+
"description": "Markdown description of the app."
|
|
1845
|
+
},
|
|
1846
|
+
{
|
|
1847
|
+
"$ref": "#/components/schemas/TranslatedString"
|
|
1848
|
+
}
|
|
1849
|
+
]
|
|
1749
1850
|
},
|
|
1750
1851
|
"notifications": {
|
|
1751
|
-
"
|
|
1752
|
-
|
|
1852
|
+
"allOf": [
|
|
1853
|
+
{
|
|
1854
|
+
"description": "Configuration for developer notifications"
|
|
1855
|
+
},
|
|
1856
|
+
{
|
|
1857
|
+
"$ref": "#/components/schemas/NotificationConfig"
|
|
1858
|
+
}
|
|
1859
|
+
]
|
|
1753
1860
|
},
|
|
1754
1861
|
"owner_org_id": {
|
|
1755
1862
|
"type": "string",
|
|
@@ -1763,13 +1870,25 @@
|
|
|
1763
1870
|
"readOnly": true
|
|
1764
1871
|
},
|
|
1765
1872
|
"pricing": {
|
|
1766
|
-
"
|
|
1767
|
-
|
|
1873
|
+
"allOf": [
|
|
1874
|
+
{
|
|
1875
|
+
"description": "Pricing information for the app"
|
|
1876
|
+
},
|
|
1877
|
+
{
|
|
1878
|
+
"$ref": "#/components/schemas/Pricing"
|
|
1879
|
+
}
|
|
1880
|
+
]
|
|
1768
1881
|
},
|
|
1769
1882
|
"configuration_audit": {
|
|
1770
|
-
"
|
|
1771
|
-
"
|
|
1772
|
-
|
|
1883
|
+
"readOnly": true,
|
|
1884
|
+
"allOf": [
|
|
1885
|
+
{
|
|
1886
|
+
"description": "Audit information for the app"
|
|
1887
|
+
},
|
|
1888
|
+
{
|
|
1889
|
+
"$ref": "#/components/schemas/Audit"
|
|
1890
|
+
}
|
|
1891
|
+
]
|
|
1773
1892
|
}
|
|
1774
1893
|
}
|
|
1775
1894
|
},
|
|
@@ -1921,8 +2040,15 @@
|
|
|
1921
2040
|
"readOnly": true
|
|
1922
2041
|
},
|
|
1923
2042
|
"installation_audit": {
|
|
1924
|
-
"
|
|
1925
|
-
"
|
|
2043
|
+
"readOnly": true,
|
|
2044
|
+
"allOf": [
|
|
2045
|
+
{
|
|
2046
|
+
"description": "Audit information for the app"
|
|
2047
|
+
},
|
|
2048
|
+
{
|
|
2049
|
+
"$ref": "#/components/schemas/Audit"
|
|
2050
|
+
}
|
|
2051
|
+
]
|
|
1926
2052
|
}
|
|
1927
2053
|
}
|
|
1928
2054
|
},
|
|
@@ -1969,12 +2095,24 @@
|
|
|
1969
2095
|
"description": "URL of the app documentation."
|
|
1970
2096
|
},
|
|
1971
2097
|
"description": {
|
|
1972
|
-
"
|
|
1973
|
-
|
|
2098
|
+
"allOf": [
|
|
2099
|
+
{
|
|
2100
|
+
"description": "Markdown description of the app."
|
|
2101
|
+
},
|
|
2102
|
+
{
|
|
2103
|
+
"$ref": "#/components/schemas/TranslatedString"
|
|
2104
|
+
}
|
|
2105
|
+
]
|
|
1974
2106
|
},
|
|
1975
2107
|
"pricing": {
|
|
1976
|
-
"
|
|
1977
|
-
|
|
2108
|
+
"allOf": [
|
|
2109
|
+
{
|
|
2110
|
+
"description": "Pricing information for the app"
|
|
2111
|
+
},
|
|
2112
|
+
{
|
|
2113
|
+
"$ref": "#/components/schemas/Pricing"
|
|
2114
|
+
}
|
|
2115
|
+
]
|
|
1978
2116
|
},
|
|
1979
2117
|
"components": {
|
|
1980
2118
|
"type": "array",
|
|
@@ -1996,6 +2134,12 @@
|
|
|
1996
2134
|
"type": "string",
|
|
1997
2135
|
"description": "Version of the app that is installed",
|
|
1998
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
|
|
1999
2143
|
}
|
|
2000
2144
|
}
|
|
2001
2145
|
},
|