@envsync-cloud/envsync-ts-sdk 0.3.0 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +724 -5
- package/dist/index.d.ts +724 -5
- package/dist/index.global.js +744 -9
- package/dist/index.js +768 -11
- package/dist/index.mjs +756 -10
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -198,6 +198,8 @@ declare class ApiKeysService {
|
|
|
198
198
|
type CreateAppRequest = {
|
|
199
199
|
name: string;
|
|
200
200
|
description: string;
|
|
201
|
+
enable_secrets?: boolean;
|
|
202
|
+
public_key?: string;
|
|
201
203
|
metadata?: Record<string, any>;
|
|
202
204
|
};
|
|
203
205
|
|
|
@@ -215,8 +217,12 @@ type GetAppResponse = {
|
|
|
215
217
|
name: string;
|
|
216
218
|
description: string;
|
|
217
219
|
metadata: Record<string, any>;
|
|
220
|
+
enable_secrets: boolean;
|
|
221
|
+
is_managed_secret: boolean;
|
|
222
|
+
public_key?: string;
|
|
218
223
|
org_id: string;
|
|
219
224
|
envCount: number;
|
|
225
|
+
secretCount: number;
|
|
220
226
|
env_types: Array<{
|
|
221
227
|
id: string;
|
|
222
228
|
name: string;
|
|
@@ -232,9 +238,13 @@ type GetAppsResponse = Array<{
|
|
|
232
238
|
id: string;
|
|
233
239
|
name: string;
|
|
234
240
|
description: string;
|
|
241
|
+
enable_secrets: boolean;
|
|
242
|
+
is_managed_secret: boolean;
|
|
243
|
+
public_key?: string;
|
|
235
244
|
metadata: Record<string, any>;
|
|
236
245
|
org_id: string;
|
|
237
246
|
envCount: number;
|
|
247
|
+
secretCount: number;
|
|
238
248
|
env_types: Array<{
|
|
239
249
|
id: string;
|
|
240
250
|
name: string;
|
|
@@ -551,6 +561,15 @@ declare class EnvironmentVariablesService {
|
|
|
551
561
|
* @throws ApiError
|
|
552
562
|
*/
|
|
553
563
|
getEnv(key: string, requestBody?: GetEnvRequest): CancelablePromise<EnvResponse>;
|
|
564
|
+
/**
|
|
565
|
+
* Update Environment Variable
|
|
566
|
+
* Update an existing environment variable
|
|
567
|
+
* @param key
|
|
568
|
+
* @param requestBody
|
|
569
|
+
* @returns EnvResponse Environment variable updated successfully
|
|
570
|
+
* @throws ApiError
|
|
571
|
+
*/
|
|
572
|
+
updateEnv(key: string, requestBody?: UpdateEnvRequest): CancelablePromise<EnvResponse>;
|
|
554
573
|
/**
|
|
555
574
|
* Create Environment Variable
|
|
556
575
|
* Create a new environment variable
|
|
@@ -583,15 +602,224 @@ declare class EnvironmentVariablesService {
|
|
|
583
602
|
* @throws ApiError
|
|
584
603
|
*/
|
|
585
604
|
deleteBatchEnv(requestBody?: BatchDeleteEnvsRequest): CancelablePromise<BatchEnvsResponse>;
|
|
605
|
+
}
|
|
606
|
+
|
|
607
|
+
type EnvDiffRequest = {
|
|
608
|
+
app_id: string;
|
|
609
|
+
env_type_id: string;
|
|
610
|
+
from_pit_id: string;
|
|
611
|
+
to_pit_id: string;
|
|
612
|
+
};
|
|
613
|
+
|
|
614
|
+
type EnvDiffResponse = {
|
|
615
|
+
added: Array<{
|
|
616
|
+
key: string;
|
|
617
|
+
value: string;
|
|
618
|
+
}>;
|
|
619
|
+
modified: Array<{
|
|
620
|
+
key: string;
|
|
621
|
+
old_value: string;
|
|
622
|
+
new_value: string;
|
|
623
|
+
}>;
|
|
624
|
+
deleted: Array<{
|
|
625
|
+
key: string;
|
|
626
|
+
value: string;
|
|
627
|
+
}>;
|
|
628
|
+
};
|
|
629
|
+
|
|
630
|
+
type EnvHistoryRequest = {
|
|
631
|
+
app_id: string;
|
|
632
|
+
env_type_id: string;
|
|
633
|
+
page?: number;
|
|
634
|
+
per_page?: number;
|
|
635
|
+
};
|
|
636
|
+
|
|
637
|
+
type EnvHistoryResponse = {
|
|
638
|
+
pits: Array<{
|
|
639
|
+
id: string;
|
|
640
|
+
org_id: string;
|
|
641
|
+
app_id: string;
|
|
642
|
+
env_type_id: string;
|
|
643
|
+
change_request_message: string;
|
|
644
|
+
user_id: string;
|
|
645
|
+
created_at: string;
|
|
646
|
+
updated_at: string;
|
|
647
|
+
}>;
|
|
648
|
+
totalPages: number;
|
|
649
|
+
};
|
|
650
|
+
|
|
651
|
+
type EnvPitRequest = {
|
|
652
|
+
app_id: string;
|
|
653
|
+
env_type_id: string;
|
|
654
|
+
pit_id: string;
|
|
655
|
+
};
|
|
656
|
+
|
|
657
|
+
type EnvPitStateResponse = Array<{
|
|
658
|
+
key: string;
|
|
659
|
+
value: string;
|
|
660
|
+
last_updated: string;
|
|
661
|
+
}>;
|
|
662
|
+
|
|
663
|
+
type EnvTimestampRequest = {
|
|
664
|
+
app_id: string;
|
|
665
|
+
env_type_id: string;
|
|
666
|
+
timestamp: string;
|
|
667
|
+
};
|
|
668
|
+
|
|
669
|
+
type VariableTimelineRequest = {
|
|
670
|
+
app_id: string;
|
|
671
|
+
env_type_id: string;
|
|
672
|
+
key: string;
|
|
673
|
+
limit?: number;
|
|
674
|
+
};
|
|
675
|
+
|
|
676
|
+
type VariableTimelineResponse = Array<{
|
|
677
|
+
pit_id: string;
|
|
678
|
+
change_request_message: string;
|
|
679
|
+
user_id: string;
|
|
680
|
+
created_at: string;
|
|
681
|
+
value: string;
|
|
682
|
+
operation: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
683
|
+
}>;
|
|
684
|
+
|
|
685
|
+
declare class EnvironmentVariablesPointInTimeService {
|
|
686
|
+
readonly httpRequest: BaseHttpRequest;
|
|
687
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
586
688
|
/**
|
|
587
|
-
*
|
|
588
|
-
*
|
|
689
|
+
* Get Environment Variables History
|
|
690
|
+
* Retrieve paginated history of environment variable changes
|
|
691
|
+
* @param requestBody
|
|
692
|
+
* @returns EnvHistoryResponse Environment variables history retrieved successfully
|
|
693
|
+
* @throws ApiError
|
|
694
|
+
*/
|
|
695
|
+
getEnvHistory(requestBody?: EnvHistoryRequest): CancelablePromise<EnvHistoryResponse>;
|
|
696
|
+
/**
|
|
697
|
+
* Get Environment Variables at Point in Time
|
|
698
|
+
* Retrieve environment variables state at a specific point in time
|
|
699
|
+
* @param requestBody
|
|
700
|
+
* @returns EnvPitStateResponse Environment variables at point in time retrieved successfully
|
|
701
|
+
* @throws ApiError
|
|
702
|
+
*/
|
|
703
|
+
getEnvsAtPointInTime(requestBody?: EnvPitRequest): CancelablePromise<EnvPitStateResponse>;
|
|
704
|
+
/**
|
|
705
|
+
* Get Environment Variables at Timestamp
|
|
706
|
+
* Retrieve environment variables state at a specific timestamp
|
|
707
|
+
* @param requestBody
|
|
708
|
+
* @returns EnvPitStateResponse Environment variables at timestamp retrieved successfully
|
|
709
|
+
* @throws ApiError
|
|
710
|
+
*/
|
|
711
|
+
getEnvsAtTimestamp(requestBody?: EnvTimestampRequest): CancelablePromise<EnvPitStateResponse>;
|
|
712
|
+
/**
|
|
713
|
+
* Get Environment Variables Diff
|
|
714
|
+
* Compare environment variables between two points in time
|
|
715
|
+
* @param requestBody
|
|
716
|
+
* @returns EnvDiffResponse Environment variables diff retrieved successfully
|
|
717
|
+
* @throws ApiError
|
|
718
|
+
*/
|
|
719
|
+
getEnvDiff(requestBody?: EnvDiffRequest): CancelablePromise<EnvDiffResponse>;
|
|
720
|
+
/**
|
|
721
|
+
* Get Variable Timeline
|
|
722
|
+
* Get timeline of changes for a specific environment variable
|
|
589
723
|
* @param key
|
|
590
724
|
* @param requestBody
|
|
591
|
-
* @returns
|
|
725
|
+
* @returns VariableTimelineResponse Variable timeline retrieved successfully
|
|
592
726
|
* @throws ApiError
|
|
593
727
|
*/
|
|
594
|
-
|
|
728
|
+
getVariableTimeline(key: string, requestBody?: VariableTimelineRequest): CancelablePromise<VariableTimelineResponse>;
|
|
729
|
+
}
|
|
730
|
+
|
|
731
|
+
type RollbackResponse = {
|
|
732
|
+
message: string;
|
|
733
|
+
operations_performed: number;
|
|
734
|
+
operations: Array<{
|
|
735
|
+
key: string;
|
|
736
|
+
value: string;
|
|
737
|
+
operation: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
738
|
+
}>;
|
|
739
|
+
};
|
|
740
|
+
|
|
741
|
+
type RollbackToPitRequest = {
|
|
742
|
+
app_id: string;
|
|
743
|
+
env_type_id: string;
|
|
744
|
+
pit_id: string;
|
|
745
|
+
rollback_message?: string;
|
|
746
|
+
};
|
|
747
|
+
|
|
748
|
+
type RollbackToTimestampRequest = {
|
|
749
|
+
app_id: string;
|
|
750
|
+
env_type_id: string;
|
|
751
|
+
timestamp: string;
|
|
752
|
+
rollback_message?: string;
|
|
753
|
+
};
|
|
754
|
+
|
|
755
|
+
type VariableRollbackResponse = {
|
|
756
|
+
message: string;
|
|
757
|
+
key: string;
|
|
758
|
+
operation: VariableRollbackResponse.operation;
|
|
759
|
+
previous_value: string | null;
|
|
760
|
+
target_value: string | null;
|
|
761
|
+
pit_id?: string;
|
|
762
|
+
target_timestamp?: string;
|
|
763
|
+
};
|
|
764
|
+
declare namespace VariableRollbackResponse {
|
|
765
|
+
enum operation {
|
|
766
|
+
CREATE = "CREATE",
|
|
767
|
+
UPDATE = "UPDATE",
|
|
768
|
+
DELETE = "DELETE"
|
|
769
|
+
}
|
|
770
|
+
}
|
|
771
|
+
|
|
772
|
+
type VariableRollbackToPitRequest = {
|
|
773
|
+
app_id: string;
|
|
774
|
+
env_type_id: string;
|
|
775
|
+
pit_id: string;
|
|
776
|
+
rollback_message?: string;
|
|
777
|
+
};
|
|
778
|
+
|
|
779
|
+
type VariableRollbackToTimestampRequest = {
|
|
780
|
+
app_id: string;
|
|
781
|
+
env_type_id: string;
|
|
782
|
+
timestamp: string;
|
|
783
|
+
rollback_message?: string;
|
|
784
|
+
};
|
|
785
|
+
|
|
786
|
+
declare class EnvironmentVariablesRollbackService {
|
|
787
|
+
readonly httpRequest: BaseHttpRequest;
|
|
788
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
789
|
+
/**
|
|
790
|
+
* Rollback Environment Variables to Point in Time
|
|
791
|
+
* Rollback all environment variables to a specific point in time
|
|
792
|
+
* @param requestBody
|
|
793
|
+
* @returns RollbackResponse Environment variables rolled back successfully
|
|
794
|
+
* @throws ApiError
|
|
795
|
+
*/
|
|
796
|
+
rollbackEnvsToPitId(requestBody?: RollbackToPitRequest): CancelablePromise<RollbackResponse>;
|
|
797
|
+
/**
|
|
798
|
+
* Rollback Environment Variables to Timestamp
|
|
799
|
+
* Rollback all environment variables to a specific timestamp
|
|
800
|
+
* @param requestBody
|
|
801
|
+
* @returns RollbackResponse Environment variables rolled back successfully
|
|
802
|
+
* @throws ApiError
|
|
803
|
+
*/
|
|
804
|
+
rollbackEnvsToTimestamp(requestBody?: RollbackToTimestampRequest): CancelablePromise<RollbackResponse>;
|
|
805
|
+
/**
|
|
806
|
+
* Rollback Single Variable to Point in Time
|
|
807
|
+
* Rollback a specific environment variable to a point in time
|
|
808
|
+
* @param key
|
|
809
|
+
* @param requestBody
|
|
810
|
+
* @returns VariableRollbackResponse Variable rolled back successfully
|
|
811
|
+
* @throws ApiError
|
|
812
|
+
*/
|
|
813
|
+
rollbackVariableToPitId(key: string, requestBody?: VariableRollbackToPitRequest): CancelablePromise<VariableRollbackResponse>;
|
|
814
|
+
/**
|
|
815
|
+
* Rollback Single Variable to Timestamp
|
|
816
|
+
* Rollback a specific environment variable to a timestamp
|
|
817
|
+
* @param key
|
|
818
|
+
* @param requestBody
|
|
819
|
+
* @returns VariableRollbackResponse Variable rolled back successfully
|
|
820
|
+
* @throws ApiError
|
|
821
|
+
*/
|
|
822
|
+
rollbackVariableToTimestamp(key: string, requestBody?: VariableRollbackToTimestampRequest): CancelablePromise<VariableRollbackResponse>;
|
|
595
823
|
}
|
|
596
824
|
|
|
597
825
|
type UploadFileResponse = {
|
|
@@ -902,6 +1130,376 @@ declare class RolesService {
|
|
|
902
1130
|
deleteRole(id: string): CancelablePromise<RoleResponse>;
|
|
903
1131
|
}
|
|
904
1132
|
|
|
1133
|
+
type BatchCreateSecretsRequest = {
|
|
1134
|
+
app_id: string;
|
|
1135
|
+
env_type_id: string;
|
|
1136
|
+
envs: Array<{
|
|
1137
|
+
key: string;
|
|
1138
|
+
value: string;
|
|
1139
|
+
}>;
|
|
1140
|
+
};
|
|
1141
|
+
|
|
1142
|
+
type BatchDeleteSecretsRequest = {
|
|
1143
|
+
app_id: string;
|
|
1144
|
+
env_type_id: string;
|
|
1145
|
+
keys: Array<string>;
|
|
1146
|
+
};
|
|
1147
|
+
|
|
1148
|
+
type BatchSecretsResponse = {
|
|
1149
|
+
message: string;
|
|
1150
|
+
};
|
|
1151
|
+
|
|
1152
|
+
type CreateSecretRequest = {
|
|
1153
|
+
key: string;
|
|
1154
|
+
value: string;
|
|
1155
|
+
app_id: string;
|
|
1156
|
+
env_type_id: string;
|
|
1157
|
+
};
|
|
1158
|
+
|
|
1159
|
+
type DeleteSecretRequest = {
|
|
1160
|
+
app_id: string;
|
|
1161
|
+
env_type_id: string;
|
|
1162
|
+
key: string;
|
|
1163
|
+
};
|
|
1164
|
+
|
|
1165
|
+
type GetSecretRequest = {
|
|
1166
|
+
app_id: string;
|
|
1167
|
+
env_type_id: string;
|
|
1168
|
+
};
|
|
1169
|
+
|
|
1170
|
+
type RevealSecretsRequest = {
|
|
1171
|
+
app_id: string;
|
|
1172
|
+
env_type_id: string;
|
|
1173
|
+
keys: Array<string>;
|
|
1174
|
+
};
|
|
1175
|
+
|
|
1176
|
+
type RevealSecretsResponse = Array<{
|
|
1177
|
+
id: string;
|
|
1178
|
+
key: string;
|
|
1179
|
+
value: string;
|
|
1180
|
+
app_id: string;
|
|
1181
|
+
env_type_id: string;
|
|
1182
|
+
org_id: string;
|
|
1183
|
+
created_at: string;
|
|
1184
|
+
updated_at: string;
|
|
1185
|
+
}>;
|
|
1186
|
+
|
|
1187
|
+
type SecretResponse = {
|
|
1188
|
+
id: string;
|
|
1189
|
+
key: string;
|
|
1190
|
+
value: string;
|
|
1191
|
+
app_id: string;
|
|
1192
|
+
env_type_id: string;
|
|
1193
|
+
org_id: string;
|
|
1194
|
+
created_at: string;
|
|
1195
|
+
updated_at: string;
|
|
1196
|
+
};
|
|
1197
|
+
|
|
1198
|
+
type SecretsResponse = Array<SecretResponse>;
|
|
1199
|
+
|
|
1200
|
+
type UpdateSecretRequest = {
|
|
1201
|
+
value: string;
|
|
1202
|
+
app_id: string;
|
|
1203
|
+
env_type_id: string;
|
|
1204
|
+
};
|
|
1205
|
+
|
|
1206
|
+
declare class SecretsService {
|
|
1207
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1208
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1209
|
+
/**
|
|
1210
|
+
* Get Secrets
|
|
1211
|
+
* Retrieve all secrets for an application and environment type
|
|
1212
|
+
* @param requestBody
|
|
1213
|
+
* @returns SecretsResponse Secrets retrieved successfully
|
|
1214
|
+
* @throws ApiError
|
|
1215
|
+
*/
|
|
1216
|
+
getSecrets(requestBody?: GetSecretRequest): CancelablePromise<SecretsResponse>;
|
|
1217
|
+
/**
|
|
1218
|
+
* Delete Secret
|
|
1219
|
+
* Delete an existing secret
|
|
1220
|
+
* @param requestBody
|
|
1221
|
+
* @returns BatchSecretsResponse Secret deleted successfully
|
|
1222
|
+
* @throws ApiError
|
|
1223
|
+
*/
|
|
1224
|
+
deleteSecret(requestBody?: DeleteSecretRequest): CancelablePromise<BatchSecretsResponse>;
|
|
1225
|
+
/**
|
|
1226
|
+
* Get Single Secret
|
|
1227
|
+
* Retrieve a specific secret
|
|
1228
|
+
* @param key
|
|
1229
|
+
* @param requestBody
|
|
1230
|
+
* @returns SecretResponse Secret retrieved successfully
|
|
1231
|
+
* @throws ApiError
|
|
1232
|
+
*/
|
|
1233
|
+
getSecret(key: string, requestBody?: GetSecretRequest): CancelablePromise<SecretResponse>;
|
|
1234
|
+
/**
|
|
1235
|
+
* Update Secret
|
|
1236
|
+
* Update an existing secret
|
|
1237
|
+
* @param key
|
|
1238
|
+
* @param requestBody
|
|
1239
|
+
* @returns BatchSecretsResponse Secret updated successfully
|
|
1240
|
+
* @throws ApiError
|
|
1241
|
+
*/
|
|
1242
|
+
updateSecret(key: string, requestBody?: UpdateSecretRequest): CancelablePromise<BatchSecretsResponse>;
|
|
1243
|
+
/**
|
|
1244
|
+
* Create Secret
|
|
1245
|
+
* Create a new secret
|
|
1246
|
+
* @param requestBody
|
|
1247
|
+
* @returns SecretResponse Secret created successfully
|
|
1248
|
+
* @throws ApiError
|
|
1249
|
+
*/
|
|
1250
|
+
createSecret(requestBody?: CreateSecretRequest): CancelablePromise<SecretResponse>;
|
|
1251
|
+
/**
|
|
1252
|
+
* Batch Create Secrets
|
|
1253
|
+
* Create multiple secrets in a single request
|
|
1254
|
+
* @param requestBody
|
|
1255
|
+
* @returns BatchSecretsResponse Secrets created successfully
|
|
1256
|
+
* @throws ApiError
|
|
1257
|
+
*/
|
|
1258
|
+
batchCreateSecrets(requestBody?: BatchCreateSecretsRequest): CancelablePromise<BatchSecretsResponse>;
|
|
1259
|
+
/**
|
|
1260
|
+
* Batch Update Secrets
|
|
1261
|
+
* Update multiple secrets in a single request
|
|
1262
|
+
* @param requestBody
|
|
1263
|
+
* @returns BatchSecretsResponse Secrets updated successfully
|
|
1264
|
+
* @throws ApiError
|
|
1265
|
+
*/
|
|
1266
|
+
batchUpdateSecrets(requestBody?: BatchCreateSecretsRequest): CancelablePromise<BatchSecretsResponse>;
|
|
1267
|
+
/**
|
|
1268
|
+
* Batch Delete Secrets
|
|
1269
|
+
* Delete multiple secrets in a single request
|
|
1270
|
+
* @param requestBody
|
|
1271
|
+
* @returns BatchSecretsResponse Secrets deleted successfully
|
|
1272
|
+
* @throws ApiError
|
|
1273
|
+
*/
|
|
1274
|
+
deleteBatchSecrets(requestBody?: BatchDeleteSecretsRequest): CancelablePromise<BatchSecretsResponse>;
|
|
1275
|
+
/**
|
|
1276
|
+
* Reveal Secrets
|
|
1277
|
+
* Decrypt and reveal secret values for managed apps
|
|
1278
|
+
* @param requestBody
|
|
1279
|
+
* @returns RevealSecretsResponse Secrets revealed successfully
|
|
1280
|
+
* @throws ApiError
|
|
1281
|
+
*/
|
|
1282
|
+
revealSecrets(requestBody?: RevealSecretsRequest): CancelablePromise<RevealSecretsResponse>;
|
|
1283
|
+
}
|
|
1284
|
+
|
|
1285
|
+
type SecretDiffRequest = {
|
|
1286
|
+
app_id: string;
|
|
1287
|
+
env_type_id: string;
|
|
1288
|
+
from_pit_id: string;
|
|
1289
|
+
to_pit_id: string;
|
|
1290
|
+
};
|
|
1291
|
+
|
|
1292
|
+
type SecretDiffResponse = {
|
|
1293
|
+
added: Array<{
|
|
1294
|
+
key: string;
|
|
1295
|
+
value: string;
|
|
1296
|
+
}>;
|
|
1297
|
+
modified: Array<{
|
|
1298
|
+
key: string;
|
|
1299
|
+
old_value: string;
|
|
1300
|
+
new_value: string;
|
|
1301
|
+
}>;
|
|
1302
|
+
deleted: Array<{
|
|
1303
|
+
key: string;
|
|
1304
|
+
value: string;
|
|
1305
|
+
}>;
|
|
1306
|
+
};
|
|
1307
|
+
|
|
1308
|
+
type SecretHistoryRequest = {
|
|
1309
|
+
app_id: string;
|
|
1310
|
+
env_type_id: string;
|
|
1311
|
+
page: string;
|
|
1312
|
+
per_page: string;
|
|
1313
|
+
};
|
|
1314
|
+
|
|
1315
|
+
type SecretHistoryResponse = {
|
|
1316
|
+
pits: Array<{
|
|
1317
|
+
id: string;
|
|
1318
|
+
org_id: string;
|
|
1319
|
+
app_id: string;
|
|
1320
|
+
env_type_id: string;
|
|
1321
|
+
change_request_message: string;
|
|
1322
|
+
user_id: string;
|
|
1323
|
+
created_at: string;
|
|
1324
|
+
updated_at: string;
|
|
1325
|
+
}>;
|
|
1326
|
+
totalPages: number;
|
|
1327
|
+
};
|
|
1328
|
+
|
|
1329
|
+
type SecretPitRequest = {
|
|
1330
|
+
app_id: string;
|
|
1331
|
+
env_type_id: string;
|
|
1332
|
+
pit_id: string;
|
|
1333
|
+
};
|
|
1334
|
+
|
|
1335
|
+
type SecretPitStateResponse = Array<{
|
|
1336
|
+
key: string;
|
|
1337
|
+
value: string;
|
|
1338
|
+
last_updated: string;
|
|
1339
|
+
}>;
|
|
1340
|
+
|
|
1341
|
+
type SecretTimestampRequest = {
|
|
1342
|
+
app_id: string;
|
|
1343
|
+
env_type_id: string;
|
|
1344
|
+
timestamp: string;
|
|
1345
|
+
};
|
|
1346
|
+
|
|
1347
|
+
type SecretVariableTimelineRequest = {
|
|
1348
|
+
app_id: string;
|
|
1349
|
+
env_type_id: string;
|
|
1350
|
+
key: string;
|
|
1351
|
+
limit?: number;
|
|
1352
|
+
};
|
|
1353
|
+
|
|
1354
|
+
type SecretVariableTimelineResponse = Array<{
|
|
1355
|
+
pit_id: string;
|
|
1356
|
+
change_request_message: string;
|
|
1357
|
+
user_id: string;
|
|
1358
|
+
created_at: string;
|
|
1359
|
+
value: string;
|
|
1360
|
+
operation: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
1361
|
+
}>;
|
|
1362
|
+
|
|
1363
|
+
declare class SecretsPointInTimeService {
|
|
1364
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1365
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1366
|
+
/**
|
|
1367
|
+
* Get Secrets History
|
|
1368
|
+
* Retrieve paginated history of secret changes
|
|
1369
|
+
* @param requestBody
|
|
1370
|
+
* @returns SecretHistoryResponse Secrets history retrieved successfully
|
|
1371
|
+
* @throws ApiError
|
|
1372
|
+
*/
|
|
1373
|
+
getSecretHistory(requestBody?: SecretHistoryRequest): CancelablePromise<SecretHistoryResponse>;
|
|
1374
|
+
/**
|
|
1375
|
+
* Get Secrets at Point in Time
|
|
1376
|
+
* Retrieve secrets state at a specific point in time
|
|
1377
|
+
* @param requestBody
|
|
1378
|
+
* @returns SecretPitStateResponse Secrets at point in time retrieved successfully
|
|
1379
|
+
* @throws ApiError
|
|
1380
|
+
*/
|
|
1381
|
+
getSecretsAtPointInTime(requestBody?: SecretPitRequest): CancelablePromise<SecretPitStateResponse>;
|
|
1382
|
+
/**
|
|
1383
|
+
* Get Secrets at Timestamp
|
|
1384
|
+
* Retrieve secrets state at a specific timestamp
|
|
1385
|
+
* @param requestBody
|
|
1386
|
+
* @returns SecretPitStateResponse Secrets at timestamp retrieved successfully
|
|
1387
|
+
* @throws ApiError
|
|
1388
|
+
*/
|
|
1389
|
+
getSecretsAtTimestamp(requestBody?: SecretTimestampRequest): CancelablePromise<SecretPitStateResponse>;
|
|
1390
|
+
/**
|
|
1391
|
+
* Get Secrets Diff
|
|
1392
|
+
* Compare secrets between two points in time
|
|
1393
|
+
* @param requestBody
|
|
1394
|
+
* @returns SecretDiffResponse Secrets diff retrieved successfully
|
|
1395
|
+
* @throws ApiError
|
|
1396
|
+
*/
|
|
1397
|
+
getSecretDiff(requestBody?: SecretDiffRequest): CancelablePromise<SecretDiffResponse>;
|
|
1398
|
+
/**
|
|
1399
|
+
* Get Secret Variable Timeline
|
|
1400
|
+
* Get timeline of changes for a specific secret variable
|
|
1401
|
+
* @param key
|
|
1402
|
+
* @param requestBody
|
|
1403
|
+
* @returns SecretVariableTimelineResponse Secret variable timeline retrieved successfully
|
|
1404
|
+
* @throws ApiError
|
|
1405
|
+
*/
|
|
1406
|
+
getSecretVariableTimeline(key: string, requestBody?: SecretVariableTimelineRequest): CancelablePromise<SecretVariableTimelineResponse>;
|
|
1407
|
+
}
|
|
1408
|
+
|
|
1409
|
+
type RollbackSecretsResponse = {
|
|
1410
|
+
message: string;
|
|
1411
|
+
operations_performed: number;
|
|
1412
|
+
operations: Array<{
|
|
1413
|
+
key: string;
|
|
1414
|
+
value: string;
|
|
1415
|
+
operation: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
1416
|
+
}>;
|
|
1417
|
+
};
|
|
1418
|
+
|
|
1419
|
+
type RollbackSecretsToPitRequest = {
|
|
1420
|
+
app_id: string;
|
|
1421
|
+
env_type_id: string;
|
|
1422
|
+
pit_id: string;
|
|
1423
|
+
rollback_message?: string;
|
|
1424
|
+
};
|
|
1425
|
+
|
|
1426
|
+
type RollbackSecretsToTimestampRequest = {
|
|
1427
|
+
app_id: string;
|
|
1428
|
+
env_type_id: string;
|
|
1429
|
+
timestamp: string;
|
|
1430
|
+
rollback_message?: string;
|
|
1431
|
+
};
|
|
1432
|
+
|
|
1433
|
+
type SecretVariableRollbackResponse = {
|
|
1434
|
+
message: string;
|
|
1435
|
+
key: string;
|
|
1436
|
+
operation: SecretVariableRollbackResponse.operation;
|
|
1437
|
+
previous_value: string | null;
|
|
1438
|
+
target_value: string | null;
|
|
1439
|
+
pit_id?: string;
|
|
1440
|
+
target_timestamp?: string;
|
|
1441
|
+
};
|
|
1442
|
+
declare namespace SecretVariableRollbackResponse {
|
|
1443
|
+
enum operation {
|
|
1444
|
+
CREATE = "CREATE",
|
|
1445
|
+
UPDATE = "UPDATE",
|
|
1446
|
+
DELETE = "DELETE"
|
|
1447
|
+
}
|
|
1448
|
+
}
|
|
1449
|
+
|
|
1450
|
+
type SecretVariableRollbackToPitRequest = {
|
|
1451
|
+
app_id: string;
|
|
1452
|
+
env_type_id: string;
|
|
1453
|
+
pit_id: string;
|
|
1454
|
+
rollback_message?: string;
|
|
1455
|
+
};
|
|
1456
|
+
|
|
1457
|
+
type SecretVariableRollbackToTimestampRequest = {
|
|
1458
|
+
app_id: string;
|
|
1459
|
+
env_type_id: string;
|
|
1460
|
+
timestamp: string;
|
|
1461
|
+
rollback_message?: string;
|
|
1462
|
+
};
|
|
1463
|
+
|
|
1464
|
+
declare class SecretsRollbackService {
|
|
1465
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1466
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1467
|
+
/**
|
|
1468
|
+
* Rollback Secrets to Point in Time
|
|
1469
|
+
* Rollback all secrets to a specific point in time
|
|
1470
|
+
* @param requestBody
|
|
1471
|
+
* @returns RollbackSecretsResponse Secrets rolled back successfully
|
|
1472
|
+
* @throws ApiError
|
|
1473
|
+
*/
|
|
1474
|
+
rollbackSecretsToPitId(requestBody?: RollbackSecretsToPitRequest): CancelablePromise<RollbackSecretsResponse>;
|
|
1475
|
+
/**
|
|
1476
|
+
* Rollback Secrets to Timestamp
|
|
1477
|
+
* Rollback all secrets to a specific timestamp
|
|
1478
|
+
* @param requestBody
|
|
1479
|
+
* @returns RollbackSecretsResponse Secrets rolled back successfully
|
|
1480
|
+
* @throws ApiError
|
|
1481
|
+
*/
|
|
1482
|
+
rollbackSecretsToTimestamp(requestBody?: RollbackSecretsToTimestampRequest): CancelablePromise<RollbackSecretsResponse>;
|
|
1483
|
+
/**
|
|
1484
|
+
* Rollback Single Secret Variable to Point in Time
|
|
1485
|
+
* Rollback a specific secret variable to a point in time
|
|
1486
|
+
* @param key
|
|
1487
|
+
* @param requestBody
|
|
1488
|
+
* @returns SecretVariableRollbackResponse Secret variable rolled back successfully
|
|
1489
|
+
* @throws ApiError
|
|
1490
|
+
*/
|
|
1491
|
+
rollbackSecretVariableToPitId(key: string, requestBody?: SecretVariableRollbackToPitRequest): CancelablePromise<SecretVariableRollbackResponse>;
|
|
1492
|
+
/**
|
|
1493
|
+
* Rollback Single Secret Variable to Timestamp
|
|
1494
|
+
* Rollback a specific secret variable to a timestamp
|
|
1495
|
+
* @param key
|
|
1496
|
+
* @param requestBody
|
|
1497
|
+
* @returns SecretVariableRollbackResponse Secret variable rolled back successfully
|
|
1498
|
+
* @throws ApiError
|
|
1499
|
+
*/
|
|
1500
|
+
rollbackSecretVariableToTimestamp(key: string, requestBody?: SecretVariableRollbackToTimestampRequest): CancelablePromise<SecretVariableRollbackResponse>;
|
|
1501
|
+
}
|
|
1502
|
+
|
|
905
1503
|
type UpdateUserRequest = {
|
|
906
1504
|
full_name?: string;
|
|
907
1505
|
profile_picture_url?: string;
|
|
@@ -977,6 +1575,121 @@ declare class UsersService {
|
|
|
977
1575
|
updatePassword(id: string): CancelablePromise<UserResponse>;
|
|
978
1576
|
}
|
|
979
1577
|
|
|
1578
|
+
type CreateWebhookRequest = {
|
|
1579
|
+
name: string;
|
|
1580
|
+
url: string;
|
|
1581
|
+
event_types: Array<string>;
|
|
1582
|
+
webhook_type: CreateWebhookRequest.webhook_type;
|
|
1583
|
+
linked_to?: CreateWebhookRequest.linked_to;
|
|
1584
|
+
app_id?: string;
|
|
1585
|
+
};
|
|
1586
|
+
declare namespace CreateWebhookRequest {
|
|
1587
|
+
enum webhook_type {
|
|
1588
|
+
DISCORD = "DISCORD",
|
|
1589
|
+
SLACK = "SLACK",
|
|
1590
|
+
CUSTOM = "CUSTOM"
|
|
1591
|
+
}
|
|
1592
|
+
enum linked_to {
|
|
1593
|
+
ORG = "org",
|
|
1594
|
+
APP = "app"
|
|
1595
|
+
}
|
|
1596
|
+
}
|
|
1597
|
+
|
|
1598
|
+
type UpdateWebhookRequest = {
|
|
1599
|
+
name?: string;
|
|
1600
|
+
url?: string;
|
|
1601
|
+
event_types?: Array<string>;
|
|
1602
|
+
is_active?: boolean;
|
|
1603
|
+
webhook_type?: UpdateWebhookRequest.webhook_type;
|
|
1604
|
+
app_id?: string;
|
|
1605
|
+
linked_to?: UpdateWebhookRequest.linked_to;
|
|
1606
|
+
};
|
|
1607
|
+
declare namespace UpdateWebhookRequest {
|
|
1608
|
+
enum webhook_type {
|
|
1609
|
+
DISCORD = "DISCORD",
|
|
1610
|
+
SLACK = "SLACK",
|
|
1611
|
+
CUSTOM = "CUSTOM"
|
|
1612
|
+
}
|
|
1613
|
+
enum linked_to {
|
|
1614
|
+
ORG = "org",
|
|
1615
|
+
APP = "app"
|
|
1616
|
+
}
|
|
1617
|
+
}
|
|
1618
|
+
|
|
1619
|
+
type WebhookResponse = {
|
|
1620
|
+
id: string;
|
|
1621
|
+
name: string;
|
|
1622
|
+
org_id: string;
|
|
1623
|
+
user_id: string;
|
|
1624
|
+
url: string;
|
|
1625
|
+
event_types: Array<string>;
|
|
1626
|
+
is_active: boolean;
|
|
1627
|
+
webhook_type: WebhookResponse.webhook_type;
|
|
1628
|
+
app_id: string | null;
|
|
1629
|
+
linked_to: WebhookResponse.linked_to;
|
|
1630
|
+
created_at: string;
|
|
1631
|
+
updated_at: string;
|
|
1632
|
+
last_triggered_at: string | null;
|
|
1633
|
+
};
|
|
1634
|
+
declare namespace WebhookResponse {
|
|
1635
|
+
enum webhook_type {
|
|
1636
|
+
DISCORD = "DISCORD",
|
|
1637
|
+
SLACK = "SLACK",
|
|
1638
|
+
CUSTOM = "CUSTOM"
|
|
1639
|
+
}
|
|
1640
|
+
enum linked_to {
|
|
1641
|
+
ORG = "org",
|
|
1642
|
+
APP = "app"
|
|
1643
|
+
}
|
|
1644
|
+
}
|
|
1645
|
+
|
|
1646
|
+
type WebhooksResponse = Array<WebhookResponse>;
|
|
1647
|
+
|
|
1648
|
+
declare class WebhooksService {
|
|
1649
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1650
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1651
|
+
/**
|
|
1652
|
+
* Create Webhook
|
|
1653
|
+
* Create a new webhook for the organization
|
|
1654
|
+
* @param requestBody
|
|
1655
|
+
* @returns WebhookResponse Webhook created successfully
|
|
1656
|
+
* @throws ApiError
|
|
1657
|
+
*/
|
|
1658
|
+
createWebhook(requestBody?: CreateWebhookRequest): CancelablePromise<WebhookResponse>;
|
|
1659
|
+
/**
|
|
1660
|
+
* Get All Webhooks
|
|
1661
|
+
* Retrieve all webhooks for the organization
|
|
1662
|
+
* @returns WebhooksResponse Webhooks retrieved successfully
|
|
1663
|
+
* @throws ApiError
|
|
1664
|
+
*/
|
|
1665
|
+
getWebhooks(): CancelablePromise<WebhooksResponse>;
|
|
1666
|
+
/**
|
|
1667
|
+
* Get Webhook
|
|
1668
|
+
* Retrieve a specific webhook
|
|
1669
|
+
* @param id
|
|
1670
|
+
* @returns WebhookResponse Webhook retrieved successfully
|
|
1671
|
+
* @throws ApiError
|
|
1672
|
+
*/
|
|
1673
|
+
getWebhook(id: string): CancelablePromise<WebhookResponse>;
|
|
1674
|
+
/**
|
|
1675
|
+
* Update Webhook
|
|
1676
|
+
* Update an existing webhook
|
|
1677
|
+
* @param id
|
|
1678
|
+
* @param requestBody
|
|
1679
|
+
* @returns WebhookResponse Webhook updated successfully
|
|
1680
|
+
* @throws ApiError
|
|
1681
|
+
*/
|
|
1682
|
+
updateWebhook(id: string, requestBody?: UpdateWebhookRequest): CancelablePromise<WebhookResponse>;
|
|
1683
|
+
/**
|
|
1684
|
+
* Delete Webhook
|
|
1685
|
+
* Delete an existing webhook
|
|
1686
|
+
* @param id
|
|
1687
|
+
* @returns WebhookResponse Webhook deleted successfully
|
|
1688
|
+
* @throws ApiError
|
|
1689
|
+
*/
|
|
1690
|
+
deleteWebhook(id: string): CancelablePromise<WebhookResponse>;
|
|
1691
|
+
}
|
|
1692
|
+
|
|
980
1693
|
type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
|
|
981
1694
|
declare class EnvSyncAPISDK {
|
|
982
1695
|
readonly access: AccessService;
|
|
@@ -986,11 +1699,17 @@ declare class EnvSyncAPISDK {
|
|
|
986
1699
|
readonly authentication: AuthenticationService;
|
|
987
1700
|
readonly environmentTypes: EnvironmentTypesService;
|
|
988
1701
|
readonly environmentVariables: EnvironmentVariablesService;
|
|
1702
|
+
readonly environmentVariablesPointInTime: EnvironmentVariablesPointInTimeService;
|
|
1703
|
+
readonly environmentVariablesRollback: EnvironmentVariablesRollbackService;
|
|
989
1704
|
readonly fileUpload: FileUploadService;
|
|
990
1705
|
readonly onboarding: OnboardingService;
|
|
991
1706
|
readonly organizations: OrganizationsService;
|
|
992
1707
|
readonly roles: RolesService;
|
|
1708
|
+
readonly secrets: SecretsService;
|
|
1709
|
+
readonly secretsPointInTime: SecretsPointInTimeService;
|
|
1710
|
+
readonly secretsRollback: SecretsRollbackService;
|
|
993
1711
|
readonly users: UsersService;
|
|
1712
|
+
readonly webhooks: WebhooksService;
|
|
994
1713
|
readonly request: BaseHttpRequest;
|
|
995
1714
|
constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
|
|
996
1715
|
}
|
|
@@ -1020,4 +1739,4 @@ type UploadFileError = {
|
|
|
1020
1739
|
error: string;
|
|
1021
1740
|
};
|
|
1022
1741
|
|
|
1023
|
-
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, ApiError, type ApiKeyResponse, type ApiKeysResponse, ApiKeysService, ApplicationsService, AuditLogsService, AuthenticationService, BaseHttpRequest, type BatchCreateEnvsRequest, type BatchDeleteEnvsRequest, type BatchEnvsResponse, type CallbackResponse, CancelError, CancelablePromise, type CheckSlugResponse, type CreateApiKeyRequest, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type CreateEnvTypeRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateRoleRequest, type CreateUserInviteRequest, type CreateUserInviteResponse, type DeleteAppResponse, type DeleteEnvRequest, type DeleteEnvTypeRequest, type DeleteUserInviteResponse, type EnvResponse, EnvSyncAPISDK, type EnvTypeResponse, type EnvTypesResponse, EnvironmentTypesService, EnvironmentVariablesService, type EnvsResponse, type ErrorResponse, FileUploadService, type GetAppResponse, type GetAppsResponse, type GetAuditLogsResponse, type GetAuditLogsResponseWrapper, type GetEnvRequest, type GetOrgInviteByCodeResponse, type GetUserInviteByTokenResponse, type LoginUrlResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgResponse, OrganizationsService, type RegenerateApiKeyResponse, type RoleResponse, type RoleStatsResponse, type RolesResponse, RolesService, type UpdateApiKeyRequest, type UpdateAppRequest, type UpdateAppResponse, type UpdateEnvRequest, type UpdateEnvTypeRequest, type UpdateOrgRequest, type UpdateRoleRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse, type UpdateUserRequest, type UploadFileError, type UploadFileResponse, type UserResponse, type UsersResponse, UsersService, type WhoAmIResponse };
|
|
1742
|
+
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, ApiError, type ApiKeyResponse, type ApiKeysResponse, ApiKeysService, ApplicationsService, AuditLogsService, AuthenticationService, BaseHttpRequest, type BatchCreateEnvsRequest, type BatchCreateSecretsRequest, type BatchDeleteEnvsRequest, type BatchDeleteSecretsRequest, type BatchEnvsResponse, type BatchSecretsResponse, type CallbackResponse, CancelError, CancelablePromise, type CheckSlugResponse, type CreateApiKeyRequest, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type CreateEnvTypeRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateRoleRequest, type CreateSecretRequest, type CreateUserInviteRequest, type CreateUserInviteResponse, CreateWebhookRequest, type DeleteAppResponse, type DeleteEnvRequest, type DeleteEnvTypeRequest, type DeleteSecretRequest, type DeleteUserInviteResponse, type EnvDiffRequest, type EnvDiffResponse, type EnvHistoryRequest, type EnvHistoryResponse, type EnvPitRequest, type EnvPitStateResponse, type EnvResponse, EnvSyncAPISDK, type EnvTimestampRequest, type EnvTypeResponse, type EnvTypesResponse, EnvironmentTypesService, EnvironmentVariablesPointInTimeService, EnvironmentVariablesRollbackService, EnvironmentVariablesService, type EnvsResponse, type ErrorResponse, FileUploadService, type GetAppResponse, type GetAppsResponse, type GetAuditLogsResponse, type GetAuditLogsResponseWrapper, type GetEnvRequest, type GetOrgInviteByCodeResponse, type GetSecretRequest, type GetUserInviteByTokenResponse, type LoginUrlResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgResponse, OrganizationsService, type RegenerateApiKeyResponse, type RevealSecretsRequest, type RevealSecretsResponse, type RoleResponse, type RoleStatsResponse, type RolesResponse, RolesService, type RollbackResponse, type RollbackSecretsResponse, type RollbackSecretsToPitRequest, type RollbackSecretsToTimestampRequest, type RollbackToPitRequest, type RollbackToTimestampRequest, type SecretDiffRequest, type SecretDiffResponse, type SecretHistoryRequest, type SecretHistoryResponse, type SecretPitRequest, type SecretPitStateResponse, type SecretResponse, type SecretTimestampRequest, SecretVariableRollbackResponse, type SecretVariableRollbackToPitRequest, type SecretVariableRollbackToTimestampRequest, type SecretVariableTimelineRequest, type SecretVariableTimelineResponse, SecretsPointInTimeService, type SecretsResponse, SecretsRollbackService, SecretsService, type UpdateApiKeyRequest, type UpdateAppRequest, type UpdateAppResponse, type UpdateEnvRequest, type UpdateEnvTypeRequest, type UpdateOrgRequest, type UpdateRoleRequest, type UpdateSecretRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse, type UpdateUserRequest, UpdateWebhookRequest, type UploadFileError, type UploadFileResponse, type UserResponse, type UsersResponse, UsersService, VariableRollbackResponse, type VariableRollbackToPitRequest, type VariableRollbackToTimestampRequest, type VariableTimelineRequest, type VariableTimelineResponse, WebhookResponse, type WebhooksResponse, WebhooksService, type WhoAmIResponse };
|