@epilot/app-client 0.1.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +44 -22
- package/dist/openapi.d.ts +249 -169
- package/dist/openapi.json +138 -44
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -10,8 +10,21 @@ import type {
|
|
|
10
10
|
|
|
11
11
|
declare namespace Components {
|
|
12
12
|
namespace RequestBodies {
|
|
13
|
+
export interface CreateBundlePresignedRequest {
|
|
14
|
+
/**
|
|
15
|
+
* Version of the app
|
|
16
|
+
*/
|
|
17
|
+
version: string;
|
|
18
|
+
/**
|
|
19
|
+
* ID of the journye block component
|
|
20
|
+
*/
|
|
21
|
+
component_id?: string;
|
|
22
|
+
}
|
|
13
23
|
export interface CreateConfigRequest {
|
|
14
|
-
|
|
24
|
+
/**
|
|
25
|
+
* Name of the app
|
|
26
|
+
*/
|
|
27
|
+
name: string;
|
|
15
28
|
description: Schemas.TranslatedString;
|
|
16
29
|
category?: string;
|
|
17
30
|
/**
|
|
@@ -19,7 +32,7 @@ declare namespace Components {
|
|
|
19
32
|
*/
|
|
20
33
|
logo_url_key?: string;
|
|
21
34
|
}
|
|
22
|
-
export interface
|
|
35
|
+
export interface CreateLogoPresignedRequest {
|
|
23
36
|
/**
|
|
24
37
|
* Original filename of the logo
|
|
25
38
|
* example:
|
|
@@ -33,14 +46,17 @@ declare namespace Components {
|
|
|
33
46
|
*/
|
|
34
47
|
mime_type: "image/png" | "image/jpeg" | "image/jpg";
|
|
35
48
|
}
|
|
36
|
-
export interface
|
|
49
|
+
export interface InstallRequest {
|
|
37
50
|
/**
|
|
38
51
|
* Configuration values for the app components
|
|
39
52
|
*/
|
|
40
53
|
option_values?: Schemas.OptionsRef[];
|
|
41
54
|
}
|
|
42
55
|
export interface PatchConfigMetadataRequest {
|
|
43
|
-
|
|
56
|
+
/**
|
|
57
|
+
* Name of the app
|
|
58
|
+
*/
|
|
59
|
+
name?: string;
|
|
44
60
|
description?: Schemas.TranslatedString;
|
|
45
61
|
category?: string;
|
|
46
62
|
documentation_url?: string;
|
|
@@ -55,7 +71,7 @@ declare namespace Components {
|
|
|
55
71
|
*/
|
|
56
72
|
support_email?: string;
|
|
57
73
|
}
|
|
58
|
-
export interface
|
|
74
|
+
export interface PatchVersionRequest {
|
|
59
75
|
/**
|
|
60
76
|
* Updated full list of app components
|
|
61
77
|
*/
|
|
@@ -162,12 +178,19 @@ declare namespace Components {
|
|
|
162
178
|
*/
|
|
163
179
|
export interface Configuration {
|
|
164
180
|
app_id: string;
|
|
165
|
-
|
|
181
|
+
/**
|
|
182
|
+
* Name of the app
|
|
183
|
+
*/
|
|
184
|
+
name: string;
|
|
166
185
|
author?: Author;
|
|
167
186
|
/**
|
|
168
187
|
* List of available versions of the app
|
|
169
188
|
*/
|
|
170
|
-
versions
|
|
189
|
+
versions: string[];
|
|
190
|
+
/**
|
|
191
|
+
* List of available public versions of the app
|
|
192
|
+
*/
|
|
193
|
+
public_versions?: string[];
|
|
171
194
|
/**
|
|
172
195
|
* Email address for support requests
|
|
173
196
|
*/
|
|
@@ -261,12 +284,19 @@ declare namespace Components {
|
|
|
261
284
|
*/
|
|
262
285
|
export interface ConfigurationMetadata {
|
|
263
286
|
app_id: string;
|
|
264
|
-
|
|
287
|
+
/**
|
|
288
|
+
* Name of the app
|
|
289
|
+
*/
|
|
290
|
+
name: string;
|
|
265
291
|
author?: Author;
|
|
266
292
|
/**
|
|
267
293
|
* List of available versions of the app
|
|
268
294
|
*/
|
|
269
|
-
versions
|
|
295
|
+
versions: string[];
|
|
296
|
+
/**
|
|
297
|
+
* List of available public versions of the app
|
|
298
|
+
*/
|
|
299
|
+
public_versions?: string[];
|
|
270
300
|
/**
|
|
271
301
|
* Email address for support requests
|
|
272
302
|
*/
|
|
@@ -428,7 +458,7 @@ declare namespace Components {
|
|
|
428
458
|
/**
|
|
429
459
|
* Name of the app
|
|
430
460
|
*/
|
|
431
|
-
name:
|
|
461
|
+
name: string;
|
|
432
462
|
/**
|
|
433
463
|
* Configuration values for the app components
|
|
434
464
|
*/
|
|
@@ -475,6 +505,10 @@ declare namespace Components {
|
|
|
475
505
|
* Arguments to pass to the component
|
|
476
506
|
*/
|
|
477
507
|
component_args?: JourneyBlockComponentArgs[];
|
|
508
|
+
/**
|
|
509
|
+
* Size of the bundle in bytes
|
|
510
|
+
*/
|
|
511
|
+
component_size?: number;
|
|
478
512
|
/**
|
|
479
513
|
* Define data which is mapped to entity mapping ui blocks
|
|
480
514
|
*/
|
|
@@ -624,7 +658,7 @@ declare namespace Components {
|
|
|
624
658
|
}
|
|
625
659
|
}
|
|
626
660
|
declare namespace Paths {
|
|
627
|
-
namespace
|
|
661
|
+
namespace CloneVersion {
|
|
628
662
|
namespace Parameters {
|
|
629
663
|
export type AppId = string;
|
|
630
664
|
export type SourceVersion = string;
|
|
@@ -647,7 +681,31 @@ declare namespace Paths {
|
|
|
647
681
|
}
|
|
648
682
|
}
|
|
649
683
|
}
|
|
650
|
-
namespace
|
|
684
|
+
namespace CreateBundleUploadUrl {
|
|
685
|
+
namespace Parameters {
|
|
686
|
+
export type AppId = string;
|
|
687
|
+
}
|
|
688
|
+
export interface PathParameters {
|
|
689
|
+
appId: Parameters.AppId;
|
|
690
|
+
}
|
|
691
|
+
export type RequestBody = Components.RequestBodies.CreateBundlePresignedRequest;
|
|
692
|
+
namespace Responses {
|
|
693
|
+
export interface $200 {
|
|
694
|
+
/**
|
|
695
|
+
* Presigned S3 URL for uploading the bundle
|
|
696
|
+
*/
|
|
697
|
+
upload_url: string;
|
|
698
|
+
s3ref?: Components.Schemas.S3Reference;
|
|
699
|
+
/**
|
|
700
|
+
* Timestamp when the upload URL expires
|
|
701
|
+
*/
|
|
702
|
+
expires_at?: string; // date-time
|
|
703
|
+
}
|
|
704
|
+
export interface $404 {
|
|
705
|
+
}
|
|
706
|
+
}
|
|
707
|
+
}
|
|
708
|
+
namespace CreateConfiguration {
|
|
651
709
|
export type RequestBody = Components.RequestBodies.CreateConfigRequest;
|
|
652
710
|
namespace Responses {
|
|
653
711
|
export interface $202 {
|
|
@@ -656,7 +714,7 @@ declare namespace Paths {
|
|
|
656
714
|
}
|
|
657
715
|
}
|
|
658
716
|
namespace CreateLogoUploadUrl {
|
|
659
|
-
export type RequestBody = Components.RequestBodies.
|
|
717
|
+
export type RequestBody = Components.RequestBodies.CreateLogoPresignedRequest;
|
|
660
718
|
namespace Responses {
|
|
661
719
|
export interface $200 {
|
|
662
720
|
/**
|
|
@@ -673,7 +731,15 @@ declare namespace Paths {
|
|
|
673
731
|
}
|
|
674
732
|
}
|
|
675
733
|
}
|
|
676
|
-
namespace
|
|
734
|
+
namespace DeleteLogo {
|
|
735
|
+
namespace Responses {
|
|
736
|
+
export interface $204 {
|
|
737
|
+
}
|
|
738
|
+
export interface $404 {
|
|
739
|
+
}
|
|
740
|
+
}
|
|
741
|
+
}
|
|
742
|
+
namespace DeleteVersion {
|
|
677
743
|
namespace Parameters {
|
|
678
744
|
export type AppId = string;
|
|
679
745
|
export type Version = string;
|
|
@@ -693,15 +759,7 @@ declare namespace Paths {
|
|
|
693
759
|
}
|
|
694
760
|
}
|
|
695
761
|
}
|
|
696
|
-
namespace
|
|
697
|
-
namespace Responses {
|
|
698
|
-
export interface $204 {
|
|
699
|
-
}
|
|
700
|
-
export interface $404 {
|
|
701
|
-
}
|
|
702
|
-
}
|
|
703
|
-
}
|
|
704
|
-
namespace GetAppConfiguration {
|
|
762
|
+
namespace GetConfiguration {
|
|
705
763
|
namespace Parameters {
|
|
706
764
|
export type Version = string;
|
|
707
765
|
}
|
|
@@ -714,42 +772,42 @@ declare namespace Paths {
|
|
|
714
772
|
}
|
|
715
773
|
}
|
|
716
774
|
}
|
|
717
|
-
namespace
|
|
775
|
+
namespace GetInstallation {
|
|
718
776
|
namespace Parameters {
|
|
719
777
|
export type AppId = string;
|
|
720
|
-
export type Version = string;
|
|
721
778
|
}
|
|
722
779
|
export interface PathParameters {
|
|
723
780
|
appId: Parameters.AppId;
|
|
724
|
-
version: Parameters.Version;
|
|
725
781
|
}
|
|
726
782
|
namespace Responses {
|
|
727
|
-
export type $200 = /*
|
|
783
|
+
export type $200 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
|
|
728
784
|
export interface $404 {
|
|
729
785
|
}
|
|
730
786
|
}
|
|
731
787
|
}
|
|
732
|
-
namespace
|
|
788
|
+
namespace GetVersion {
|
|
733
789
|
namespace Parameters {
|
|
734
790
|
export type AppId = string;
|
|
791
|
+
export type Version = string;
|
|
735
792
|
}
|
|
736
793
|
export interface PathParameters {
|
|
737
794
|
appId: Parameters.AppId;
|
|
795
|
+
version: Parameters.Version;
|
|
738
796
|
}
|
|
739
797
|
namespace Responses {
|
|
740
|
-
export type $200 = /*
|
|
798
|
+
export type $200 = /* Configuration of the published app */ Components.Schemas.Configuration;
|
|
741
799
|
export interface $404 {
|
|
742
800
|
}
|
|
743
801
|
}
|
|
744
802
|
}
|
|
745
|
-
namespace
|
|
803
|
+
namespace Install {
|
|
746
804
|
namespace Parameters {
|
|
747
805
|
export type AppId = string;
|
|
748
806
|
}
|
|
749
807
|
export interface PathParameters {
|
|
750
808
|
appId: Parameters.AppId;
|
|
751
809
|
}
|
|
752
|
-
export type RequestBody = Components.RequestBodies.
|
|
810
|
+
export type RequestBody = Components.RequestBodies.InstallRequest;
|
|
753
811
|
namespace Responses {
|
|
754
812
|
export interface $204 {
|
|
755
813
|
}
|
|
@@ -757,18 +815,22 @@ declare namespace Paths {
|
|
|
757
815
|
}
|
|
758
816
|
}
|
|
759
817
|
}
|
|
760
|
-
namespace
|
|
818
|
+
namespace ListAppVersions {
|
|
761
819
|
namespace Parameters {
|
|
820
|
+
export type AppId = string;
|
|
762
821
|
export type Page = number;
|
|
763
822
|
export type PageSize = number;
|
|
764
823
|
}
|
|
824
|
+
export interface PathParameters {
|
|
825
|
+
appId: Parameters.AppId;
|
|
826
|
+
}
|
|
765
827
|
export interface QueryParameters {
|
|
766
828
|
page?: Parameters.Page;
|
|
767
829
|
pageSize?: Parameters.PageSize;
|
|
768
830
|
}
|
|
769
831
|
namespace Responses {
|
|
770
832
|
export interface $200 {
|
|
771
|
-
|
|
833
|
+
versions?: /* Configuration data about your app which is versionable */ Components.Schemas.ConfigurationVersion[];
|
|
772
834
|
pagination?: {
|
|
773
835
|
total?: number;
|
|
774
836
|
page?: number;
|
|
@@ -777,22 +839,18 @@ declare namespace Paths {
|
|
|
777
839
|
}
|
|
778
840
|
}
|
|
779
841
|
}
|
|
780
|
-
namespace
|
|
842
|
+
namespace ListConfigurations {
|
|
781
843
|
namespace Parameters {
|
|
782
|
-
export type AppId = string;
|
|
783
844
|
export type Page = number;
|
|
784
845
|
export type PageSize = number;
|
|
785
846
|
}
|
|
786
|
-
export interface PathParameters {
|
|
787
|
-
appId: Parameters.AppId;
|
|
788
|
-
}
|
|
789
847
|
export interface QueryParameters {
|
|
790
848
|
page?: Parameters.Page;
|
|
791
849
|
pageSize?: Parameters.PageSize;
|
|
792
850
|
}
|
|
793
851
|
namespace Responses {
|
|
794
852
|
export interface $200 {
|
|
795
|
-
|
|
853
|
+
configurations?: /* Basic metadata about your app configuration which does not get versioned */ Components.Schemas.ConfigurationMetadata[];
|
|
796
854
|
pagination?: {
|
|
797
855
|
total?: number;
|
|
798
856
|
page?: number;
|
|
@@ -801,7 +859,7 @@ declare namespace Paths {
|
|
|
801
859
|
}
|
|
802
860
|
}
|
|
803
861
|
}
|
|
804
|
-
namespace
|
|
862
|
+
namespace ListInstallations {
|
|
805
863
|
namespace Parameters {
|
|
806
864
|
export type ComponentType = /* Type of app component */ Components.Schemas.ComponentType;
|
|
807
865
|
export type Enabled = boolean;
|
|
@@ -825,8 +883,14 @@ declare namespace Paths {
|
|
|
825
883
|
}
|
|
826
884
|
}
|
|
827
885
|
}
|
|
828
|
-
namespace
|
|
829
|
-
|
|
886
|
+
namespace PatchInstallation {
|
|
887
|
+
namespace Parameters {
|
|
888
|
+
export type AppId = string;
|
|
889
|
+
}
|
|
890
|
+
export interface PathParameters {
|
|
891
|
+
appId: Parameters.AppId;
|
|
892
|
+
}
|
|
893
|
+
export type RequestBody = Components.RequestBodies.InstallRequest;
|
|
830
894
|
namespace Responses {
|
|
831
895
|
export interface $204 {
|
|
832
896
|
}
|
|
@@ -834,14 +898,8 @@ declare namespace Paths {
|
|
|
834
898
|
}
|
|
835
899
|
}
|
|
836
900
|
}
|
|
837
|
-
namespace
|
|
838
|
-
|
|
839
|
-
export type AppId = string;
|
|
840
|
-
}
|
|
841
|
-
export interface PathParameters {
|
|
842
|
-
appId: Parameters.AppId;
|
|
843
|
-
}
|
|
844
|
-
export type RequestBody = Components.RequestBodies.InstallAppRequest;
|
|
901
|
+
namespace PatchMetadata {
|
|
902
|
+
export type RequestBody = Components.RequestBodies.PatchConfigMetadataRequest;
|
|
845
903
|
namespace Responses {
|
|
846
904
|
export interface $204 {
|
|
847
905
|
}
|
|
@@ -849,7 +907,7 @@ declare namespace Paths {
|
|
|
849
907
|
}
|
|
850
908
|
}
|
|
851
909
|
}
|
|
852
|
-
namespace
|
|
910
|
+
namespace PatchVersion {
|
|
853
911
|
namespace Parameters {
|
|
854
912
|
export type AppId = string;
|
|
855
913
|
export type Version = string;
|
|
@@ -858,43 +916,43 @@ declare namespace Paths {
|
|
|
858
916
|
appId: Parameters.AppId;
|
|
859
917
|
version: Parameters.Version;
|
|
860
918
|
}
|
|
919
|
+
export type RequestBody = Components.RequestBodies.PatchVersionRequest;
|
|
861
920
|
namespace Responses {
|
|
862
|
-
export
|
|
921
|
+
export interface $204 {
|
|
922
|
+
}
|
|
863
923
|
export interface $400 {
|
|
864
924
|
}
|
|
865
925
|
export interface $404 {
|
|
866
926
|
}
|
|
867
927
|
}
|
|
868
928
|
}
|
|
869
|
-
namespace
|
|
929
|
+
namespace PromoteVersion {
|
|
870
930
|
namespace Parameters {
|
|
871
931
|
export type AppId = string;
|
|
932
|
+
export type Version = string;
|
|
872
933
|
}
|
|
873
934
|
export interface PathParameters {
|
|
874
935
|
appId: Parameters.AppId;
|
|
936
|
+
version: Parameters.Version;
|
|
875
937
|
}
|
|
876
938
|
namespace Responses {
|
|
877
|
-
export
|
|
939
|
+
export type $200 = /* Information about the installed app. Has configuration data of the installed version */ Components.Schemas.Installation;
|
|
940
|
+
export interface $400 {
|
|
878
941
|
}
|
|
879
942
|
export interface $404 {
|
|
880
943
|
}
|
|
881
944
|
}
|
|
882
945
|
}
|
|
883
|
-
namespace
|
|
946
|
+
namespace Uninstall {
|
|
884
947
|
namespace Parameters {
|
|
885
948
|
export type AppId = string;
|
|
886
|
-
export type Version = string;
|
|
887
949
|
}
|
|
888
950
|
export interface PathParameters {
|
|
889
951
|
appId: Parameters.AppId;
|
|
890
|
-
version: Parameters.Version;
|
|
891
952
|
}
|
|
892
|
-
export type RequestBody = Components.RequestBodies.UpdateVersionRequest;
|
|
893
953
|
namespace Responses {
|
|
894
954
|
export interface $204 {
|
|
895
955
|
}
|
|
896
|
-
export interface $400 {
|
|
897
|
-
}
|
|
898
956
|
export interface $404 {
|
|
899
957
|
}
|
|
900
958
|
}
|
|
@@ -919,45 +977,55 @@ declare namespace Paths {
|
|
|
919
977
|
|
|
920
978
|
export interface OperationMethods {
|
|
921
979
|
/**
|
|
922
|
-
*
|
|
980
|
+
* listConfigurations - listConfigurations
|
|
923
981
|
*
|
|
924
982
|
* List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.
|
|
925
983
|
*/
|
|
926
|
-
'
|
|
927
|
-
parameters?: Parameters<Paths.
|
|
984
|
+
'listConfigurations'(
|
|
985
|
+
parameters?: Parameters<Paths.ListConfigurations.QueryParameters> | null,
|
|
928
986
|
data?: any,
|
|
929
987
|
config?: AxiosRequestConfig
|
|
930
|
-
): OperationResponse<Paths.
|
|
988
|
+
): OperationResponse<Paths.ListConfigurations.Responses.$200>
|
|
931
989
|
/**
|
|
932
|
-
*
|
|
990
|
+
* createConfiguration - createConfiguration
|
|
933
991
|
*
|
|
934
992
|
* Create a new private app configuration. To make it public a verification process needs to be triggered
|
|
935
993
|
*/
|
|
936
|
-
'
|
|
994
|
+
'createConfiguration'(
|
|
937
995
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
938
|
-
data?: Paths.
|
|
996
|
+
data?: Paths.CreateConfiguration.RequestBody,
|
|
939
997
|
config?: AxiosRequestConfig
|
|
940
|
-
): OperationResponse<Paths.
|
|
998
|
+
): OperationResponse<Paths.CreateConfiguration.Responses.$202>
|
|
941
999
|
/**
|
|
942
|
-
*
|
|
1000
|
+
* getConfiguration - getConfiguration
|
|
943
1001
|
*
|
|
944
1002
|
* Retrieve a specific app configuration
|
|
945
1003
|
*/
|
|
946
|
-
'
|
|
947
|
-
parameters?: Parameters<Paths.
|
|
1004
|
+
'getConfiguration'(
|
|
1005
|
+
parameters?: Parameters<Paths.GetConfiguration.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
|
|
948
1006
|
data?: any,
|
|
949
1007
|
config?: AxiosRequestConfig
|
|
950
|
-
): OperationResponse<Paths.
|
|
1008
|
+
): OperationResponse<Paths.GetConfiguration.Responses.$200>
|
|
951
1009
|
/**
|
|
952
|
-
*
|
|
1010
|
+
* patchMetadata - patchMetadata
|
|
953
1011
|
*
|
|
954
1012
|
* Patch non-versioned configuration metadata of a given app configuration.
|
|
955
1013
|
*/
|
|
956
|
-
'
|
|
1014
|
+
'patchMetadata'(
|
|
957
1015
|
parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
|
|
958
|
-
data?: Paths.
|
|
1016
|
+
data?: Paths.PatchMetadata.RequestBody,
|
|
1017
|
+
config?: AxiosRequestConfig
|
|
1018
|
+
): OperationResponse<Paths.PatchMetadata.Responses.$204>
|
|
1019
|
+
/**
|
|
1020
|
+
* createBundleUploadUrl - createBundleUploadUrl
|
|
1021
|
+
*
|
|
1022
|
+
* Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path
|
|
1023
|
+
*/
|
|
1024
|
+
'createBundleUploadUrl'(
|
|
1025
|
+
parameters?: Parameters<Paths.CreateBundleUploadUrl.PathParameters> | null,
|
|
1026
|
+
data?: Paths.CreateBundleUploadUrl.RequestBody,
|
|
959
1027
|
config?: AxiosRequestConfig
|
|
960
|
-
): OperationResponse<Paths.
|
|
1028
|
+
): OperationResponse<Paths.CreateBundleUploadUrl.Responses.$200>
|
|
961
1029
|
/**
|
|
962
1030
|
* createLogoUploadUrl - createLogoUploadUrl
|
|
963
1031
|
*
|
|
@@ -979,7 +1047,7 @@ export interface OperationMethods {
|
|
|
979
1047
|
config?: AxiosRequestConfig
|
|
980
1048
|
): OperationResponse<Paths.DeleteLogo.Responses.$204>
|
|
981
1049
|
/**
|
|
982
|
-
* listAppVersions -
|
|
1050
|
+
* listAppVersions - listVersions
|
|
983
1051
|
*
|
|
984
1052
|
* Retrieve a list of versions for an app configuration
|
|
985
1053
|
*/
|
|
@@ -989,151 +1057,163 @@ export interface OperationMethods {
|
|
|
989
1057
|
config?: AxiosRequestConfig
|
|
990
1058
|
): OperationResponse<Paths.ListAppVersions.Responses.$200>
|
|
991
1059
|
/**
|
|
992
|
-
*
|
|
1060
|
+
* getVersion - getVersion
|
|
993
1061
|
*
|
|
994
1062
|
* Retrieve a specific version of an app configuration
|
|
995
1063
|
*/
|
|
996
|
-
'
|
|
997
|
-
parameters?: Parameters<Paths.
|
|
1064
|
+
'getVersion'(
|
|
1065
|
+
parameters?: Parameters<Paths.GetVersion.PathParameters> | null,
|
|
998
1066
|
data?: any,
|
|
999
1067
|
config?: AxiosRequestConfig
|
|
1000
|
-
): OperationResponse<Paths.
|
|
1068
|
+
): OperationResponse<Paths.GetVersion.Responses.$200>
|
|
1001
1069
|
/**
|
|
1002
|
-
*
|
|
1070
|
+
* patchVersion - patchVersion
|
|
1003
1071
|
*
|
|
1004
|
-
*
|
|
1072
|
+
* Patch version specific data of a configuration
|
|
1005
1073
|
*/
|
|
1006
|
-
'
|
|
1007
|
-
parameters?: Parameters<Paths.
|
|
1008
|
-
data?: Paths.
|
|
1074
|
+
'patchVersion'(
|
|
1075
|
+
parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
|
|
1076
|
+
data?: Paths.PatchVersion.RequestBody,
|
|
1009
1077
|
config?: AxiosRequestConfig
|
|
1010
|
-
): OperationResponse<Paths.
|
|
1078
|
+
): OperationResponse<Paths.PatchVersion.Responses.$204>
|
|
1011
1079
|
/**
|
|
1012
|
-
*
|
|
1080
|
+
* deleteVersion - deleteVersion
|
|
1013
1081
|
*
|
|
1014
1082
|
* Delete a specific version of an app configuration
|
|
1015
1083
|
*/
|
|
1016
|
-
'
|
|
1017
|
-
parameters?: Parameters<Paths.
|
|
1084
|
+
'deleteVersion'(
|
|
1085
|
+
parameters?: Parameters<Paths.DeleteVersion.PathParameters> | null,
|
|
1018
1086
|
data?: any,
|
|
1019
1087
|
config?: AxiosRequestConfig
|
|
1020
|
-
): OperationResponse<Paths.
|
|
1088
|
+
): OperationResponse<Paths.DeleteVersion.Responses.$204>
|
|
1021
1089
|
/**
|
|
1022
|
-
*
|
|
1090
|
+
* cloneVersion - cloneVersion
|
|
1023
1091
|
*
|
|
1024
1092
|
* Clone an existing app version to create a new version
|
|
1025
1093
|
*/
|
|
1026
|
-
'
|
|
1027
|
-
parameters?: Parameters<Paths.
|
|
1094
|
+
'cloneVersion'(
|
|
1095
|
+
parameters?: Parameters<Paths.CloneVersion.PathParameters> | null,
|
|
1028
1096
|
data?: any,
|
|
1029
1097
|
config?: AxiosRequestConfig
|
|
1030
|
-
): OperationResponse<Paths.
|
|
1098
|
+
): OperationResponse<Paths.CloneVersion.Responses.$201>
|
|
1031
1099
|
/**
|
|
1032
|
-
*
|
|
1100
|
+
* listInstallations - listInstallations
|
|
1033
1101
|
*
|
|
1034
1102
|
* Retrieve a list of installed apps for the organization.
|
|
1035
1103
|
*/
|
|
1036
|
-
'
|
|
1037
|
-
parameters?: Parameters<Paths.
|
|
1104
|
+
'listInstallations'(
|
|
1105
|
+
parameters?: Parameters<Paths.ListInstallations.QueryParameters> | null,
|
|
1038
1106
|
data?: any,
|
|
1039
1107
|
config?: AxiosRequestConfig
|
|
1040
|
-
): OperationResponse<Paths.
|
|
1108
|
+
): OperationResponse<Paths.ListInstallations.Responses.$200>
|
|
1041
1109
|
/**
|
|
1042
|
-
*
|
|
1110
|
+
* getInstallation - getInstallation
|
|
1043
1111
|
*
|
|
1044
1112
|
* Retrieve details of an installed app by its ID.
|
|
1045
1113
|
*/
|
|
1046
|
-
'
|
|
1047
|
-
parameters?: Parameters<Paths.
|
|
1114
|
+
'getInstallation'(
|
|
1115
|
+
parameters?: Parameters<Paths.GetInstallation.PathParameters> | null,
|
|
1048
1116
|
data?: any,
|
|
1049
1117
|
config?: AxiosRequestConfig
|
|
1050
|
-
): OperationResponse<Paths.
|
|
1118
|
+
): OperationResponse<Paths.GetInstallation.Responses.$200>
|
|
1051
1119
|
/**
|
|
1052
|
-
*
|
|
1120
|
+
* install - install
|
|
1053
1121
|
*
|
|
1054
1122
|
* Upsert app installation by its ID.
|
|
1055
1123
|
*/
|
|
1056
|
-
'
|
|
1057
|
-
parameters?: Parameters<Paths.
|
|
1058
|
-
data?: Paths.
|
|
1124
|
+
'install'(
|
|
1125
|
+
parameters?: Parameters<Paths.Install.PathParameters> | null,
|
|
1126
|
+
data?: Paths.Install.RequestBody,
|
|
1059
1127
|
config?: AxiosRequestConfig
|
|
1060
|
-
): OperationResponse<Paths.
|
|
1128
|
+
): OperationResponse<Paths.Install.Responses.$204>
|
|
1061
1129
|
/**
|
|
1062
|
-
*
|
|
1130
|
+
* patchInstallation - patchInstallation
|
|
1063
1131
|
*
|
|
1064
1132
|
* Patch an installed app by its ID.
|
|
1065
1133
|
*/
|
|
1066
|
-
'
|
|
1067
|
-
parameters?: Parameters<Paths.
|
|
1068
|
-
data?: Paths.
|
|
1134
|
+
'patchInstallation'(
|
|
1135
|
+
parameters?: Parameters<Paths.PatchInstallation.PathParameters> | null,
|
|
1136
|
+
data?: Paths.PatchInstallation.RequestBody,
|
|
1069
1137
|
config?: AxiosRequestConfig
|
|
1070
|
-
): OperationResponse<Paths.
|
|
1138
|
+
): OperationResponse<Paths.PatchInstallation.Responses.$204>
|
|
1071
1139
|
/**
|
|
1072
|
-
*
|
|
1140
|
+
* uninstall - uninstall
|
|
1073
1141
|
*
|
|
1074
1142
|
* Uninstall an app by its ID.
|
|
1075
1143
|
*/
|
|
1076
|
-
'
|
|
1077
|
-
parameters?: Parameters<Paths.
|
|
1144
|
+
'uninstall'(
|
|
1145
|
+
parameters?: Parameters<Paths.Uninstall.PathParameters> | null,
|
|
1078
1146
|
data?: any,
|
|
1079
1147
|
config?: AxiosRequestConfig
|
|
1080
|
-
): OperationResponse<Paths.
|
|
1148
|
+
): OperationResponse<Paths.Uninstall.Responses.$204>
|
|
1081
1149
|
/**
|
|
1082
|
-
*
|
|
1150
|
+
* promoteVersion - promoteVersion
|
|
1083
1151
|
*
|
|
1084
1152
|
* Update an installed app to a new version
|
|
1085
1153
|
*/
|
|
1086
|
-
'
|
|
1087
|
-
parameters?: Parameters<Paths.
|
|
1154
|
+
'promoteVersion'(
|
|
1155
|
+
parameters?: Parameters<Paths.PromoteVersion.PathParameters> | null,
|
|
1088
1156
|
data?: any,
|
|
1089
1157
|
config?: AxiosRequestConfig
|
|
1090
|
-
): OperationResponse<Paths.
|
|
1158
|
+
): OperationResponse<Paths.PromoteVersion.Responses.$200>
|
|
1091
1159
|
}
|
|
1092
1160
|
|
|
1093
1161
|
export interface PathsDictionary {
|
|
1094
1162
|
['/v1/app-configurations']: {
|
|
1095
1163
|
/**
|
|
1096
|
-
*
|
|
1164
|
+
* listConfigurations - listConfigurations
|
|
1097
1165
|
*
|
|
1098
1166
|
* List all app configuration metadata owned by an organization. To get full app configuration details, use the /v1/app-configurations/{appId} endpoint.
|
|
1099
1167
|
*/
|
|
1100
1168
|
'get'(
|
|
1101
|
-
parameters?: Parameters<Paths.
|
|
1169
|
+
parameters?: Parameters<Paths.ListConfigurations.QueryParameters> | null,
|
|
1102
1170
|
data?: any,
|
|
1103
1171
|
config?: AxiosRequestConfig
|
|
1104
|
-
): OperationResponse<Paths.
|
|
1172
|
+
): OperationResponse<Paths.ListConfigurations.Responses.$200>
|
|
1105
1173
|
/**
|
|
1106
|
-
*
|
|
1174
|
+
* createConfiguration - createConfiguration
|
|
1107
1175
|
*
|
|
1108
1176
|
* Create a new private app configuration. To make it public a verification process needs to be triggered
|
|
1109
1177
|
*/
|
|
1110
1178
|
'post'(
|
|
1111
1179
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1112
|
-
data?: Paths.
|
|
1180
|
+
data?: Paths.CreateConfiguration.RequestBody,
|
|
1113
1181
|
config?: AxiosRequestConfig
|
|
1114
|
-
): OperationResponse<Paths.
|
|
1182
|
+
): OperationResponse<Paths.CreateConfiguration.Responses.$202>
|
|
1115
1183
|
}
|
|
1116
1184
|
['/v1/app-configurations/{appId}']: {
|
|
1117
1185
|
/**
|
|
1118
|
-
*
|
|
1186
|
+
* getConfiguration - getConfiguration
|
|
1119
1187
|
*
|
|
1120
1188
|
* Retrieve a specific app configuration
|
|
1121
1189
|
*/
|
|
1122
1190
|
'get'(
|
|
1123
|
-
parameters?: Parameters<Paths.
|
|
1191
|
+
parameters?: Parameters<Paths.GetConfiguration.QueryParameters & Paths.V1AppConfigurations$AppId.PathParameters> | null,
|
|
1124
1192
|
data?: any,
|
|
1125
1193
|
config?: AxiosRequestConfig
|
|
1126
|
-
): OperationResponse<Paths.
|
|
1194
|
+
): OperationResponse<Paths.GetConfiguration.Responses.$200>
|
|
1127
1195
|
/**
|
|
1128
|
-
*
|
|
1196
|
+
* patchMetadata - patchMetadata
|
|
1129
1197
|
*
|
|
1130
1198
|
* Patch non-versioned configuration metadata of a given app configuration.
|
|
1131
1199
|
*/
|
|
1132
1200
|
'patch'(
|
|
1133
1201
|
parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
|
|
1134
|
-
data?: Paths.
|
|
1202
|
+
data?: Paths.PatchMetadata.RequestBody,
|
|
1135
1203
|
config?: AxiosRequestConfig
|
|
1136
|
-
): OperationResponse<Paths.
|
|
1204
|
+
): OperationResponse<Paths.PatchMetadata.Responses.$204>
|
|
1205
|
+
}
|
|
1206
|
+
['/v1/app-configurations/{appId}/bundle']: {
|
|
1207
|
+
/**
|
|
1208
|
+
* createBundleUploadUrl - createBundleUploadUrl
|
|
1209
|
+
*
|
|
1210
|
+
* Generate a presigned URL for uploading app bundle to /<app-id>/bundle.zip path
|
|
1211
|
+
*/
|
|
1212
|
+
'post'(
|
|
1213
|
+
parameters?: Parameters<Paths.CreateBundleUploadUrl.PathParameters> | null,
|
|
1214
|
+
data?: Paths.CreateBundleUploadUrl.RequestBody,
|
|
1215
|
+
config?: AxiosRequestConfig
|
|
1216
|
+
): OperationResponse<Paths.CreateBundleUploadUrl.Responses.$200>
|
|
1137
1217
|
}
|
|
1138
1218
|
['/v1/app-configurations/{appId}/logo']: {
|
|
1139
1219
|
/**
|
|
@@ -1159,7 +1239,7 @@ export interface PathsDictionary {
|
|
|
1159
1239
|
}
|
|
1160
1240
|
['/v1/app-configurations/{appId}/versions']: {
|
|
1161
1241
|
/**
|
|
1162
|
-
* listAppVersions -
|
|
1242
|
+
* listAppVersions - listVersions
|
|
1163
1243
|
*
|
|
1164
1244
|
* Retrieve a list of versions for an app configuration
|
|
1165
1245
|
*/
|
|
@@ -1171,113 +1251,113 @@ export interface PathsDictionary {
|
|
|
1171
1251
|
}
|
|
1172
1252
|
['/v1/app-configurations/{appId}/versions/{version}']: {
|
|
1173
1253
|
/**
|
|
1174
|
-
*
|
|
1254
|
+
* getVersion - getVersion
|
|
1175
1255
|
*
|
|
1176
1256
|
* Retrieve a specific version of an app configuration
|
|
1177
1257
|
*/
|
|
1178
1258
|
'get'(
|
|
1179
|
-
parameters?: Parameters<Paths.
|
|
1259
|
+
parameters?: Parameters<Paths.GetVersion.PathParameters> | null,
|
|
1180
1260
|
data?: any,
|
|
1181
1261
|
config?: AxiosRequestConfig
|
|
1182
|
-
): OperationResponse<Paths.
|
|
1262
|
+
): OperationResponse<Paths.GetVersion.Responses.$200>
|
|
1183
1263
|
/**
|
|
1184
|
-
*
|
|
1264
|
+
* deleteVersion - deleteVersion
|
|
1185
1265
|
*
|
|
1186
1266
|
* Delete a specific version of an app configuration
|
|
1187
1267
|
*/
|
|
1188
1268
|
'delete'(
|
|
1189
|
-
parameters?: Parameters<Paths.
|
|
1269
|
+
parameters?: Parameters<Paths.DeleteVersion.PathParameters> | null,
|
|
1190
1270
|
data?: any,
|
|
1191
1271
|
config?: AxiosRequestConfig
|
|
1192
|
-
): OperationResponse<Paths.
|
|
1272
|
+
): OperationResponse<Paths.DeleteVersion.Responses.$204>
|
|
1193
1273
|
/**
|
|
1194
|
-
*
|
|
1274
|
+
* patchVersion - patchVersion
|
|
1195
1275
|
*
|
|
1196
|
-
*
|
|
1276
|
+
* Patch version specific data of a configuration
|
|
1197
1277
|
*/
|
|
1198
|
-
'
|
|
1199
|
-
parameters?: Parameters<Paths.
|
|
1200
|
-
data?: Paths.
|
|
1278
|
+
'patch'(
|
|
1279
|
+
parameters?: Parameters<Paths.PatchVersion.PathParameters> | null,
|
|
1280
|
+
data?: Paths.PatchVersion.RequestBody,
|
|
1201
1281
|
config?: AxiosRequestConfig
|
|
1202
|
-
): OperationResponse<Paths.
|
|
1282
|
+
): OperationResponse<Paths.PatchVersion.Responses.$204>
|
|
1203
1283
|
}
|
|
1204
1284
|
['/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}']: {
|
|
1205
1285
|
/**
|
|
1206
|
-
*
|
|
1286
|
+
* cloneVersion - cloneVersion
|
|
1207
1287
|
*
|
|
1208
1288
|
* Clone an existing app version to create a new version
|
|
1209
1289
|
*/
|
|
1210
1290
|
'post'(
|
|
1211
|
-
parameters?: Parameters<Paths.
|
|
1291
|
+
parameters?: Parameters<Paths.CloneVersion.PathParameters> | null,
|
|
1212
1292
|
data?: any,
|
|
1213
1293
|
config?: AxiosRequestConfig
|
|
1214
|
-
): OperationResponse<Paths.
|
|
1294
|
+
): OperationResponse<Paths.CloneVersion.Responses.$201>
|
|
1215
1295
|
}
|
|
1216
1296
|
['/v1/app']: {
|
|
1217
1297
|
/**
|
|
1218
|
-
*
|
|
1298
|
+
* listInstallations - listInstallations
|
|
1219
1299
|
*
|
|
1220
1300
|
* Retrieve a list of installed apps for the organization.
|
|
1221
1301
|
*/
|
|
1222
1302
|
'get'(
|
|
1223
|
-
parameters?: Parameters<Paths.
|
|
1303
|
+
parameters?: Parameters<Paths.ListInstallations.QueryParameters> | null,
|
|
1224
1304
|
data?: any,
|
|
1225
1305
|
config?: AxiosRequestConfig
|
|
1226
|
-
): OperationResponse<Paths.
|
|
1306
|
+
): OperationResponse<Paths.ListInstallations.Responses.$200>
|
|
1227
1307
|
}
|
|
1228
1308
|
['/v1/app/{appId}']: {
|
|
1229
1309
|
/**
|
|
1230
|
-
*
|
|
1310
|
+
* getInstallation - getInstallation
|
|
1231
1311
|
*
|
|
1232
1312
|
* Retrieve details of an installed app by its ID.
|
|
1233
1313
|
*/
|
|
1234
1314
|
'get'(
|
|
1235
|
-
parameters?: Parameters<Paths.
|
|
1315
|
+
parameters?: Parameters<Paths.GetInstallation.PathParameters> | null,
|
|
1236
1316
|
data?: any,
|
|
1237
1317
|
config?: AxiosRequestConfig
|
|
1238
|
-
): OperationResponse<Paths.
|
|
1318
|
+
): OperationResponse<Paths.GetInstallation.Responses.$200>
|
|
1239
1319
|
/**
|
|
1240
|
-
*
|
|
1320
|
+
* install - install
|
|
1241
1321
|
*
|
|
1242
1322
|
* Upsert app installation by its ID.
|
|
1243
1323
|
*/
|
|
1244
1324
|
'post'(
|
|
1245
|
-
parameters?: Parameters<Paths.
|
|
1246
|
-
data?: Paths.
|
|
1325
|
+
parameters?: Parameters<Paths.Install.PathParameters> | null,
|
|
1326
|
+
data?: Paths.Install.RequestBody,
|
|
1247
1327
|
config?: AxiosRequestConfig
|
|
1248
|
-
): OperationResponse<Paths.
|
|
1328
|
+
): OperationResponse<Paths.Install.Responses.$204>
|
|
1249
1329
|
/**
|
|
1250
|
-
*
|
|
1330
|
+
* patchInstallation - patchInstallation
|
|
1251
1331
|
*
|
|
1252
1332
|
* Patch an installed app by its ID.
|
|
1253
1333
|
*/
|
|
1254
1334
|
'patch'(
|
|
1255
|
-
parameters?: Parameters<Paths.
|
|
1256
|
-
data?: Paths.
|
|
1335
|
+
parameters?: Parameters<Paths.PatchInstallation.PathParameters> | null,
|
|
1336
|
+
data?: Paths.PatchInstallation.RequestBody,
|
|
1257
1337
|
config?: AxiosRequestConfig
|
|
1258
|
-
): OperationResponse<Paths.
|
|
1338
|
+
): OperationResponse<Paths.PatchInstallation.Responses.$204>
|
|
1259
1339
|
/**
|
|
1260
|
-
*
|
|
1340
|
+
* uninstall - uninstall
|
|
1261
1341
|
*
|
|
1262
1342
|
* Uninstall an app by its ID.
|
|
1263
1343
|
*/
|
|
1264
1344
|
'delete'(
|
|
1265
|
-
parameters?: Parameters<Paths.
|
|
1345
|
+
parameters?: Parameters<Paths.Uninstall.PathParameters> | null,
|
|
1266
1346
|
data?: any,
|
|
1267
1347
|
config?: AxiosRequestConfig
|
|
1268
|
-
): OperationResponse<Paths.
|
|
1348
|
+
): OperationResponse<Paths.Uninstall.Responses.$204>
|
|
1269
1349
|
}
|
|
1270
1350
|
['/v1/app/{appId}/promote-to/{version}']: {
|
|
1271
1351
|
/**
|
|
1272
|
-
*
|
|
1352
|
+
* promoteVersion - promoteVersion
|
|
1273
1353
|
*
|
|
1274
1354
|
* Update an installed app to a new version
|
|
1275
1355
|
*/
|
|
1276
1356
|
'post'(
|
|
1277
|
-
parameters?: Parameters<Paths.
|
|
1357
|
+
parameters?: Parameters<Paths.PromoteVersion.PathParameters> | null,
|
|
1278
1358
|
data?: any,
|
|
1279
1359
|
config?: AxiosRequestConfig
|
|
1280
|
-
): OperationResponse<Paths.
|
|
1360
|
+
): OperationResponse<Paths.PromoteVersion.Responses.$200>
|
|
1281
1361
|
}
|
|
1282
1362
|
}
|
|
1283
1363
|
|