@turnkey/http 3.5.1 → 3.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,9 +4,9 @@ var base = require('../../../../../base.js');
4
4
 
5
5
  /* @generated by `@turnkey/fetchers`. DO NOT EDIT BY HAND */
6
6
  /**
7
- * Get Activity
7
+ * Get activity
8
8
  *
9
- * Get details about an Activity
9
+ * Get details about an activity.
10
10
  *
11
11
  * `POST /public/v1/query/get_activity`
12
12
  */
@@ -28,7 +28,7 @@ const signGetActivity = (input, options) => base.signedRequest({
28
28
  /**
29
29
  * Get API key
30
30
  *
31
- * Get details about an API key
31
+ * Get details about an API key.
32
32
  *
33
33
  * `POST /public/v1/query/get_api_key`
34
34
  */
@@ -50,7 +50,7 @@ const signGetApiKey = (input, options) => base.signedRequest({
50
50
  /**
51
51
  * Get API keys
52
52
  *
53
- * Get details about API keys for a user
53
+ * Get details about API keys for a user.
54
54
  *
55
55
  * `POST /public/v1/query/get_api_keys`
56
56
  */
@@ -92,9 +92,9 @@ const signGetAttestationDocument = (input, options) => base.signedRequest({
92
92
  options,
93
93
  });
94
94
  /**
95
- * Get Authenticator
95
+ * Get authenticator
96
96
  *
97
- * Get details about an authenticator
97
+ * Get details about an authenticator.
98
98
  *
99
99
  * `POST /public/v1/query/get_authenticator`
100
100
  */
@@ -114,9 +114,9 @@ const signGetAuthenticator = (input, options) => base.signedRequest({
114
114
  options,
115
115
  });
116
116
  /**
117
- * Get Authenticators
117
+ * Get authenticators
118
118
  *
119
- * Get details about authenticators for a user
119
+ * Get details about authenticators for a user.
120
120
  *
121
121
  * `POST /public/v1/query/get_authenticators`
122
122
  */
@@ -138,7 +138,7 @@ const signGetAuthenticators = (input, options) => base.signedRequest({
138
138
  /**
139
139
  * Get Oauth providers
140
140
  *
141
- * Get details about Oauth providers for a user
141
+ * Get details about Oauth providers for a user.
142
142
  *
143
143
  * `POST /public/v1/query/get_oauth_providers`
144
144
  */
@@ -158,9 +158,9 @@ const signGetOauthProviders = (input, options) => base.signedRequest({
158
158
  options,
159
159
  });
160
160
  /**
161
- * Get Organization
161
+ * Get organization
162
162
  *
163
- * Get details about an Organization
163
+ * Get details about an organization.
164
164
  *
165
165
  * `POST /public/v1/query/get_organization`
166
166
  */
@@ -180,9 +180,9 @@ const signGetOrganization = (input, options) => base.signedRequest({
180
180
  options,
181
181
  });
182
182
  /**
183
- * Get Configs
183
+ * Get configs
184
184
  *
185
- * Get quorum settings and features for an organization
185
+ * Get quorum settings and features for an organization.
186
186
  *
187
187
  * `POST /public/v1/query/get_organization_configs`
188
188
  */
@@ -202,9 +202,9 @@ const signGetOrganizationConfigs = (input, options) => base.signedRequest({
202
202
  options,
203
203
  });
204
204
  /**
205
- * Get Policy
205
+ * Get policy
206
206
  *
207
- * Get details about a Policy
207
+ * Get details about a policy.
208
208
  *
209
209
  * `POST /public/v1/query/get_policy`
210
210
  */
@@ -224,9 +224,31 @@ const signGetPolicy = (input, options) => base.signedRequest({
224
224
  options,
225
225
  });
226
226
  /**
227
- * Get Private Key
227
+ * Get policy evaluations
228
228
  *
229
- * Get details about a Private Key
229
+ * Get the policy evaluations for an activity.
230
+ *
231
+ * `POST /public/v1/query/get_policy_evaluations`
232
+ */
233
+ const getPolicyEvaluations = (input) => base.request({
234
+ uri: "/public/v1/query/get_policy_evaluations",
235
+ method: "POST",
236
+ body: input.body,
237
+ });
238
+ /**
239
+ * Request a WebAuthn assertion and return a signed `GetPolicyEvaluations` request, ready to be POSTed to Turnkey.
240
+ *
241
+ * See {@link GetPolicyEvaluations}
242
+ */
243
+ const signGetPolicyEvaluations = (input, options) => base.signedRequest({
244
+ uri: "/public/v1/query/get_policy_evaluations",
245
+ body: input.body,
246
+ options,
247
+ });
248
+ /**
249
+ * Get private key
250
+ *
251
+ * Get details about a private key.
230
252
  *
231
253
  * `POST /public/v1/query/get_private_key`
232
254
  */
@@ -246,9 +268,9 @@ const signGetPrivateKey = (input, options) => base.signedRequest({
246
268
  options,
247
269
  });
248
270
  /**
249
- * Get Smart Contract Interface
271
+ * Get smart contract interface
250
272
  *
251
- * Get details about a Smart Contract Interface
273
+ * Get details about a smart contract interface.
252
274
  *
253
275
  * `POST /public/v1/query/get_smart_contract_interface`
254
276
  */
@@ -268,9 +290,9 @@ const signGetSmartContractInterface = (input, options) => base.signedRequest({
268
290
  options,
269
291
  });
270
292
  /**
271
- * Get User
293
+ * Get user
272
294
  *
273
- * Get details about a User
295
+ * Get details about a user.
274
296
  *
275
297
  * `POST /public/v1/query/get_user`
276
298
  */
@@ -290,9 +312,9 @@ const signGetUser = (input, options) => base.signedRequest({
290
312
  options,
291
313
  });
292
314
  /**
293
- * Get Wallet
315
+ * Get wallet
294
316
  *
295
- * Get details about a Wallet
317
+ * Get details about a wallet.
296
318
  *
297
319
  * `POST /public/v1/query/get_wallet`
298
320
  */
@@ -312,9 +334,9 @@ const signGetWallet = (input, options) => base.signedRequest({
312
334
  options,
313
335
  });
314
336
  /**
315
- * Get Wallet Account
337
+ * Get wallet account
316
338
  *
317
- * Get a single wallet account
339
+ * Get a single wallet account.
318
340
  *
319
341
  * `POST /public/v1/query/get_wallet_account`
320
342
  */
@@ -334,9 +356,9 @@ const signGetWalletAccount = (input, options) => base.signedRequest({
334
356
  options,
335
357
  });
336
358
  /**
337
- * List Activities
359
+ * List activities
338
360
  *
339
- * List all Activities within an Organization
361
+ * List all activities within an organization.
340
362
  *
341
363
  * `POST /public/v1/query/list_activities`
342
364
  */
@@ -356,9 +378,9 @@ const signGetActivities = (input, options) => base.signedRequest({
356
378
  options,
357
379
  });
358
380
  /**
359
- * List Policies
381
+ * List policies
360
382
  *
361
- * List all Policies within an Organization
383
+ * List all policies within an organization.
362
384
  *
363
385
  * `POST /public/v1/query/list_policies`
364
386
  */
@@ -378,9 +400,9 @@ const signGetPolicies = (input, options) => base.signedRequest({
378
400
  options,
379
401
  });
380
402
  /**
381
- * List Private Key Tags
403
+ * List private key tags
382
404
  *
383
- * List all Private Key Tags within an Organization
405
+ * List all private key tags within an organization.
384
406
  *
385
407
  * `POST /public/v1/query/list_private_key_tags`
386
408
  */
@@ -400,9 +422,9 @@ const signListPrivateKeyTags = (input, options) => base.signedRequest({
400
422
  options,
401
423
  });
402
424
  /**
403
- * List Private Keys
425
+ * List private keys
404
426
  *
405
- * List all Private Keys within an Organization
427
+ * List all private keys within an organization.
406
428
  *
407
429
  * `POST /public/v1/query/list_private_keys`
408
430
  */
@@ -422,9 +444,9 @@ const signGetPrivateKeys = (input, options) => base.signedRequest({
422
444
  options,
423
445
  });
424
446
  /**
425
- * List Smart Contract Interfaces
447
+ * List smart contract interfaces
426
448
  *
427
- * List all Smart Contract Interfaces within an Organization
449
+ * List all smart contract interfaces within an organization.
428
450
  *
429
451
  * `POST /public/v1/query/list_smart_contract_interfaces`
430
452
  */
@@ -444,7 +466,7 @@ const signGetSmartContractInterfaces = (input, options) => base.signedRequest({
444
466
  options,
445
467
  });
446
468
  /**
447
- * Get Suborgs
469
+ * Get sub-organizations
448
470
  *
449
471
  * Get all suborg IDs associated given a parent org ID and an optional filter.
450
472
  *
@@ -466,9 +488,9 @@ const signGetSubOrgIds = (input, options) => base.signedRequest({
466
488
  options,
467
489
  });
468
490
  /**
469
- * List User Tags
491
+ * List user tags
470
492
  *
471
- * List all User Tags within an Organization
493
+ * List all user tags within an organization.
472
494
  *
473
495
  * `POST /public/v1/query/list_user_tags`
474
496
  */
@@ -488,9 +510,9 @@ const signListUserTags = (input, options) => base.signedRequest({
488
510
  options,
489
511
  });
490
512
  /**
491
- * List Users
513
+ * List users
492
514
  *
493
- * List all Users within an Organization
515
+ * List all users within an organization.
494
516
  *
495
517
  * `POST /public/v1/query/list_users`
496
518
  */
@@ -510,7 +532,7 @@ const signGetUsers = (input, options) => base.signedRequest({
510
532
  options,
511
533
  });
512
534
  /**
513
- * Get Verified Suborgs
535
+ * Get verified sub-organizations
514
536
  *
515
537
  * Get all email or phone verified suborg IDs associated given a parent org ID.
516
538
  *
@@ -532,9 +554,9 @@ const signGetVerifiedSubOrgIds = (input, options) => base.signedRequest({
532
554
  options,
533
555
  });
534
556
  /**
535
- * List Wallets Accounts
557
+ * List wallets accounts
536
558
  *
537
- * List all Accounts within a Wallet
559
+ * List all accounts within a wallet.
538
560
  *
539
561
  * `POST /public/v1/query/list_wallet_accounts`
540
562
  */
@@ -554,9 +576,9 @@ const signGetWalletAccounts = (input, options) => base.signedRequest({
554
576
  options,
555
577
  });
556
578
  /**
557
- * List Wallets
579
+ * List wallets
558
580
  *
559
- * List all Wallets within an Organization
581
+ * List all wallets within an organization.
560
582
  *
561
583
  * `POST /public/v1/query/list_wallets`
562
584
  */
@@ -578,7 +600,7 @@ const signGetWallets = (input, options) => base.signedRequest({
578
600
  /**
579
601
  * Who am I?
580
602
  *
581
- * Get basic information about your current API or WebAuthN user and their organization. Affords Sub-Organization look ups via Parent Organization for WebAuthN or API key users.
603
+ * Get basic information about your current API or WebAuthN user and their organization. Affords sub-organization look ups via parent organization for WebAuthN or API key users.
582
604
  *
583
605
  * `POST /public/v1/query/whoami`
584
606
  */
@@ -598,9 +620,9 @@ const signGetWhoami = (input, options) => base.signedRequest({
598
620
  options,
599
621
  });
600
622
  /**
601
- * Approve Activity
623
+ * Approve activity
602
624
  *
603
- * Approve an Activity
625
+ * Approve an activity.
604
626
  *
605
627
  * `POST /public/v1/submit/approve_activity`
606
628
  */
@@ -620,9 +642,9 @@ const signApproveActivity = (input, options) => base.signedRequest({
620
642
  options,
621
643
  });
622
644
  /**
623
- * Create API Keys
645
+ * Create API keys
624
646
  *
625
- * Add api keys to an existing User
647
+ * Add API keys to an existing user.
626
648
  *
627
649
  * `POST /public/v1/submit/create_api_keys`
628
650
  */
@@ -642,9 +664,9 @@ const signCreateApiKeys = (input, options) => base.signedRequest({
642
664
  options,
643
665
  });
644
666
  /**
645
- * Create API-only Users
667
+ * Create API-only users
646
668
  *
647
- * Create API-only Users in an existing Organization
669
+ * Create API-only users in an existing organization.
648
670
  *
649
671
  * `POST /public/v1/submit/create_api_only_users`
650
672
  */
@@ -664,9 +686,9 @@ const signCreateApiOnlyUsers = (input, options) => base.signedRequest({
664
686
  options,
665
687
  });
666
688
  /**
667
- * Create Authenticators
689
+ * Create authenticators
668
690
  *
669
- * Create Authenticators to authenticate requests to Turnkey
691
+ * Create authenticators to authenticate requests to Turnkey.
670
692
  *
671
693
  * `POST /public/v1/submit/create_authenticators`
672
694
  */
@@ -686,9 +708,9 @@ const signCreateAuthenticators = (input, options) => base.signedRequest({
686
708
  options,
687
709
  });
688
710
  /**
689
- * Create Invitations
711
+ * Create invitations
690
712
  *
691
- * Create Invitations to join an existing Organization
713
+ * Create invitations to join an existing organization.
692
714
  *
693
715
  * `POST /public/v1/submit/create_invitations`
694
716
  */
@@ -708,9 +730,9 @@ const signCreateInvitations = (input, options) => base.signedRequest({
708
730
  options,
709
731
  });
710
732
  /**
711
- * Create Oauth Providers
733
+ * Create Oauth providers
712
734
  *
713
- * Creates Oauth providers for a specified user - BETA
735
+ * Create Oauth providers for a specified user.
714
736
  *
715
737
  * `POST /public/v1/submit/create_oauth_providers`
716
738
  */
@@ -730,9 +752,9 @@ const signCreateOauthProviders = (input, options) => base.signedRequest({
730
752
  options,
731
753
  });
732
754
  /**
733
- * Create Policies
755
+ * Create policies
734
756
  *
735
- * Create new Policies
757
+ * Create new policies.
736
758
  *
737
759
  * `POST /public/v1/submit/create_policies`
738
760
  */
@@ -752,9 +774,9 @@ const signCreatePolicies = (input, options) => base.signedRequest({
752
774
  options,
753
775
  });
754
776
  /**
755
- * Create Policy
777
+ * Create policy
756
778
  *
757
- * Create a new Policy
779
+ * Create a new policy.
758
780
  *
759
781
  * `POST /public/v1/submit/create_policy`
760
782
  */
@@ -774,7 +796,7 @@ const signCreatePolicy = (input, options) => base.signedRequest({
774
796
  options,
775
797
  });
776
798
  /**
777
- * Create Private Key Tag
799
+ * Create private key tag
778
800
  *
779
801
  * Create a private key tag and add it to private keys.
780
802
  *
@@ -796,9 +818,9 @@ const signCreatePrivateKeyTag = (input, options) => base.signedRequest({
796
818
  options,
797
819
  });
798
820
  /**
799
- * Create Private Keys
821
+ * Create private keys
800
822
  *
801
- * Create new Private Keys
823
+ * Create new private keys.
802
824
  *
803
825
  * `POST /public/v1/submit/create_private_keys`
804
826
  */
@@ -818,9 +840,9 @@ const signCreatePrivateKeys = (input, options) => base.signedRequest({
818
840
  options,
819
841
  });
820
842
  /**
821
- * Create Read Only Session
843
+ * Create read only session
822
844
  *
823
- * Create a read only session for a user (valid for 1 hour)
845
+ * Create a read only session for a user (valid for 1 hour).
824
846
  *
825
847
  * `POST /public/v1/submit/create_read_only_session`
826
848
  */
@@ -840,9 +862,9 @@ const signCreateReadOnlySession = (input, options) => base.signedRequest({
840
862
  options,
841
863
  });
842
864
  /**
843
- * Create Read Write Session
865
+ * Create read write session
844
866
  *
845
- * Create a read write session for a user
867
+ * Create a read write session for a user.
846
868
  *
847
869
  * `POST /public/v1/submit/create_read_write_session`
848
870
  */
@@ -862,9 +884,9 @@ const signCreateReadWriteSession = (input, options) => base.signedRequest({
862
884
  options,
863
885
  });
864
886
  /**
865
- * Create Smart Contract Interface
887
+ * Create smart contract interface
866
888
  *
867
- * Create an ABI/IDL in JSON
889
+ * Create an ABI/IDL in JSON.
868
890
  *
869
891
  * `POST /public/v1/submit/create_smart_contract_interface`
870
892
  */
@@ -884,9 +906,9 @@ const signCreateSmartContractInterface = (input, options) => base.signedRequest(
884
906
  options,
885
907
  });
886
908
  /**
887
- * Create Sub-Organization
909
+ * Create sub-organization
888
910
  *
889
- * Create a new Sub-Organization
911
+ * Create a new sub-organization.
890
912
  *
891
913
  * `POST /public/v1/submit/create_sub_organization`
892
914
  */
@@ -906,7 +928,7 @@ const signCreateSubOrganization = (input, options) => base.signedRequest({
906
928
  options,
907
929
  });
908
930
  /**
909
- * Create User Tag
931
+ * Create user tag
910
932
  *
911
933
  * Create a user tag and add it to users.
912
934
  *
@@ -928,9 +950,9 @@ const signCreateUserTag = (input, options) => base.signedRequest({
928
950
  options,
929
951
  });
930
952
  /**
931
- * Create Users
953
+ * Create users
932
954
  *
933
- * Create Users in an existing Organization
955
+ * Create users in an existing organization.
934
956
  *
935
957
  * `POST /public/v1/submit/create_users`
936
958
  */
@@ -950,9 +972,9 @@ const signCreateUsers = (input, options) => base.signedRequest({
950
972
  options,
951
973
  });
952
974
  /**
953
- * Create Wallet
975
+ * Create wallet
954
976
  *
955
- * Create a Wallet and derive addresses
977
+ * Create a wallet and derive addresses.
956
978
  *
957
979
  * `POST /public/v1/submit/create_wallet`
958
980
  */
@@ -972,9 +994,9 @@ const signCreateWallet = (input, options) => base.signedRequest({
972
994
  options,
973
995
  });
974
996
  /**
975
- * Create Wallet Accounts
997
+ * Create wallet accounts
976
998
  *
977
- * Derive additional addresses using an existing wallet
999
+ * Derive additional addresses using an existing wallet.
978
1000
  *
979
1001
  * `POST /public/v1/submit/create_wallet_accounts`
980
1002
  */
@@ -994,9 +1016,9 @@ const signCreateWalletAccounts = (input, options) => base.signedRequest({
994
1016
  options,
995
1017
  });
996
1018
  /**
997
- * Delete API Keys
1019
+ * Delete API keys
998
1020
  *
999
- * Remove api keys from a User
1021
+ * Remove api keys from a user.
1000
1022
  *
1001
1023
  * `POST /public/v1/submit/delete_api_keys`
1002
1024
  */
@@ -1016,9 +1038,9 @@ const signDeleteApiKeys = (input, options) => base.signedRequest({
1016
1038
  options,
1017
1039
  });
1018
1040
  /**
1019
- * Delete Authenticators
1041
+ * Delete authenticators
1020
1042
  *
1021
- * Remove authenticators from a User
1043
+ * Remove authenticators from a user.
1022
1044
  *
1023
1045
  * `POST /public/v1/submit/delete_authenticators`
1024
1046
  */
@@ -1038,9 +1060,9 @@ const signDeleteAuthenticators = (input, options) => base.signedRequest({
1038
1060
  options,
1039
1061
  });
1040
1062
  /**
1041
- * Delete Invitation
1063
+ * Delete invitation
1042
1064
  *
1043
- * Delete an existing Invitation
1065
+ * Delete an existing invitation.
1044
1066
  *
1045
1067
  * `POST /public/v1/submit/delete_invitation`
1046
1068
  */
@@ -1060,9 +1082,9 @@ const signDeleteInvitation = (input, options) => base.signedRequest({
1060
1082
  options,
1061
1083
  });
1062
1084
  /**
1063
- * Delete Oauth Providers
1085
+ * Delete Oauth providers
1064
1086
  *
1065
- * Removes Oauth providers for a specified user - BETA
1087
+ * Remove Oauth providers for a specified user.
1066
1088
  *
1067
1089
  * `POST /public/v1/submit/delete_oauth_providers`
1068
1090
  */
@@ -1082,9 +1104,9 @@ const signDeleteOauthProviders = (input, options) => base.signedRequest({
1082
1104
  options,
1083
1105
  });
1084
1106
  /**
1085
- * Delete Policy
1107
+ * Delete policy
1086
1108
  *
1087
- * Delete an existing Policy
1109
+ * Delete an existing policy.
1088
1110
  *
1089
1111
  * `POST /public/v1/submit/delete_policy`
1090
1112
  */
@@ -1104,9 +1126,9 @@ const signDeletePolicy = (input, options) => base.signedRequest({
1104
1126
  options,
1105
1127
  });
1106
1128
  /**
1107
- * Delete Private Key Tags
1129
+ * Delete private key tags
1108
1130
  *
1109
- * Delete Private Key Tags within an Organization
1131
+ * Delete private key tags within an organization.
1110
1132
  *
1111
1133
  * `POST /public/v1/submit/delete_private_key_tags`
1112
1134
  */
@@ -1126,9 +1148,9 @@ const signDeletePrivateKeyTags = (input, options) => base.signedRequest({
1126
1148
  options,
1127
1149
  });
1128
1150
  /**
1129
- * Delete Private Keys
1151
+ * Delete private keys
1130
1152
  *
1131
- * Deletes private keys for an organization
1153
+ * Delete private keys for an organization.
1132
1154
  *
1133
1155
  * `POST /public/v1/submit/delete_private_keys`
1134
1156
  */
@@ -1148,9 +1170,9 @@ const signDeletePrivateKeys = (input, options) => base.signedRequest({
1148
1170
  options,
1149
1171
  });
1150
1172
  /**
1151
- * Create Smart Contract Interface
1173
+ * Delete smart contract interface
1152
1174
  *
1153
- * Delete a Smart Contract Interface
1175
+ * Delete a smart contract interface.
1154
1176
  *
1155
1177
  * `POST /public/v1/submit/delete_smart_contract_interface`
1156
1178
  */
@@ -1170,9 +1192,9 @@ const signDeleteSmartContractInterface = (input, options) => base.signedRequest(
1170
1192
  options,
1171
1193
  });
1172
1194
  /**
1173
- * Delete Sub Organization
1195
+ * Delete sub-organization
1174
1196
  *
1175
- * Deletes a sub organization
1197
+ * Delete a sub-organization.
1176
1198
  *
1177
1199
  * `POST /public/v1/submit/delete_sub_organization`
1178
1200
  */
@@ -1192,9 +1214,9 @@ const signDeleteSubOrganization = (input, options) => base.signedRequest({
1192
1214
  options,
1193
1215
  });
1194
1216
  /**
1195
- * Delete User Tags
1217
+ * Delete user tags
1196
1218
  *
1197
- * Delete User Tags within an Organization
1219
+ * Delete user tags within an organization.
1198
1220
  *
1199
1221
  * `POST /public/v1/submit/delete_user_tags`
1200
1222
  */
@@ -1214,9 +1236,9 @@ const signDeleteUserTags = (input, options) => base.signedRequest({
1214
1236
  options,
1215
1237
  });
1216
1238
  /**
1217
- * Delete Users
1239
+ * Delete users
1218
1240
  *
1219
- * Delete Users within an Organization
1241
+ * Delete users within an organization.
1220
1242
  *
1221
1243
  * `POST /public/v1/submit/delete_users`
1222
1244
  */
@@ -1236,9 +1258,9 @@ const signDeleteUsers = (input, options) => base.signedRequest({
1236
1258
  options,
1237
1259
  });
1238
1260
  /**
1239
- * Delete Wallets
1261
+ * Delete wallets
1240
1262
  *
1241
- * Deletes wallets for an organization
1263
+ * Delete wallets for an organization.
1242
1264
  *
1243
1265
  * `POST /public/v1/submit/delete_wallets`
1244
1266
  */
@@ -1258,9 +1280,9 @@ const signDeleteWallets = (input, options) => base.signedRequest({
1258
1280
  options,
1259
1281
  });
1260
1282
  /**
1261
- * Perform Email Auth
1283
+ * Perform email auth
1262
1284
  *
1263
- * Authenticate a user via Email
1285
+ * Authenticate a user via email.
1264
1286
  *
1265
1287
  * `POST /public/v1/submit/email_auth`
1266
1288
  */
@@ -1280,9 +1302,9 @@ const signEmailAuth = (input, options) => base.signedRequest({
1280
1302
  options,
1281
1303
  });
1282
1304
  /**
1283
- * Export Private Key
1305
+ * Export private key
1284
1306
  *
1285
- * Exports a Private Key
1307
+ * Export a private key.
1286
1308
  *
1287
1309
  * `POST /public/v1/submit/export_private_key`
1288
1310
  */
@@ -1302,9 +1324,9 @@ const signExportPrivateKey = (input, options) => base.signedRequest({
1302
1324
  options,
1303
1325
  });
1304
1326
  /**
1305
- * Export Wallet
1327
+ * Export wallet
1306
1328
  *
1307
- * Exports a Wallet
1329
+ * Export a wallet.
1308
1330
  *
1309
1331
  * `POST /public/v1/submit/export_wallet`
1310
1332
  */
@@ -1324,9 +1346,9 @@ const signExportWallet = (input, options) => base.signedRequest({
1324
1346
  options,
1325
1347
  });
1326
1348
  /**
1327
- * Export Wallet Account
1349
+ * Export wallet account
1328
1350
  *
1329
- * Exports a Wallet Account
1351
+ * Export a wallet account.
1330
1352
  *
1331
1353
  * `POST /public/v1/submit/export_wallet_account`
1332
1354
  */
@@ -1346,9 +1368,9 @@ const signExportWalletAccount = (input, options) => base.signedRequest({
1346
1368
  options,
1347
1369
  });
1348
1370
  /**
1349
- * Import Private Key
1371
+ * Import private key
1350
1372
  *
1351
- * Imports a private key
1373
+ * Import a private key.
1352
1374
  *
1353
1375
  * `POST /public/v1/submit/import_private_key`
1354
1376
  */
@@ -1368,9 +1390,9 @@ const signImportPrivateKey = (input, options) => base.signedRequest({
1368
1390
  options,
1369
1391
  });
1370
1392
  /**
1371
- * Import Wallet
1393
+ * Import wallet
1372
1394
  *
1373
- * Imports a wallet
1395
+ * Import a wallet.
1374
1396
  *
1375
1397
  * `POST /public/v1/submit/import_wallet`
1376
1398
  */
@@ -1390,9 +1412,9 @@ const signImportWallet = (input, options) => base.signedRequest({
1390
1412
  options,
1391
1413
  });
1392
1414
  /**
1393
- * Init Fiat On Ramp
1415
+ * Init fiat on ramp
1394
1416
  *
1395
- * Initiate a fiat on ramp flow
1417
+ * Initiate a fiat on ramp flow.
1396
1418
  *
1397
1419
  * `POST /public/v1/submit/init_fiat_on_ramp`
1398
1420
  */
@@ -1412,9 +1434,9 @@ const signInitFiatOnRamp = (input, options) => base.signedRequest({
1412
1434
  options,
1413
1435
  });
1414
1436
  /**
1415
- * Init Import Private Key
1437
+ * Init import private key
1416
1438
  *
1417
- * Initializes a new private key import
1439
+ * Initialize a new private key import.
1418
1440
  *
1419
1441
  * `POST /public/v1/submit/init_import_private_key`
1420
1442
  */
@@ -1434,9 +1456,9 @@ const signInitImportPrivateKey = (input, options) => base.signedRequest({
1434
1456
  options,
1435
1457
  });
1436
1458
  /**
1437
- * Init Import Wallet
1459
+ * Init import wallet
1438
1460
  *
1439
- * Initializes a new wallet import
1461
+ * Initialize a new wallet import.
1440
1462
  *
1441
1463
  * `POST /public/v1/submit/init_import_wallet`
1442
1464
  */
@@ -1456,9 +1478,9 @@ const signInitImportWallet = (input, options) => base.signedRequest({
1456
1478
  options,
1457
1479
  });
1458
1480
  /**
1459
- * Init Generic OTP
1481
+ * Init generic OTP
1460
1482
  *
1461
- * Initiate a Generic OTP activity
1483
+ * Initiate a generic OTP activity.
1462
1484
  *
1463
1485
  * `POST /public/v1/submit/init_otp`
1464
1486
  */
@@ -1480,7 +1502,7 @@ const signInitOtp = (input, options) => base.signedRequest({
1480
1502
  /**
1481
1503
  * Init OTP auth
1482
1504
  *
1483
- * Initiate an OTP auth activity
1505
+ * Initiate an OTP auth activity.
1484
1506
  *
1485
1507
  * `POST /public/v1/submit/init_otp_auth`
1486
1508
  */
@@ -1500,9 +1522,9 @@ const signInitOtpAuth = (input, options) => base.signedRequest({
1500
1522
  options,
1501
1523
  });
1502
1524
  /**
1503
- * Init Email Recovery
1525
+ * Init email recovery
1504
1526
  *
1505
- * Initializes a new email recovery
1527
+ * Initialize a new email recovery.
1506
1528
  *
1507
1529
  * `POST /public/v1/submit/init_user_email_recovery`
1508
1530
  */
@@ -1524,7 +1546,7 @@ const signInitUserEmailRecovery = (input, options) => base.signedRequest({
1524
1546
  /**
1525
1547
  * Oauth
1526
1548
  *
1527
- * Authenticate a user with an Oidc token (Oauth) - BETA
1549
+ * Authenticate a user with an OIDC token (Oauth).
1528
1550
  *
1529
1551
  * `POST /public/v1/submit/oauth`
1530
1552
  */
@@ -1546,7 +1568,7 @@ const signOauth = (input, options) => base.signedRequest({
1546
1568
  /**
1547
1569
  * Login with Oauth
1548
1570
  *
1549
- * Create an Oauth session for a user
1571
+ * Create an Oauth session for a user.
1550
1572
  *
1551
1573
  * `POST /public/v1/submit/oauth_login`
1552
1574
  */
@@ -1568,7 +1590,7 @@ const signOauthLogin = (input, options) => base.signedRequest({
1568
1590
  /**
1569
1591
  * OTP auth
1570
1592
  *
1571
- * Authenticate a user with an OTP code sent via email or SMS
1593
+ * Authenticate a user with an OTP code sent via email or SMS.
1572
1594
  *
1573
1595
  * `POST /public/v1/submit/otp_auth`
1574
1596
  */
@@ -1590,7 +1612,7 @@ const signOtpAuth = (input, options) => base.signedRequest({
1590
1612
  /**
1591
1613
  * Login with OTP
1592
1614
  *
1593
- * Create an OTP session for a user
1615
+ * Create an OTP session for a user.
1594
1616
  *
1595
1617
  * `POST /public/v1/submit/otp_login`
1596
1618
  */
@@ -1612,7 +1634,7 @@ const signOtpLogin = (input, options) => base.signedRequest({
1612
1634
  /**
1613
1635
  * Recover a user
1614
1636
  *
1615
- * Completes the process of recovering a user by adding an authenticator
1637
+ * Complete the process of recovering a user by adding an authenticator.
1616
1638
  *
1617
1639
  * `POST /public/v1/submit/recover_user`
1618
1640
  */
@@ -1632,9 +1654,9 @@ const signRecoverUser = (input, options) => base.signedRequest({
1632
1654
  options,
1633
1655
  });
1634
1656
  /**
1635
- * Reject Activity
1657
+ * Reject activity
1636
1658
  *
1637
- * Reject an Activity
1659
+ * Reject an activity.
1638
1660
  *
1639
1661
  * `POST /public/v1/submit/reject_activity`
1640
1662
  */
@@ -1654,9 +1676,9 @@ const signRejectActivity = (input, options) => base.signedRequest({
1654
1676
  options,
1655
1677
  });
1656
1678
  /**
1657
- * Remove Organization Feature
1679
+ * Remove organization feature
1658
1680
  *
1659
- * Removes an organization feature. This activity must be approved by the current root quorum.
1681
+ * Remove an organization feature. This activity must be approved by the current root quorum.
1660
1682
  *
1661
1683
  * `POST /public/v1/submit/remove_organization_feature`
1662
1684
  */
@@ -1676,9 +1698,9 @@ const signRemoveOrganizationFeature = (input, options) => base.signedRequest({
1676
1698
  options,
1677
1699
  });
1678
1700
  /**
1679
- * Set Organization Feature
1701
+ * Set organization feature
1680
1702
  *
1681
- * Sets an organization feature. This activity must be approved by the current root quorum.
1703
+ * Set an organization feature. This activity must be approved by the current root quorum.
1682
1704
  *
1683
1705
  * `POST /public/v1/submit/set_organization_feature`
1684
1706
  */
@@ -1698,9 +1720,9 @@ const signSetOrganizationFeature = (input, options) => base.signedRequest({
1698
1720
  options,
1699
1721
  });
1700
1722
  /**
1701
- * Sign Raw Payload
1723
+ * Sign raw payload
1702
1724
  *
1703
- * Sign a raw payload
1725
+ * Sign a raw payload.
1704
1726
  *
1705
1727
  * `POST /public/v1/submit/sign_raw_payload`
1706
1728
  */
@@ -1720,9 +1742,9 @@ const signSignRawPayload = (input, options) => base.signedRequest({
1720
1742
  options,
1721
1743
  });
1722
1744
  /**
1723
- * Sign Raw Payloads
1745
+ * Sign raw payloads
1724
1746
  *
1725
- * Sign multiple raw payloads with the same signing parameters
1747
+ * Sign multiple raw payloads with the same signing parameters.
1726
1748
  *
1727
1749
  * `POST /public/v1/submit/sign_raw_payloads`
1728
1750
  */
@@ -1742,9 +1764,9 @@ const signSignRawPayloads = (input, options) => base.signedRequest({
1742
1764
  options,
1743
1765
  });
1744
1766
  /**
1745
- * Sign Transaction
1767
+ * Sign transaction
1746
1768
  *
1747
- * Sign a transaction
1769
+ * Sign a transaction.
1748
1770
  *
1749
1771
  * `POST /public/v1/submit/sign_transaction`
1750
1772
  */
@@ -1764,9 +1786,9 @@ const signSignTransaction = (input, options) => base.signedRequest({
1764
1786
  options,
1765
1787
  });
1766
1788
  /**
1767
- * Login with a Stamp
1789
+ * Login with a stamp
1768
1790
  *
1769
- * Create a session for a user through stamping client side (api key, wallet client, or passkey client)
1791
+ * Create a session for a user through stamping client side (API key, wallet client, or passkey client).
1770
1792
  *
1771
1793
  * `POST /public/v1/submit/stamp_login`
1772
1794
  */
@@ -1786,9 +1808,9 @@ const signStampLogin = (input, options) => base.signedRequest({
1786
1808
  options,
1787
1809
  });
1788
1810
  /**
1789
- * Update Policy
1811
+ * Update policy
1790
1812
  *
1791
- * Update an existing Policy
1813
+ * Update an existing policy.
1792
1814
  *
1793
1815
  * `POST /public/v1/submit/update_policy`
1794
1816
  */
@@ -1808,7 +1830,7 @@ const signUpdatePolicy = (input, options) => base.signedRequest({
1808
1830
  options,
1809
1831
  });
1810
1832
  /**
1811
- * Update Private Key Tag
1833
+ * Update private key tag
1812
1834
  *
1813
1835
  * Update human-readable name or associated private keys. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.
1814
1836
  *
@@ -1830,7 +1852,7 @@ const signUpdatePrivateKeyTag = (input, options) => base.signedRequest({
1830
1852
  options,
1831
1853
  });
1832
1854
  /**
1833
- * Update Root Quorum
1855
+ * Update root quorum
1834
1856
  *
1835
1857
  * Set the threshold and members of the root quorum. This activity must be approved by the current root quorum.
1836
1858
  *
@@ -1852,9 +1874,9 @@ const signUpdateRootQuorum = (input, options) => base.signedRequest({
1852
1874
  options,
1853
1875
  });
1854
1876
  /**
1855
- * Update User
1877
+ * Update user
1856
1878
  *
1857
- * Update a User in an existing Organization
1879
+ * Update a user in an existing organization.
1858
1880
  *
1859
1881
  * `POST /public/v1/submit/update_user`
1860
1882
  */
@@ -1874,9 +1896,9 @@ const signUpdateUser = (input, options) => base.signedRequest({
1874
1896
  options,
1875
1897
  });
1876
1898
  /**
1877
- * Update User's Email
1899
+ * Update user's email
1878
1900
  *
1879
- * Update a User's email in an existing Organization
1901
+ * Update a user's email in an existing organization.
1880
1902
  *
1881
1903
  * `POST /public/v1/submit/update_user_email`
1882
1904
  */
@@ -1896,9 +1918,9 @@ const signUpdateUserEmail = (input, options) => base.signedRequest({
1896
1918
  options,
1897
1919
  });
1898
1920
  /**
1899
- * Update User's Name
1921
+ * Update user's name
1900
1922
  *
1901
- * Update a User's name in an existing Organization
1923
+ * Update a user's name in an existing organization.
1902
1924
  *
1903
1925
  * `POST /public/v1/submit/update_user_name`
1904
1926
  */
@@ -1918,9 +1940,9 @@ const signUpdateUserName = (input, options) => base.signedRequest({
1918
1940
  options,
1919
1941
  });
1920
1942
  /**
1921
- * Update User's Phone Number
1943
+ * Update user's phone number
1922
1944
  *
1923
- * Update a User's phone number in an existing Organization
1945
+ * Update a user's phone number in an existing organization.
1924
1946
  *
1925
1947
  * `POST /public/v1/submit/update_user_phone_number`
1926
1948
  */
@@ -1940,7 +1962,7 @@ const signUpdateUserPhoneNumber = (input, options) => base.signedRequest({
1940
1962
  options,
1941
1963
  });
1942
1964
  /**
1943
- * Update User Tag
1965
+ * Update user tag
1944
1966
  *
1945
1967
  * Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.
1946
1968
  *
@@ -1962,9 +1984,9 @@ const signUpdateUserTag = (input, options) => base.signedRequest({
1962
1984
  options,
1963
1985
  });
1964
1986
  /**
1965
- * Update Wallet
1987
+ * Update wallet
1966
1988
  *
1967
- * Update a wallet for an organization
1989
+ * Update a wallet for an organization.
1968
1990
  *
1969
1991
  * `POST /public/v1/submit/update_wallet`
1970
1992
  */
@@ -1984,9 +2006,9 @@ const signUpdateWallet = (input, options) => base.signedRequest({
1984
2006
  options,
1985
2007
  });
1986
2008
  /**
1987
- * Verify Generic OTP
2009
+ * Verify generic OTP
1988
2010
  *
1989
- * Verify a Generic OTP
2011
+ * Verify a generic OTP.
1990
2012
  *
1991
2013
  * `POST /public/v1/submit/verify_otp`
1992
2014
  */
@@ -2021,9 +2043,9 @@ const signNOOPCodegenAnchor = () => base.signedRequest({
2021
2043
  uri: "/tkhq/api/v1/noop-codegen-anchor",
2022
2044
  });
2023
2045
  /**
2024
- * Test Rate Limit
2046
+ * Test rate limit
2025
2047
  *
2026
- * Set a rate local rate limit just on the current endpoint, for purposes of testing with Vivosuite
2048
+ * Set a rate local rate limit just on the current endpoint, for purposes of testing with Vivosuite.
2027
2049
  *
2028
2050
  * `POST /tkhq/api/v1/test_rate_limits`
2029
2051
  */
@@ -2089,6 +2111,7 @@ exports.getOrganization = getOrganization;
2089
2111
  exports.getOrganizationConfigs = getOrganizationConfigs;
2090
2112
  exports.getPolicies = getPolicies;
2091
2113
  exports.getPolicy = getPolicy;
2114
+ exports.getPolicyEvaluations = getPolicyEvaluations;
2092
2115
  exports.getPrivateKey = getPrivateKey;
2093
2116
  exports.getPrivateKeys = getPrivateKeys;
2094
2117
  exports.getSmartContractInterface = getSmartContractInterface;
@@ -2167,6 +2190,7 @@ exports.signGetOrganization = signGetOrganization;
2167
2190
  exports.signGetOrganizationConfigs = signGetOrganizationConfigs;
2168
2191
  exports.signGetPolicies = signGetPolicies;
2169
2192
  exports.signGetPolicy = signGetPolicy;
2193
+ exports.signGetPolicyEvaluations = signGetPolicyEvaluations;
2170
2194
  exports.signGetPrivateKey = signGetPrivateKey;
2171
2195
  exports.signGetPrivateKeys = signGetPrivateKeys;
2172
2196
  exports.signGetSmartContractInterface = signGetSmartContractInterface;