@turnkey/http - npm Package Compare versions

Comparing version 0.18.1 to 1.0.0

CHANGELOG.md

 # @turnkey/http
 
+## 1.0.0
+
+### Major Changes
+
+- 46473ec: This breaking change updates generated code to be shorter and more intuitive to read:
+
+  - generated fetchers do not include the HTTP method in their name. For example `useGetGetActivity` is now `useGetActivity`, and `usePostSignTransaction` is `useSignTransaction`.
+  - input types follow the same convention (no HTTP method in the name): `TPostCreatePrivateKeysInput` is now `TCreatePrivateKeysInput`.
+  - the "federated" request helpers introduced in `0.18.0` are now named "signed" requests to better reflect what they are. `FederatedRequest` is now `SignedRequest`, and generated types follow. For example: `federatedPostCreatePrivateKeys` is now `signCreatePrivateKeys`, `federatedGetGetActivity` is now `signGetActivity`, and so on.
+
+  The name updates should be automatically suggested if you use VSCode since the new names are simply shorter versions of the old one.
+
+### Patch Changes
+
+- 38b424f: Sync public api types
+
 ## 0.18.1
@@ -4,0 +20,0 @@

dist/__generated__/services/coordinator/public/v1/public_api.fetcher.js

 "use strict";
 /* @generated by `@turnkey/fetchers`. DO NOT EDIT BY HAND */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.federatedPostDeleteInvitation = exports.postDeleteInvitation = exports.federatedPostDeleteApiKeys = exports.postDeleteApiKeys = exports.federatedPostCreateUsers = exports.postCreateUsers = exports.federatedPostCreateUserTag = exports.postCreateUserTag = exports.federatedPostCreateSubOrganization = exports.postCreateSubOrganization = exports.federatedPostCreatePrivateKeys = exports.postCreatePrivateKeys = exports.federatedPostCreatePrivateKeyTag = exports.postCreatePrivateKeyTag = exports.federatedPostCreatePolicy = exports.postCreatePolicy = exports.federatedPostCreateInvitations = exports.postCreateInvitations = exports.federatedPostCreateAuthenticators = exports.postCreateAuthenticators = exports.federatedPostCreateApiOnlyUsers = exports.postCreateApiOnlyUsers = exports.federatedPostCreateApiKeys = exports.postCreateApiKeys = exports.federatedPostApproveActivity = exports.postApproveActivity = exports.federatedPostGetWhoami = exports.postGetWhoami = exports.federatedPostGetUsers = exports.postGetUsers = exports.federatedPostGetPrivateKeys = exports.postGetPrivateKeys = exports.federatedPostGetPolicies = exports.postGetPolicies = exports.federatedPostGetActivities = exports.postGetActivities = exports.federatedPostGetUser = exports.postGetUser = exports.federatedPostGetPrivateKey = exports.postGetPrivateKey = exports.federatedPostGetPolicy = exports.postGetPolicy = exports.federatedPostGetOrganization = exports.postGetOrganization = exports.federatedPostGetAuthenticators = exports.postGetAuthenticators = exports.federatedPostGetAuthenticator = exports.postGetAuthenticator = exports.federatedPostGetActivity = exports.postGetActivity = void 0;
-exports.federatedPostGetPrivateKeyBackwardsCompat = exports.postGetPrivateKeyBackwardsCompat = exports.federatedPostNOOPCodegenAnchor = exports.postNOOPCodegenAnchor = exports.federatedPostUpdateUserTag = exports.postUpdateUserTag = exports.federatedPostUpdateRootQuorum = exports.postUpdateRootQuorum = exports.federatedPostUpdatePrivateKeyTag = exports.postUpdatePrivateKeyTag = exports.federatedPostUpdateAllowedOrigins = exports.postUpdateAllowedOrigins = exports.federatedPostSignTransaction = exports.postSignTransaction = exports.federatedPostSignRawPayload = exports.postSignRawPayload = exports.federatedPostRejectActivity = exports.postRejectActivity = exports.federatedPostDeletePolicy = exports.postDeletePolicy = void 0;
+exports.signDeleteInvitation = exports.deleteInvitation = exports.signDeleteApiKeys = exports.deleteApiKeys = exports.signCreateUsers = exports.createUsers = exports.signCreateUserTag = exports.createUserTag = exports.signCreateSubOrganization = exports.createSubOrganization = exports.signCreatePrivateKeys = exports.createPrivateKeys = exports.signCreatePrivateKeyTag = exports.createPrivateKeyTag = exports.signCreatePolicy = exports.createPolicy = exports.signCreateInvitations = exports.createInvitations = exports.signCreateAuthenticators = exports.createAuthenticators = exports.signCreateApiOnlyUsers = exports.createApiOnlyUsers = exports.signCreateApiKeys = exports.createApiKeys = exports.signApproveActivity = exports.approveActivity = exports.signGetWhoami = exports.getWhoami = exports.signGetUsers = exports.getUsers = exports.signGetPrivateKeys = exports.getPrivateKeys = exports.signGetPolicies = exports.getPolicies = exports.signGetActivities = exports.getActivities = exports.signGetUser = exports.getUser = exports.signGetPrivateKey = exports.getPrivateKey = exports.signGetPolicy = exports.getPolicy = exports.signGetOrganization = exports.getOrganization = exports.signGetAuthenticators = exports.getAuthenticators = exports.signGetAuthenticator = exports.getAuthenticator = exports.signGetActivity = exports.getActivity = void 0;
+exports.signGetPrivateKeyBackwardsCompat = exports.getPrivateKeyBackwardsCompat = exports.signNOOPCodegenAnchor = exports.nOOPCodegenAnchor = exports.signUpdateUserTag = exports.updateUserTag = exports.signUpdateRootQuorum = exports.updateRootQuorum = exports.signUpdatePrivateKeyTag = exports.updatePrivateKeyTag = exports.signUpdateAllowedOrigins = exports.updateAllowedOrigins = exports.signSignTransaction = exports.signTransaction = exports.signSignRawPayload = exports.signRawPayload = exports.signRejectActivity = exports.rejectActivity = exports.signDeletePolicy = exports.deletePolicy = void 0;
 const base_1 = require("../../../../../base");
@@ -14,3 +14,3 @@ /**
  */
-const postGetActivity = (input) => (0, base_1.request)({
+const getActivity = (input) => (0, base_1.request)({
     uri: "/public/v1/query/get_activity",
@@ -20,9 +20,9 @@ method: "POST",
 });
-exports.postGetActivity = postGetActivity;
+exports.getActivity = getActivity;
 /**
- * Get Activity
+ * Request a WebAuthn assertion and return a signed `GetActivity` request, ready to be POSTed to Turnkey.
  *
- * Get details about an Activity
+ * See {@link GetActivity}
  */
-const federatedPostGetActivity = (input, options) => (0, base_1.federatedRequest)({
+const signGetActivity = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/get_activity",
@@ -32,3 +32,3 @@ body: input.body,
 });
-exports.federatedPostGetActivity = federatedPostGetActivity;
+exports.signGetActivity = signGetActivity;
 /**
@@ -41,3 +41,3 @@ * Get Authenticator
  */
-const postGetAuthenticator = (input) => (0, base_1.request)({
+const getAuthenticator = (input) => (0, base_1.request)({
     uri: "/public/v1/query/get_authenticator",
@@ -47,9 +47,9 @@ method: "POST",
 });
-exports.postGetAuthenticator = postGetAuthenticator;
+exports.getAuthenticator = getAuthenticator;
 /**
- * Get Authenticator
+ * Request a WebAuthn assertion and return a signed `GetAuthenticator` request, ready to be POSTed to Turnkey.
  *
- * Get details about an authenticator
+ * See {@link GetAuthenticator}
  */
-const federatedPostGetAuthenticator = (input, options) => (0, base_1.federatedRequest)({
+const signGetAuthenticator = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/get_authenticator",
@@ -59,3 +59,3 @@ body: input.body,
 });
-exports.federatedPostGetAuthenticator = federatedPostGetAuthenticator;
+exports.signGetAuthenticator = signGetAuthenticator;
 /**
@@ -68,3 +68,3 @@ * Get Authenticators
  */
-const postGetAuthenticators = (input) => (0, base_1.request)({
+const getAuthenticators = (input) => (0, base_1.request)({
     uri: "/public/v1/query/get_authenticators",
@@ -74,9 +74,9 @@ method: "POST",
 });
-exports.postGetAuthenticators = postGetAuthenticators;
+exports.getAuthenticators = getAuthenticators;
 /**
- * Get Authenticators
+ * Request a WebAuthn assertion and return a signed `GetAuthenticators` request, ready to be POSTed to Turnkey.
  *
- * Get details about authenticators for a user
+ * See {@link GetAuthenticators}
  */
-const federatedPostGetAuthenticators = (input, options) => (0, base_1.federatedRequest)({
+const signGetAuthenticators = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/get_authenticators",
@@ -86,3 +86,3 @@ body: input.body,
 });
-exports.federatedPostGetAuthenticators = federatedPostGetAuthenticators;
+exports.signGetAuthenticators = signGetAuthenticators;
 /**
@@ -95,3 +95,3 @@ * Get Organization
  */
-const postGetOrganization = (input) => (0, base_1.request)({
+const getOrganization = (input) => (0, base_1.request)({
     uri: "/public/v1/query/get_organization",
@@ -101,9 +101,9 @@ method: "POST",
 });
-exports.postGetOrganization = postGetOrganization;
+exports.getOrganization = getOrganization;
 /**
- * Get Organization
+ * Request a WebAuthn assertion and return a signed `GetOrganization` request, ready to be POSTed to Turnkey.
  *
- * Get details about an Organization
+ * See {@link GetOrganization}
  */
-const federatedPostGetOrganization = (input, options) => (0, base_1.federatedRequest)({
+const signGetOrganization = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/get_organization",
@@ -113,3 +113,3 @@ body: input.body,
 });
-exports.federatedPostGetOrganization = federatedPostGetOrganization;
+exports.signGetOrganization = signGetOrganization;
 /**
@@ -122,3 +122,3 @@ * Get Policy
  */
-const postGetPolicy = (input) => (0, base_1.request)({
+const getPolicy = (input) => (0, base_1.request)({
     uri: "/public/v1/query/get_policy",
@@ -128,9 +128,9 @@ method: "POST",
 });
-exports.postGetPolicy = postGetPolicy;
+exports.getPolicy = getPolicy;
 /**
- * Get Policy
+ * Request a WebAuthn assertion and return a signed `GetPolicy` request, ready to be POSTed to Turnkey.
  *
- * Get details about a Policy
+ * See {@link GetPolicy}
  */
-const federatedPostGetPolicy = (input, options) => (0, base_1.federatedRequest)({
+const signGetPolicy = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/get_policy",
@@ -140,3 +140,3 @@ body: input.body,
 });
-exports.federatedPostGetPolicy = federatedPostGetPolicy;
+exports.signGetPolicy = signGetPolicy;
 /**
@@ -149,3 +149,3 @@ * Get Private Key
  */
-const postGetPrivateKey = (input) => (0, base_1.request)({
+const getPrivateKey = (input) => (0, base_1.request)({
     uri: "/public/v1/query/get_private_key",
@@ -155,9 +155,9 @@ method: "POST",
 });
-exports.postGetPrivateKey = postGetPrivateKey;
+exports.getPrivateKey = getPrivateKey;
 /**
- * Get Private Key
+ * Request a WebAuthn assertion and return a signed `GetPrivateKey` request, ready to be POSTed to Turnkey.
  *
- * Get details about a Private Key
+ * See {@link GetPrivateKey}
  */
-const federatedPostGetPrivateKey = (input, options) => (0, base_1.federatedRequest)({
+const signGetPrivateKey = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/get_private_key",
@@ -167,3 +167,3 @@ body: input.body,
 });
-exports.federatedPostGetPrivateKey = federatedPostGetPrivateKey;
+exports.signGetPrivateKey = signGetPrivateKey;
 /**
@@ -176,3 +176,3 @@ * Get User
  */
-const postGetUser = (input) => (0, base_1.request)({
+const getUser = (input) => (0, base_1.request)({
     uri: "/public/v1/query/get_user",
@@ -182,9 +182,9 @@ method: "POST",
 });
-exports.postGetUser = postGetUser;
+exports.getUser = getUser;
 /**
- * Get User
+ * Request a WebAuthn assertion and return a signed `GetUser` request, ready to be POSTed to Turnkey.
  *
- * Get details about a User
+ * See {@link GetUser}
  */
-const federatedPostGetUser = (input, options) => (0, base_1.federatedRequest)({
+const signGetUser = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/get_user",
@@ -194,3 +194,3 @@ body: input.body,
 });
-exports.federatedPostGetUser = federatedPostGetUser;
+exports.signGetUser = signGetUser;
 /**
@@ -203,3 +203,3 @@ * List Activities
  */
-const postGetActivities = (input) => (0, base_1.request)({
+const getActivities = (input) => (0, base_1.request)({
     uri: "/public/v1/query/list_activities",
@@ -209,9 +209,9 @@ method: "POST",
 });
-exports.postGetActivities = postGetActivities;
+exports.getActivities = getActivities;
 /**
- * List Activities
+ * Request a WebAuthn assertion and return a signed `GetActivities` request, ready to be POSTed to Turnkey.
  *
- * List all Activities within an Organization
+ * See {@link GetActivities}
  */
-const federatedPostGetActivities = (input, options) => (0, base_1.federatedRequest)({
+const signGetActivities = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/list_activities",
@@ -221,3 +221,3 @@ body: input.body,
 });
-exports.federatedPostGetActivities = federatedPostGetActivities;
+exports.signGetActivities = signGetActivities;
 /**
@@ -230,3 +230,3 @@ * List Policies
  */
-const postGetPolicies = (input) => (0, base_1.request)({
+const getPolicies = (input) => (0, base_1.request)({
     uri: "/public/v1/query/list_policies",
@@ -236,9 +236,9 @@ method: "POST",
 });
-exports.postGetPolicies = postGetPolicies;
+exports.getPolicies = getPolicies;
 /**
- * List Policies
+ * Request a WebAuthn assertion and return a signed `GetPolicies` request, ready to be POSTed to Turnkey.
  *
- * List all Policies within an Organization
+ * See {@link GetPolicies}
  */
-const federatedPostGetPolicies = (input, options) => (0, base_1.federatedRequest)({
+const signGetPolicies = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/list_policies",
@@ -248,3 +248,3 @@ body: input.body,
 });
-exports.federatedPostGetPolicies = federatedPostGetPolicies;
+exports.signGetPolicies = signGetPolicies;
 /**
@@ -257,3 +257,3 @@ * List Private Keys
  */
-const postGetPrivateKeys = (input) => (0, base_1.request)({
+const getPrivateKeys = (input) => (0, base_1.request)({
     uri: "/public/v1/query/list_private_keys",
@@ -263,9 +263,9 @@ method: "POST",
 });
-exports.postGetPrivateKeys = postGetPrivateKeys;
+exports.getPrivateKeys = getPrivateKeys;
 /**
- * List Private Keys
+ * Request a WebAuthn assertion and return a signed `GetPrivateKeys` request, ready to be POSTed to Turnkey.
  *
- * List all Private Keys within an Organization
+ * See {@link GetPrivateKeys}
  */
-const federatedPostGetPrivateKeys = (input, options) => (0, base_1.federatedRequest)({
+const signGetPrivateKeys = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/list_private_keys",
@@ -275,3 +275,3 @@ body: input.body,
 });
-exports.federatedPostGetPrivateKeys = federatedPostGetPrivateKeys;
+exports.signGetPrivateKeys = signGetPrivateKeys;
 /**
@@ -284,3 +284,3 @@ * List Users
  */
-const postGetUsers = (input) => (0, base_1.request)({
+const getUsers = (input) => (0, base_1.request)({
     uri: "/public/v1/query/list_users",
@@ -290,9 +290,9 @@ method: "POST",
 });
-exports.postGetUsers = postGetUsers;
+exports.getUsers = getUsers;
 /**
- * List Users
+ * Request a WebAuthn assertion and return a signed `GetUsers` request, ready to be POSTed to Turnkey.
  *
- * List all Users within an Organization
+ * See {@link GetUsers}
  */
-const federatedPostGetUsers = (input, options) => (0, base_1.federatedRequest)({
+const signGetUsers = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/list_users",
@@ -302,3 +302,3 @@ body: input.body,
 });
-exports.federatedPostGetUsers = federatedPostGetUsers;
+exports.signGetUsers = signGetUsers;
 /**
@@ -311,3 +311,3 @@ * Who am I?
  */
-const postGetWhoami = (input) => (0, base_1.request)({
+const getWhoami = (input) => (0, base_1.request)({
     uri: "/public/v1/query/whoami",
@@ -317,9 +317,9 @@ method: "POST",
 });
-exports.postGetWhoami = postGetWhoami;
+exports.getWhoami = getWhoami;
 /**
- * Who am I?
+ * Request a WebAuthn assertion and return a signed `GetWhoami` request, ready to be POSTed to Turnkey.
  *
- * Get basic information about your current API user and your organization
+ * See {@link GetWhoami}
  */
-const federatedPostGetWhoami = (input, options) => (0, base_1.federatedRequest)({
+const signGetWhoami = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/query/whoami",
@@ -329,3 +329,3 @@ body: input.body,
 });
-exports.federatedPostGetWhoami = federatedPostGetWhoami;
+exports.signGetWhoami = signGetWhoami;
 /**
@@ -338,3 +338,3 @@ * Approve Activity
  */
-const postApproveActivity = (input) => (0, base_1.request)({
+const approveActivity = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/approve_activity",
@@ -344,9 +344,9 @@ method: "POST",
 });
-exports.postApproveActivity = postApproveActivity;
+exports.approveActivity = approveActivity;
 /**
- * Approve Activity
+ * Request a WebAuthn assertion and return a signed `ApproveActivity` request, ready to be POSTed to Turnkey.
  *
- * Approve an Activity
+ * See {@link ApproveActivity}
  */
-const federatedPostApproveActivity = (input, options) => (0, base_1.federatedRequest)({
+const signApproveActivity = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/approve_activity",
@@ -356,3 +356,3 @@ body: input.body,
 });
-exports.federatedPostApproveActivity = federatedPostApproveActivity;
+exports.signApproveActivity = signApproveActivity;
 /**
@@ -365,3 +365,3 @@ * Create API Keys
  */
-const postCreateApiKeys = (input) => (0, base_1.request)({
+const createApiKeys = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/create_api_keys",
@@ -371,9 +371,9 @@ method: "POST",
 });
-exports.postCreateApiKeys = postCreateApiKeys;
+exports.createApiKeys = createApiKeys;
 /**
- * Create API Keys
+ * Request a WebAuthn assertion and return a signed `CreateApiKeys` request, ready to be POSTed to Turnkey.
  *
- * Add api keys to an existing User
+ * See {@link CreateApiKeys}
  */
-const federatedPostCreateApiKeys = (input, options) => (0, base_1.federatedRequest)({
+const signCreateApiKeys = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/create_api_keys",
@@ -383,3 +383,3 @@ body: input.body,
 });
-exports.federatedPostCreateApiKeys = federatedPostCreateApiKeys;
+exports.signCreateApiKeys = signCreateApiKeys;
 /**
@@ -392,3 +392,3 @@ * Create API-only Users
  */
-const postCreateApiOnlyUsers = (input) => (0, base_1.request)({
+const createApiOnlyUsers = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/create_api_only_users",
@@ -398,9 +398,9 @@ method: "POST",
 });
-exports.postCreateApiOnlyUsers = postCreateApiOnlyUsers;
+exports.createApiOnlyUsers = createApiOnlyUsers;
 /**
- * Create API-only Users
+ * Request a WebAuthn assertion and return a signed `CreateApiOnlyUsers` request, ready to be POSTed to Turnkey.
  *
- * Create API-only Users in an existing Organization
+ * See {@link CreateApiOnlyUsers}
  */
-const federatedPostCreateApiOnlyUsers = (input, options) => (0, base_1.federatedRequest)({
+const signCreateApiOnlyUsers = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/create_api_only_users",
@@ -410,3 +410,3 @@ body: input.body,
 });
-exports.federatedPostCreateApiOnlyUsers = federatedPostCreateApiOnlyUsers;
+exports.signCreateApiOnlyUsers = signCreateApiOnlyUsers;
 /**
@@ -419,3 +419,3 @@ * Create Authenticators
  */
-const postCreateAuthenticators = (input) => (0, base_1.request)({
+const createAuthenticators = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/create_authenticators",
@@ -425,9 +425,9 @@ method: "POST",
 });
-exports.postCreateAuthenticators = postCreateAuthenticators;
+exports.createAuthenticators = createAuthenticators;
 /**
- * Create Authenticators
+ * Request a WebAuthn assertion and return a signed `CreateAuthenticators` request, ready to be POSTed to Turnkey.
  *
- * Create Authenticators to authenticate requests to Turnkey
+ * See {@link CreateAuthenticators}
  */
-const federatedPostCreateAuthenticators = (input, options) => (0, base_1.federatedRequest)({
+const signCreateAuthenticators = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/create_authenticators",
@@ -437,3 +437,3 @@ body: input.body,
 });
-exports.federatedPostCreateAuthenticators = federatedPostCreateAuthenticators;
+exports.signCreateAuthenticators = signCreateAuthenticators;
 /**
@@ -446,3 +446,3 @@ * Create Invitations
  */
-const postCreateInvitations = (input) => (0, base_1.request)({
+const createInvitations = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/create_invitations",
@@ -452,9 +452,9 @@ method: "POST",
 });
-exports.postCreateInvitations = postCreateInvitations;
+exports.createInvitations = createInvitations;
 /**
- * Create Invitations
+ * Request a WebAuthn assertion and return a signed `CreateInvitations` request, ready to be POSTed to Turnkey.
  *
- * Create Invitations to join an existing Organization
+ * See {@link CreateInvitations}
  */
-const federatedPostCreateInvitations = (input, options) => (0, base_1.federatedRequest)({
+const signCreateInvitations = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/create_invitations",
@@ -464,3 +464,3 @@ body: input.body,
 });
-exports.federatedPostCreateInvitations = federatedPostCreateInvitations;
+exports.signCreateInvitations = signCreateInvitations;
 /**
@@ -473,3 +473,3 @@ * Create Policy
  */
-const postCreatePolicy = (input) => (0, base_1.request)({
+const createPolicy = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/create_policy",
@@ -479,9 +479,9 @@ method: "POST",
 });
-exports.postCreatePolicy = postCreatePolicy;
+exports.createPolicy = createPolicy;
 /**
- * Create Policy
+ * Request a WebAuthn assertion and return a signed `CreatePolicy` request, ready to be POSTed to Turnkey.
  *
- * Create a new Policy
+ * See {@link CreatePolicy}
  */
-const federatedPostCreatePolicy = (input, options) => (0, base_1.federatedRequest)({
+const signCreatePolicy = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/create_policy",
@@ -491,5 +491,5 @@ body: input.body,
 });
-exports.federatedPostCreatePolicy = federatedPostCreatePolicy;
+exports.signCreatePolicy = signCreatePolicy;
 /**
- * Create User Tag
+ * Create Private Key Tag
  *
@@ -500,3 +500,3 @@ * Create a private key tag and add it to private keys.
  */
-const postCreatePrivateKeyTag = (input) => (0, base_1.request)({
+const createPrivateKeyTag = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/create_private_key_tag",
@@ -506,9 +506,9 @@ method: "POST",
 });
-exports.postCreatePrivateKeyTag = postCreatePrivateKeyTag;
+exports.createPrivateKeyTag = createPrivateKeyTag;
 /**
- * Create User Tag
+ * Request a WebAuthn assertion and return a signed `CreatePrivateKeyTag` request, ready to be POSTed to Turnkey.
  *
- * Create a private key tag and add it to private keys.
+ * See {@link CreatePrivateKeyTag}
  */
-const federatedPostCreatePrivateKeyTag = (input, options) => (0, base_1.federatedRequest)({
+const signCreatePrivateKeyTag = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/create_private_key_tag",
@@ -518,3 +518,3 @@ body: input.body,
 });
-exports.federatedPostCreatePrivateKeyTag = federatedPostCreatePrivateKeyTag;
+exports.signCreatePrivateKeyTag = signCreatePrivateKeyTag;
 /**
@@ -527,3 +527,3 @@ * Create Private Keys
  */
-const postCreatePrivateKeys = (input) => (0, base_1.request)({
+const createPrivateKeys = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/create_private_keys",
@@ -533,9 +533,9 @@ method: "POST",
 });
-exports.postCreatePrivateKeys = postCreatePrivateKeys;
+exports.createPrivateKeys = createPrivateKeys;
 /**
- * Create Private Keys
+ * Request a WebAuthn assertion and return a signed `CreatePrivateKeys` request, ready to be POSTed to Turnkey.
  *
- * Create new Private Keys
+ * See {@link CreatePrivateKeys}
  */
-const federatedPostCreatePrivateKeys = (input, options) => (0, base_1.federatedRequest)({
+const signCreatePrivateKeys = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/create_private_keys",
@@ -545,3 +545,3 @@ body: input.body,
 });
-exports.federatedPostCreatePrivateKeys = federatedPostCreatePrivateKeys;
+exports.signCreatePrivateKeys = signCreatePrivateKeys;
 /**
@@ -554,3 +554,3 @@ * Create Sub-Organization
  */
-const postCreateSubOrganization = (input) => (0, base_1.request)({
+const createSubOrganization = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/create_sub_organization",
@@ -560,9 +560,9 @@ method: "POST",
 });
-exports.postCreateSubOrganization = postCreateSubOrganization;
+exports.createSubOrganization = createSubOrganization;
 /**
- * Create Sub-Organization
+ * Request a WebAuthn assertion and return a signed `CreateSubOrganization` request, ready to be POSTed to Turnkey.
  *
- * Create a new Sub-Organization
+ * See {@link CreateSubOrganization}
  */
-const federatedPostCreateSubOrganization = (input, options) => (0, base_1.federatedRequest)({
+const signCreateSubOrganization = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/create_sub_organization",
@@ -572,3 +572,3 @@ body: input.body,
 });
-exports.federatedPostCreateSubOrganization = federatedPostCreateSubOrganization;
+exports.signCreateSubOrganization = signCreateSubOrganization;
 /**
@@ -581,3 +581,3 @@ * Create User Tag
  */
-const postCreateUserTag = (input) => (0, base_1.request)({
+const createUserTag = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/create_user_tag",
@@ -587,9 +587,9 @@ method: "POST",
 });
-exports.postCreateUserTag = postCreateUserTag;
+exports.createUserTag = createUserTag;
 /**
- * Create User Tag
+ * Request a WebAuthn assertion and return a signed `CreateUserTag` request, ready to be POSTed to Turnkey.
  *
- * Create a user tag and add it to users.
+ * See {@link CreateUserTag}
  */
-const federatedPostCreateUserTag = (input, options) => (0, base_1.federatedRequest)({
+const signCreateUserTag = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/create_user_tag",
@@ -599,3 +599,3 @@ body: input.body,
 });
-exports.federatedPostCreateUserTag = federatedPostCreateUserTag;
+exports.signCreateUserTag = signCreateUserTag;
 /**
@@ -610,3 +610,3 @@ * Create Users
  */
-const postCreateUsers = (input) => (0, base_1.request)({
+const createUsers = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/create_users",
@@ -616,11 +616,11 @@ method: "POST",
 });
-exports.postCreateUsers = postCreateUsers;
+exports.createUsers = createUsers;
 /**
- * Create Users
+ * Request a WebAuthn assertion and return a signed `CreateUsers` request, ready to be POSTed to Turnkey.
  *
- * Create Users in an existing Organization
+ * See {@link CreateUsers}
  *
  * @deprecated
  */
-const federatedPostCreateUsers = (input, options) => (0, base_1.federatedRequest)({
+const signCreateUsers = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/create_users",
@@ -630,3 +630,3 @@ body: input.body,
 });
-exports.federatedPostCreateUsers = federatedPostCreateUsers;
+exports.signCreateUsers = signCreateUsers;
 /**
@@ -639,3 +639,3 @@ * Delete API Keys
  */
-const postDeleteApiKeys = (input) => (0, base_1.request)({
+const deleteApiKeys = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/delete_api_keys",
@@ -645,9 +645,9 @@ method: "POST",
 });
-exports.postDeleteApiKeys = postDeleteApiKeys;
+exports.deleteApiKeys = deleteApiKeys;
 /**
- * Delete API Keys
+ * Request a WebAuthn assertion and return a signed `DeleteApiKeys` request, ready to be POSTed to Turnkey.
  *
- * Remove api keys from a User
+ * See {@link DeleteApiKeys}
  */
-const federatedPostDeleteApiKeys = (input, options) => (0, base_1.federatedRequest)({
+const signDeleteApiKeys = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/delete_api_keys",
@@ -657,3 +657,3 @@ body: input.body,
 });
-exports.federatedPostDeleteApiKeys = federatedPostDeleteApiKeys;
+exports.signDeleteApiKeys = signDeleteApiKeys;
 /**
@@ -666,3 +666,3 @@ * Delete Invitation
  */
-const postDeleteInvitation = (input) => (0, base_1.request)({
+const deleteInvitation = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/delete_invitations",
@@ -672,9 +672,9 @@ method: "POST",
 });
-exports.postDeleteInvitation = postDeleteInvitation;
+exports.deleteInvitation = deleteInvitation;
 /**
- * Delete Invitation
+ * Request a WebAuthn assertion and return a signed `DeleteInvitation` request, ready to be POSTed to Turnkey.
  *
- * Delete an existing Invitation
+ * See {@link DeleteInvitation}
  */
-const federatedPostDeleteInvitation = (input, options) => (0, base_1.federatedRequest)({
+const signDeleteInvitation = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/delete_invitations",
@@ -684,3 +684,3 @@ body: input.body,
 });
-exports.federatedPostDeleteInvitation = federatedPostDeleteInvitation;
+exports.signDeleteInvitation = signDeleteInvitation;
 /**
@@ -693,3 +693,3 @@ * Delete Policy
  */
-const postDeletePolicy = (input) => (0, base_1.request)({
+const deletePolicy = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/delete_policy",
@@ -699,9 +699,9 @@ method: "POST",
 });
-exports.postDeletePolicy = postDeletePolicy;
+exports.deletePolicy = deletePolicy;
 /**
- * Delete Policy
+ * Request a WebAuthn assertion and return a signed `DeletePolicy` request, ready to be POSTed to Turnkey.
  *
- * Delete an existing Policy
+ * See {@link DeletePolicy}
  */
-const federatedPostDeletePolicy = (input, options) => (0, base_1.federatedRequest)({
+const signDeletePolicy = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/delete_policy",
@@ -711,3 +711,3 @@ body: input.body,
 });
-exports.federatedPostDeletePolicy = federatedPostDeletePolicy;
+exports.signDeletePolicy = signDeletePolicy;
 /**
@@ -720,3 +720,3 @@ * Reject Activity
  */
-const postRejectActivity = (input) => (0, base_1.request)({
+const rejectActivity = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/reject_activity",
@@ -726,9 +726,9 @@ method: "POST",
 });
-exports.postRejectActivity = postRejectActivity;
+exports.rejectActivity = rejectActivity;
 /**
- * Reject Activity
+ * Request a WebAuthn assertion and return a signed `RejectActivity` request, ready to be POSTed to Turnkey.
  *
- * Reject an Activity
+ * See {@link RejectActivity}
  */
-const federatedPostRejectActivity = (input, options) => (0, base_1.federatedRequest)({
+const signRejectActivity = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/reject_activity",
@@ -738,3 +738,3 @@ body: input.body,
 });
-exports.federatedPostRejectActivity = federatedPostRejectActivity;
+exports.signRejectActivity = signRejectActivity;
 /**
@@ -747,3 +747,3 @@ * Sign Raw Payload
  */
-const postSignRawPayload = (input) => (0, base_1.request)({
+const signRawPayload = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/sign_raw_payload",
@@ -753,9 +753,9 @@ method: "POST",
 });
-exports.postSignRawPayload = postSignRawPayload;
+exports.signRawPayload = signRawPayload;
 /**
- * Sign Raw Payload
+ * Request a WebAuthn assertion and return a signed `SignRawPayload` request, ready to be POSTed to Turnkey.
  *
- * Sign a raw payload with a Private Key
+ * See {@link SignRawPayload}
  */
-const federatedPostSignRawPayload = (input, options) => (0, base_1.federatedRequest)({
+const signSignRawPayload = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/sign_raw_payload",
@@ -765,3 +765,3 @@ body: input.body,
 });
-exports.federatedPostSignRawPayload = federatedPostSignRawPayload;
+exports.signSignRawPayload = signSignRawPayload;
 /**
@@ -774,3 +774,3 @@ * Sign Transaction
  */
-const postSignTransaction = (input) => (0, base_1.request)({
+const signTransaction = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/sign_transaction",
@@ -780,9 +780,9 @@ method: "POST",
 });
-exports.postSignTransaction = postSignTransaction;
+exports.signTransaction = signTransaction;
 /**
- * Sign Transaction
+ * Request a WebAuthn assertion and return a signed `SignTransaction` request, ready to be POSTed to Turnkey.
  *
- * Sign a transaction with a Private Key
+ * See {@link SignTransaction}
  */
-const federatedPostSignTransaction = (input, options) => (0, base_1.federatedRequest)({
+const signSignTransaction = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/sign_transaction",
@@ -792,11 +792,11 @@ body: input.body,
 });
-exports.federatedPostSignTransaction = federatedPostSignTransaction;
+exports.signSignTransaction = signSignTransaction;
 /**
- * Update the allowable origins
+ * Update Allowable Origins
  *
- * Update the additional allowable origins for requests besides Turnkey origins
+ * Update the allowable origins for credentials and requests
  *
  * `POST /public/v1/submit/update_allowed_origins`
  */
-const postUpdateAllowedOrigins = (input) => (0, base_1.request)({
+const updateAllowedOrigins = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/update_allowed_origins",
@@ -806,9 +806,9 @@ method: "POST",
 });
-exports.postUpdateAllowedOrigins = postUpdateAllowedOrigins;
+exports.updateAllowedOrigins = updateAllowedOrigins;
 /**
- * Update the allowable origins
+ * Request a WebAuthn assertion and return a signed `UpdateAllowedOrigins` request, ready to be POSTed to Turnkey.
  *
- * Update the additional allowable origins for requests besides Turnkey origins
+ * See {@link UpdateAllowedOrigins}
  */
-const federatedPostUpdateAllowedOrigins = (input, options) => (0, base_1.federatedRequest)({
+const signUpdateAllowedOrigins = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/update_allowed_origins",
@@ -818,3 +818,3 @@ body: input.body,
 });
-exports.federatedPostUpdateAllowedOrigins = federatedPostUpdateAllowedOrigins;
+exports.signUpdateAllowedOrigins = signUpdateAllowedOrigins;
 /**
@@ -827,3 +827,3 @@ * Update Private Key Tag
  */
-const postUpdatePrivateKeyTag = (input) => (0, base_1.request)({
+const updatePrivateKeyTag = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/update_private_key_tag",
@@ -833,9 +833,9 @@ method: "POST",
 });
-exports.postUpdatePrivateKeyTag = postUpdatePrivateKeyTag;
+exports.updatePrivateKeyTag = updatePrivateKeyTag;
 /**
- * Update Private Key Tag
+ * Request a WebAuthn assertion and return a signed `UpdatePrivateKeyTag` request, ready to be POSTed to Turnkey.
  *
- * Update human-readable name or associated private keys. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.
+ * See {@link UpdatePrivateKeyTag}
  */
-const federatedPostUpdatePrivateKeyTag = (input, options) => (0, base_1.federatedRequest)({
+const signUpdatePrivateKeyTag = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/update_private_key_tag",
@@ -845,5 +845,5 @@ body: input.body,
 });
-exports.federatedPostUpdatePrivateKeyTag = federatedPostUpdatePrivateKeyTag;
+exports.signUpdatePrivateKeyTag = signUpdatePrivateKeyTag;
 /**
- * Set the root quorum
+ * Update Root Quorum
  *
@@ -854,3 +854,3 @@ * Set the threshold and members of the root quorum. This must be approved by the current root quorum.
  */
-const postUpdateRootQuorum = (input) => (0, base_1.request)({
+const updateRootQuorum = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/update_root_quorum",
@@ -860,9 +860,9 @@ method: "POST",
 });
-exports.postUpdateRootQuorum = postUpdateRootQuorum;
+exports.updateRootQuorum = updateRootQuorum;
 /**
- * Set the root quorum
+ * Request a WebAuthn assertion and return a signed `UpdateRootQuorum` request, ready to be POSTed to Turnkey.
  *
- * Set the threshold and members of the root quorum. This must be approved by the current root quorum.
+ * See {@link UpdateRootQuorum}
  */
-const federatedPostUpdateRootQuorum = (input, options) => (0, base_1.federatedRequest)({
+const signUpdateRootQuorum = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/update_root_quorum",
@@ -872,3 +872,3 @@ body: input.body,
 });
-exports.federatedPostUpdateRootQuorum = federatedPostUpdateRootQuorum;
+exports.signUpdateRootQuorum = signUpdateRootQuorum;
 /**
@@ -881,3 +881,3 @@ * Update User Tag
  */
-const postUpdateUserTag = (input) => (0, base_1.request)({
+const updateUserTag = (input) => (0, base_1.request)({
     uri: "/public/v1/submit/update_user_tag",
@@ -887,9 +887,9 @@ method: "POST",
 });
-exports.postUpdateUserTag = postUpdateUserTag;
+exports.updateUserTag = updateUserTag;
 /**
- * Update User Tag
+ * Request a WebAuthn assertion and return a signed `UpdateUserTag` request, ready to be POSTed to Turnkey.
  *
- * Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.
+ * See {@link UpdateUserTag}
  */
-const federatedPostUpdateUserTag = (input, options) => (0, base_1.federatedRequest)({
+const signUpdateUserTag = (input, options) => (0, base_1.signedRequest)({
     uri: "/public/v1/submit/update_user_tag",
@@ -899,3 +899,3 @@ body: input.body,
 });
-exports.federatedPostUpdateUserTag = federatedPostUpdateUserTag;
+exports.signUpdateUserTag = signUpdateUserTag;
 /**
@@ -908,16 +908,16 @@ * This route does nothing and does not need an implementation, but please don't remove it.
  */
-const postNOOPCodegenAnchor = () => (0, base_1.request)({
+const nOOPCodegenAnchor = () => (0, base_1.request)({
     uri: "/tkhq/api/v1/noop-codegen-anchor",
     method: "POST",
 });
-exports.postNOOPCodegenAnchor = postNOOPCodegenAnchor;
+exports.nOOPCodegenAnchor = nOOPCodegenAnchor;
 /**
- * This route does nothing and does not need an implementation, but please don't remove it.
-It's used at compile time for generating extra OpenAPI/TypeScript types
-that are not directly referenced in requests.
+ * Request a WebAuthn assertion and return a signed `NOOPCodegenAnchor` request, ready to be POSTed to Turnkey.
+ *
+ * See {@link NOOPCodegenAnchor}
  */
-const federatedPostNOOPCodegenAnchor = () => (0, base_1.federatedRequest)({
+const signNOOPCodegenAnchor = () => (0, base_1.signedRequest)({
     uri: "/tkhq/api/v1/noop-codegen-anchor",
 });
-exports.federatedPostNOOPCodegenAnchor = federatedPostNOOPCodegenAnchor;
+exports.signNOOPCodegenAnchor = signNOOPCodegenAnchor;
 /**
@@ -932,3 +932,3 @@ * Get Private Key
  */
-const postGetPrivateKeyBackwardsCompat = (input) => (0, base_1.request)({
+const getPrivateKeyBackwardsCompat = (input) => (0, base_1.request)({
     uri: "/tkhq/public/v1/query/get_private_key",
@@ -938,11 +938,11 @@ method: "POST",
 });
-exports.postGetPrivateKeyBackwardsCompat = postGetPrivateKeyBackwardsCompat;
+exports.getPrivateKeyBackwardsCompat = getPrivateKeyBackwardsCompat;
 /**
- * Get Private Key
+ * Request a WebAuthn assertion and return a signed `GetPrivateKeyBackwardsCompat` request, ready to be POSTed to Turnkey.
  *
- * Get details about a Private Key
+ * See {@link GetPrivateKeyBackwardsCompat}
  *
  * @deprecated
  */
-const federatedPostGetPrivateKeyBackwardsCompat = (input, options) => (0, base_1.federatedRequest)({
+const signGetPrivateKeyBackwardsCompat = (input, options) => (0, base_1.signedRequest)({
     uri: "/tkhq/public/v1/query/get_private_key",
@@ -952,3 +952,3 @@ body: input.body,
 });
-exports.federatedPostGetPrivateKeyBackwardsCompat = federatedPostGetPrivateKeyBackwardsCompat;
+exports.signGetPrivateKeyBackwardsCompat = signGetPrivateKeyBackwardsCompat;
 //# sourceMappingURL=public_api.fetcher.js.map

dist/async.js

@@ -66,3 +66,3 @@ "use strict";
             await sleep(refreshIntervalMs);
-            const pollingResponse = await barrel_1.PublicApiService.postGetActivity({
+            const pollingResponse = await barrel_1.PublicApiService.getActivity({
                 body: {
@@ -69,0 +69,0 @@ activityId: activity.id,

dist/base.d.ts

@@ -1,2 +0,2 @@
-import { FederatedRequest } from "./shared";
+import { SignedRequest } from "./shared";
 import { TurnkeyCredentialRequestOptions } from "./webauthn";
@@ -9,3 +9,3 @@ export type { TurnkeyCredentialRequestOptions };
 type TSubstitutionShape = Record<string, any>;
-export declare function federatedRequest<B extends TBodyShape = never, Q extends TQueryShape = never, S extends TSubstitutionShape = never>(input: {
+export declare function signedRequest<B extends TBodyShape = never, Q extends TQueryShape = never, S extends TSubstitutionShape = never>(input: {
     uri: string;
@@ -16,3 +16,3 @@ query?: Q;
     options?: TurnkeyCredentialRequestOptions | undefined;
-}): Promise<FederatedRequest>;
+}): Promise<SignedRequest>;
 export declare function request<ResponseData = never, B extends TBodyShape = never, Q extends TQueryShape = never, S extends TSubstitutionShape = never, H extends THeadersShape = never>(input: {
@@ -19,0 +19,0 @@ uri: string;

dist/base.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sealAndStampRequestBody = exports.request = exports.federatedRequest = void 0;
+exports.sealAndStampRequestBody = exports.request = exports.signedRequest = void 0;
 const universal_1 = require("./universal");
@@ -13,3 +13,3 @@ const config_1 = require("./config");
 };
-async function federatedRequest(input) {
+async function signedRequest(input) {
     const { uri: inputUri, query: inputQuery = {}, substitution: inputSubstitution = {}, body: inputBody = {}, } = input;
@@ -29,3 +29,3 @@ const url = constructUrl({
 }
-exports.federatedRequest = federatedRequest;
+exports.signedRequest = signedRequest;
 async function request(input) {
@@ -32,0 +32,0 @@ const { uri: inputUri, method, headers: inputHeaders = {}, query: inputQuery = {}, substitution: inputSubstitution = {}, body: inputBody = {}, } = input;

dist/index.d.ts

@@ -5,3 +5,3 @@ import { PublicApiService as TurnkeyApi } from "./__generated__/barrel";
 export { TurnkeyActivityError, TurnkeyRequestError } from "./shared";
-export type { FederatedRequest } from "./shared";
+export type { SignedRequest } from "./shared";
 export { getWebAuthnAttestation } from "./webauthn";
@@ -8,0 +8,0 @@ export { withAsyncPolling } from "./async";

dist/shared.d.ts

@@ -39,3 +39,6 @@ import type { definitions } from "./__generated__/services/coordinator/public/v1/public_api.types";
 }
-export type FederatedRequest = {
+/**
+ * Represents a signed request ready to be POSTed to Turnkey
+ */
+export type SignedRequest = {
     body: string;
@@ -42,0 +45,0 @@ stamp: string;

package.json

 {
   "name": "@turnkey/http",
-  "version": "0.18.1",
+  "version": "1.0.0",
   "main": "./dist/index.js",
@@ -5,0 +5,0 @@ "types": "./dist/index.d.ts",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

1159585

decreased by-1.24%

Lines of code

24861

decreased by-0.81%

No dependency changes