@envsync-cloud/envsync-ts-sdk 0.7.0 → 0.7.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 +357 -10
- package/dist/index.d.ts +357 -10
- package/dist/index.js +415 -5
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +411 -5
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -70,6 +70,11 @@ type LoginUrlResponse = {
|
|
|
70
70
|
loginUrl: string;
|
|
71
71
|
};
|
|
72
72
|
|
|
73
|
+
type LogoutUrlResponse = {
|
|
74
|
+
message: string;
|
|
75
|
+
logoutUrl: string;
|
|
76
|
+
};
|
|
77
|
+
|
|
73
78
|
declare class AccessService {
|
|
74
79
|
readonly httpRequest: BaseHttpRequest;
|
|
75
80
|
constructor(httpRequest: BaseHttpRequest);
|
|
@@ -89,12 +94,19 @@ declare class AccessService {
|
|
|
89
94
|
createWebLogin(): CancelablePromise<LoginUrlResponse>;
|
|
90
95
|
/**
|
|
91
96
|
* Web Login Callback
|
|
92
|
-
* Handle web login callback from
|
|
97
|
+
* Handle web login callback from Keycloak
|
|
93
98
|
* @param code
|
|
94
99
|
* @returns void
|
|
95
100
|
* @throws ApiError
|
|
96
101
|
*/
|
|
97
102
|
callbackWebLogin(code: string): CancelablePromise<void>;
|
|
103
|
+
/**
|
|
104
|
+
* Logout Web Session
|
|
105
|
+
* Clear API-managed web session cookies and return the Keycloak logout URL
|
|
106
|
+
* @returns LogoutUrlResponse Web logout prepared successfully
|
|
107
|
+
* @throws ApiError
|
|
108
|
+
*/
|
|
109
|
+
logoutWebLogin(): CancelablePromise<LogoutUrlResponse>;
|
|
98
110
|
/**
|
|
99
111
|
* Create API Login URL
|
|
100
112
|
* Generate authentication URL for API login
|
|
@@ -104,7 +116,7 @@ declare class AccessService {
|
|
|
104
116
|
createApiLogin(): CancelablePromise<LoginUrlResponse>;
|
|
105
117
|
/**
|
|
106
118
|
* API Login Callback
|
|
107
|
-
* Handle API login callback from
|
|
119
|
+
* Handle API login callback from Keycloak
|
|
108
120
|
* @param code
|
|
109
121
|
* @returns CallbackResponse API login callback successful
|
|
110
122
|
* @throws ApiError
|
|
@@ -356,6 +368,9 @@ type RoleResponse = {
|
|
|
356
368
|
have_api_access: boolean;
|
|
357
369
|
have_billing_options: boolean;
|
|
358
370
|
have_webhook_access: boolean;
|
|
371
|
+
have_gpg_access: boolean;
|
|
372
|
+
have_cert_access: boolean;
|
|
373
|
+
have_audit_access: boolean;
|
|
359
374
|
color?: string;
|
|
360
375
|
is_admin: boolean;
|
|
361
376
|
is_master: boolean;
|
|
@@ -412,8 +427,9 @@ type CertificateListResponse = Array<{
|
|
|
412
427
|
not_before: string | null;
|
|
413
428
|
not_after: string | null;
|
|
414
429
|
description: string | null;
|
|
415
|
-
metadata?:
|
|
430
|
+
metadata?: any | null;
|
|
416
431
|
revoked_at: string | null;
|
|
432
|
+
supersedes_certificate_id?: string | null;
|
|
417
433
|
created_at: string;
|
|
418
434
|
updated_at: string;
|
|
419
435
|
}>;
|
|
@@ -444,7 +460,7 @@ type MemberCertResponse = {
|
|
|
444
460
|
subject_cn: string;
|
|
445
461
|
subject_email: string | null;
|
|
446
462
|
status: string;
|
|
447
|
-
metadata?:
|
|
463
|
+
metadata?: any | null;
|
|
448
464
|
cert_pem: string;
|
|
449
465
|
key_pem: string;
|
|
450
466
|
created_at: string;
|
|
@@ -466,6 +482,11 @@ type OrgCAResponse = {
|
|
|
466
482
|
created_at: string;
|
|
467
483
|
};
|
|
468
484
|
|
|
485
|
+
type RenewCertRequest = {
|
|
486
|
+
description?: string;
|
|
487
|
+
revoke_previous?: boolean;
|
|
488
|
+
};
|
|
489
|
+
|
|
469
490
|
type RevokeCertRequest = {
|
|
470
491
|
reason: number;
|
|
471
492
|
};
|
|
@@ -480,6 +501,12 @@ type RootCAResponse = {
|
|
|
480
501
|
cert_pem: string;
|
|
481
502
|
};
|
|
482
503
|
|
|
504
|
+
type RotateCertRequest = {
|
|
505
|
+
description?: string;
|
|
506
|
+
revoke_previous?: boolean;
|
|
507
|
+
reason?: number;
|
|
508
|
+
};
|
|
509
|
+
|
|
483
510
|
declare class CertificatesService {
|
|
484
511
|
readonly httpRequest: BaseHttpRequest;
|
|
485
512
|
constructor(httpRequest: BaseHttpRequest);
|
|
@@ -544,6 +571,24 @@ declare class CertificatesService {
|
|
|
544
571
|
* @throws ApiError
|
|
545
572
|
*/
|
|
546
573
|
revokeCert(serialHex: string, requestBody?: RevokeCertRequest): CancelablePromise<RevokeCertResponse>;
|
|
574
|
+
/**
|
|
575
|
+
* Renew Certificate
|
|
576
|
+
* Issue a renewed replacement certificate linked to the existing certificate lineage.
|
|
577
|
+
* @param id
|
|
578
|
+
* @param requestBody
|
|
579
|
+
* @returns MemberCertResponse Certificate renewed successfully
|
|
580
|
+
* @throws ApiError
|
|
581
|
+
*/
|
|
582
|
+
renewCertificate(id: string, requestBody?: RenewCertRequest): CancelablePromise<MemberCertResponse>;
|
|
583
|
+
/**
|
|
584
|
+
* Rotate Certificate
|
|
585
|
+
* Rotate a certificate by issuing a replacement and optionally revoking the previous certificate.
|
|
586
|
+
* @param id
|
|
587
|
+
* @param requestBody
|
|
588
|
+
* @returns MemberCertResponse Certificate rotated successfully
|
|
589
|
+
* @throws ApiError
|
|
590
|
+
*/
|
|
591
|
+
rotateCertificate(id: string, requestBody?: RotateCertRequest): CancelablePromise<MemberCertResponse>;
|
|
547
592
|
/**
|
|
548
593
|
* Check OCSP Status
|
|
549
594
|
* Check the OCSP status of a certificate
|
|
@@ -554,6 +599,151 @@ declare class CertificatesService {
|
|
|
554
599
|
checkOcsp(serialHex: string): CancelablePromise<OCSPResponse>;
|
|
555
600
|
}
|
|
556
601
|
|
|
602
|
+
type ChangeRequestResponse = {
|
|
603
|
+
id: string;
|
|
604
|
+
org_id: string;
|
|
605
|
+
app_id: string;
|
|
606
|
+
request_kind: ChangeRequestResponse.request_kind;
|
|
607
|
+
source_env_type_id: string | null;
|
|
608
|
+
target_env_type_id: string;
|
|
609
|
+
status: ChangeRequestResponse.status;
|
|
610
|
+
title: string;
|
|
611
|
+
message: string;
|
|
612
|
+
requested_by_user_id: string;
|
|
613
|
+
reviewed_by_user_id: string | null;
|
|
614
|
+
reviewed_at: string | null;
|
|
615
|
+
applied_at: string | null;
|
|
616
|
+
rejection_reason: string | null;
|
|
617
|
+
created_at: string;
|
|
618
|
+
updated_at: string;
|
|
619
|
+
env_item_count: number;
|
|
620
|
+
secret_item_count: number;
|
|
621
|
+
env_items: Array<{
|
|
622
|
+
id: string;
|
|
623
|
+
change_request_id: string;
|
|
624
|
+
key: string;
|
|
625
|
+
previous_value: string | null;
|
|
626
|
+
proposed_value: string | null;
|
|
627
|
+
operation: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
628
|
+
created_at: string;
|
|
629
|
+
updated_at: string;
|
|
630
|
+
}>;
|
|
631
|
+
secret_items: Array<{
|
|
632
|
+
id: string;
|
|
633
|
+
change_request_id: string;
|
|
634
|
+
key: string;
|
|
635
|
+
previous_value: string | null;
|
|
636
|
+
proposed_value: string | null;
|
|
637
|
+
operation: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
638
|
+
created_at: string;
|
|
639
|
+
updated_at: string;
|
|
640
|
+
}>;
|
|
641
|
+
};
|
|
642
|
+
declare namespace ChangeRequestResponse {
|
|
643
|
+
enum request_kind {
|
|
644
|
+
DIRECT = "direct",
|
|
645
|
+
PROMOTION = "promotion"
|
|
646
|
+
}
|
|
647
|
+
enum status {
|
|
648
|
+
PENDING = "pending",
|
|
649
|
+
APPROVED = "approved",
|
|
650
|
+
REJECTED = "rejected",
|
|
651
|
+
CANCELLED = "cancelled"
|
|
652
|
+
}
|
|
653
|
+
}
|
|
654
|
+
|
|
655
|
+
type ChangeRequestListResponse = Array<ChangeRequestResponse>;
|
|
656
|
+
|
|
657
|
+
type DirectChangeRequestBody = {
|
|
658
|
+
app_id: string;
|
|
659
|
+
target_env_type_id: string;
|
|
660
|
+
title: string;
|
|
661
|
+
message: string;
|
|
662
|
+
envs?: Array<{
|
|
663
|
+
key: string;
|
|
664
|
+
operation: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
665
|
+
proposed_value?: string | null;
|
|
666
|
+
}>;
|
|
667
|
+
secrets?: Array<{
|
|
668
|
+
key: string;
|
|
669
|
+
operation: 'CREATE' | 'UPDATE' | 'DELETE';
|
|
670
|
+
proposed_value?: string | null;
|
|
671
|
+
}>;
|
|
672
|
+
};
|
|
673
|
+
|
|
674
|
+
type PromotionChangeRequestBody = {
|
|
675
|
+
app_id: string;
|
|
676
|
+
source_env_type_id: string;
|
|
677
|
+
target_env_type_id: string;
|
|
678
|
+
title: string;
|
|
679
|
+
message: string;
|
|
680
|
+
};
|
|
681
|
+
|
|
682
|
+
type RejectChangeRequestBody = {
|
|
683
|
+
rejection_reason: string;
|
|
684
|
+
};
|
|
685
|
+
|
|
686
|
+
declare class ChangeRequestsService {
|
|
687
|
+
readonly httpRequest: BaseHttpRequest;
|
|
688
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
689
|
+
/**
|
|
690
|
+
* Create Direct Change Request
|
|
691
|
+
* Create a protected-environment change request with explicit env and secret changes.
|
|
692
|
+
* @param requestBody
|
|
693
|
+
* @returns ChangeRequestResponse Direct change request created
|
|
694
|
+
* @throws ApiError
|
|
695
|
+
*/
|
|
696
|
+
createDirectChangeRequest(requestBody?: DirectChangeRequestBody): CancelablePromise<ChangeRequestResponse>;
|
|
697
|
+
/**
|
|
698
|
+
* Create Promotion Change Request
|
|
699
|
+
* Create a promotion request from one app environment to another protected environment.
|
|
700
|
+
* @param requestBody
|
|
701
|
+
* @returns ChangeRequestResponse Promotion change request created
|
|
702
|
+
* @throws ApiError
|
|
703
|
+
*/
|
|
704
|
+
createPromotionChangeRequest(requestBody?: PromotionChangeRequestBody): CancelablePromise<ChangeRequestResponse>;
|
|
705
|
+
/**
|
|
706
|
+
* List Change Requests
|
|
707
|
+
* List change requests for the current organization.
|
|
708
|
+
* @returns ChangeRequestListResponse Change requests listed
|
|
709
|
+
* @throws ApiError
|
|
710
|
+
*/
|
|
711
|
+
listChangeRequests(): CancelablePromise<ChangeRequestListResponse>;
|
|
712
|
+
/**
|
|
713
|
+
* Get Change Request
|
|
714
|
+
* Fetch a single change request including env and secret item diffs.
|
|
715
|
+
* @param id
|
|
716
|
+
* @returns ChangeRequestResponse Change request fetched
|
|
717
|
+
* @throws ApiError
|
|
718
|
+
*/
|
|
719
|
+
getChangeRequest(id: string): CancelablePromise<ChangeRequestResponse>;
|
|
720
|
+
/**
|
|
721
|
+
* Approve Change Request
|
|
722
|
+
* Approve a pending change request and apply it atomically to the target environment.
|
|
723
|
+
* @param id
|
|
724
|
+
* @returns ChangeRequestResponse Change request approved and applied
|
|
725
|
+
* @throws ApiError
|
|
726
|
+
*/
|
|
727
|
+
approveChangeRequest(id: string): CancelablePromise<ChangeRequestResponse>;
|
|
728
|
+
/**
|
|
729
|
+
* Reject Change Request
|
|
730
|
+
* Reject a pending change request without mutating the target environment.
|
|
731
|
+
* @param id
|
|
732
|
+
* @param requestBody
|
|
733
|
+
* @returns ChangeRequestResponse Change request rejected
|
|
734
|
+
* @throws ApiError
|
|
735
|
+
*/
|
|
736
|
+
rejectChangeRequest(id: string, requestBody?: RejectChangeRequestBody): CancelablePromise<ChangeRequestResponse>;
|
|
737
|
+
/**
|
|
738
|
+
* Cancel Change Request
|
|
739
|
+
* Cancel a pending change request created by the current user.
|
|
740
|
+
* @param id
|
|
741
|
+
* @returns ChangeRequestResponse Change request cancelled
|
|
742
|
+
* @throws ApiError
|
|
743
|
+
*/
|
|
744
|
+
cancelChangeRequest(id: string): CancelablePromise<ChangeRequestResponse>;
|
|
745
|
+
}
|
|
746
|
+
|
|
557
747
|
type CreateEnvTypeRequest = {
|
|
558
748
|
name: string;
|
|
559
749
|
color?: string;
|
|
@@ -678,6 +868,36 @@ type EnvResponse = {
|
|
|
678
868
|
|
|
679
869
|
type EnvsResponse = Array<EnvResponse>;
|
|
680
870
|
|
|
871
|
+
type ExportEnvRequest = {
|
|
872
|
+
app_id: string;
|
|
873
|
+
env_type_id?: string;
|
|
874
|
+
env_type?: string;
|
|
875
|
+
enable_secrets?: ExportEnvRequest.enable_secrets;
|
|
876
|
+
is_secret_managed?: ExportEnvRequest.is_secret_managed;
|
|
877
|
+
private_key?: string;
|
|
878
|
+
};
|
|
879
|
+
declare namespace ExportEnvRequest {
|
|
880
|
+
enum enable_secrets {
|
|
881
|
+
AUTO = "auto",
|
|
882
|
+
TRUE = "true",
|
|
883
|
+
FALSE = "false"
|
|
884
|
+
}
|
|
885
|
+
enum is_secret_managed {
|
|
886
|
+
AUTO = "auto",
|
|
887
|
+
TRUE = "true",
|
|
888
|
+
FALSE = "false"
|
|
889
|
+
}
|
|
890
|
+
}
|
|
891
|
+
|
|
892
|
+
type ExportEnvResponse = {
|
|
893
|
+
resolved_app_id: string;
|
|
894
|
+
resolved_env_type_id: string;
|
|
895
|
+
resolved_env_type_name: string;
|
|
896
|
+
secrets_enabled: boolean;
|
|
897
|
+
managed_secrets: boolean;
|
|
898
|
+
environment: Record<string, string>;
|
|
899
|
+
};
|
|
900
|
+
|
|
681
901
|
type GetEnvRequest = {
|
|
682
902
|
app_id: string;
|
|
683
903
|
env_type_id: string;
|
|
@@ -692,6 +912,14 @@ type UpdateEnvRequest = {
|
|
|
692
912
|
declare class EnvironmentVariablesService {
|
|
693
913
|
readonly httpRequest: BaseHttpRequest;
|
|
694
914
|
constructor(httpRequest: BaseHttpRequest);
|
|
915
|
+
/**
|
|
916
|
+
* Export Environment
|
|
917
|
+
* Export environment variables and optionally secrets for an application environment in a single payload.
|
|
918
|
+
* @param requestBody
|
|
919
|
+
* @returns ExportEnvResponse Environment exported successfully
|
|
920
|
+
* @throws ApiError
|
|
921
|
+
*/
|
|
922
|
+
exportEnvironment(requestBody?: ExportEnvRequest): CancelablePromise<ExportEnvResponse>;
|
|
695
923
|
/**
|
|
696
924
|
* Get Environment Variables
|
|
697
925
|
* Retrieve all environment variables for an application and environment type
|
|
@@ -1004,6 +1232,10 @@ type ExportKeyResponse = {
|
|
|
1004
1232
|
fingerprint: string;
|
|
1005
1233
|
};
|
|
1006
1234
|
|
|
1235
|
+
type ExtendGpgKeyExpiryRequest = {
|
|
1236
|
+
expires_in_days: number;
|
|
1237
|
+
};
|
|
1238
|
+
|
|
1007
1239
|
type GenerateGpgKeyRequest = {
|
|
1008
1240
|
name: string;
|
|
1009
1241
|
email: string;
|
|
@@ -1034,8 +1266,10 @@ type GpgKeyResponse = {
|
|
|
1034
1266
|
key_size: number | null;
|
|
1035
1267
|
usage_flags: Array<string>;
|
|
1036
1268
|
trust_level: string;
|
|
1269
|
+
status: string;
|
|
1037
1270
|
expires_at: string | null;
|
|
1038
1271
|
revoked_at: string | null;
|
|
1272
|
+
supersedes_gpg_key_id?: string | null;
|
|
1039
1273
|
is_default: boolean;
|
|
1040
1274
|
created_at: string;
|
|
1041
1275
|
updated_at: string;
|
|
@@ -1059,6 +1293,24 @@ type RevokeGpgKeyRequest = {
|
|
|
1059
1293
|
reason?: string;
|
|
1060
1294
|
};
|
|
1061
1295
|
|
|
1296
|
+
type RotateGpgKeyRequest = {
|
|
1297
|
+
name?: string;
|
|
1298
|
+
email?: string;
|
|
1299
|
+
algorithm?: RotateGpgKeyRequest.algorithm;
|
|
1300
|
+
key_size?: number;
|
|
1301
|
+
expires_in_days?: number;
|
|
1302
|
+
revoke_previous?: boolean;
|
|
1303
|
+
set_new_default?: boolean;
|
|
1304
|
+
};
|
|
1305
|
+
declare namespace RotateGpgKeyRequest {
|
|
1306
|
+
enum algorithm {
|
|
1307
|
+
RSA = "rsa",
|
|
1308
|
+
ECC_CURVE25519 = "ecc-curve25519",
|
|
1309
|
+
ECC_P256 = "ecc-p256",
|
|
1310
|
+
ECC_P384 = "ecc-p384"
|
|
1311
|
+
}
|
|
1312
|
+
}
|
|
1313
|
+
|
|
1062
1314
|
type SignatureResponse = {
|
|
1063
1315
|
signature: string;
|
|
1064
1316
|
key_id: string;
|
|
@@ -1179,6 +1431,24 @@ declare class GpgKeysService {
|
|
|
1179
1431
|
* @throws ApiError
|
|
1180
1432
|
*/
|
|
1181
1433
|
revokeGpgKey(id: string, requestBody?: RevokeGpgKeyRequest): CancelablePromise<GpgKeyDetailResponse>;
|
|
1434
|
+
/**
|
|
1435
|
+
* Rotate GPG Key
|
|
1436
|
+
* Create a replacement GPG key, optionally promote it to default, and supersede the original key.
|
|
1437
|
+
* @param id
|
|
1438
|
+
* @param requestBody
|
|
1439
|
+
* @returns GpgKeyDetailResponse GPG key rotated successfully
|
|
1440
|
+
* @throws ApiError
|
|
1441
|
+
*/
|
|
1442
|
+
rotateGpgKey(id: string, requestBody?: RotateGpgKeyRequest): CancelablePromise<GpgKeyDetailResponse>;
|
|
1443
|
+
/**
|
|
1444
|
+
* Extend GPG Key Expiry
|
|
1445
|
+
* Extend the expiry date of an active GPG key without rotating it.
|
|
1446
|
+
* @param id
|
|
1447
|
+
* @param requestBody
|
|
1448
|
+
* @returns GpgKeyDetailResponse GPG key expiry extended successfully
|
|
1449
|
+
* @throws ApiError
|
|
1450
|
+
*/
|
|
1451
|
+
extendGpgKeyExpiry(id: string, requestBody?: ExtendGpgKeyExpiryRequest): CancelablePromise<GpgKeyDetailResponse>;
|
|
1182
1452
|
/**
|
|
1183
1453
|
* Update Trust Level
|
|
1184
1454
|
* Update the trust level of a GPG key
|
|
@@ -1364,8 +1634,9 @@ type OrgResponse = {
|
|
|
1364
1634
|
};
|
|
1365
1635
|
|
|
1366
1636
|
type UpdateOrgRequest = {
|
|
1367
|
-
logo_url?: string;
|
|
1368
|
-
|
|
1637
|
+
logo_url?: string | null;
|
|
1638
|
+
contact_email?: string | null;
|
|
1639
|
+
website?: string | null;
|
|
1369
1640
|
name?: string;
|
|
1370
1641
|
slug?: string;
|
|
1371
1642
|
};
|
|
@@ -1398,6 +1669,14 @@ declare class OrganizationsService {
|
|
|
1398
1669
|
checkIfSlugExists(slug: string): CancelablePromise<CheckSlugResponse>;
|
|
1399
1670
|
}
|
|
1400
1671
|
|
|
1672
|
+
type EffectiveAccessResponse = Array<{
|
|
1673
|
+
user_id: string;
|
|
1674
|
+
email: string;
|
|
1675
|
+
relation: 'admin' | 'editor' | 'viewer';
|
|
1676
|
+
source: 'direct' | 'team' | 'both';
|
|
1677
|
+
teams: Array<string>;
|
|
1678
|
+
}>;
|
|
1679
|
+
|
|
1401
1680
|
type EffectivePermissionsResponse = {
|
|
1402
1681
|
can_view: boolean;
|
|
1403
1682
|
can_edit: boolean;
|
|
@@ -1433,6 +1712,12 @@ declare namespace GrantAccessRequest {
|
|
|
1433
1712
|
}
|
|
1434
1713
|
}
|
|
1435
1714
|
|
|
1715
|
+
type GrantsListResponse = Array<{
|
|
1716
|
+
subject_id: string;
|
|
1717
|
+
subject_type: 'user' | 'team';
|
|
1718
|
+
relation: 'admin' | 'editor' | 'viewer';
|
|
1719
|
+
}>;
|
|
1720
|
+
|
|
1436
1721
|
type PermissionMessageResponse = {
|
|
1437
1722
|
message: string;
|
|
1438
1723
|
};
|
|
@@ -1482,6 +1767,22 @@ declare class PermissionsService {
|
|
|
1482
1767
|
* @throws ApiError
|
|
1483
1768
|
*/
|
|
1484
1769
|
revokeAppAccess(appId: string, requestBody?: RevokeAccessRequest): CancelablePromise<PermissionMessageResponse>;
|
|
1770
|
+
/**
|
|
1771
|
+
* List App Grants
|
|
1772
|
+
* List direct user and team grants on an app
|
|
1773
|
+
* @param appId
|
|
1774
|
+
* @returns GrantsListResponse App grants listed successfully
|
|
1775
|
+
* @throws ApiError
|
|
1776
|
+
*/
|
|
1777
|
+
listAppGrants(appId: string): CancelablePromise<GrantsListResponse>;
|
|
1778
|
+
/**
|
|
1779
|
+
* Get App Effective Access
|
|
1780
|
+
* List user effective access for an app including team inheritance
|
|
1781
|
+
* @param appId
|
|
1782
|
+
* @returns EffectiveAccessResponse Effective app access returned successfully
|
|
1783
|
+
* @throws ApiError
|
|
1784
|
+
*/
|
|
1785
|
+
getAppEffectiveAccess(appId: string): CancelablePromise<EffectiveAccessResponse>;
|
|
1485
1786
|
/**
|
|
1486
1787
|
* Grant Env Type Access
|
|
1487
1788
|
* Grant a user or team access to an environment type
|
|
@@ -1500,6 +1801,14 @@ declare class PermissionsService {
|
|
|
1500
1801
|
* @throws ApiError
|
|
1501
1802
|
*/
|
|
1502
1803
|
revokeEnvTypeAccess(id: string, requestBody?: RevokeAccessRequest): CancelablePromise<PermissionMessageResponse>;
|
|
1804
|
+
/**
|
|
1805
|
+
* List Env Type Grants
|
|
1806
|
+
* List direct user and team grants on an environment type
|
|
1807
|
+
* @param id
|
|
1808
|
+
* @returns GrantsListResponse Env type grants listed successfully
|
|
1809
|
+
* @throws ApiError
|
|
1810
|
+
*/
|
|
1811
|
+
listEnvTypeGrants(id: string): CancelablePromise<GrantsListResponse>;
|
|
1503
1812
|
}
|
|
1504
1813
|
|
|
1505
1814
|
type CreateRoleRequest = {
|
|
@@ -1509,6 +1818,9 @@ type CreateRoleRequest = {
|
|
|
1509
1818
|
have_api_access: boolean;
|
|
1510
1819
|
have_billing_options: boolean;
|
|
1511
1820
|
have_webhook_access: boolean;
|
|
1821
|
+
have_gpg_access: boolean;
|
|
1822
|
+
have_cert_access: boolean;
|
|
1823
|
+
have_audit_access: boolean;
|
|
1512
1824
|
is_admin: boolean;
|
|
1513
1825
|
color?: string;
|
|
1514
1826
|
};
|
|
@@ -1520,6 +1832,9 @@ type RoleStatsResponse = {
|
|
|
1520
1832
|
billing_access_count: number;
|
|
1521
1833
|
api_access_count: number;
|
|
1522
1834
|
webhook_access_count: number;
|
|
1835
|
+
gpg_access_count: number;
|
|
1836
|
+
cert_access_count: number;
|
|
1837
|
+
audit_access_count: number;
|
|
1523
1838
|
view_access_count: number;
|
|
1524
1839
|
edit_access_count: number;
|
|
1525
1840
|
total_roles: number;
|
|
@@ -1759,8 +2074,8 @@ type SecretDiffResponse = {
|
|
|
1759
2074
|
type SecretHistoryRequest = {
|
|
1760
2075
|
app_id: string;
|
|
1761
2076
|
env_type_id: string;
|
|
1762
|
-
page
|
|
1763
|
-
per_page
|
|
2077
|
+
page?: number;
|
|
2078
|
+
per_page?: number;
|
|
1764
2079
|
};
|
|
1765
2080
|
|
|
1766
2081
|
type SecretHistoryResponse = {
|
|
@@ -1955,6 +2270,10 @@ type AddTeamMemberRequest = {
|
|
|
1955
2270
|
user_id: string;
|
|
1956
2271
|
};
|
|
1957
2272
|
|
|
2273
|
+
type AssignTeamRoleRequest = {
|
|
2274
|
+
role_id: string;
|
|
2275
|
+
};
|
|
2276
|
+
|
|
1958
2277
|
type CreateTeamRequest = {
|
|
1959
2278
|
name: string;
|
|
1960
2279
|
description?: string;
|
|
@@ -1967,6 +2286,7 @@ type CreateTeamResponse = {
|
|
|
1967
2286
|
org_id: string;
|
|
1968
2287
|
description: string | null;
|
|
1969
2288
|
color: string;
|
|
2289
|
+
role_id?: string | null;
|
|
1970
2290
|
created_at: string;
|
|
1971
2291
|
updated_at: string;
|
|
1972
2292
|
};
|
|
@@ -1977,6 +2297,7 @@ type GetTeamResponse = {
|
|
|
1977
2297
|
org_id: string;
|
|
1978
2298
|
description: string | null;
|
|
1979
2299
|
color: string;
|
|
2300
|
+
role_id?: string | null;
|
|
1980
2301
|
created_at: string;
|
|
1981
2302
|
updated_at: string;
|
|
1982
2303
|
members: Array<{
|
|
@@ -1995,6 +2316,7 @@ type GetTeamsResponse = Array<{
|
|
|
1995
2316
|
org_id: string;
|
|
1996
2317
|
description: string | null;
|
|
1997
2318
|
color: string;
|
|
2319
|
+
role_id?: string | null;
|
|
1998
2320
|
created_at: string;
|
|
1999
2321
|
updated_at: string;
|
|
2000
2322
|
}>;
|
|
@@ -2070,6 +2392,31 @@ declare class TeamsService {
|
|
|
2070
2392
|
* @throws ApiError
|
|
2071
2393
|
*/
|
|
2072
2394
|
removeTeamMember(id: string, userId: string): CancelablePromise<TeamMessageResponse>;
|
|
2395
|
+
/**
|
|
2396
|
+
* Assign Team Role
|
|
2397
|
+
* Assign an organization role to a team so members inherit its permissions.
|
|
2398
|
+
* @param id
|
|
2399
|
+
* @param requestBody
|
|
2400
|
+
* @returns TeamMessageResponse Team role assigned successfully
|
|
2401
|
+
* @throws ApiError
|
|
2402
|
+
*/
|
|
2403
|
+
assignTeamRole(id: string, requestBody?: AssignTeamRoleRequest): CancelablePromise<TeamMessageResponse>;
|
|
2404
|
+
/**
|
|
2405
|
+
* Unassign Team Role
|
|
2406
|
+
* Remove the inherited organization role from a team.
|
|
2407
|
+
* @param id
|
|
2408
|
+
* @returns TeamMessageResponse Team role removed successfully
|
|
2409
|
+
* @throws ApiError
|
|
2410
|
+
*/
|
|
2411
|
+
unassignTeamRole(id: string): CancelablePromise<TeamMessageResponse>;
|
|
2412
|
+
/**
|
|
2413
|
+
* Get Team Effective Permissions
|
|
2414
|
+
* Get the org-level permissions inherited by team members through the team role
|
|
2415
|
+
* @param id
|
|
2416
|
+
* @returns EffectivePermissionsResponse Team effective permissions returned successfully
|
|
2417
|
+
* @throws ApiError
|
|
2418
|
+
*/
|
|
2419
|
+
getTeamEffectivePermissions(id: string): CancelablePromise<EffectivePermissionsResponse>;
|
|
2073
2420
|
}
|
|
2074
2421
|
|
|
2075
2422
|
type UpdateUserRequest = {
|
|
@@ -2270,6 +2617,7 @@ declare class EnvSyncAPISDK {
|
|
|
2270
2617
|
readonly auditLogs: AuditLogsService;
|
|
2271
2618
|
readonly authentication: AuthenticationService;
|
|
2272
2619
|
readonly certificates: CertificatesService;
|
|
2620
|
+
readonly changeRequests: ChangeRequestsService;
|
|
2273
2621
|
readonly environmentTypes: EnvironmentTypesService;
|
|
2274
2622
|
readonly environmentVariables: EnvironmentVariablesService;
|
|
2275
2623
|
readonly environmentVariablesPointInTime: EnvironmentVariablesPointInTimeService;
|
|
@@ -2309,11 +2657,10 @@ declare class ApiError extends Error {
|
|
|
2309
2657
|
|
|
2310
2658
|
type ErrorResponse = {
|
|
2311
2659
|
error: string;
|
|
2312
|
-
code?: string;
|
|
2313
2660
|
};
|
|
2314
2661
|
|
|
2315
2662
|
type UploadFileError = {
|
|
2316
2663
|
error: string;
|
|
2317
2664
|
};
|
|
2318
2665
|
|
|
2319
|
-
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, type AddTeamMemberRequest, ApiError, type ApiKeyResponse, type ApiKeysResponse, ApiKeysService, ApplicationsService, AuditLogsService, AuthenticationService, BaseHttpRequest, type BatchCreateEnvsRequest, type BatchCreateSecretsRequest, type BatchDeleteEnvsRequest, type BatchDeleteSecretsRequest, type BatchEnvsResponse, type BatchSecretsResponse, type CRLResponse, type CallbackResponse, CancelError, CancelablePromise, type CertificateListResponse, CertificatesService, type CheckSlugResponse, type CreateApiKeyRequest, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type CreateEnvTypeRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateRoleRequest, type CreateSecretRequest, type CreateTeamRequest, type CreateTeamResponse, type CreateUserInviteRequest, type CreateUserInviteResponse, CreateWebhookRequest, type DeleteAppResponse, type DeleteEnvRequest, type DeleteEnvTypeRequest, type DeleteSecretRequest, type DeleteUserInviteResponse, type EffectivePermissionsResponse, 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, type ExportKeyResponse, FileUploadService, GenerateGpgKeyRequest, type GetAppResponse, type GetAppsResponse, type GetAuditLogsResponse, type GetAuditLogsResponseWrapper, type GetEnvRequest, type GetOrgInviteByCodeResponse, type GetSecretRequest, type GetTeamResponse, type GetTeamsResponse, type GetUserInviteByTokenResponse, type GpgKeyDetailResponse, type GpgKeyResponse, type GpgKeysResponse, GpgKeysService, GrantAccessRequest, type ImportGpgKeyRequest, type InitOrgCARequest, type IssueMemberCertRequest, type LoginUrlResponse, type MemberCertResponse, type OCSPResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgCAResponse, type OrgResponse, OrganizationsService, type PermissionMessageResponse, PermissionsService, type RegenerateApiKeyResponse, type RevealSecretsRequest, type RevealSecretsResponse, RevokeAccessRequest, type RevokeCertRequest, type RevokeCertResponse, type RevokeGpgKeyRequest, type RoleResponse, type RoleStatsResponse, type RolesResponse, RolesService, type RollbackResponse, type RollbackSecretsResponse, type RollbackSecretsToPitRequest, type RollbackSecretsToTimestampRequest, type RollbackToPitRequest, type RollbackToTimestampRequest, type RootCAResponse, 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, SignDataRequest, type SignatureResponse, type TeamMessageResponse, TeamsService, type UpdateApiKeyRequest, type UpdateAppRequest, type UpdateAppResponse, type UpdateEnvRequest, type UpdateEnvTypeRequest, type UpdateOrgRequest, type UpdateRoleRequest, type UpdateSecretRequest, type UpdateTeamRequest, UpdateTrustLevelRequest, 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, type VerifyResponse, type VerifySignatureRequest, WebhookResponse, type WebhooksResponse, WebhooksService, type WhoAmIResponse };
|
|
2666
|
+
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, type AddTeamMemberRequest, ApiError, type ApiKeyResponse, type ApiKeysResponse, ApiKeysService, ApplicationsService, type AssignTeamRoleRequest, AuditLogsService, AuthenticationService, BaseHttpRequest, type BatchCreateEnvsRequest, type BatchCreateSecretsRequest, type BatchDeleteEnvsRequest, type BatchDeleteSecretsRequest, type BatchEnvsResponse, type BatchSecretsResponse, type CRLResponse, type CallbackResponse, CancelError, CancelablePromise, type CertificateListResponse, CertificatesService, type ChangeRequestListResponse, ChangeRequestResponse, ChangeRequestsService, type CheckSlugResponse, type CreateApiKeyRequest, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type CreateEnvTypeRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateRoleRequest, type CreateSecretRequest, type CreateTeamRequest, type CreateTeamResponse, type CreateUserInviteRequest, type CreateUserInviteResponse, CreateWebhookRequest, type DeleteAppResponse, type DeleteEnvRequest, type DeleteEnvTypeRequest, type DeleteSecretRequest, type DeleteUserInviteResponse, type DirectChangeRequestBody, type EffectiveAccessResponse, type EffectivePermissionsResponse, 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, ExportEnvRequest, type ExportEnvResponse, type ExportKeyResponse, type ExtendGpgKeyExpiryRequest, FileUploadService, GenerateGpgKeyRequest, type GetAppResponse, type GetAppsResponse, type GetAuditLogsResponse, type GetAuditLogsResponseWrapper, type GetEnvRequest, type GetOrgInviteByCodeResponse, type GetSecretRequest, type GetTeamResponse, type GetTeamsResponse, type GetUserInviteByTokenResponse, type GpgKeyDetailResponse, type GpgKeyResponse, type GpgKeysResponse, GpgKeysService, GrantAccessRequest, type GrantsListResponse, type ImportGpgKeyRequest, type InitOrgCARequest, type IssueMemberCertRequest, type LoginUrlResponse, type LogoutUrlResponse, type MemberCertResponse, type OCSPResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgCAResponse, type OrgResponse, OrganizationsService, type PermissionMessageResponse, PermissionsService, type PromotionChangeRequestBody, type RegenerateApiKeyResponse, type RejectChangeRequestBody, type RenewCertRequest, type RevealSecretsRequest, type RevealSecretsResponse, RevokeAccessRequest, type RevokeCertRequest, type RevokeCertResponse, type RevokeGpgKeyRequest, type RoleResponse, type RoleStatsResponse, type RolesResponse, RolesService, type RollbackResponse, type RollbackSecretsResponse, type RollbackSecretsToPitRequest, type RollbackSecretsToTimestampRequest, type RollbackToPitRequest, type RollbackToTimestampRequest, type RootCAResponse, type RotateCertRequest, RotateGpgKeyRequest, 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, SignDataRequest, type SignatureResponse, type TeamMessageResponse, TeamsService, type UpdateApiKeyRequest, type UpdateAppRequest, type UpdateAppResponse, type UpdateEnvRequest, type UpdateEnvTypeRequest, type UpdateOrgRequest, type UpdateRoleRequest, type UpdateSecretRequest, type UpdateTeamRequest, UpdateTrustLevelRequest, 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, type VerifyResponse, type VerifySignatureRequest, WebhookResponse, type WebhooksResponse, WebhooksService, type WhoAmIResponse };
|