@turnkey/http 3.17.1 → 3.18.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.
@@ -83,6 +83,31 @@ class TurnkeyClient {
83
83
  url: fullUrl,
84
84
  };
85
85
  };
86
+ /**
87
+ * Get live runtime status for a TVC App from the cluster.
88
+ *
89
+ * Sign the provided `TGetAppStatusBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_app_status).
90
+ *
91
+ * See also {@link stampGetAppStatus}.
92
+ */
93
+ this.getAppStatus = async (input) => {
94
+ return this.request("/public/v1/query/get_app_status", input);
95
+ };
96
+ /**
97
+ * Produce a `SignedRequest` from `TGetAppStatusBody` by using the client's `stamp` function.
98
+ *
99
+ * See also {@link GetAppStatus}.
100
+ */
101
+ this.stampGetAppStatus = async (input) => {
102
+ const fullUrl = this.config.baseUrl + "/public/v1/query/get_app_status";
103
+ const body = JSON.stringify(input);
104
+ const stamp = await this.stamper.stamp(body);
105
+ return {
106
+ body: body,
107
+ stamp: stamp,
108
+ url: fullUrl,
109
+ };
110
+ };
86
111
  /**
87
112
  * Get details about an authenticator.
88
113
  *
@@ -308,31 +333,6 @@ class TurnkeyClient {
308
333
  url: fullUrl,
309
334
  };
310
335
  };
311
- /**
312
- * Get details about an organization.
313
- *
314
- * Sign the provided `TGetOrganizationBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_organization).
315
- *
316
- * See also {@link stampGetOrganization}.
317
- */
318
- this.getOrganization = async (input) => {
319
- return this.request("/public/v1/query/get_organization", input);
320
- };
321
- /**
322
- * Produce a `SignedRequest` from `TGetOrganizationBody` by using the client's `stamp` function.
323
- *
324
- * See also {@link GetOrganization}.
325
- */
326
- this.stampGetOrganization = async (input) => {
327
- const fullUrl = this.config.baseUrl + "/public/v1/query/get_organization";
328
- const body = JSON.stringify(input);
329
- const stamp = await this.stamper.stamp(body);
330
- return {
331
- body: body,
332
- stamp: stamp,
333
- url: fullUrl,
334
- };
335
- };
336
336
  /**
337
337
  * Get quorum settings and features for an organization.
338
338
  *
@@ -483,56 +483,6 @@ class TurnkeyClient {
483
483
  url: fullUrl,
484
484
  };
485
485
  };
486
- /**
487
- * Get details about a single TVC App
488
- *
489
- * Sign the provided `TGetTvcAppBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_tvc_app).
490
- *
491
- * See also {@link stampGetTvcApp}.
492
- */
493
- this.getTvcApp = async (input) => {
494
- return this.request("/public/v1/query/get_tvc_app", input);
495
- };
496
- /**
497
- * Produce a `SignedRequest` from `TGetTvcAppBody` by using the client's `stamp` function.
498
- *
499
- * See also {@link GetTvcApp}.
500
- */
501
- this.stampGetTvcApp = async (input) => {
502
- const fullUrl = this.config.baseUrl + "/public/v1/query/get_tvc_app";
503
- const body = JSON.stringify(input);
504
- const stamp = await this.stamper.stamp(body);
505
- return {
506
- body: body,
507
- stamp: stamp,
508
- url: fullUrl,
509
- };
510
- };
511
- /**
512
- * Get details about a single TVC Deployment
513
- *
514
- * Sign the provided `TGetTvcDeploymentBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_tvc_deployment).
515
- *
516
- * See also {@link stampGetTvcDeployment}.
517
- */
518
- this.getTvcDeployment = async (input) => {
519
- return this.request("/public/v1/query/get_tvc_deployment", input);
520
- };
521
- /**
522
- * Produce a `SignedRequest` from `TGetTvcDeploymentBody` by using the client's `stamp` function.
523
- *
524
- * See also {@link GetTvcDeployment}.
525
- */
526
- this.stampGetTvcDeployment = async (input) => {
527
- const fullUrl = this.config.baseUrl + "/public/v1/query/get_tvc_deployment";
528
- const body = JSON.stringify(input);
529
- const stamp = await this.stamper.stamp(body);
530
- return {
531
- body: body,
532
- stamp: stamp,
533
- url: fullUrl,
534
- };
535
- };
536
486
  /**
537
487
  * Get details about a user.
538
488
  *
@@ -609,7 +559,7 @@ class TurnkeyClient {
609
559
  };
610
560
  };
611
561
  /**
612
- * Get non-zero balances of supported assets for a single wallet account address on the specified network.
562
+ * Get balances of supported assets for an address on the specified network. Only non-zero balances are returned. This feature is in beta - please contact support for access.
613
563
  *
614
564
  * Sign the provided `TGetWalletAddressBalancesBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/get_wallet_address_balances).
615
565
  *
@@ -859,7 +809,7 @@ class TurnkeyClient {
859
809
  };
860
810
  };
861
811
  /**
862
- * List supported assets for the specified network
812
+ * List supported assets for the specified network. This feature is in beta - please contact support for access.
863
813
  *
864
814
  * Sign the provided `TListSupportedAssetsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_supported_assets).
865
815
  *
@@ -883,56 +833,6 @@ class TurnkeyClient {
883
833
  url: fullUrl,
884
834
  };
885
835
  };
886
- /**
887
- * List all deployments for a given TVC App
888
- *
889
- * Sign the provided `TGetTvcAppDeploymentsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_tvc_app_deployments).
890
- *
891
- * See also {@link stampGetTvcAppDeployments}.
892
- */
893
- this.getTvcAppDeployments = async (input) => {
894
- return this.request("/public/v1/query/list_tvc_app_deployments", input);
895
- };
896
- /**
897
- * Produce a `SignedRequest` from `TGetTvcAppDeploymentsBody` by using the client's `stamp` function.
898
- *
899
- * See also {@link GetTvcAppDeployments}.
900
- */
901
- this.stampGetTvcAppDeployments = async (input) => {
902
- const fullUrl = this.config.baseUrl + "/public/v1/query/list_tvc_app_deployments";
903
- const body = JSON.stringify(input);
904
- const stamp = await this.stamper.stamp(body);
905
- return {
906
- body: body,
907
- stamp: stamp,
908
- url: fullUrl,
909
- };
910
- };
911
- /**
912
- * List all TVC Apps within an organization.
913
- *
914
- * Sign the provided `TGetTvcAppsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_tvc_apps).
915
- *
916
- * See also {@link stampGetTvcApps}.
917
- */
918
- this.getTvcApps = async (input) => {
919
- return this.request("/public/v1/query/list_tvc_apps", input);
920
- };
921
- /**
922
- * Produce a `SignedRequest` from `TGetTvcAppsBody` by using the client's `stamp` function.
923
- *
924
- * See also {@link GetTvcApps}.
925
- */
926
- this.stampGetTvcApps = async (input) => {
927
- const fullUrl = this.config.baseUrl + "/public/v1/query/list_tvc_apps";
928
- const body = JSON.stringify(input);
929
- const stamp = await this.stamper.stamp(body);
930
- return {
931
- body: body,
932
- stamp: stamp,
933
- url: fullUrl,
934
- };
935
- };
936
836
  /**
937
837
  * List all user tags within an organization.
938
838
  *
@@ -1058,6 +958,31 @@ class TurnkeyClient {
1058
958
  url: fullUrl,
1059
959
  };
1060
960
  };
961
+ /**
962
+ * List webhook endpoints within an organization.
963
+ *
964
+ * Sign the provided `TListWebhookEndpointsBody` with the client's `stamp` function, and submit the request (POST /public/v1/query/list_webhook_endpoints).
965
+ *
966
+ * See also {@link stampListWebhookEndpoints}.
967
+ */
968
+ this.listWebhookEndpoints = async (input) => {
969
+ return this.request("/public/v1/query/list_webhook_endpoints", input);
970
+ };
971
+ /**
972
+ * Produce a `SignedRequest` from `TListWebhookEndpointsBody` by using the client's `stamp` function.
973
+ *
974
+ * See also {@link ListWebhookEndpoints}.
975
+ */
976
+ this.stampListWebhookEndpoints = async (input) => {
977
+ const fullUrl = this.config.baseUrl + "/public/v1/query/list_webhook_endpoints";
978
+ const body = JSON.stringify(input);
979
+ const stamp = await this.stamper.stamp(body);
980
+ return {
981
+ body: body,
982
+ stamp: stamp,
983
+ url: fullUrl,
984
+ };
985
+ };
1061
986
  /**
1062
987
  * 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.
1063
988
  *
@@ -1483,81 +1408,6 @@ class TurnkeyClient {
1483
1408
  url: fullUrl,
1484
1409
  };
1485
1410
  };
1486
- /**
1487
- * Create a new TVC application
1488
- *
1489
- * Sign the provided `TCreateTvcAppBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_tvc_app).
1490
- *
1491
- * See also {@link stampCreateTvcApp}.
1492
- */
1493
- this.createTvcApp = async (input) => {
1494
- return this.request("/public/v1/submit/create_tvc_app", input);
1495
- };
1496
- /**
1497
- * Produce a `SignedRequest` from `TCreateTvcAppBody` by using the client's `stamp` function.
1498
- *
1499
- * See also {@link CreateTvcApp}.
1500
- */
1501
- this.stampCreateTvcApp = async (input) => {
1502
- const fullUrl = this.config.baseUrl + "/public/v1/submit/create_tvc_app";
1503
- const body = JSON.stringify(input);
1504
- const stamp = await this.stamper.stamp(body);
1505
- return {
1506
- body: body,
1507
- stamp: stamp,
1508
- url: fullUrl,
1509
- };
1510
- };
1511
- /**
1512
- * Create a new TVC Deployment
1513
- *
1514
- * Sign the provided `TCreateTvcDeploymentBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_tvc_deployment).
1515
- *
1516
- * See also {@link stampCreateTvcDeployment}.
1517
- */
1518
- this.createTvcDeployment = async (input) => {
1519
- return this.request("/public/v1/submit/create_tvc_deployment", input);
1520
- };
1521
- /**
1522
- * Produce a `SignedRequest` from `TCreateTvcDeploymentBody` by using the client's `stamp` function.
1523
- *
1524
- * See also {@link CreateTvcDeployment}.
1525
- */
1526
- this.stampCreateTvcDeployment = async (input) => {
1527
- const fullUrl = this.config.baseUrl + "/public/v1/submit/create_tvc_deployment";
1528
- const body = JSON.stringify(input);
1529
- const stamp = await this.stamper.stamp(body);
1530
- return {
1531
- body: body,
1532
- stamp: stamp,
1533
- url: fullUrl,
1534
- };
1535
- };
1536
- /**
1537
- * Post one or more manifest approvals for a TVC Manifest
1538
- *
1539
- * Sign the provided `TCreateTvcManifestApprovalsBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_tvc_manifest_approvals).
1540
- *
1541
- * See also {@link stampCreateTvcManifestApprovals}.
1542
- */
1543
- this.createTvcManifestApprovals = async (input) => {
1544
- return this.request("/public/v1/submit/create_tvc_manifest_approvals", input);
1545
- };
1546
- /**
1547
- * Produce a `SignedRequest` from `TCreateTvcManifestApprovalsBody` by using the client's `stamp` function.
1548
- *
1549
- * See also {@link CreateTvcManifestApprovals}.
1550
- */
1551
- this.stampCreateTvcManifestApprovals = async (input) => {
1552
- const fullUrl = this.config.baseUrl + "/public/v1/submit/create_tvc_manifest_approvals";
1553
- const body = JSON.stringify(input);
1554
- const stamp = await this.stamper.stamp(body);
1555
- return {
1556
- body: body,
1557
- stamp: stamp,
1558
- url: fullUrl,
1559
- };
1560
- };
1561
1411
  /**
1562
1412
  * Create a user tag and add it to users.
1563
1413
  *
@@ -1658,6 +1508,31 @@ class TurnkeyClient {
1658
1508
  url: fullUrl,
1659
1509
  };
1660
1510
  };
1511
+ /**
1512
+ * Create a webhook endpoint for an organization.
1513
+ *
1514
+ * Sign the provided `TCreateWebhookEndpointBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/create_webhook_endpoint).
1515
+ *
1516
+ * See also {@link stampCreateWebhookEndpoint}.
1517
+ */
1518
+ this.createWebhookEndpoint = async (input) => {
1519
+ return this.request("/public/v1/submit/create_webhook_endpoint", input);
1520
+ };
1521
+ /**
1522
+ * Produce a `SignedRequest` from `TCreateWebhookEndpointBody` by using the client's `stamp` function.
1523
+ *
1524
+ * See also {@link CreateWebhookEndpoint}.
1525
+ */
1526
+ this.stampCreateWebhookEndpoint = async (input) => {
1527
+ const fullUrl = this.config.baseUrl + "/public/v1/submit/create_webhook_endpoint";
1528
+ const body = JSON.stringify(input);
1529
+ const stamp = await this.stamper.stamp(body);
1530
+ return {
1531
+ body: body,
1532
+ stamp: stamp,
1533
+ url: fullUrl,
1534
+ };
1535
+ };
1661
1536
  /**
1662
1537
  * Remove api keys from a user.
1663
1538
  *
@@ -2059,22 +1934,22 @@ class TurnkeyClient {
2059
1934
  };
2060
1935
  };
2061
1936
  /**
2062
- * Authenticate a user via email.
1937
+ * Delete a webhook endpoint for an organization.
2063
1938
  *
2064
- * Sign the provided `TEmailAuthBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/email_auth).
1939
+ * Sign the provided `TDeleteWebhookEndpointBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/delete_webhook_endpoint).
2065
1940
  *
2066
- * See also {@link stampEmailAuth}.
1941
+ * See also {@link stampDeleteWebhookEndpoint}.
2067
1942
  */
2068
- this.emailAuth = async (input) => {
2069
- return this.request("/public/v1/submit/email_auth", input);
1943
+ this.deleteWebhookEndpoint = async (input) => {
1944
+ return this.request("/public/v1/submit/delete_webhook_endpoint", input);
2070
1945
  };
2071
1946
  /**
2072
- * Produce a `SignedRequest` from `TEmailAuthBody` by using the client's `stamp` function.
1947
+ * Produce a `SignedRequest` from `TDeleteWebhookEndpointBody` by using the client's `stamp` function.
2073
1948
  *
2074
- * See also {@link EmailAuth}.
1949
+ * See also {@link DeleteWebhookEndpoint}.
2075
1950
  */
2076
- this.stampEmailAuth = async (input) => {
2077
- const fullUrl = this.config.baseUrl + "/public/v1/submit/email_auth";
1951
+ this.stampDeleteWebhookEndpoint = async (input) => {
1952
+ const fullUrl = this.config.baseUrl + "/public/v1/submit/delete_webhook_endpoint";
2078
1953
  const body = JSON.stringify(input);
2079
1954
  const stamp = await this.stamper.stamp(body);
2080
1955
  return {
@@ -2084,22 +1959,22 @@ class TurnkeyClient {
2084
1959
  };
2085
1960
  };
2086
1961
  /**
2087
- * Submit a raw transaction (serialized and signed) for broadcasting to the network.
1962
+ * Authenticate a user via email.
2088
1963
  *
2089
- * Sign the provided `TEthSendRawTransactionBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/eth_send_raw_transaction).
1964
+ * Sign the provided `TEmailAuthBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/email_auth).
2090
1965
  *
2091
- * See also {@link stampEthSendRawTransaction}.
1966
+ * See also {@link stampEmailAuth}.
2092
1967
  */
2093
- this.ethSendRawTransaction = async (input) => {
2094
- return this.request("/public/v1/submit/eth_send_raw_transaction", input);
1968
+ this.emailAuth = async (input) => {
1969
+ return this.request("/public/v1/submit/email_auth", input);
2095
1970
  };
2096
1971
  /**
2097
- * Produce a `SignedRequest` from `TEthSendRawTransactionBody` by using the client's `stamp` function.
1972
+ * Produce a `SignedRequest` from `TEmailAuthBody` by using the client's `stamp` function.
2098
1973
  *
2099
- * See also {@link EthSendRawTransaction}.
1974
+ * See also {@link EmailAuth}.
2100
1975
  */
2101
- this.stampEthSendRawTransaction = async (input) => {
2102
- const fullUrl = this.config.baseUrl + "/public/v1/submit/eth_send_raw_transaction";
1976
+ this.stampEmailAuth = async (input) => {
1977
+ const fullUrl = this.config.baseUrl + "/public/v1/submit/email_auth";
2103
1978
  const body = JSON.stringify(input);
2104
1979
  const stamp = await this.stamper.stamp(body);
2105
1980
  return {
@@ -2808,6 +2683,31 @@ class TurnkeyClient {
2808
2683
  url: fullUrl,
2809
2684
  };
2810
2685
  };
2686
+ /**
2687
+ * Update the name of an organization.
2688
+ *
2689
+ * Sign the provided `TUpdateOrganizationNameBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_organization_name).
2690
+ *
2691
+ * See also {@link stampUpdateOrganizationName}.
2692
+ */
2693
+ this.updateOrganizationName = async (input) => {
2694
+ return this.request("/public/v1/submit/update_organization_name", input);
2695
+ };
2696
+ /**
2697
+ * Produce a `SignedRequest` from `TUpdateOrganizationNameBody` by using the client's `stamp` function.
2698
+ *
2699
+ * See also {@link UpdateOrganizationName}.
2700
+ */
2701
+ this.stampUpdateOrganizationName = async (input) => {
2702
+ const fullUrl = this.config.baseUrl + "/public/v1/submit/update_organization_name";
2703
+ const body = JSON.stringify(input);
2704
+ const stamp = await this.stamper.stamp(body);
2705
+ return {
2706
+ body: body,
2707
+ stamp: stamp,
2708
+ url: fullUrl,
2709
+ };
2710
+ };
2811
2711
  /**
2812
2712
  * Update an existing policy.
2813
2713
  *
@@ -3034,47 +2934,22 @@ class TurnkeyClient {
3034
2934
  };
3035
2935
  };
3036
2936
  /**
3037
- * Verify a generic OTP.
2937
+ * Update a webhook endpoint for an organization.
3038
2938
  *
3039
- * Sign the provided `TVerifyOtpBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/verify_otp).
2939
+ * Sign the provided `TUpdateWebhookEndpointBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/update_webhook_endpoint).
3040
2940
  *
3041
- * See also {@link stampVerifyOtp}.
2941
+ * See also {@link stampUpdateWebhookEndpoint}.
3042
2942
  */
3043
- this.verifyOtp = async (input) => {
3044
- return this.request("/public/v1/submit/verify_otp", input);
3045
- };
3046
- /**
3047
- * Produce a `SignedRequest` from `TVerifyOtpBody` by using the client's `stamp` function.
3048
- *
3049
- * See also {@link VerifyOtp}.
3050
- */
3051
- this.stampVerifyOtp = async (input) => {
3052
- const fullUrl = this.config.baseUrl + "/public/v1/submit/verify_otp";
3053
- const body = JSON.stringify(input);
3054
- const stamp = await this.stamper.stamp(body);
3055
- return {
3056
- body: body,
3057
- stamp: stamp,
3058
- url: fullUrl,
3059
- };
3060
- };
3061
- /**
3062
- * Refresh feature flags by triggering a DB read to flush the in-memory cache.
3063
- *
3064
- * Sign the provided `TRefreshFeatureFlagsBody` with the client's `stamp` function, and submit the request (POST /tkhq/api/v1/refresh_feature_flags).
3065
- *
3066
- * See also {@link stampRefreshFeatureFlags}.
3067
- */
3068
- this.refreshFeatureFlags = async (input) => {
3069
- return this.request("/tkhq/api/v1/refresh_feature_flags", input);
2943
+ this.updateWebhookEndpoint = async (input) => {
2944
+ return this.request("/public/v1/submit/update_webhook_endpoint", input);
3070
2945
  };
3071
2946
  /**
3072
- * Produce a `SignedRequest` from `TRefreshFeatureFlagsBody` by using the client's `stamp` function.
2947
+ * Produce a `SignedRequest` from `TUpdateWebhookEndpointBody` by using the client's `stamp` function.
3073
2948
  *
3074
- * See also {@link RefreshFeatureFlags}.
2949
+ * See also {@link UpdateWebhookEndpoint}.
3075
2950
  */
3076
- this.stampRefreshFeatureFlags = async (input) => {
3077
- const fullUrl = this.config.baseUrl + "/tkhq/api/v1/refresh_feature_flags";
2951
+ this.stampUpdateWebhookEndpoint = async (input) => {
2952
+ const fullUrl = this.config.baseUrl + "/public/v1/submit/update_webhook_endpoint";
3078
2953
  const body = JSON.stringify(input);
3079
2954
  const stamp = await this.stamper.stamp(body);
3080
2955
  return {
@@ -3084,22 +2959,22 @@ class TurnkeyClient {
3084
2959
  };
3085
2960
  };
3086
2961
  /**
3087
- * Set a rate local rate limit just on the current endpoint, for purposes of testing with Vivosuite.
2962
+ * Verify a generic OTP.
3088
2963
  *
3089
- * Sign the provided `TTestRateLimitsBody` with the client's `stamp` function, and submit the request (POST /tkhq/api/v1/test_rate_limits).
2964
+ * Sign the provided `TVerifyOtpBody` with the client's `stamp` function, and submit the request (POST /public/v1/submit/verify_otp).
3090
2965
  *
3091
- * See also {@link stampTestRateLimits}.
2966
+ * See also {@link stampVerifyOtp}.
3092
2967
  */
3093
- this.testRateLimits = async (input) => {
3094
- return this.request("/tkhq/api/v1/test_rate_limits", input);
2968
+ this.verifyOtp = async (input) => {
2969
+ return this.request("/public/v1/submit/verify_otp", input);
3095
2970
  };
3096
2971
  /**
3097
- * Produce a `SignedRequest` from `TTestRateLimitsBody` by using the client's `stamp` function.
2972
+ * Produce a `SignedRequest` from `TVerifyOtpBody` by using the client's `stamp` function.
3098
2973
  *
3099
- * See also {@link TestRateLimits}.
2974
+ * See also {@link VerifyOtp}.
3100
2975
  */
3101
- this.stampTestRateLimits = async (input) => {
3102
- const fullUrl = this.config.baseUrl + "/tkhq/api/v1/test_rate_limits";
2976
+ this.stampVerifyOtp = async (input) => {
2977
+ const fullUrl = this.config.baseUrl + "/public/v1/submit/verify_otp";
3103
2978
  const body = JSON.stringify(input);
3104
2979
  const stamp = await this.stamper.stamp(body);
3105
2980
  return {