@turnkey/http 3.5.1 → 3.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.d.ts +99 -84
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.d.ts.map +1 -1
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.js +109 -84
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.js.map +1 -1
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.mjs +109 -84
- package/dist/__generated__/services/coordinator/public/v1/public_api.client.mjs.map +1 -1
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.d.ts +1417 -7689
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.d.ts.map +1 -1
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.js +189 -165
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.js.map +1 -1
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.mjs +188 -166
- package/dist/__generated__/services/coordinator/public/v1/public_api.fetcher.mjs.map +1 -1
- package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts +312 -260
- package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts.map +1 -1
- package/dist/async.js.map +1 -1
- package/dist/async.mjs.map +1 -1
- package/dist/base.js.map +1 -1
- package/dist/base.mjs.map +1 -1
- package/dist/config.js.map +1 -1
- package/dist/config.mjs.map +1 -1
- package/dist/shared.js.map +1 -1
- package/dist/shared.mjs.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/version.mjs +1 -1
- package/dist/webauthn-json/api.js.map +1 -1
- package/dist/webauthn-json/api.mjs.map +1 -1
- package/dist/webauthn-json/base64url.js.map +1 -1
- package/dist/webauthn-json/base64url.mjs.map +1 -1
- package/dist/webauthn-json/convert.js.map +1 -1
- package/dist/webauthn-json/convert.mjs.map +1 -1
- package/dist/webauthn-json/index.js.map +1 -1
- package/dist/webauthn-json/index.mjs.map +1 -1
- package/dist/webauthn-json/schema.js.map +1 -1
- package/dist/webauthn-json/schema.mjs +1 -1
- package/dist/webauthn-json/schema.mjs.map +1 -1
- package/dist/webauthn.js.map +1 -1
- package/dist/webauthn.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -7,7 +7,7 @@ class TurnkeyClient {
|
|
|
7
7
|
constructor(config, stamper) {
|
|
8
8
|
this.name = "TurnkeyClient";
|
|
9
9
|
/**
|
|
10
|
-
* Get details about an
|
|
10
|
+
* Get details about an activity.
|
|
11
11
|
*
|
|
12
12
|
* Sign the provided `TGetActivityBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_activity).
|
|
13
13
|
*
|
|
@@ -32,7 +32,7 @@ class TurnkeyClient {
|
|
|
32
32
|
};
|
|
33
33
|
};
|
|
34
34
|
/**
|
|
35
|
-
* Get details about an API key
|
|
35
|
+
* Get details about an API key.
|
|
36
36
|
*
|
|
37
37
|
* Sign the provided `TGetApiKeyBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_api_key).
|
|
38
38
|
*
|
|
@@ -57,7 +57,7 @@ class TurnkeyClient {
|
|
|
57
57
|
};
|
|
58
58
|
};
|
|
59
59
|
/**
|
|
60
|
-
* Get details about API keys for a user
|
|
60
|
+
* Get details about API keys for a user.
|
|
61
61
|
*
|
|
62
62
|
* Sign the provided `TGetApiKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_api_keys).
|
|
63
63
|
*
|
|
@@ -107,7 +107,7 @@ class TurnkeyClient {
|
|
|
107
107
|
};
|
|
108
108
|
};
|
|
109
109
|
/**
|
|
110
|
-
* Get details about an authenticator
|
|
110
|
+
* Get details about an authenticator.
|
|
111
111
|
*
|
|
112
112
|
* Sign the provided `TGetAuthenticatorBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_authenticator).
|
|
113
113
|
*
|
|
@@ -132,7 +132,7 @@ class TurnkeyClient {
|
|
|
132
132
|
};
|
|
133
133
|
};
|
|
134
134
|
/**
|
|
135
|
-
* Get details about authenticators for a user
|
|
135
|
+
* Get details about authenticators for a user.
|
|
136
136
|
*
|
|
137
137
|
* Sign the provided `TGetAuthenticatorsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_authenticators).
|
|
138
138
|
*
|
|
@@ -157,7 +157,7 @@ class TurnkeyClient {
|
|
|
157
157
|
};
|
|
158
158
|
};
|
|
159
159
|
/**
|
|
160
|
-
* Get details about Oauth providers for a user
|
|
160
|
+
* Get details about Oauth providers for a user.
|
|
161
161
|
*
|
|
162
162
|
* Sign the provided `TGetOauthProvidersBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_oauth_providers).
|
|
163
163
|
*
|
|
@@ -182,7 +182,7 @@ class TurnkeyClient {
|
|
|
182
182
|
};
|
|
183
183
|
};
|
|
184
184
|
/**
|
|
185
|
-
* Get details about an
|
|
185
|
+
* Get details about an organization.
|
|
186
186
|
*
|
|
187
187
|
* Sign the provided `TGetOrganizationBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_organization).
|
|
188
188
|
*
|
|
@@ -207,7 +207,7 @@ class TurnkeyClient {
|
|
|
207
207
|
};
|
|
208
208
|
};
|
|
209
209
|
/**
|
|
210
|
-
* Get quorum settings and features for an organization
|
|
210
|
+
* Get quorum settings and features for an organization.
|
|
211
211
|
*
|
|
212
212
|
* Sign the provided `TGetOrganizationConfigsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_organization_configs).
|
|
213
213
|
*
|
|
@@ -232,7 +232,7 @@ class TurnkeyClient {
|
|
|
232
232
|
};
|
|
233
233
|
};
|
|
234
234
|
/**
|
|
235
|
-
* Get details about a
|
|
235
|
+
* Get details about a policy.
|
|
236
236
|
*
|
|
237
237
|
* Sign the provided `TGetPolicyBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_policy).
|
|
238
238
|
*
|
|
@@ -257,7 +257,32 @@ class TurnkeyClient {
|
|
|
257
257
|
};
|
|
258
258
|
};
|
|
259
259
|
/**
|
|
260
|
-
* Get
|
|
260
|
+
* Get the policy evaluations for an activity.
|
|
261
|
+
*
|
|
262
|
+
* Sign the provided `TGetPolicyEvaluationsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_policy_evaluations).
|
|
263
|
+
*
|
|
264
|
+
* See also {@link stampGetPolicyEvaluations}.
|
|
265
|
+
*/
|
|
266
|
+
this.getPolicyEvaluations = async (input) => {
|
|
267
|
+
return this.request("/public/v1/query/get_policy_evaluations", input);
|
|
268
|
+
};
|
|
269
|
+
/**
|
|
270
|
+
* Produce a `SignedRequest` from `TGetPolicyEvaluationsBody` by using the client's `stamp` function.
|
|
271
|
+
*
|
|
272
|
+
* See also {@link GetPolicyEvaluations}.
|
|
273
|
+
*/
|
|
274
|
+
this.stampGetPolicyEvaluations = async (input) => {
|
|
275
|
+
const fullUrl = this.config.baseUrl + "/public/v1/query/get_policy_evaluations";
|
|
276
|
+
const body = JSON.stringify(input);
|
|
277
|
+
const stamp = await this.stamper.stamp(body);
|
|
278
|
+
return {
|
|
279
|
+
body: body,
|
|
280
|
+
stamp: stamp,
|
|
281
|
+
url: fullUrl,
|
|
282
|
+
};
|
|
283
|
+
};
|
|
284
|
+
/**
|
|
285
|
+
* Get details about a private key.
|
|
261
286
|
*
|
|
262
287
|
* Sign the provided `TGetPrivateKeyBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_private_key).
|
|
263
288
|
*
|
|
@@ -282,7 +307,7 @@ class TurnkeyClient {
|
|
|
282
307
|
};
|
|
283
308
|
};
|
|
284
309
|
/**
|
|
285
|
-
* Get details about a
|
|
310
|
+
* Get details about a smart contract interface.
|
|
286
311
|
*
|
|
287
312
|
* Sign the provided `TGetSmartContractInterfaceBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_smart_contract_interface).
|
|
288
313
|
*
|
|
@@ -307,7 +332,7 @@ class TurnkeyClient {
|
|
|
307
332
|
};
|
|
308
333
|
};
|
|
309
334
|
/**
|
|
310
|
-
* Get details about a
|
|
335
|
+
* Get details about a user.
|
|
311
336
|
*
|
|
312
337
|
* Sign the provided `TGetUserBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_user).
|
|
313
338
|
*
|
|
@@ -332,7 +357,7 @@ class TurnkeyClient {
|
|
|
332
357
|
};
|
|
333
358
|
};
|
|
334
359
|
/**
|
|
335
|
-
* Get details about a
|
|
360
|
+
* Get details about a wallet.
|
|
336
361
|
*
|
|
337
362
|
* Sign the provided `TGetWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_wallet).
|
|
338
363
|
*
|
|
@@ -357,7 +382,7 @@ class TurnkeyClient {
|
|
|
357
382
|
};
|
|
358
383
|
};
|
|
359
384
|
/**
|
|
360
|
-
* Get a single wallet account
|
|
385
|
+
* Get a single wallet account.
|
|
361
386
|
*
|
|
362
387
|
* Sign the provided `TGetWalletAccountBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_wallet_account).
|
|
363
388
|
*
|
|
@@ -382,7 +407,7 @@ class TurnkeyClient {
|
|
|
382
407
|
};
|
|
383
408
|
};
|
|
384
409
|
/**
|
|
385
|
-
* List all
|
|
410
|
+
* List all activities within an organization.
|
|
386
411
|
*
|
|
387
412
|
* Sign the provided `TGetActivitiesBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_activities).
|
|
388
413
|
*
|
|
@@ -407,7 +432,7 @@ class TurnkeyClient {
|
|
|
407
432
|
};
|
|
408
433
|
};
|
|
409
434
|
/**
|
|
410
|
-
* List all
|
|
435
|
+
* List all policies within an organization.
|
|
411
436
|
*
|
|
412
437
|
* Sign the provided `TGetPoliciesBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_policies).
|
|
413
438
|
*
|
|
@@ -432,7 +457,7 @@ class TurnkeyClient {
|
|
|
432
457
|
};
|
|
433
458
|
};
|
|
434
459
|
/**
|
|
435
|
-
* List all
|
|
460
|
+
* List all private key tags within an organization.
|
|
436
461
|
*
|
|
437
462
|
* Sign the provided `TListPrivateKeyTagsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_private_key_tags).
|
|
438
463
|
*
|
|
@@ -457,7 +482,7 @@ class TurnkeyClient {
|
|
|
457
482
|
};
|
|
458
483
|
};
|
|
459
484
|
/**
|
|
460
|
-
* List all
|
|
485
|
+
* List all private keys within an organization.
|
|
461
486
|
*
|
|
462
487
|
* Sign the provided `TGetPrivateKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_private_keys).
|
|
463
488
|
*
|
|
@@ -482,7 +507,7 @@ class TurnkeyClient {
|
|
|
482
507
|
};
|
|
483
508
|
};
|
|
484
509
|
/**
|
|
485
|
-
* List all
|
|
510
|
+
* List all smart contract interfaces within an organization.
|
|
486
511
|
*
|
|
487
512
|
* Sign the provided `TGetSmartContractInterfacesBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_smart_contract_interfaces).
|
|
488
513
|
*
|
|
@@ -532,7 +557,7 @@ class TurnkeyClient {
|
|
|
532
557
|
};
|
|
533
558
|
};
|
|
534
559
|
/**
|
|
535
|
-
* List all
|
|
560
|
+
* List all user tags within an organization.
|
|
536
561
|
*
|
|
537
562
|
* Sign the provided `TListUserTagsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_user_tags).
|
|
538
563
|
*
|
|
@@ -557,7 +582,7 @@ class TurnkeyClient {
|
|
|
557
582
|
};
|
|
558
583
|
};
|
|
559
584
|
/**
|
|
560
|
-
* List all
|
|
585
|
+
* List all users within an organization.
|
|
561
586
|
*
|
|
562
587
|
* Sign the provided `TGetUsersBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_users).
|
|
563
588
|
*
|
|
@@ -607,7 +632,7 @@ class TurnkeyClient {
|
|
|
607
632
|
};
|
|
608
633
|
};
|
|
609
634
|
/**
|
|
610
|
-
* List all
|
|
635
|
+
* List all accounts within a wallet.
|
|
611
636
|
*
|
|
612
637
|
* Sign the provided `TGetWalletAccountsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_wallet_accounts).
|
|
613
638
|
*
|
|
@@ -632,7 +657,7 @@ class TurnkeyClient {
|
|
|
632
657
|
};
|
|
633
658
|
};
|
|
634
659
|
/**
|
|
635
|
-
* List all
|
|
660
|
+
* List all wallets within an organization.
|
|
636
661
|
*
|
|
637
662
|
* Sign the provided `TGetWalletsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_wallets).
|
|
638
663
|
*
|
|
@@ -657,7 +682,7 @@ class TurnkeyClient {
|
|
|
657
682
|
};
|
|
658
683
|
};
|
|
659
684
|
/**
|
|
660
|
-
* Get basic information about your current API or WebAuthN user and their organization. Affords
|
|
685
|
+
* 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.
|
|
661
686
|
*
|
|
662
687
|
* Sign the provided `TGetWhoamiBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/whoami).
|
|
663
688
|
*
|
|
@@ -682,7 +707,7 @@ class TurnkeyClient {
|
|
|
682
707
|
};
|
|
683
708
|
};
|
|
684
709
|
/**
|
|
685
|
-
* Approve an
|
|
710
|
+
* Approve an activity.
|
|
686
711
|
*
|
|
687
712
|
* Sign the provided `TApproveActivityBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/approve_activity).
|
|
688
713
|
*
|
|
@@ -707,7 +732,7 @@ class TurnkeyClient {
|
|
|
707
732
|
};
|
|
708
733
|
};
|
|
709
734
|
/**
|
|
710
|
-
* Add
|
|
735
|
+
* Add API keys to an existing user.
|
|
711
736
|
*
|
|
712
737
|
* Sign the provided `TCreateApiKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_api_keys).
|
|
713
738
|
*
|
|
@@ -732,7 +757,7 @@ class TurnkeyClient {
|
|
|
732
757
|
};
|
|
733
758
|
};
|
|
734
759
|
/**
|
|
735
|
-
* Create API-only
|
|
760
|
+
* Create API-only users in an existing organization.
|
|
736
761
|
*
|
|
737
762
|
* Sign the provided `TCreateApiOnlyUsersBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_api_only_users).
|
|
738
763
|
*
|
|
@@ -757,7 +782,7 @@ class TurnkeyClient {
|
|
|
757
782
|
};
|
|
758
783
|
};
|
|
759
784
|
/**
|
|
760
|
-
* Create
|
|
785
|
+
* Create authenticators to authenticate requests to Turnkey.
|
|
761
786
|
*
|
|
762
787
|
* Sign the provided `TCreateAuthenticatorsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_authenticators).
|
|
763
788
|
*
|
|
@@ -782,7 +807,7 @@ class TurnkeyClient {
|
|
|
782
807
|
};
|
|
783
808
|
};
|
|
784
809
|
/**
|
|
785
|
-
* Create
|
|
810
|
+
* Create invitations to join an existing organization.
|
|
786
811
|
*
|
|
787
812
|
* Sign the provided `TCreateInvitationsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_invitations).
|
|
788
813
|
*
|
|
@@ -807,7 +832,7 @@ class TurnkeyClient {
|
|
|
807
832
|
};
|
|
808
833
|
};
|
|
809
834
|
/**
|
|
810
|
-
*
|
|
835
|
+
* Create Oauth providers for a specified user.
|
|
811
836
|
*
|
|
812
837
|
* Sign the provided `TCreateOauthProvidersBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_oauth_providers).
|
|
813
838
|
*
|
|
@@ -832,7 +857,7 @@ class TurnkeyClient {
|
|
|
832
857
|
};
|
|
833
858
|
};
|
|
834
859
|
/**
|
|
835
|
-
* Create new
|
|
860
|
+
* Create new policies.
|
|
836
861
|
*
|
|
837
862
|
* Sign the provided `TCreatePoliciesBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_policies).
|
|
838
863
|
*
|
|
@@ -857,7 +882,7 @@ class TurnkeyClient {
|
|
|
857
882
|
};
|
|
858
883
|
};
|
|
859
884
|
/**
|
|
860
|
-
* Create a new
|
|
885
|
+
* Create a new policy.
|
|
861
886
|
*
|
|
862
887
|
* Sign the provided `TCreatePolicyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_policy).
|
|
863
888
|
*
|
|
@@ -907,7 +932,7 @@ class TurnkeyClient {
|
|
|
907
932
|
};
|
|
908
933
|
};
|
|
909
934
|
/**
|
|
910
|
-
* Create new
|
|
935
|
+
* Create new private keys.
|
|
911
936
|
*
|
|
912
937
|
* Sign the provided `TCreatePrivateKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_private_keys).
|
|
913
938
|
*
|
|
@@ -932,7 +957,7 @@ class TurnkeyClient {
|
|
|
932
957
|
};
|
|
933
958
|
};
|
|
934
959
|
/**
|
|
935
|
-
* Create a read only session for a user (valid for 1 hour)
|
|
960
|
+
* Create a read only session for a user (valid for 1 hour).
|
|
936
961
|
*
|
|
937
962
|
* Sign the provided `TCreateReadOnlySessionBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_read_only_session).
|
|
938
963
|
*
|
|
@@ -957,7 +982,7 @@ class TurnkeyClient {
|
|
|
957
982
|
};
|
|
958
983
|
};
|
|
959
984
|
/**
|
|
960
|
-
* Create a read write session for a user
|
|
985
|
+
* Create a read write session for a user.
|
|
961
986
|
*
|
|
962
987
|
* Sign the provided `TCreateReadWriteSessionBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_read_write_session).
|
|
963
988
|
*
|
|
@@ -982,7 +1007,7 @@ class TurnkeyClient {
|
|
|
982
1007
|
};
|
|
983
1008
|
};
|
|
984
1009
|
/**
|
|
985
|
-
* Create an ABI/IDL in JSON
|
|
1010
|
+
* Create an ABI/IDL in JSON.
|
|
986
1011
|
*
|
|
987
1012
|
* Sign the provided `TCreateSmartContractInterfaceBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_smart_contract_interface).
|
|
988
1013
|
*
|
|
@@ -1007,7 +1032,7 @@ class TurnkeyClient {
|
|
|
1007
1032
|
};
|
|
1008
1033
|
};
|
|
1009
1034
|
/**
|
|
1010
|
-
* Create a new
|
|
1035
|
+
* Create a new sub-organization.
|
|
1011
1036
|
*
|
|
1012
1037
|
* Sign the provided `TCreateSubOrganizationBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_sub_organization).
|
|
1013
1038
|
*
|
|
@@ -1057,7 +1082,7 @@ class TurnkeyClient {
|
|
|
1057
1082
|
};
|
|
1058
1083
|
};
|
|
1059
1084
|
/**
|
|
1060
|
-
* Create
|
|
1085
|
+
* Create users in an existing organization.
|
|
1061
1086
|
*
|
|
1062
1087
|
* Sign the provided `TCreateUsersBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_users).
|
|
1063
1088
|
*
|
|
@@ -1082,7 +1107,7 @@ class TurnkeyClient {
|
|
|
1082
1107
|
};
|
|
1083
1108
|
};
|
|
1084
1109
|
/**
|
|
1085
|
-
* Create a
|
|
1110
|
+
* Create a wallet and derive addresses.
|
|
1086
1111
|
*
|
|
1087
1112
|
* Sign the provided `TCreateWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_wallet).
|
|
1088
1113
|
*
|
|
@@ -1107,7 +1132,7 @@ class TurnkeyClient {
|
|
|
1107
1132
|
};
|
|
1108
1133
|
};
|
|
1109
1134
|
/**
|
|
1110
|
-
* Derive additional addresses using an existing wallet
|
|
1135
|
+
* Derive additional addresses using an existing wallet.
|
|
1111
1136
|
*
|
|
1112
1137
|
* Sign the provided `TCreateWalletAccountsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_wallet_accounts).
|
|
1113
1138
|
*
|
|
@@ -1132,7 +1157,7 @@ class TurnkeyClient {
|
|
|
1132
1157
|
};
|
|
1133
1158
|
};
|
|
1134
1159
|
/**
|
|
1135
|
-
* Remove api keys from a
|
|
1160
|
+
* Remove api keys from a user.
|
|
1136
1161
|
*
|
|
1137
1162
|
* Sign the provided `TDeleteApiKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_api_keys).
|
|
1138
1163
|
*
|
|
@@ -1157,7 +1182,7 @@ class TurnkeyClient {
|
|
|
1157
1182
|
};
|
|
1158
1183
|
};
|
|
1159
1184
|
/**
|
|
1160
|
-
* Remove authenticators from a
|
|
1185
|
+
* Remove authenticators from a user.
|
|
1161
1186
|
*
|
|
1162
1187
|
* Sign the provided `TDeleteAuthenticatorsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_authenticators).
|
|
1163
1188
|
*
|
|
@@ -1182,7 +1207,7 @@ class TurnkeyClient {
|
|
|
1182
1207
|
};
|
|
1183
1208
|
};
|
|
1184
1209
|
/**
|
|
1185
|
-
* Delete an existing
|
|
1210
|
+
* Delete an existing invitation.
|
|
1186
1211
|
*
|
|
1187
1212
|
* Sign the provided `TDeleteInvitationBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_invitation).
|
|
1188
1213
|
*
|
|
@@ -1207,7 +1232,7 @@ class TurnkeyClient {
|
|
|
1207
1232
|
};
|
|
1208
1233
|
};
|
|
1209
1234
|
/**
|
|
1210
|
-
*
|
|
1235
|
+
* Remove Oauth providers for a specified user.
|
|
1211
1236
|
*
|
|
1212
1237
|
* Sign the provided `TDeleteOauthProvidersBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_oauth_providers).
|
|
1213
1238
|
*
|
|
@@ -1232,7 +1257,7 @@ class TurnkeyClient {
|
|
|
1232
1257
|
};
|
|
1233
1258
|
};
|
|
1234
1259
|
/**
|
|
1235
|
-
* Delete an existing
|
|
1260
|
+
* Delete an existing policy.
|
|
1236
1261
|
*
|
|
1237
1262
|
* Sign the provided `TDeletePolicyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_policy).
|
|
1238
1263
|
*
|
|
@@ -1257,7 +1282,7 @@ class TurnkeyClient {
|
|
|
1257
1282
|
};
|
|
1258
1283
|
};
|
|
1259
1284
|
/**
|
|
1260
|
-
* Delete
|
|
1285
|
+
* Delete private key tags within an organization.
|
|
1261
1286
|
*
|
|
1262
1287
|
* Sign the provided `TDeletePrivateKeyTagsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_private_key_tags).
|
|
1263
1288
|
*
|
|
@@ -1282,7 +1307,7 @@ class TurnkeyClient {
|
|
|
1282
1307
|
};
|
|
1283
1308
|
};
|
|
1284
1309
|
/**
|
|
1285
|
-
*
|
|
1310
|
+
* Delete private keys for an organization.
|
|
1286
1311
|
*
|
|
1287
1312
|
* Sign the provided `TDeletePrivateKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_private_keys).
|
|
1288
1313
|
*
|
|
@@ -1307,7 +1332,7 @@ class TurnkeyClient {
|
|
|
1307
1332
|
};
|
|
1308
1333
|
};
|
|
1309
1334
|
/**
|
|
1310
|
-
* Delete a
|
|
1335
|
+
* Delete a smart contract interface.
|
|
1311
1336
|
*
|
|
1312
1337
|
* Sign the provided `TDeleteSmartContractInterfaceBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_smart_contract_interface).
|
|
1313
1338
|
*
|
|
@@ -1332,7 +1357,7 @@ class TurnkeyClient {
|
|
|
1332
1357
|
};
|
|
1333
1358
|
};
|
|
1334
1359
|
/**
|
|
1335
|
-
*
|
|
1360
|
+
* Delete a sub-organization.
|
|
1336
1361
|
*
|
|
1337
1362
|
* Sign the provided `TDeleteSubOrganizationBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_sub_organization).
|
|
1338
1363
|
*
|
|
@@ -1357,7 +1382,7 @@ class TurnkeyClient {
|
|
|
1357
1382
|
};
|
|
1358
1383
|
};
|
|
1359
1384
|
/**
|
|
1360
|
-
* Delete
|
|
1385
|
+
* Delete user tags within an organization.
|
|
1361
1386
|
*
|
|
1362
1387
|
* Sign the provided `TDeleteUserTagsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_user_tags).
|
|
1363
1388
|
*
|
|
@@ -1382,7 +1407,7 @@ class TurnkeyClient {
|
|
|
1382
1407
|
};
|
|
1383
1408
|
};
|
|
1384
1409
|
/**
|
|
1385
|
-
* Delete
|
|
1410
|
+
* Delete users within an organization.
|
|
1386
1411
|
*
|
|
1387
1412
|
* Sign the provided `TDeleteUsersBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_users).
|
|
1388
1413
|
*
|
|
@@ -1407,7 +1432,7 @@ class TurnkeyClient {
|
|
|
1407
1432
|
};
|
|
1408
1433
|
};
|
|
1409
1434
|
/**
|
|
1410
|
-
*
|
|
1435
|
+
* Delete wallets for an organization.
|
|
1411
1436
|
*
|
|
1412
1437
|
* Sign the provided `TDeleteWalletsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_wallets).
|
|
1413
1438
|
*
|
|
@@ -1432,7 +1457,7 @@ class TurnkeyClient {
|
|
|
1432
1457
|
};
|
|
1433
1458
|
};
|
|
1434
1459
|
/**
|
|
1435
|
-
* Authenticate a user via
|
|
1460
|
+
* Authenticate a user via email.
|
|
1436
1461
|
*
|
|
1437
1462
|
* Sign the provided `TEmailAuthBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/email_auth).
|
|
1438
1463
|
*
|
|
@@ -1457,7 +1482,7 @@ class TurnkeyClient {
|
|
|
1457
1482
|
};
|
|
1458
1483
|
};
|
|
1459
1484
|
/**
|
|
1460
|
-
*
|
|
1485
|
+
* Export a private key.
|
|
1461
1486
|
*
|
|
1462
1487
|
* Sign the provided `TExportPrivateKeyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/export_private_key).
|
|
1463
1488
|
*
|
|
@@ -1482,7 +1507,7 @@ class TurnkeyClient {
|
|
|
1482
1507
|
};
|
|
1483
1508
|
};
|
|
1484
1509
|
/**
|
|
1485
|
-
*
|
|
1510
|
+
* Export a wallet.
|
|
1486
1511
|
*
|
|
1487
1512
|
* Sign the provided `TExportWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/export_wallet).
|
|
1488
1513
|
*
|
|
@@ -1507,7 +1532,7 @@ class TurnkeyClient {
|
|
|
1507
1532
|
};
|
|
1508
1533
|
};
|
|
1509
1534
|
/**
|
|
1510
|
-
*
|
|
1535
|
+
* Export a wallet account.
|
|
1511
1536
|
*
|
|
1512
1537
|
* Sign the provided `TExportWalletAccountBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/export_wallet_account).
|
|
1513
1538
|
*
|
|
@@ -1532,7 +1557,7 @@ class TurnkeyClient {
|
|
|
1532
1557
|
};
|
|
1533
1558
|
};
|
|
1534
1559
|
/**
|
|
1535
|
-
*
|
|
1560
|
+
* Import a private key.
|
|
1536
1561
|
*
|
|
1537
1562
|
* Sign the provided `TImportPrivateKeyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/import_private_key).
|
|
1538
1563
|
*
|
|
@@ -1557,7 +1582,7 @@ class TurnkeyClient {
|
|
|
1557
1582
|
};
|
|
1558
1583
|
};
|
|
1559
1584
|
/**
|
|
1560
|
-
*
|
|
1585
|
+
* Import a wallet.
|
|
1561
1586
|
*
|
|
1562
1587
|
* Sign the provided `TImportWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/import_wallet).
|
|
1563
1588
|
*
|
|
@@ -1582,7 +1607,7 @@ class TurnkeyClient {
|
|
|
1582
1607
|
};
|
|
1583
1608
|
};
|
|
1584
1609
|
/**
|
|
1585
|
-
* Initiate a fiat on ramp flow
|
|
1610
|
+
* Initiate a fiat on ramp flow.
|
|
1586
1611
|
*
|
|
1587
1612
|
* Sign the provided `TInitFiatOnRampBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_fiat_on_ramp).
|
|
1588
1613
|
*
|
|
@@ -1607,7 +1632,7 @@ class TurnkeyClient {
|
|
|
1607
1632
|
};
|
|
1608
1633
|
};
|
|
1609
1634
|
/**
|
|
1610
|
-
*
|
|
1635
|
+
* Initialize a new private key import.
|
|
1611
1636
|
*
|
|
1612
1637
|
* Sign the provided `TInitImportPrivateKeyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_import_private_key).
|
|
1613
1638
|
*
|
|
@@ -1632,7 +1657,7 @@ class TurnkeyClient {
|
|
|
1632
1657
|
};
|
|
1633
1658
|
};
|
|
1634
1659
|
/**
|
|
1635
|
-
*
|
|
1660
|
+
* Initialize a new wallet import.
|
|
1636
1661
|
*
|
|
1637
1662
|
* Sign the provided `TInitImportWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_import_wallet).
|
|
1638
1663
|
*
|
|
@@ -1657,7 +1682,7 @@ class TurnkeyClient {
|
|
|
1657
1682
|
};
|
|
1658
1683
|
};
|
|
1659
1684
|
/**
|
|
1660
|
-
* Initiate a
|
|
1685
|
+
* Initiate a generic OTP activity.
|
|
1661
1686
|
*
|
|
1662
1687
|
* Sign the provided `TInitOtpBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_otp).
|
|
1663
1688
|
*
|
|
@@ -1682,7 +1707,7 @@ class TurnkeyClient {
|
|
|
1682
1707
|
};
|
|
1683
1708
|
};
|
|
1684
1709
|
/**
|
|
1685
|
-
* Initiate an OTP auth activity
|
|
1710
|
+
* Initiate an OTP auth activity.
|
|
1686
1711
|
*
|
|
1687
1712
|
* Sign the provided `TInitOtpAuthBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_otp_auth).
|
|
1688
1713
|
*
|
|
@@ -1707,7 +1732,7 @@ class TurnkeyClient {
|
|
|
1707
1732
|
};
|
|
1708
1733
|
};
|
|
1709
1734
|
/**
|
|
1710
|
-
*
|
|
1735
|
+
* Initialize a new email recovery.
|
|
1711
1736
|
*
|
|
1712
1737
|
* Sign the provided `TInitUserEmailRecoveryBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_user_email_recovery).
|
|
1713
1738
|
*
|
|
@@ -1732,7 +1757,7 @@ class TurnkeyClient {
|
|
|
1732
1757
|
};
|
|
1733
1758
|
};
|
|
1734
1759
|
/**
|
|
1735
|
-
* Authenticate a user with an
|
|
1760
|
+
* Authenticate a user with an OIDC token (Oauth).
|
|
1736
1761
|
*
|
|
1737
1762
|
* Sign the provided `TOauthBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/oauth).
|
|
1738
1763
|
*
|
|
@@ -1757,7 +1782,7 @@ class TurnkeyClient {
|
|
|
1757
1782
|
};
|
|
1758
1783
|
};
|
|
1759
1784
|
/**
|
|
1760
|
-
* Create an Oauth session for a user
|
|
1785
|
+
* Create an Oauth session for a user.
|
|
1761
1786
|
*
|
|
1762
1787
|
* Sign the provided `TOauthLoginBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/oauth_login).
|
|
1763
1788
|
*
|
|
@@ -1782,7 +1807,7 @@ class TurnkeyClient {
|
|
|
1782
1807
|
};
|
|
1783
1808
|
};
|
|
1784
1809
|
/**
|
|
1785
|
-
* Authenticate a user with an OTP code sent via email or SMS
|
|
1810
|
+
* Authenticate a user with an OTP code sent via email or SMS.
|
|
1786
1811
|
*
|
|
1787
1812
|
* Sign the provided `TOtpAuthBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/otp_auth).
|
|
1788
1813
|
*
|
|
@@ -1807,7 +1832,7 @@ class TurnkeyClient {
|
|
|
1807
1832
|
};
|
|
1808
1833
|
};
|
|
1809
1834
|
/**
|
|
1810
|
-
* Create an OTP session for a user
|
|
1835
|
+
* Create an OTP session for a user.
|
|
1811
1836
|
*
|
|
1812
1837
|
* Sign the provided `TOtpLoginBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/otp_login).
|
|
1813
1838
|
*
|
|
@@ -1832,7 +1857,7 @@ class TurnkeyClient {
|
|
|
1832
1857
|
};
|
|
1833
1858
|
};
|
|
1834
1859
|
/**
|
|
1835
|
-
*
|
|
1860
|
+
* Complete the process of recovering a user by adding an authenticator.
|
|
1836
1861
|
*
|
|
1837
1862
|
* Sign the provided `TRecoverUserBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/recover_user).
|
|
1838
1863
|
*
|
|
@@ -1857,7 +1882,7 @@ class TurnkeyClient {
|
|
|
1857
1882
|
};
|
|
1858
1883
|
};
|
|
1859
1884
|
/**
|
|
1860
|
-
* Reject an
|
|
1885
|
+
* Reject an activity.
|
|
1861
1886
|
*
|
|
1862
1887
|
* Sign the provided `TRejectActivityBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/reject_activity).
|
|
1863
1888
|
*
|
|
@@ -1882,7 +1907,7 @@ class TurnkeyClient {
|
|
|
1882
1907
|
};
|
|
1883
1908
|
};
|
|
1884
1909
|
/**
|
|
1885
|
-
*
|
|
1910
|
+
* Remove an organization feature. This activity must be approved by the current root quorum.
|
|
1886
1911
|
*
|
|
1887
1912
|
* Sign the provided `TRemoveOrganizationFeatureBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/remove_organization_feature).
|
|
1888
1913
|
*
|
|
@@ -1907,7 +1932,7 @@ class TurnkeyClient {
|
|
|
1907
1932
|
};
|
|
1908
1933
|
};
|
|
1909
1934
|
/**
|
|
1910
|
-
*
|
|
1935
|
+
* Set an organization feature. This activity must be approved by the current root quorum.
|
|
1911
1936
|
*
|
|
1912
1937
|
* Sign the provided `TSetOrganizationFeatureBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/set_organization_feature).
|
|
1913
1938
|
*
|
|
@@ -1932,7 +1957,7 @@ class TurnkeyClient {
|
|
|
1932
1957
|
};
|
|
1933
1958
|
};
|
|
1934
1959
|
/**
|
|
1935
|
-
* Sign a raw payload
|
|
1960
|
+
* Sign a raw payload.
|
|
1936
1961
|
*
|
|
1937
1962
|
* Sign the provided `TSignRawPayloadBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/sign_raw_payload).
|
|
1938
1963
|
*
|
|
@@ -1957,7 +1982,7 @@ class TurnkeyClient {
|
|
|
1957
1982
|
};
|
|
1958
1983
|
};
|
|
1959
1984
|
/**
|
|
1960
|
-
* Sign multiple raw payloads with the same signing parameters
|
|
1985
|
+
* Sign multiple raw payloads with the same signing parameters.
|
|
1961
1986
|
*
|
|
1962
1987
|
* Sign the provided `TSignRawPayloadsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/sign_raw_payloads).
|
|
1963
1988
|
*
|
|
@@ -1982,7 +2007,7 @@ class TurnkeyClient {
|
|
|
1982
2007
|
};
|
|
1983
2008
|
};
|
|
1984
2009
|
/**
|
|
1985
|
-
* Sign a transaction
|
|
2010
|
+
* Sign a transaction.
|
|
1986
2011
|
*
|
|
1987
2012
|
* Sign the provided `TSignTransactionBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/sign_transaction).
|
|
1988
2013
|
*
|
|
@@ -2007,7 +2032,7 @@ class TurnkeyClient {
|
|
|
2007
2032
|
};
|
|
2008
2033
|
};
|
|
2009
2034
|
/**
|
|
2010
|
-
* Create a session for a user through stamping client side (
|
|
2035
|
+
* Create a session for a user through stamping client side (API key, wallet client, or passkey client).
|
|
2011
2036
|
*
|
|
2012
2037
|
* Sign the provided `TStampLoginBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/stamp_login).
|
|
2013
2038
|
*
|
|
@@ -2032,7 +2057,7 @@ class TurnkeyClient {
|
|
|
2032
2057
|
};
|
|
2033
2058
|
};
|
|
2034
2059
|
/**
|
|
2035
|
-
* Update an existing
|
|
2060
|
+
* Update an existing policy.
|
|
2036
2061
|
*
|
|
2037
2062
|
* Sign the provided `TUpdatePolicyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_policy).
|
|
2038
2063
|
*
|
|
@@ -2107,7 +2132,7 @@ class TurnkeyClient {
|
|
|
2107
2132
|
};
|
|
2108
2133
|
};
|
|
2109
2134
|
/**
|
|
2110
|
-
* Update a
|
|
2135
|
+
* Update a user in an existing organization.
|
|
2111
2136
|
*
|
|
2112
2137
|
* Sign the provided `TUpdateUserBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_user).
|
|
2113
2138
|
*
|
|
@@ -2132,7 +2157,7 @@ class TurnkeyClient {
|
|
|
2132
2157
|
};
|
|
2133
2158
|
};
|
|
2134
2159
|
/**
|
|
2135
|
-
* Update a
|
|
2160
|
+
* Update a user's email in an existing organization.
|
|
2136
2161
|
*
|
|
2137
2162
|
* Sign the provided `TUpdateUserEmailBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_user_email).
|
|
2138
2163
|
*
|
|
@@ -2157,7 +2182,7 @@ class TurnkeyClient {
|
|
|
2157
2182
|
};
|
|
2158
2183
|
};
|
|
2159
2184
|
/**
|
|
2160
|
-
* Update a
|
|
2185
|
+
* Update a user's name in an existing organization.
|
|
2161
2186
|
*
|
|
2162
2187
|
* Sign the provided `TUpdateUserNameBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_user_name).
|
|
2163
2188
|
*
|
|
@@ -2182,7 +2207,7 @@ class TurnkeyClient {
|
|
|
2182
2207
|
};
|
|
2183
2208
|
};
|
|
2184
2209
|
/**
|
|
2185
|
-
* Update a
|
|
2210
|
+
* Update a user's phone number in an existing organization.
|
|
2186
2211
|
*
|
|
2187
2212
|
* Sign the provided `TUpdateUserPhoneNumberBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_user_phone_number).
|
|
2188
2213
|
*
|
|
@@ -2232,7 +2257,7 @@ class TurnkeyClient {
|
|
|
2232
2257
|
};
|
|
2233
2258
|
};
|
|
2234
2259
|
/**
|
|
2235
|
-
* Update a wallet for an organization
|
|
2260
|
+
* Update a wallet for an organization.
|
|
2236
2261
|
*
|
|
2237
2262
|
* Sign the provided `TUpdateWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_wallet).
|
|
2238
2263
|
*
|
|
@@ -2257,7 +2282,7 @@ class TurnkeyClient {
|
|
|
2257
2282
|
};
|
|
2258
2283
|
};
|
|
2259
2284
|
/**
|
|
2260
|
-
* Verify a
|
|
2285
|
+
* Verify a generic OTP.
|
|
2261
2286
|
*
|
|
2262
2287
|
* Sign the provided `TVerifyOtpBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/verify_otp).
|
|
2263
2288
|
*
|
|
@@ -2282,7 +2307,7 @@ class TurnkeyClient {
|
|
|
2282
2307
|
};
|
|
2283
2308
|
};
|
|
2284
2309
|
/**
|
|
2285
|
-
* Set a rate local rate limit just on the current endpoint, for purposes of testing with Vivosuite
|
|
2310
|
+
* Set a rate local rate limit just on the current endpoint, for purposes of testing with Vivosuite.
|
|
2286
2311
|
*
|
|
2287
2312
|
* Sign the provided `TTestRateLimitsBody` with the client's `stamp` function, and submit the request (POST /tkhq/api/v1/test_rate_limits).
|
|
2288
2313
|
*
|