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