@turnkey/http 3.5.0 → 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.
@@ -9,7 +9,9 @@ import type { TGetOauthProvidersBody, TGetOauthProvidersResponse } from "./publi
9
9
  import type { TGetOrganizationBody, TGetOrganizationResponse } from "./public_api.fetcher";
10
10
  import type { TGetOrganizationConfigsBody, TGetOrganizationConfigsResponse } from "./public_api.fetcher";
11
11
  import type { TGetPolicyBody, TGetPolicyResponse } from "./public_api.fetcher";
12
+ import type { TGetPolicyEvaluationsBody, TGetPolicyEvaluationsResponse } from "./public_api.fetcher";
12
13
  import type { TGetPrivateKeyBody, TGetPrivateKeyResponse } from "./public_api.fetcher";
14
+ import type { TGetSmartContractInterfaceBody, TGetSmartContractInterfaceResponse } from "./public_api.fetcher";
13
15
  import type { TGetUserBody, TGetUserResponse } from "./public_api.fetcher";
14
16
  import type { TGetWalletBody, TGetWalletResponse } from "./public_api.fetcher";
15
17
  import type { TGetWalletAccountBody, TGetWalletAccountResponse } from "./public_api.fetcher";
@@ -17,6 +19,7 @@ import type { TGetActivitiesBody, TGetActivitiesResponse } from "./public_api.fe
17
19
  import type { TGetPoliciesBody, TGetPoliciesResponse } from "./public_api.fetcher";
18
20
  import type { TListPrivateKeyTagsBody, TListPrivateKeyTagsResponse } from "./public_api.fetcher";
19
21
  import type { TGetPrivateKeysBody, TGetPrivateKeysResponse } from "./public_api.fetcher";
22
+ import type { TGetSmartContractInterfacesBody, TGetSmartContractInterfacesResponse } from "./public_api.fetcher";
20
23
  import type { TGetSubOrgIdsBody, TGetSubOrgIdsResponse } from "./public_api.fetcher";
21
24
  import type { TListUserTagsBody, TListUserTagsResponse } from "./public_api.fetcher";
22
25
  import type { TGetUsersBody, TGetUsersResponse } from "./public_api.fetcher";
@@ -36,6 +39,7 @@ import type { TCreatePrivateKeyTagBody, TCreatePrivateKeyTagResponse } from "./p
36
39
  import type { TCreatePrivateKeysBody, TCreatePrivateKeysResponse } from "./public_api.fetcher";
37
40
  import type { TCreateReadOnlySessionBody, TCreateReadOnlySessionResponse } from "./public_api.fetcher";
38
41
  import type { TCreateReadWriteSessionBody, TCreateReadWriteSessionResponse } from "./public_api.fetcher";
42
+ import type { TCreateSmartContractInterfaceBody, TCreateSmartContractInterfaceResponse } from "./public_api.fetcher";
39
43
  import type { TCreateSubOrganizationBody, TCreateSubOrganizationResponse } from "./public_api.fetcher";
40
44
  import type { TCreateUserTagBody, TCreateUserTagResponse } from "./public_api.fetcher";
41
45
  import type { TCreateUsersBody, TCreateUsersResponse } from "./public_api.fetcher";
@@ -48,6 +52,7 @@ import type { TDeleteOauthProvidersBody, TDeleteOauthProvidersResponse } from ".
48
52
  import type { TDeletePolicyBody, TDeletePolicyResponse } from "./public_api.fetcher";
49
53
  import type { TDeletePrivateKeyTagsBody, TDeletePrivateKeyTagsResponse } from "./public_api.fetcher";
50
54
  import type { TDeletePrivateKeysBody, TDeletePrivateKeysResponse } from "./public_api.fetcher";
55
+ import type { TDeleteSmartContractInterfaceBody, TDeleteSmartContractInterfaceResponse } from "./public_api.fetcher";
51
56
  import type { TDeleteSubOrganizationBody, TDeleteSubOrganizationResponse } from "./public_api.fetcher";
52
57
  import type { TDeleteUserTagsBody, TDeleteUserTagsResponse } from "./public_api.fetcher";
53
58
  import type { TDeleteUsersBody, TDeleteUsersResponse } from "./public_api.fetcher";
@@ -94,7 +99,7 @@ export declare class TurnkeyClient {
94
99
  constructor(config: THttpConfig, stamper: TStamper);
95
100
  request<TBodyType, TResponseType>(url: string, body: TBodyType): Promise<TResponseType>;
96
101
  /**
97
- * Get details about an Activity
102
+ * Get details about an activity.
98
103
  *
99
104
  * Sign the provided `TGetActivityBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_activity).
100
105
  *
@@ -108,7 +113,7 @@ export declare class TurnkeyClient {
108
113
  */
109
114
  stampGetActivity: (input: TGetActivityBody) => Promise<TSignedRequest>;
110
115
  /**
111
- * Get details about an API key
116
+ * Get details about an API key.
112
117
  *
113
118
  * Sign the provided `TGetApiKeyBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_api_key).
114
119
  *
@@ -122,7 +127,7 @@ export declare class TurnkeyClient {
122
127
  */
123
128
  stampGetApiKey: (input: TGetApiKeyBody) => Promise<TSignedRequest>;
124
129
  /**
125
- * Get details about API keys for a user
130
+ * Get details about API keys for a user.
126
131
  *
127
132
  * Sign the provided `TGetApiKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_api_keys).
128
133
  *
@@ -150,7 +155,7 @@ export declare class TurnkeyClient {
150
155
  */
151
156
  stampGetAttestationDocument: (input: TGetAttestationDocumentBody) => Promise<TSignedRequest>;
152
157
  /**
153
- * Get details about an authenticator
158
+ * Get details about an authenticator.
154
159
  *
155
160
  * Sign the provided `TGetAuthenticatorBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_authenticator).
156
161
  *
@@ -164,7 +169,7 @@ export declare class TurnkeyClient {
164
169
  */
165
170
  stampGetAuthenticator: (input: TGetAuthenticatorBody) => Promise<TSignedRequest>;
166
171
  /**
167
- * Get details about authenticators for a user
172
+ * Get details about authenticators for a user.
168
173
  *
169
174
  * Sign the provided `TGetAuthenticatorsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_authenticators).
170
175
  *
@@ -178,7 +183,7 @@ export declare class TurnkeyClient {
178
183
  */
179
184
  stampGetAuthenticators: (input: TGetAuthenticatorsBody) => Promise<TSignedRequest>;
180
185
  /**
181
- * Get details about Oauth providers for a user
186
+ * Get details about Oauth providers for a user.
182
187
  *
183
188
  * Sign the provided `TGetOauthProvidersBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_oauth_providers).
184
189
  *
@@ -192,7 +197,7 @@ export declare class TurnkeyClient {
192
197
  */
193
198
  stampGetOauthProviders: (input: TGetOauthProvidersBody) => Promise<TSignedRequest>;
194
199
  /**
195
- * Get details about an Organization
200
+ * Get details about an organization.
196
201
  *
197
202
  * Sign the provided `TGetOrganizationBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_organization).
198
203
  *
@@ -206,7 +211,7 @@ export declare class TurnkeyClient {
206
211
  */
207
212
  stampGetOrganization: (input: TGetOrganizationBody) => Promise<TSignedRequest>;
208
213
  /**
209
- * Get quorum settings and features for an organization
214
+ * Get quorum settings and features for an organization.
210
215
  *
211
216
  * Sign the provided `TGetOrganizationConfigsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_organization_configs).
212
217
  *
@@ -220,7 +225,7 @@ export declare class TurnkeyClient {
220
225
  */
221
226
  stampGetOrganizationConfigs: (input: TGetOrganizationConfigsBody) => Promise<TSignedRequest>;
222
227
  /**
223
- * Get details about a Policy
228
+ * Get details about a policy.
224
229
  *
225
230
  * Sign the provided `TGetPolicyBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_policy).
226
231
  *
@@ -234,7 +239,21 @@ export declare class TurnkeyClient {
234
239
  */
235
240
  stampGetPolicy: (input: TGetPolicyBody) => Promise<TSignedRequest>;
236
241
  /**
237
- * Get details about a Private Key
242
+ * Get the policy evaluations for an activity.
243
+ *
244
+ * Sign the provided `TGetPolicyEvaluationsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_policy_evaluations).
245
+ *
246
+ * See also {@link stampGetPolicyEvaluations}.
247
+ */
248
+ getPolicyEvaluations: (input: TGetPolicyEvaluationsBody) => Promise<TGetPolicyEvaluationsResponse>;
249
+ /**
250
+ * Produce a `SignedRequest` from `TGetPolicyEvaluationsBody` by using the client's `stamp` function.
251
+ *
252
+ * See also {@link GetPolicyEvaluations}.
253
+ */
254
+ stampGetPolicyEvaluations: (input: TGetPolicyEvaluationsBody) => Promise<TSignedRequest>;
255
+ /**
256
+ * Get details about a private key.
238
257
  *
239
258
  * Sign the provided `TGetPrivateKeyBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_private_key).
240
259
  *
@@ -248,7 +267,21 @@ export declare class TurnkeyClient {
248
267
  */
249
268
  stampGetPrivateKey: (input: TGetPrivateKeyBody) => Promise<TSignedRequest>;
250
269
  /**
251
- * Get details about a User
270
+ * Get details about a smart contract interface.
271
+ *
272
+ * Sign the provided `TGetSmartContractInterfaceBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_smart_contract_interface).
273
+ *
274
+ * See also {@link stampGetSmartContractInterface}.
275
+ */
276
+ getSmartContractInterface: (input: TGetSmartContractInterfaceBody) => Promise<TGetSmartContractInterfaceResponse>;
277
+ /**
278
+ * Produce a `SignedRequest` from `TGetSmartContractInterfaceBody` by using the client's `stamp` function.
279
+ *
280
+ * See also {@link GetSmartContractInterface}.
281
+ */
282
+ stampGetSmartContractInterface: (input: TGetSmartContractInterfaceBody) => Promise<TSignedRequest>;
283
+ /**
284
+ * Get details about a user.
252
285
  *
253
286
  * Sign the provided `TGetUserBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_user).
254
287
  *
@@ -262,7 +295,7 @@ export declare class TurnkeyClient {
262
295
  */
263
296
  stampGetUser: (input: TGetUserBody) => Promise<TSignedRequest>;
264
297
  /**
265
- * Get details about a Wallet
298
+ * Get details about a wallet.
266
299
  *
267
300
  * Sign the provided `TGetWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_wallet).
268
301
  *
@@ -276,7 +309,7 @@ export declare class TurnkeyClient {
276
309
  */
277
310
  stampGetWallet: (input: TGetWalletBody) => Promise<TSignedRequest>;
278
311
  /**
279
- * Get a single wallet account
312
+ * Get a single wallet account.
280
313
  *
281
314
  * Sign the provided `TGetWalletAccountBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_wallet_account).
282
315
  *
@@ -290,7 +323,7 @@ export declare class TurnkeyClient {
290
323
  */
291
324
  stampGetWalletAccount: (input: TGetWalletAccountBody) => Promise<TSignedRequest>;
292
325
  /**
293
- * List all Activities within an Organization
326
+ * List all activities within an organization.
294
327
  *
295
328
  * Sign the provided `TGetActivitiesBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_activities).
296
329
  *
@@ -304,7 +337,7 @@ export declare class TurnkeyClient {
304
337
  */
305
338
  stampGetActivities: (input: TGetActivitiesBody) => Promise<TSignedRequest>;
306
339
  /**
307
- * List all Policies within an Organization
340
+ * List all policies within an organization.
308
341
  *
309
342
  * Sign the provided `TGetPoliciesBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_policies).
310
343
  *
@@ -318,7 +351,7 @@ export declare class TurnkeyClient {
318
351
  */
319
352
  stampGetPolicies: (input: TGetPoliciesBody) => Promise<TSignedRequest>;
320
353
  /**
321
- * List all Private Key Tags within an Organization
354
+ * List all private key tags within an organization.
322
355
  *
323
356
  * Sign the provided `TListPrivateKeyTagsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_private_key_tags).
324
357
  *
@@ -332,7 +365,7 @@ export declare class TurnkeyClient {
332
365
  */
333
366
  stampListPrivateKeyTags: (input: TListPrivateKeyTagsBody) => Promise<TSignedRequest>;
334
367
  /**
335
- * List all Private Keys within an Organization
368
+ * List all private keys within an organization.
336
369
  *
337
370
  * Sign the provided `TGetPrivateKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_private_keys).
338
371
  *
@@ -345,6 +378,20 @@ export declare class TurnkeyClient {
345
378
  * See also {@link GetPrivateKeys}.
346
379
  */
347
380
  stampGetPrivateKeys: (input: TGetPrivateKeysBody) => Promise<TSignedRequest>;
381
+ /**
382
+ * List all smart contract interfaces within an organization.
383
+ *
384
+ * Sign the provided `TGetSmartContractInterfacesBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_smart_contract_interfaces).
385
+ *
386
+ * See also {@link stampGetSmartContractInterfaces}.
387
+ */
388
+ getSmartContractInterfaces: (input: TGetSmartContractInterfacesBody) => Promise<TGetSmartContractInterfacesResponse>;
389
+ /**
390
+ * Produce a `SignedRequest` from `TGetSmartContractInterfacesBody` by using the client's `stamp` function.
391
+ *
392
+ * See also {@link GetSmartContractInterfaces}.
393
+ */
394
+ stampGetSmartContractInterfaces: (input: TGetSmartContractInterfacesBody) => Promise<TSignedRequest>;
348
395
  /**
349
396
  * Get all suborg IDs associated given a parent org ID and an optional filter.
350
397
  *
@@ -360,7 +407,7 @@ export declare class TurnkeyClient {
360
407
  */
361
408
  stampGetSubOrgIds: (input: TGetSubOrgIdsBody) => Promise<TSignedRequest>;
362
409
  /**
363
- * List all User Tags within an Organization
410
+ * List all user tags within an organization.
364
411
  *
365
412
  * Sign the provided `TListUserTagsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_user_tags).
366
413
  *
@@ -374,7 +421,7 @@ export declare class TurnkeyClient {
374
421
  */
375
422
  stampListUserTags: (input: TListUserTagsBody) => Promise<TSignedRequest>;
376
423
  /**
377
- * List all Users within an Organization
424
+ * List all users within an organization.
378
425
  *
379
426
  * Sign the provided `TGetUsersBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_users).
380
427
  *
@@ -402,7 +449,7 @@ export declare class TurnkeyClient {
402
449
  */
403
450
  stampGetVerifiedSubOrgIds: (input: TGetVerifiedSubOrgIdsBody) => Promise<TSignedRequest>;
404
451
  /**
405
- * List all Accounts within a Wallet
452
+ * List all accounts within a wallet.
406
453
  *
407
454
  * Sign the provided `TGetWalletAccountsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_wallet_accounts).
408
455
  *
@@ -416,7 +463,7 @@ export declare class TurnkeyClient {
416
463
  */
417
464
  stampGetWalletAccounts: (input: TGetWalletAccountsBody) => Promise<TSignedRequest>;
418
465
  /**
419
- * List all Wallets within an Organization
466
+ * List all wallets within an organization.
420
467
  *
421
468
  * Sign the provided `TGetWalletsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_wallets).
422
469
  *
@@ -430,7 +477,7 @@ export declare class TurnkeyClient {
430
477
  */
431
478
  stampGetWallets: (input: TGetWalletsBody) => Promise<TSignedRequest>;
432
479
  /**
433
- * 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.
480
+ * 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.
434
481
  *
435
482
  * Sign the provided `TGetWhoamiBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/whoami).
436
483
  *
@@ -444,7 +491,7 @@ export declare class TurnkeyClient {
444
491
  */
445
492
  stampGetWhoami: (input: TGetWhoamiBody) => Promise<TSignedRequest>;
446
493
  /**
447
- * Approve an Activity
494
+ * Approve an activity.
448
495
  *
449
496
  * Sign the provided `TApproveActivityBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/approve_activity).
450
497
  *
@@ -458,7 +505,7 @@ export declare class TurnkeyClient {
458
505
  */
459
506
  stampApproveActivity: (input: TApproveActivityBody) => Promise<TSignedRequest>;
460
507
  /**
461
- * Add api keys to an existing User
508
+ * Add API keys to an existing user.
462
509
  *
463
510
  * Sign the provided `TCreateApiKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_api_keys).
464
511
  *
@@ -472,7 +519,7 @@ export declare class TurnkeyClient {
472
519
  */
473
520
  stampCreateApiKeys: (input: TCreateApiKeysBody) => Promise<TSignedRequest>;
474
521
  /**
475
- * Create API-only Users in an existing Organization
522
+ * Create API-only users in an existing organization.
476
523
  *
477
524
  * Sign the provided `TCreateApiOnlyUsersBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_api_only_users).
478
525
  *
@@ -486,7 +533,7 @@ export declare class TurnkeyClient {
486
533
  */
487
534
  stampCreateApiOnlyUsers: (input: TCreateApiOnlyUsersBody) => Promise<TSignedRequest>;
488
535
  /**
489
- * Create Authenticators to authenticate requests to Turnkey
536
+ * Create authenticators to authenticate requests to Turnkey.
490
537
  *
491
538
  * Sign the provided `TCreateAuthenticatorsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_authenticators).
492
539
  *
@@ -500,7 +547,7 @@ export declare class TurnkeyClient {
500
547
  */
501
548
  stampCreateAuthenticators: (input: TCreateAuthenticatorsBody) => Promise<TSignedRequest>;
502
549
  /**
503
- * Create Invitations to join an existing Organization
550
+ * Create invitations to join an existing organization.
504
551
  *
505
552
  * Sign the provided `TCreateInvitationsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_invitations).
506
553
  *
@@ -514,7 +561,7 @@ export declare class TurnkeyClient {
514
561
  */
515
562
  stampCreateInvitations: (input: TCreateInvitationsBody) => Promise<TSignedRequest>;
516
563
  /**
517
- * Creates Oauth providers for a specified user - BETA
564
+ * Create Oauth providers for a specified user.
518
565
  *
519
566
  * Sign the provided `TCreateOauthProvidersBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_oauth_providers).
520
567
  *
@@ -528,7 +575,7 @@ export declare class TurnkeyClient {
528
575
  */
529
576
  stampCreateOauthProviders: (input: TCreateOauthProvidersBody) => Promise<TSignedRequest>;
530
577
  /**
531
- * Create new Policies
578
+ * Create new policies.
532
579
  *
533
580
  * Sign the provided `TCreatePoliciesBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_policies).
534
581
  *
@@ -542,7 +589,7 @@ export declare class TurnkeyClient {
542
589
  */
543
590
  stampCreatePolicies: (input: TCreatePoliciesBody) => Promise<TSignedRequest>;
544
591
  /**
545
- * Create a new Policy
592
+ * Create a new policy.
546
593
  *
547
594
  * Sign the provided `TCreatePolicyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_policy).
548
595
  *
@@ -570,7 +617,7 @@ export declare class TurnkeyClient {
570
617
  */
571
618
  stampCreatePrivateKeyTag: (input: TCreatePrivateKeyTagBody) => Promise<TSignedRequest>;
572
619
  /**
573
- * Create new Private Keys
620
+ * Create new private keys.
574
621
  *
575
622
  * Sign the provided `TCreatePrivateKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_private_keys).
576
623
  *
@@ -584,7 +631,7 @@ export declare class TurnkeyClient {
584
631
  */
585
632
  stampCreatePrivateKeys: (input: TCreatePrivateKeysBody) => Promise<TSignedRequest>;
586
633
  /**
587
- * Create a read only session for a user (valid for 1 hour)
634
+ * Create a read only session for a user (valid for 1 hour).
588
635
  *
589
636
  * Sign the provided `TCreateReadOnlySessionBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_read_only_session).
590
637
  *
@@ -598,7 +645,7 @@ export declare class TurnkeyClient {
598
645
  */
599
646
  stampCreateReadOnlySession: (input: TCreateReadOnlySessionBody) => Promise<TSignedRequest>;
600
647
  /**
601
- * Create a read write session for a user
648
+ * Create a read write session for a user.
602
649
  *
603
650
  * Sign the provided `TCreateReadWriteSessionBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_read_write_session).
604
651
  *
@@ -612,7 +659,21 @@ export declare class TurnkeyClient {
612
659
  */
613
660
  stampCreateReadWriteSession: (input: TCreateReadWriteSessionBody) => Promise<TSignedRequest>;
614
661
  /**
615
- * Create a new Sub-Organization
662
+ * Create an ABI/IDL in JSON.
663
+ *
664
+ * Sign the provided `TCreateSmartContractInterfaceBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_smart_contract_interface).
665
+ *
666
+ * See also {@link stampCreateSmartContractInterface}.
667
+ */
668
+ createSmartContractInterface: (input: TCreateSmartContractInterfaceBody) => Promise<TCreateSmartContractInterfaceResponse>;
669
+ /**
670
+ * Produce a `SignedRequest` from `TCreateSmartContractInterfaceBody` by using the client's `stamp` function.
671
+ *
672
+ * See also {@link CreateSmartContractInterface}.
673
+ */
674
+ stampCreateSmartContractInterface: (input: TCreateSmartContractInterfaceBody) => Promise<TSignedRequest>;
675
+ /**
676
+ * Create a new sub-organization.
616
677
  *
617
678
  * Sign the provided `TCreateSubOrganizationBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_sub_organization).
618
679
  *
@@ -640,7 +701,7 @@ export declare class TurnkeyClient {
640
701
  */
641
702
  stampCreateUserTag: (input: TCreateUserTagBody) => Promise<TSignedRequest>;
642
703
  /**
643
- * Create Users in an existing Organization
704
+ * Create users in an existing organization.
644
705
  *
645
706
  * Sign the provided `TCreateUsersBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_users).
646
707
  *
@@ -654,7 +715,7 @@ export declare class TurnkeyClient {
654
715
  */
655
716
  stampCreateUsers: (input: TCreateUsersBody) => Promise<TSignedRequest>;
656
717
  /**
657
- * Create a Wallet and derive addresses
718
+ * Create a wallet and derive addresses.
658
719
  *
659
720
  * Sign the provided `TCreateWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_wallet).
660
721
  *
@@ -668,7 +729,7 @@ export declare class TurnkeyClient {
668
729
  */
669
730
  stampCreateWallet: (input: TCreateWalletBody) => Promise<TSignedRequest>;
670
731
  /**
671
- * Derive additional addresses using an existing wallet
732
+ * Derive additional addresses using an existing wallet.
672
733
  *
673
734
  * Sign the provided `TCreateWalletAccountsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_wallet_accounts).
674
735
  *
@@ -682,7 +743,7 @@ export declare class TurnkeyClient {
682
743
  */
683
744
  stampCreateWalletAccounts: (input: TCreateWalletAccountsBody) => Promise<TSignedRequest>;
684
745
  /**
685
- * Remove api keys from a User
746
+ * Remove api keys from a user.
686
747
  *
687
748
  * Sign the provided `TDeleteApiKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_api_keys).
688
749
  *
@@ -696,7 +757,7 @@ export declare class TurnkeyClient {
696
757
  */
697
758
  stampDeleteApiKeys: (input: TDeleteApiKeysBody) => Promise<TSignedRequest>;
698
759
  /**
699
- * Remove authenticators from a User
760
+ * Remove authenticators from a user.
700
761
  *
701
762
  * Sign the provided `TDeleteAuthenticatorsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_authenticators).
702
763
  *
@@ -710,7 +771,7 @@ export declare class TurnkeyClient {
710
771
  */
711
772
  stampDeleteAuthenticators: (input: TDeleteAuthenticatorsBody) => Promise<TSignedRequest>;
712
773
  /**
713
- * Delete an existing Invitation
774
+ * Delete an existing invitation.
714
775
  *
715
776
  * Sign the provided `TDeleteInvitationBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_invitation).
716
777
  *
@@ -724,7 +785,7 @@ export declare class TurnkeyClient {
724
785
  */
725
786
  stampDeleteInvitation: (input: TDeleteInvitationBody) => Promise<TSignedRequest>;
726
787
  /**
727
- * Removes Oauth providers for a specified user - BETA
788
+ * Remove Oauth providers for a specified user.
728
789
  *
729
790
  * Sign the provided `TDeleteOauthProvidersBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_oauth_providers).
730
791
  *
@@ -738,7 +799,7 @@ export declare class TurnkeyClient {
738
799
  */
739
800
  stampDeleteOauthProviders: (input: TDeleteOauthProvidersBody) => Promise<TSignedRequest>;
740
801
  /**
741
- * Delete an existing Policy
802
+ * Delete an existing policy.
742
803
  *
743
804
  * Sign the provided `TDeletePolicyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_policy).
744
805
  *
@@ -752,7 +813,7 @@ export declare class TurnkeyClient {
752
813
  */
753
814
  stampDeletePolicy: (input: TDeletePolicyBody) => Promise<TSignedRequest>;
754
815
  /**
755
- * Delete Private Key Tags within an Organization
816
+ * Delete private key tags within an organization.
756
817
  *
757
818
  * Sign the provided `TDeletePrivateKeyTagsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_private_key_tags).
758
819
  *
@@ -766,7 +827,7 @@ export declare class TurnkeyClient {
766
827
  */
767
828
  stampDeletePrivateKeyTags: (input: TDeletePrivateKeyTagsBody) => Promise<TSignedRequest>;
768
829
  /**
769
- * Deletes private keys for an organization
830
+ * Delete private keys for an organization.
770
831
  *
771
832
  * Sign the provided `TDeletePrivateKeysBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_private_keys).
772
833
  *
@@ -780,7 +841,21 @@ export declare class TurnkeyClient {
780
841
  */
781
842
  stampDeletePrivateKeys: (input: TDeletePrivateKeysBody) => Promise<TSignedRequest>;
782
843
  /**
783
- * Deletes a sub organization
844
+ * Delete a smart contract interface.
845
+ *
846
+ * Sign the provided `TDeleteSmartContractInterfaceBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_smart_contract_interface).
847
+ *
848
+ * See also {@link stampDeleteSmartContractInterface}.
849
+ */
850
+ deleteSmartContractInterface: (input: TDeleteSmartContractInterfaceBody) => Promise<TDeleteSmartContractInterfaceResponse>;
851
+ /**
852
+ * Produce a `SignedRequest` from `TDeleteSmartContractInterfaceBody` by using the client's `stamp` function.
853
+ *
854
+ * See also {@link DeleteSmartContractInterface}.
855
+ */
856
+ stampDeleteSmartContractInterface: (input: TDeleteSmartContractInterfaceBody) => Promise<TSignedRequest>;
857
+ /**
858
+ * Delete a sub-organization.
784
859
  *
785
860
  * Sign the provided `TDeleteSubOrganizationBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_sub_organization).
786
861
  *
@@ -794,7 +869,7 @@ export declare class TurnkeyClient {
794
869
  */
795
870
  stampDeleteSubOrganization: (input: TDeleteSubOrganizationBody) => Promise<TSignedRequest>;
796
871
  /**
797
- * Delete User Tags within an Organization
872
+ * Delete user tags within an organization.
798
873
  *
799
874
  * Sign the provided `TDeleteUserTagsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_user_tags).
800
875
  *
@@ -808,7 +883,7 @@ export declare class TurnkeyClient {
808
883
  */
809
884
  stampDeleteUserTags: (input: TDeleteUserTagsBody) => Promise<TSignedRequest>;
810
885
  /**
811
- * Delete Users within an Organization
886
+ * Delete users within an organization.
812
887
  *
813
888
  * Sign the provided `TDeleteUsersBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_users).
814
889
  *
@@ -822,7 +897,7 @@ export declare class TurnkeyClient {
822
897
  */
823
898
  stampDeleteUsers: (input: TDeleteUsersBody) => Promise<TSignedRequest>;
824
899
  /**
825
- * Deletes wallets for an organization
900
+ * Delete wallets for an organization.
826
901
  *
827
902
  * Sign the provided `TDeleteWalletsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_wallets).
828
903
  *
@@ -836,7 +911,7 @@ export declare class TurnkeyClient {
836
911
  */
837
912
  stampDeleteWallets: (input: TDeleteWalletsBody) => Promise<TSignedRequest>;
838
913
  /**
839
- * Authenticate a user via Email
914
+ * Authenticate a user via email.
840
915
  *
841
916
  * Sign the provided `TEmailAuthBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/email_auth).
842
917
  *
@@ -850,7 +925,7 @@ export declare class TurnkeyClient {
850
925
  */
851
926
  stampEmailAuth: (input: TEmailAuthBody) => Promise<TSignedRequest>;
852
927
  /**
853
- * Exports a Private Key
928
+ * Export a private key.
854
929
  *
855
930
  * Sign the provided `TExportPrivateKeyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/export_private_key).
856
931
  *
@@ -864,7 +939,7 @@ export declare class TurnkeyClient {
864
939
  */
865
940
  stampExportPrivateKey: (input: TExportPrivateKeyBody) => Promise<TSignedRequest>;
866
941
  /**
867
- * Exports a Wallet
942
+ * Export a wallet.
868
943
  *
869
944
  * Sign the provided `TExportWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/export_wallet).
870
945
  *
@@ -878,7 +953,7 @@ export declare class TurnkeyClient {
878
953
  */
879
954
  stampExportWallet: (input: TExportWalletBody) => Promise<TSignedRequest>;
880
955
  /**
881
- * Exports a Wallet Account
956
+ * Export a wallet account.
882
957
  *
883
958
  * Sign the provided `TExportWalletAccountBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/export_wallet_account).
884
959
  *
@@ -892,7 +967,7 @@ export declare class TurnkeyClient {
892
967
  */
893
968
  stampExportWalletAccount: (input: TExportWalletAccountBody) => Promise<TSignedRequest>;
894
969
  /**
895
- * Imports a private key
970
+ * Import a private key.
896
971
  *
897
972
  * Sign the provided `TImportPrivateKeyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/import_private_key).
898
973
  *
@@ -906,7 +981,7 @@ export declare class TurnkeyClient {
906
981
  */
907
982
  stampImportPrivateKey: (input: TImportPrivateKeyBody) => Promise<TSignedRequest>;
908
983
  /**
909
- * Imports a wallet
984
+ * Import a wallet.
910
985
  *
911
986
  * Sign the provided `TImportWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/import_wallet).
912
987
  *
@@ -920,7 +995,7 @@ export declare class TurnkeyClient {
920
995
  */
921
996
  stampImportWallet: (input: TImportWalletBody) => Promise<TSignedRequest>;
922
997
  /**
923
- * Initiate a fiat on ramp flow
998
+ * Initiate a fiat on ramp flow.
924
999
  *
925
1000
  * Sign the provided `TInitFiatOnRampBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_fiat_on_ramp).
926
1001
  *
@@ -934,7 +1009,7 @@ export declare class TurnkeyClient {
934
1009
  */
935
1010
  stampInitFiatOnRamp: (input: TInitFiatOnRampBody) => Promise<TSignedRequest>;
936
1011
  /**
937
- * Initializes a new private key import
1012
+ * Initialize a new private key import.
938
1013
  *
939
1014
  * Sign the provided `TInitImportPrivateKeyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_import_private_key).
940
1015
  *
@@ -948,7 +1023,7 @@ export declare class TurnkeyClient {
948
1023
  */
949
1024
  stampInitImportPrivateKey: (input: TInitImportPrivateKeyBody) => Promise<TSignedRequest>;
950
1025
  /**
951
- * Initializes a new wallet import
1026
+ * Initialize a new wallet import.
952
1027
  *
953
1028
  * Sign the provided `TInitImportWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_import_wallet).
954
1029
  *
@@ -962,7 +1037,7 @@ export declare class TurnkeyClient {
962
1037
  */
963
1038
  stampInitImportWallet: (input: TInitImportWalletBody) => Promise<TSignedRequest>;
964
1039
  /**
965
- * Initiate a Generic OTP activity
1040
+ * Initiate a generic OTP activity.
966
1041
  *
967
1042
  * Sign the provided `TInitOtpBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_otp).
968
1043
  *
@@ -976,7 +1051,7 @@ export declare class TurnkeyClient {
976
1051
  */
977
1052
  stampInitOtp: (input: TInitOtpBody) => Promise<TSignedRequest>;
978
1053
  /**
979
- * Initiate an OTP auth activity
1054
+ * Initiate an OTP auth activity.
980
1055
  *
981
1056
  * Sign the provided `TInitOtpAuthBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_otp_auth).
982
1057
  *
@@ -990,7 +1065,7 @@ export declare class TurnkeyClient {
990
1065
  */
991
1066
  stampInitOtpAuth: (input: TInitOtpAuthBody) => Promise<TSignedRequest>;
992
1067
  /**
993
- * Initializes a new email recovery
1068
+ * Initialize a new email recovery.
994
1069
  *
995
1070
  * Sign the provided `TInitUserEmailRecoveryBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/init_user_email_recovery).
996
1071
  *
@@ -1004,7 +1079,7 @@ export declare class TurnkeyClient {
1004
1079
  */
1005
1080
  stampInitUserEmailRecovery: (input: TInitUserEmailRecoveryBody) => Promise<TSignedRequest>;
1006
1081
  /**
1007
- * Authenticate a user with an Oidc token (Oauth) - BETA
1082
+ * Authenticate a user with an OIDC token (Oauth).
1008
1083
  *
1009
1084
  * Sign the provided `TOauthBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/oauth).
1010
1085
  *
@@ -1018,7 +1093,7 @@ export declare class TurnkeyClient {
1018
1093
  */
1019
1094
  stampOauth: (input: TOauthBody) => Promise<TSignedRequest>;
1020
1095
  /**
1021
- * Create an Oauth session for a user
1096
+ * Create an Oauth session for a user.
1022
1097
  *
1023
1098
  * Sign the provided `TOauthLoginBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/oauth_login).
1024
1099
  *
@@ -1032,7 +1107,7 @@ export declare class TurnkeyClient {
1032
1107
  */
1033
1108
  stampOauthLogin: (input: TOauthLoginBody) => Promise<TSignedRequest>;
1034
1109
  /**
1035
- * Authenticate a user with an OTP code sent via email or SMS
1110
+ * Authenticate a user with an OTP code sent via email or SMS.
1036
1111
  *
1037
1112
  * Sign the provided `TOtpAuthBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/otp_auth).
1038
1113
  *
@@ -1046,7 +1121,7 @@ export declare class TurnkeyClient {
1046
1121
  */
1047
1122
  stampOtpAuth: (input: TOtpAuthBody) => Promise<TSignedRequest>;
1048
1123
  /**
1049
- * Create an OTP session for a user
1124
+ * Create an OTP session for a user.
1050
1125
  *
1051
1126
  * Sign the provided `TOtpLoginBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/otp_login).
1052
1127
  *
@@ -1060,7 +1135,7 @@ export declare class TurnkeyClient {
1060
1135
  */
1061
1136
  stampOtpLogin: (input: TOtpLoginBody) => Promise<TSignedRequest>;
1062
1137
  /**
1063
- * Completes the process of recovering a user by adding an authenticator
1138
+ * Complete the process of recovering a user by adding an authenticator.
1064
1139
  *
1065
1140
  * Sign the provided `TRecoverUserBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/recover_user).
1066
1141
  *
@@ -1074,7 +1149,7 @@ export declare class TurnkeyClient {
1074
1149
  */
1075
1150
  stampRecoverUser: (input: TRecoverUserBody) => Promise<TSignedRequest>;
1076
1151
  /**
1077
- * Reject an Activity
1152
+ * Reject an activity.
1078
1153
  *
1079
1154
  * Sign the provided `TRejectActivityBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/reject_activity).
1080
1155
  *
@@ -1088,7 +1163,7 @@ export declare class TurnkeyClient {
1088
1163
  */
1089
1164
  stampRejectActivity: (input: TRejectActivityBody) => Promise<TSignedRequest>;
1090
1165
  /**
1091
- * Removes an organization feature. This activity must be approved by the current root quorum.
1166
+ * Remove an organization feature. This activity must be approved by the current root quorum.
1092
1167
  *
1093
1168
  * Sign the provided `TRemoveOrganizationFeatureBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/remove_organization_feature).
1094
1169
  *
@@ -1102,7 +1177,7 @@ export declare class TurnkeyClient {
1102
1177
  */
1103
1178
  stampRemoveOrganizationFeature: (input: TRemoveOrganizationFeatureBody) => Promise<TSignedRequest>;
1104
1179
  /**
1105
- * Sets an organization feature. This activity must be approved by the current root quorum.
1180
+ * Set an organization feature. This activity must be approved by the current root quorum.
1106
1181
  *
1107
1182
  * Sign the provided `TSetOrganizationFeatureBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/set_organization_feature).
1108
1183
  *
@@ -1116,7 +1191,7 @@ export declare class TurnkeyClient {
1116
1191
  */
1117
1192
  stampSetOrganizationFeature: (input: TSetOrganizationFeatureBody) => Promise<TSignedRequest>;
1118
1193
  /**
1119
- * Sign a raw payload
1194
+ * Sign a raw payload.
1120
1195
  *
1121
1196
  * Sign the provided `TSignRawPayloadBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/sign_raw_payload).
1122
1197
  *
@@ -1130,7 +1205,7 @@ export declare class TurnkeyClient {
1130
1205
  */
1131
1206
  stampSignRawPayload: (input: TSignRawPayloadBody) => Promise<TSignedRequest>;
1132
1207
  /**
1133
- * Sign multiple raw payloads with the same signing parameters
1208
+ * Sign multiple raw payloads with the same signing parameters.
1134
1209
  *
1135
1210
  * Sign the provided `TSignRawPayloadsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/sign_raw_payloads).
1136
1211
  *
@@ -1144,7 +1219,7 @@ export declare class TurnkeyClient {
1144
1219
  */
1145
1220
  stampSignRawPayloads: (input: TSignRawPayloadsBody) => Promise<TSignedRequest>;
1146
1221
  /**
1147
- * Sign a transaction
1222
+ * Sign a transaction.
1148
1223
  *
1149
1224
  * Sign the provided `TSignTransactionBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/sign_transaction).
1150
1225
  *
@@ -1158,7 +1233,7 @@ export declare class TurnkeyClient {
1158
1233
  */
1159
1234
  stampSignTransaction: (input: TSignTransactionBody) => Promise<TSignedRequest>;
1160
1235
  /**
1161
- * Create a session for a user through stamping client side (api key, wallet client, or passkey client)
1236
+ * Create a session for a user through stamping client side (API key, wallet client, or passkey client).
1162
1237
  *
1163
1238
  * Sign the provided `TStampLoginBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/stamp_login).
1164
1239
  *
@@ -1172,7 +1247,7 @@ export declare class TurnkeyClient {
1172
1247
  */
1173
1248
  stampStampLogin: (input: TStampLoginBody) => Promise<TSignedRequest>;
1174
1249
  /**
1175
- * Update an existing Policy
1250
+ * Update an existing policy.
1176
1251
  *
1177
1252
  * Sign the provided `TUpdatePolicyBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_policy).
1178
1253
  *
@@ -1214,7 +1289,7 @@ export declare class TurnkeyClient {
1214
1289
  */
1215
1290
  stampUpdateRootQuorum: (input: TUpdateRootQuorumBody) => Promise<TSignedRequest>;
1216
1291
  /**
1217
- * Update a User in an existing Organization
1292
+ * Update a user in an existing organization.
1218
1293
  *
1219
1294
  * Sign the provided `TUpdateUserBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_user).
1220
1295
  *
@@ -1228,7 +1303,7 @@ export declare class TurnkeyClient {
1228
1303
  */
1229
1304
  stampUpdateUser: (input: TUpdateUserBody) => Promise<TSignedRequest>;
1230
1305
  /**
1231
- * Update a User's email in an existing Organization
1306
+ * Update a user's email in an existing organization.
1232
1307
  *
1233
1308
  * Sign the provided `TUpdateUserEmailBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_user_email).
1234
1309
  *
@@ -1242,7 +1317,7 @@ export declare class TurnkeyClient {
1242
1317
  */
1243
1318
  stampUpdateUserEmail: (input: TUpdateUserEmailBody) => Promise<TSignedRequest>;
1244
1319
  /**
1245
- * Update a User's name in an existing Organization
1320
+ * Update a user's name in an existing organization.
1246
1321
  *
1247
1322
  * Sign the provided `TUpdateUserNameBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_user_name).
1248
1323
  *
@@ -1256,7 +1331,7 @@ export declare class TurnkeyClient {
1256
1331
  */
1257
1332
  stampUpdateUserName: (input: TUpdateUserNameBody) => Promise<TSignedRequest>;
1258
1333
  /**
1259
- * Update a User's phone number in an existing Organization
1334
+ * Update a user's phone number in an existing organization.
1260
1335
  *
1261
1336
  * Sign the provided `TUpdateUserPhoneNumberBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_user_phone_number).
1262
1337
  *
@@ -1284,7 +1359,7 @@ export declare class TurnkeyClient {
1284
1359
  */
1285
1360
  stampUpdateUserTag: (input: TUpdateUserTagBody) => Promise<TSignedRequest>;
1286
1361
  /**
1287
- * Update a wallet for an organization
1362
+ * Update a wallet for an organization.
1288
1363
  *
1289
1364
  * Sign the provided `TUpdateWalletBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_wallet).
1290
1365
  *
@@ -1298,7 +1373,7 @@ export declare class TurnkeyClient {
1298
1373
  */
1299
1374
  stampUpdateWallet: (input: TUpdateWalletBody) => Promise<TSignedRequest>;
1300
1375
  /**
1301
- * Verify a Generic OTP
1376
+ * Verify a generic OTP.
1302
1377
  *
1303
1378
  * Sign the provided `TVerifyOtpBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/verify_otp).
1304
1379
  *
@@ -1312,7 +1387,7 @@ export declare class TurnkeyClient {
1312
1387
  */
1313
1388
  stampVerifyOtp: (input: TVerifyOtpBody) => Promise<TSignedRequest>;
1314
1389
  /**
1315
- * Set a rate local rate limit just on the current endpoint, for purposes of testing with Vivosuite
1390
+ * Set a rate local rate limit just on the current endpoint, for purposes of testing with Vivosuite.
1316
1391
  *
1317
1392
  * Sign the provided `TTestRateLimitsBody` with the client's `stamp` function, and submit the request (POST /tkhq/api/v1/test_rate_limits).
1318
1393
  *