sylphx 0.3.2

The Sylphx SDK: one API, one key, every Sylphx service. Generated from the Sylphx schema registry.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
// @generated by sylphx-gen 0.1.0 from contracts@c8a7361c53e572321b0ec9fb014fd1e8279b007b62562423038e0d0e5b9d767a. Do not edit.
//! `sylphx.keys.v1`.

#![allow(clippy::all)]

/// The request of CreateKey.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct CreateKeyRequest {
    /// The environment to create in.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub parent: String,
    /// The key to create; only spec and caller-writable metadata are read.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<Key>,
    /// The id of the new key, `^[a-z]([a-z0-9_-]{0,61}[a-z0-9])?$`; the server assigns one when
    /// empty.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "keyId"
    )]
    pub key_id: String,
    /// Validate and return the result without writing anything.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "validateOnly"
    )]
    pub validate_only: bool,
}

/// The request of Decrypt.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct DecryptRequest {
    /// The key to use.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// The ciphertext from Encrypt.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub ciphertext: String,
    /// The additional authenticated data given to Encrypt.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "additionalAuthenticatedData"
    )]
    pub additional_authenticated_data: String,
}

/// The response of Decrypt.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct DecryptResponse {
    /// The plaintext.
    ///
    /// Field behavior: `sensitive`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub plaintext: String,
    /// The version that decrypted.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "keyVersion"
    )]
    pub key_version: String,
}

/// The request of DeleteKey.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct DeleteKeyRequest {
    /// The name of the key to delete.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// Delete only if the current etag matches.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub etag: String,
    /// Validate without deleting anything.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "validateOnly"
    )]
    pub validate_only: bool,
    /// Also delete every child Resource; without it a parent with children
    /// fails with FAILED_PRECONDITION.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub force: bool,
}

/// The request of DestroyKeyVersion.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct DestroyKeyVersionRequest {
    /// The name of the key version to destroy.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// Destroy only if the current etag matches.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub etag: String,
    /// Validate without destroying.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "validateOnly"
    )]
    pub validate_only: bool,
}

/// The request of Encrypt.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct EncryptRequest {
    /// The key to use.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// The plaintext, at most 64 KiB.
    ///
    /// Field behavior: `required`, `sensitive`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub plaintext: String,
    /// Data bound to the ciphertext and required again to decrypt it.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "additionalAuthenticatedData"
    )]
    pub additional_authenticated_data: String,
}

/// The response of Encrypt.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct EncryptResponse {
    /// The ciphertext; it names the version that made it.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub ciphertext: String,
    /// The version that encrypted.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "keyVersion"
    )]
    pub key_version: String,
}

/// The request of GetKey.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct GetKeyRequest {
    /// The name of the key to get.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
}

/// The request of GetKeyVersion.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct GetKeyVersionRequest {
    /// The name of the key version to get.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
}

/// A Key is a non-exportable key on the regional signer: a handle for
/// signing, encryption, or MAC. Rotation adds a version and keeps the old
/// one usable for verification and decryption until it is destroyed.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct Key {
    /// `orgs/{org}/projects/{project}/envs/{env}/keys/{key}`.
    ///
    /// Field behavior: `identifier`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// `kms_<cell><ulid>`.
    ///
    /// Field behavior: `output_only`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub uid: String,
    /// Resource metadata.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub meta: Option<crate::common::ResourceMeta>,
    /// Desired state.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub spec: Option<KeySpec>,
    /// Observed state.
    ///
    /// Field behavior: `output_only`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<KeyStatus>,
}

/// KeySpec is the caller-writable state of a Key.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct KeySpec {
    /// What the key does.
    ///
    /// Field behavior: `required`, `immutable`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub purpose: Option<KeyPurpose>,
    /// The algorithm; it must suit the purpose.
    ///
    /// Field behavior: `required`, `immutable`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub algorithm: Option<KeyAlgorithm>,
    /// Rotate automatically this often; unset means rotate only on request.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "rotationPeriod"
    )]
    pub rotation_period: String,
    /// While true, Delete fails with DELETION_PROTECTED. Default true.
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        alias = "deletionProtection"
    )]
    pub deletion_protection: Option<bool>,
}

/// KeyStatus is the observed state of a Key.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct KeyStatus {
    /// The generation this status was computed from.
    ///
    /// Field behavior: `output_only`.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        with = "crate::runtime::int64",
        alias = "observedGeneration"
    )]
    pub observed_generation: i64,
    /// Ready, Reconciling, Stalled.
    ///
    /// Field behavior: `output_only`.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub conditions: Vec<crate::common::Condition>,
    /// The version Sign, Encrypt, and MacSign use.
    ///
    /// Field behavior: `output_only`.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "primaryVersion"
    )]
    pub primary_version: String,
    /// Where the key material came from.
    ///
    /// Field behavior: `output_only`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub origin: Option<KeyOrigin>,
    /// When the next automatic rotation runs.
    ///
    /// Field behavior: `output_only`.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "nextRotationTime"
    )]
    pub next_rotation_time: String,
    /// The regions whose signer holds the key.
    ///
    /// Field behavior: `output_only`.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub regions: Vec<String>,
}

/// A KeyVersion is one generation of a Key's material. Its private or
/// symmetric material never leaves the signer; an asymmetric version
/// publishes its public key.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct KeyVersion {
    /// `…/keys/{key}/key_versions/{key_version}`; the id is the version
    /// number, from 1.
    ///
    /// Field behavior: `identifier`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// `kmv_<cell><ulid>`.
    ///
    /// Field behavior: `output_only`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub uid: String,
    /// Resource metadata.
    ///
    /// Field behavior: `output_only`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub meta: Option<crate::common::ResourceMeta>,
    /// The version's lifecycle state.
    ///
    /// Field behavior: `output_only`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<KeyVersionState>,
    /// The algorithm, equal to the key's.
    ///
    /// Field behavior: `output_only`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub algorithm: Option<KeyAlgorithm>,
    /// The public key in PEM (SubjectPublicKeyInfo), for asymmetric keys; empty
    /// otherwise.
    ///
    /// Field behavior: `output_only`.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "publicKeyPem"
    )]
    pub public_key_pem: String,
    /// When the version's material is destroyed, or was.
    ///
    /// Field behavior: `output_only`.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "destroyTime"
    )]
    pub destroy_time: String,
}

/// The request of ListKeyVersions.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct ListKeyVersionsRequest {
    /// The key to list in.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub parent: String,
    /// At most this many; default 50, clamped to 1000.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "pageSize"
    )]
    pub page_size: i32,
    /// `next_page_token` of the previous page.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "pageToken"
    )]
    pub page_token: String,
    /// AIP-160 filter over labels and filterable fields.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub filter: String,
    /// AIP-132 ordering over filterable fields.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "orderBy"
    )]
    pub order_by: String,
}

/// The response of ListKeyVersions.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct ListKeyVersionsResponse {
    /// The page.
    #[serde(default, skip_serializing_if = "Vec::is_empty", alias = "keyVersions")]
    pub key_versions: Vec<KeyVersion>,
    /// The token of the next page; empty on the last page.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "nextPageToken"
    )]
    pub next_page_token: String,
}

/// The request of ListKeys.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct ListKeysRequest {
    /// The environment to list in.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub parent: String,
    /// At most this many; default 50, clamped to 1000.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "pageSize"
    )]
    pub page_size: i32,
    /// `next_page_token` of the previous page.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "pageToken"
    )]
    pub page_token: String,
    /// AIP-160 filter over labels and filterable fields.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub filter: String,
    /// AIP-132 ordering over filterable fields.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "orderBy"
    )]
    pub order_by: String,
}

/// The response of ListKeys.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct ListKeysResponse {
    /// The page.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub keys: Vec<Key>,
    /// The token of the next page; empty on the last page.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "nextPageToken"
    )]
    pub next_page_token: String,
}

/// The request of MacSign.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct MacSignRequest {
    /// The key to use.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// The version to use; default the primary version.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "keyVersion"
    )]
    pub key_version: String,
    /// The message, at most 64 KiB.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub data: String,
}

/// The response of MacSign.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct MacSignResponse {
    /// The MAC.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub mac: String,
    /// The version that computed the MAC.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "keyVersion"
    )]
    pub key_version: String,
}

/// The request of MacVerify.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct MacVerifyRequest {
    /// The key to use.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// The version to use; default the primary version.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "keyVersion"
    )]
    pub key_version: String,
    /// The message.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub data: String,
    /// The MAC to check.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub mac: String,
}

/// The response of MacVerify.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct MacVerifyResponse {
    /// The MAC is valid.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub valid: bool,
}

/// The request of RotateKey.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct RotateKeyRequest {
    /// The name of the key to rotate.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// Rotate only if the current etag matches.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub etag: String,
    /// Validate without rotating.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "validateOnly"
    )]
    pub validate_only: bool,
}

/// The request of Sign.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct SignRequest {
    /// The key to use.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// The version to use; default the primary version.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "keyVersion"
    )]
    pub key_version: String,
    /// The message to sign, at most 64 KiB. Set exactly one of `data` and
    /// `digest`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub data: String,
    /// The digest of the message under the algorithm's hash.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub digest: String,
}

/// The response of Sign.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct SignResponse {
    /// The signature.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub signature: String,
    /// The version that signed.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "keyVersion"
    )]
    pub key_version: String,
}

/// The request of UpdateKey.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct UpdateKeyRequest {
    /// The key to update; `name` identifies it.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<Key>,
    /// The fields to write; unset writes every populated field.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "updateMask"
    )]
    pub update_mask: String,
    /// Validate and return the result without writing anything.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "validateOnly"
    )]
    pub validate_only: bool,
}

/// The request of Verify.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct VerifyRequest {
    /// The key to use.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub name: String,
    /// The version to use; default the primary version; the signature names none.
    #[serde(
        default,
        skip_serializing_if = "crate::runtime::is_default",
        alias = "keyVersion"
    )]
    pub key_version: String,
    /// The signed message. Set exactly one of `data` and `digest`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub data: String,
    /// The digest of the signed message.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub digest: String,
    /// The signature to check.
    ///
    /// Field behavior: `required`.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub signature: String,
}

/// The response of Verify.
#[derive(Debug, Clone, Default, PartialEq, serde::Serialize, serde::Deserialize)]
#[non_exhaustive]
pub struct VerifyResponse {
    /// The signature is valid.
    #[serde(default, skip_serializing_if = "crate::runtime::is_default")]
    pub valid: bool,
}

/// KeyAlgorithm is a Key's algorithm.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum KeyAlgorithm {
    /// Ed25519 signatures.
    Ed25519,
    /// ECDSA on P-256 with SHA-256.
    EcP256Sha256,
    /// RSASSA-PKCS1-v1_5, 2048-bit, SHA-256 (JWT RS256).
    RsaPkcs12048Sha256,
    /// RSASSA-PSS, 3072-bit, SHA-256.
    RsaPss3072Sha256,
    /// AES-256-GCM authenticated encryption.
    Aes256Gcm,
    /// HMAC with SHA-256.
    HmacSha256,
    /// A value this SDK version does not know.
    Unknown(String),
}

impl KeyAlgorithm {
    /// The wire string.
    pub fn as_str(&self) -> &str {
        match self {
            Self::Ed25519 => "ed25519",
            Self::EcP256Sha256 => "ec_p256_sha256",
            Self::RsaPkcs12048Sha256 => "rsa_pkcs1_2048_sha256",
            Self::RsaPss3072Sha256 => "rsa_pss_3072_sha256",
            Self::Aes256Gcm => "aes_256_gcm",
            Self::HmacSha256 => "hmac_sha256",
            Self::Unknown(s) => s.as_str(),
        }
    }

    /// Parses a wire string; unknown values are kept.
    pub fn from_wire(s: &str) -> Self {
        match s {
            "ed25519" => Self::Ed25519,
            "ec_p256_sha256" => Self::EcP256Sha256,
            "rsa_pkcs1_2048_sha256" => Self::RsaPkcs12048Sha256,
            "rsa_pss_3072_sha256" => Self::RsaPss3072Sha256,
            "aes_256_gcm" => Self::Aes256Gcm,
            "hmac_sha256" => Self::HmacSha256,
            other => Self::Unknown(other.to_string()),
        }
    }
}

impl serde::Serialize for KeyAlgorithm {
    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
        s.serialize_str(self.as_str())
    }
}

impl<'de> serde::Deserialize<'de> for KeyAlgorithm {
    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
        let s = <String as serde::Deserialize>::deserialize(d)?;
        Ok(Self::from_wire(&s))
    }
}

impl crate::runtime::QueryValue for KeyAlgorithm {
    fn query_value(&self) -> Option<String> {
        Some(self.as_str().to_string())
    }
}

/// KeyOrigin is where a Key's material came from.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum KeyOrigin {
    /// Generated on the signer.
    Generated,
    /// Imported once by ceremony; the local copy was destroyed.
    Imported,
    /// A value this SDK version does not know.
    Unknown(String),
}

impl KeyOrigin {
    /// The wire string.
    pub fn as_str(&self) -> &str {
        match self {
            Self::Generated => "generated",
            Self::Imported => "imported",
            Self::Unknown(s) => s.as_str(),
        }
    }

    /// Parses a wire string; unknown values are kept.
    pub fn from_wire(s: &str) -> Self {
        match s {
            "generated" => Self::Generated,
            "imported" => Self::Imported,
            other => Self::Unknown(other.to_string()),
        }
    }
}

impl serde::Serialize for KeyOrigin {
    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
        s.serialize_str(self.as_str())
    }
}

impl<'de> serde::Deserialize<'de> for KeyOrigin {
    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
        let s = <String as serde::Deserialize>::deserialize(d)?;
        Ok(Self::from_wire(&s))
    }
}

impl crate::runtime::QueryValue for KeyOrigin {
    fn query_value(&self) -> Option<String> {
        Some(self.as_str().to_string())
    }
}

/// KeyPurpose is what a Key does.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum KeyPurpose {
    /// Asymmetric sign and verify.
    Sign,
    /// Symmetric encrypt and decrypt.
    Encrypt,
    /// Symmetric MAC sign and verify.
    Mac,
    /// A value this SDK version does not know.
    Unknown(String),
}

impl KeyPurpose {
    /// The wire string.
    pub fn as_str(&self) -> &str {
        match self {
            Self::Sign => "sign",
            Self::Encrypt => "encrypt",
            Self::Mac => "mac",
            Self::Unknown(s) => s.as_str(),
        }
    }

    /// Parses a wire string; unknown values are kept.
    pub fn from_wire(s: &str) -> Self {
        match s {
            "sign" => Self::Sign,
            "encrypt" => Self::Encrypt,
            "mac" => Self::Mac,
            other => Self::Unknown(other.to_string()),
        }
    }
}

impl serde::Serialize for KeyPurpose {
    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
        s.serialize_str(self.as_str())
    }
}

impl<'de> serde::Deserialize<'de> for KeyPurpose {
    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
        let s = <String as serde::Deserialize>::deserialize(d)?;
        Ok(Self::from_wire(&s))
    }
}

impl crate::runtime::QueryValue for KeyPurpose {
    fn query_value(&self) -> Option<String> {
        Some(self.as_str().to_string())
    }
}

/// KeyVersionState is the lifecycle state of a KeyVersion.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum KeyVersionState {
    /// The signer is generating or importing the material.
    Pending,
    /// Usable.
    Enabled,
    /// Verify and decrypt only; no new signatures or ciphertexts.
    Retired,
    /// Destruction is scheduled for `destroy_time`.
    DestroyScheduled,
    /// The material is gone.
    Destroyed,
    /// A value this SDK version does not know.
    Unknown(String),
}

impl KeyVersionState {
    /// The wire string.
    pub fn as_str(&self) -> &str {
        match self {
            Self::Pending => "pending",
            Self::Enabled => "enabled",
            Self::Retired => "retired",
            Self::DestroyScheduled => "destroy_scheduled",
            Self::Destroyed => "destroyed",
            Self::Unknown(s) => s.as_str(),
        }
    }

    /// Parses a wire string; unknown values are kept.
    pub fn from_wire(s: &str) -> Self {
        match s {
            "pending" => Self::Pending,
            "enabled" => Self::Enabled,
            "retired" => Self::Retired,
            "destroy_scheduled" => Self::DestroyScheduled,
            "destroyed" => Self::Destroyed,
            other => Self::Unknown(other.to_string()),
        }
    }
}

impl serde::Serialize for KeyVersionState {
    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
        s.serialize_str(self.as_str())
    }
}

impl<'de> serde::Deserialize<'de> for KeyVersionState {
    fn deserialize<D: serde::Deserializer<'de>>(d: D) -> Result<Self, D::Error> {
        let s = <String as serde::Deserialize>::deserialize(d)?;
        Ok(Self::from_wire(&s))
    }
}

impl crate::runtime::QueryValue for KeyVersionState {
    fn query_value(&self) -> Option<String> {
        Some(self.as_str().to_string())
    }
}

impl<T: crate::runtime::Transport> crate::runtime::Client<T> {
    /// Sylphx Keys (`preview`).
    pub fn keys(&self) -> KeysApi<'_, T> {
        KeysApi { client: self }
    }
}

/// KeysService is Sylphx Keys: non-exportable keys on the regional signer.
/// Callers use a key; no method returns key material.
///
/// Namespace of Sylphx Keys on the client.
pub struct KeysApi<'a, T> {
    client: &'a crate::runtime::Client<T>,
}

impl<'a, T: crate::runtime::Transport> KeysApi<'a, T> {
    /// The `keys` collection.
    pub fn keys(&self) -> KeysCollection<'a, T> {
        KeysCollection {
            client: self.client,
        }
    }

    /// The `key_versions` collection.
    pub fn key_versions(&self) -> KeyVersionsCollection<'a, T> {
        KeyVersionsCollection {
            client: self.client,
        }
    }
}

/// `keys` of Sylphx Keys: Resource type `keys.sylphx.com/Key`.
pub struct KeysCollection<'a, T> {
    client: &'a crate::runtime::Client<T>,
}

impl<'a, T: crate::runtime::Transport> KeysCollection<'a, T> {
    /// Gets a key.
    ///
    /// `GET /v1/{name=orgs/*/projects/*/envs/*/keys/*}` · permission `keys:read` · effect `read`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`.
    pub async fn get(&self, request: GetKeyRequest) -> Result<Key, crate::runtime::Error> {
        let path = format!(
            "/v1/{}",
            crate::runtime::path_param(&request.name, "orgs/*/projects/*/envs/*/keys/*", "name")?
        );
        let query = crate::runtime::Query::default();
        let http = crate::runtime::HttpRequest {
            method: "GET",
            path,
            query: query.0,
            body: None,
            mutation: false,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }

    /// Lists keys in an environment.
    ///
    /// `GET /v1/{parent=orgs/*/projects/*/envs/*}/keys` · permission `keys:read` · effect `read`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `INVALID_FIELD`, `PAGE_TOKEN_MISMATCH`.
    pub async fn list(
        &self,
        request: ListKeysRequest,
    ) -> Result<ListKeysResponse, crate::runtime::Error> {
        let path = format!(
            "/v1/{}/keys",
            crate::runtime::path_param(&request.parent, "orgs/*/projects/*/envs/*", "parent")?
        );
        let mut query = crate::runtime::Query::default();
        query.push("page_size", &request.page_size);
        query.push("page_token", &request.page_token);
        query.push("filter", &request.filter);
        query.push("order_by", &request.order_by);
        let http = crate::runtime::HttpRequest {
            method: "GET",
            path,
            query: query.0,
            body: None,
            mutation: false,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }

    /// Every page of [`Self::list`], collected.
    pub async fn list_all(
        &self,
        mut request: ListKeysRequest,
    ) -> Result<Vec<Key>, crate::runtime::Error> {
        let mut items = Vec::new();
        loop {
            let page = self.list(request.clone()).await?;
            items.extend(page.keys);
            if page.next_page_token.is_empty() {
                return Ok(items);
            }
            request.page_token = page.next_page_token;
        }
    }

    /// Creates a key; the signer generates its first version.
    ///
    /// `POST /v1/{parent=orgs/*/projects/*/envs/*}/keys` · permission `keys:write` · effect `write`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `UNKNOWN_FIELD`, `INVALID_FIELD`, `RESOURCE_ALREADY_EXISTS`, `IDEMPOTENCY_KEY_REUSED`, `IDEMPOTENCY_IN_PROGRESS`, `PLAN_LIMIT_REACHED`.
    pub async fn create(
        &self,
        request: CreateKeyRequest,
    ) -> Result<crate::runtime::Operation<'a, T, Key>, crate::runtime::Error> {
        let path = format!(
            "/v1/{}/keys",
            crate::runtime::path_param(&request.parent, "orgs/*/projects/*/envs/*", "parent")?
        );
        let mut query = crate::runtime::Query::default();
        query.push("key_id", &request.key_id);
        query.push("validate_only", &request.validate_only);
        let http = crate::runtime::HttpRequest {
            method: "POST",
            path,
            query: query.0,
            body: Some(crate::runtime::body(&request.key)?),
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        let operation = self.client.call(http).await?;
        Ok(crate::runtime::Operation::new(self.client, operation))
    }

    /// Updates a key's rotation period, deletion protection, or metadata.
    ///
    /// `PATCH /v1/{key.name=orgs/*/projects/*/envs/*/keys/*}` · permission `keys:write` · effect `write`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`, `UNKNOWN_FIELD`, `INVALID_FIELD`, `ETAG_MISMATCH`, `IDEMPOTENCY_KEY_REUSED`, `IDEMPOTENCY_IN_PROGRESS`.
    pub async fn update(
        &self,
        request: UpdateKeyRequest,
    ) -> Result<crate::runtime::Operation<'a, T, Key>, crate::runtime::Error> {
        let path = format!(
            "/v1/{}",
            crate::runtime::path_param(
                request.key.as_ref().map(|v| v.name.as_str()).unwrap_or(""),
                "orgs/*/projects/*/envs/*/keys/*",
                "key.name"
            )?
        );
        let mut query = crate::runtime::Query::default();
        query.push("update_mask", &request.update_mask);
        query.push("validate_only", &request.validate_only);
        let http = crate::runtime::HttpRequest {
            method: "PATCH",
            path,
            query: query.0,
            body: Some(crate::runtime::body(&request.key)?),
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        let operation = self.client.call(http).await?;
        Ok(crate::runtime::Operation::new(self.client, operation))
    }

    /// Deletes a key and schedules every version's destruction.
    ///
    /// `DELETE /v1/{name=orgs/*/projects/*/envs/*/keys/*}` · permission `keys:write` · effect `destructive`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`, `ETAG_MISMATCH`, `INVALID_STATE`, `IDEMPOTENCY_KEY_REUSED`, `IDEMPOTENCY_IN_PROGRESS`, `DELETION_PROTECTED`.
    pub async fn delete(
        &self,
        request: DeleteKeyRequest,
    ) -> Result<crate::runtime::Operation<'a, T, crate::runtime::Empty>, crate::runtime::Error>
    {
        let path = format!(
            "/v1/{}",
            crate::runtime::path_param(&request.name, "orgs/*/projects/*/envs/*/keys/*", "name")?
        );
        let mut query = crate::runtime::Query::default();
        query.push("etag", &request.etag);
        query.push("validate_only", &request.validate_only);
        query.push("force", &request.force);
        let http = crate::runtime::HttpRequest {
            method: "DELETE",
            path,
            query: query.0,
            body: None,
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        let operation = self.client.call(http).await?;
        Ok(crate::runtime::Operation::new(self.client, operation))
    }

    /// Rotates a key: adds a version and makes it primary. Older versions keep
    /// verifying and decrypting until destroyed.
    ///
    /// `POST /v1/{name=orgs/*/projects/*/envs/*/keys/*}:rotate` · permission `keys:write` · effect `write`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`, `ETAG_MISMATCH`, `INVALID_STATE`, `IDEMPOTENCY_KEY_REUSED`, `IDEMPOTENCY_IN_PROGRESS`.
    pub async fn rotate(
        &self,
        request: RotateKeyRequest,
    ) -> Result<crate::runtime::Operation<'a, T, Key>, crate::runtime::Error> {
        let path = format!(
            "/v1/{}:rotate",
            crate::runtime::path_param(&request.name, "orgs/*/projects/*/envs/*/keys/*", "name")?
        );
        let query = crate::runtime::Query::default();
        let http = crate::runtime::HttpRequest {
            method: "POST",
            path,
            query: query.0,
            body: Some(crate::runtime::body_without(&request, &["name"])?),
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        let operation = self.client.call(http).await?;
        Ok(crate::runtime::Operation::new(self.client, operation))
    }

    /// Signs data or a digest with a SIGN key. Every use is audited.
    ///
    /// `POST /v1/{name=orgs/*/projects/*/envs/*/keys/*}:sign` · permission `keys:sign` · effect `read`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`, `INVALID_FIELD`, `INVALID_STATE`, `RATE_LIMITED`.
    pub async fn sign(&self, request: SignRequest) -> Result<SignResponse, crate::runtime::Error> {
        let path = format!(
            "/v1/{}:sign",
            crate::runtime::path_param(&request.name, "orgs/*/projects/*/envs/*/keys/*", "name")?
        );
        let query = crate::runtime::Query::default();
        let http = crate::runtime::HttpRequest {
            method: "POST",
            path,
            query: query.0,
            body: Some(crate::runtime::body_without(&request, &["name"])?),
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }

    /// Verifies a signature made by a SIGN key.
    ///
    /// `POST /v1/{name=orgs/*/projects/*/envs/*/keys/*}:verify` · permission `keys:verify` · effect `read`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`, `INVALID_FIELD`, `INVALID_STATE`, `RATE_LIMITED`.
    pub async fn verify(
        &self,
        request: VerifyRequest,
    ) -> Result<VerifyResponse, crate::runtime::Error> {
        let path = format!(
            "/v1/{}:verify",
            crate::runtime::path_param(&request.name, "orgs/*/projects/*/envs/*/keys/*", "name")?
        );
        let query = crate::runtime::Query::default();
        let http = crate::runtime::HttpRequest {
            method: "POST",
            path,
            query: query.0,
            body: Some(crate::runtime::body_without(&request, &["name"])?),
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }

    /// Encrypts data with an ENCRYPT key.
    ///
    /// `POST /v1/{name=orgs/*/projects/*/envs/*/keys/*}:encrypt` · permission `keys:encrypt` · effect `read`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`, `INVALID_FIELD`, `INVALID_STATE`, `RATE_LIMITED`.
    pub async fn encrypt(
        &self,
        request: EncryptRequest,
    ) -> Result<EncryptResponse, crate::runtime::Error> {
        let path = format!(
            "/v1/{}:encrypt",
            crate::runtime::path_param(&request.name, "orgs/*/projects/*/envs/*/keys/*", "name")?
        );
        let query = crate::runtime::Query::default();
        let http = crate::runtime::HttpRequest {
            method: "POST",
            path,
            query: query.0,
            body: Some(crate::runtime::body_without(&request, &["name"])?),
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }

    /// Decrypts a ciphertext made by Encrypt with this key.
    ///
    /// `POST /v1/{name=orgs/*/projects/*/envs/*/keys/*}:decrypt` · permission `keys:decrypt` · effect `read`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`, `INVALID_FIELD`, `INVALID_STATE`, `RATE_LIMITED`.
    pub async fn decrypt(
        &self,
        request: DecryptRequest,
    ) -> Result<DecryptResponse, crate::runtime::Error> {
        let path = format!(
            "/v1/{}:decrypt",
            crate::runtime::path_param(&request.name, "orgs/*/projects/*/envs/*/keys/*", "name")?
        );
        let query = crate::runtime::Query::default();
        let http = crate::runtime::HttpRequest {
            method: "POST",
            path,
            query: query.0,
            body: Some(crate::runtime::body_without(&request, &["name"])?),
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }

    /// Computes a MAC of data with a MAC key.
    ///
    /// `POST /v1/{name=orgs/*/projects/*/envs/*/keys/*}:macSign` · permission `keys:sign` · effect `read`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`, `INVALID_FIELD`, `INVALID_STATE`, `RATE_LIMITED`.
    pub async fn mac_sign(
        &self,
        request: MacSignRequest,
    ) -> Result<MacSignResponse, crate::runtime::Error> {
        let path = format!(
            "/v1/{}:macSign",
            crate::runtime::path_param(&request.name, "orgs/*/projects/*/envs/*/keys/*", "name")?
        );
        let query = crate::runtime::Query::default();
        let http = crate::runtime::HttpRequest {
            method: "POST",
            path,
            query: query.0,
            body: Some(crate::runtime::body_without(&request, &["name"])?),
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }

    /// Verifies a MAC made by a MAC key, in constant time.
    ///
    /// `POST /v1/{name=orgs/*/projects/*/envs/*/keys/*}:macVerify` · permission `keys:verify` · effect `read`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`, `INVALID_FIELD`, `INVALID_STATE`, `RATE_LIMITED`.
    pub async fn mac_verify(
        &self,
        request: MacVerifyRequest,
    ) -> Result<MacVerifyResponse, crate::runtime::Error> {
        let path = format!(
            "/v1/{}:macVerify",
            crate::runtime::path_param(&request.name, "orgs/*/projects/*/envs/*/keys/*", "name")?
        );
        let query = crate::runtime::Query::default();
        let http = crate::runtime::HttpRequest {
            method: "POST",
            path,
            query: query.0,
            body: Some(crate::runtime::body_without(&request, &["name"])?),
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }
}

/// `key_versions` of Sylphx Keys: Resource type `keys.sylphx.com/KeyVersion`.
pub struct KeyVersionsCollection<'a, T> {
    client: &'a crate::runtime::Client<T>,
}

impl<'a, T: crate::runtime::Transport> KeyVersionsCollection<'a, T> {
    /// Gets a key version.
    ///
    /// `GET /v1/{name=orgs/*/projects/*/envs/*/keys/*/key_versions/*}` · permission `keys:read` · effect `read`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`.
    pub async fn get(
        &self,
        request: GetKeyVersionRequest,
    ) -> Result<KeyVersion, crate::runtime::Error> {
        let path = format!(
            "/v1/{}",
            crate::runtime::path_param(
                &request.name,
                "orgs/*/projects/*/envs/*/keys/*/key_versions/*",
                "name"
            )?
        );
        let query = crate::runtime::Query::default();
        let http = crate::runtime::HttpRequest {
            method: "GET",
            path,
            query: query.0,
            body: None,
            mutation: false,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }

    /// Lists a key's versions.
    ///
    /// `GET /v1/{parent=orgs/*/projects/*/envs/*/keys/*}/key_versions` · permission `keys:read` · effect `read`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `INVALID_FIELD`, `PAGE_TOKEN_MISMATCH`.
    pub async fn list(
        &self,
        request: ListKeyVersionsRequest,
    ) -> Result<ListKeyVersionsResponse, crate::runtime::Error> {
        let path = format!(
            "/v1/{}/key_versions",
            crate::runtime::path_param(
                &request.parent,
                "orgs/*/projects/*/envs/*/keys/*",
                "parent"
            )?
        );
        let mut query = crate::runtime::Query::default();
        query.push("page_size", &request.page_size);
        query.push("page_token", &request.page_token);
        query.push("filter", &request.filter);
        query.push("order_by", &request.order_by);
        let http = crate::runtime::HttpRequest {
            method: "GET",
            path,
            query: query.0,
            body: None,
            mutation: false,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }

    /// Every page of [`Self::list`], collected.
    pub async fn list_all(
        &self,
        mut request: ListKeyVersionsRequest,
    ) -> Result<Vec<KeyVersion>, crate::runtime::Error> {
        let mut items = Vec::new();
        loop {
            let page = self.list(request.clone()).await?;
            items.extend(page.key_versions);
            if page.next_page_token.is_empty() {
                return Ok(items);
            }
            request.page_token = page.next_page_token;
        }
    }

    /// Schedules a key version's destruction after a 24-hour grace; the
    /// primary version cannot be destroyed.
    ///
    /// `POST /v1/{name=orgs/*/projects/*/envs/*/keys/*/key_versions/*}:destroy` · permission `keys:write` · effect `destructive`
    ///
    /// Errors: `UNAUTHENTICATED`, `PERMISSION_DENIED`, `RESOURCE_NOT_FOUND`, `ETAG_MISMATCH`, `INVALID_STATE`, `IDEMPOTENCY_KEY_REUSED`, `IDEMPOTENCY_IN_PROGRESS`.
    pub async fn destroy(
        &self,
        request: DestroyKeyVersionRequest,
    ) -> Result<KeyVersion, crate::runtime::Error> {
        let path = format!(
            "/v1/{}:destroy",
            crate::runtime::path_param(
                &request.name,
                "orgs/*/projects/*/envs/*/keys/*/key_versions/*",
                "name"
            )?
        );
        let query = crate::runtime::Query::default();
        let http = crate::runtime::HttpRequest {
            method: "POST",
            path,
            query: query.0,
            body: Some(crate::runtime::body_without(&request, &["name"])?),
            mutation: true,
            origin: None,
            effect_ids: false,
        };
        self.client.call(http).await
    }
}