@turnkey/http 2.0.0 → 2.1.0

package/dist/__generated__/services/coordinator/public/v1/public_api.swagger.json

@@ -24,15 +24,15 @@
         },
         {
             "name": "Wallets",
-            "description": "Wallets contain collections of deterministically generated cryptographic public / private key pairs that share a common seed. Turnkey securely holds the common seed, but only you can access it. In most cases, Wallets should be preferred over Private Keys since they can be represented by a mnemonic phrase, used across a variety of cryptographic curves, and can derive many addresses."
+            "description": "Wallets contain collections of deterministically generated cryptographic public / private key pairs that share a common seed. Turnkey securely holds the common seed, but only you can access it. In most cases, Wallets should be preferred over Private Keys since they can be represented by a mnemonic phrase, used across a variety of cryptographic curves, and can derive many addresses.\n\nDerived addresses can be used to create digital signatures using the corresponding underlying private key. See [Signers](./api#tag/Signers) for more information"
         },
         {
-            "name": "Signatures",
-            "description": "Signatures are used to validate the authenticity and integrity of a digital message. Signatures are a fundamental building block in blockchains. Turnkey makes it easy to produce signatures by allowing you to sign with an address. If Turnkey doesn't yet support an address format you need, you can generate and sign with the public key instead by using the address format `ADDRESS_FORMAT_COMPRESSED`."
+            "name": "Signers",
+            "description": "Signers allow you to create digitial signatures. Signatures are used to validate the authenticity and integrity of a digital message. Turnkey makes it easy to produce signatures by allowing you to sign with an address. If Turnkey doesn't yet support an address format you need, you can generate and sign with the public key instead by using the address format `ADDRESS_FORMAT_COMPRESSED`."
         },
         {
             "name": "Private Keys",
-            "description": "Private Keys are cryptographic public / private key pairs that can be used for cryptocurrency needs or more generalized encryption. Turnkey securely holds all Private Key materials for you, but only you can access them."
+            "description": "Private Keys are cryptographic public / private key pairs that can be used for cryptocurrency needs or more generalized encryption. Turnkey securely holds all private key materials for you, but only you can access them.\n\nThe Private Key ID or any derived address can be used to create digital signatures. See [Signers](./api#tag/Signers) for more information"
         },
         {
             "name": "Private Key Tags",
@@ -292,6 +292,38 @@
                 "tags": ["Users"]
             }
         },
+        "/public/v1/query/get_wallet": {
+            "post": {
+                "summary": "Get Wallet",
+                "description": "Get details about a Wallet",
+                "operationId": "PublicApiService_GetWallet",
+                "responses": {
+                    "200": {
+                        "description": "A successful response.",
+                        "schema": {
+                            "$ref": "#/definitions/v1GetWalletResponse"
+                        }
+                    },
+                    "default": {
+                        "description": "An unexpected error response.",
+                        "schema": {
+                            "$ref": "#/definitions/rpcStatus"
+                        }
+                    }
+                },
+                "parameters": [
+                    {
+                        "name": "body",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/v1GetWalletRequest"
+                        }
+                    }
+                ],
+                "tags": ["Wallets"]
+            }
+        },
         "/public/v1/query/list_activities": {
             "post": {
                 "summary": "List Activities",
@@ -420,6 +452,70 @@
                 "tags": ["Users"]
             }
         },
+        "/public/v1/query/list_wallet_accounts": {
+            "post": {
+                "summary": "List Wallets Accounts",
+                "description": "List all Accounts wirhin a Wallet",
+                "operationId": "PublicApiService_GetWalletAccounts",
+                "responses": {
+                    "200": {
+                        "description": "A successful response.",
+                        "schema": {
+                            "$ref": "#/definitions/v1GetWalletAccountsResponse"
+                        }
+                    },
+                    "default": {
+                        "description": "An unexpected error response.",
+                        "schema": {
+                            "$ref": "#/definitions/rpcStatus"
+                        }
+                    }
+                },
+                "parameters": [
+                    {
+                        "name": "body",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/v1GetWalletAccountsRequest"
+                        }
+                    }
+                ],
+                "tags": ["Wallets"]
+            }
+        },
+        "/public/v1/query/list_wallets": {
+            "post": {
+                "summary": "List Wallets",
+                "description": "List all Wallets within an Organization",
+                "operationId": "PublicApiService_GetWallets",
+                "responses": {
+                    "200": {
+                        "description": "A successful response.",
+                        "schema": {
+                            "$ref": "#/definitions/v1GetWalletsResponse"
+                        }
+                    },
+                    "default": {
+                        "description": "An unexpected error response.",
+                        "schema": {
+                            "$ref": "#/definitions/rpcStatus"
+                        }
+                    }
+                },
+                "parameters": [
+                    {
+                        "name": "body",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/v1GetWalletsRequest"
+                        }
+                    }
+                ],
+                "tags": ["Wallets"]
+            }
+        },
         "/public/v1/query/whoami": {
             "post": {
                 "summary": "Who am I?",
@@ -449,7 +545,7 @@
                         }
                     }
                 ],
-                "tags": ["Who am I?"]
+                "tags": ["Sessions"]
             }
         },
         "/public/v1/submit/approve_activity": {
@@ -1249,7 +1345,7 @@
                         }
                     }
                 ],
-                "tags": ["Signatures"]
+                "tags": ["Signers"]
             }
         },
         "/public/v1/submit/sign_transaction": {
@@ -1281,13 +1377,13 @@
                         }
                     }
                 ],
-                "tags": ["Signatures"]
+                "tags": ["Signers"]
             }
         },
         "/public/v1/submit/update_allowed_origins": {
             "post": {
-                "summary": "Update Allowable Origins",
-                "description": "Update the allowable origins for credentials and requests",
+                "summary": "Update Allowed Origins",
+                "description": "Update the origins WebAuthN credentials are allowed to sign requests from. Setting this on a Parent-Organization applies to all Sub-Organizations.",
                 "operationId": "PublicApiService_UpdateAllowedOrigins",
                 "responses": {
                     "200": {
@@ -3866,6 +3962,82 @@
             },
             "required": ["users"]
         },
+        "v1GetWalletAccountsRequest": {
+            "type": "object",
+            "properties": {
+                "organizationId": {
+                    "type": "string",
+                    "description": "Unique identifier for a given Organization."
+                },
+                "walletId": {
+                    "type": "string",
+                    "description": "Unique identifier for a given Wallet."
+                }
+            },
+            "required": ["organizationId", "walletId"]
+        },
+        "v1GetWalletAccountsResponse": {
+            "type": "object",
+            "properties": {
+                "accounts": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "$ref": "#/definitions/v1WalletAccount"
+                    },
+                    "description": "A list of Accounts generated from a Wallet that share a common seed"
+                }
+            },
+            "required": ["accounts"]
+        },
+        "v1GetWalletRequest": {
+            "type": "object",
+            "properties": {
+                "organizationId": {
+                    "type": "string",
+                    "description": "Unique identifier for a given Organization."
+                },
+                "walletId": {
+                    "type": "string",
+                    "description": "Unique identifier for a given Wallet."
+                }
+            },
+            "required": ["organizationId", "walletId"]
+        },
+        "v1GetWalletResponse": {
+            "type": "object",
+            "properties": {
+                "wallet": {
+                    "$ref": "#/definitions/v1Wallet",
+                    "description": "A collection of deterministically generated cryptographic public / private key pairs that share a common seed"
+                }
+            },
+            "required": ["wallet"]
+        },
+        "v1GetWalletsRequest": {
+            "type": "object",
+            "properties": {
+                "organizationId": {
+                    "type": "string",
+                    "description": "Unique identifier for a given Organization."
+                }
+            },
+            "required": ["organizationId"]
+        },
+        "v1GetWalletsResponse": {
+            "type": "object",
+            "properties": {
+                "wallets": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "$ref": "#/definitions/v1Wallet"
+                    },
+                    "description": "A list of Wallets."
+                }
+            },
+            "required": ["wallets"]
+        },
         "v1GetWhoamiRequest": {
             "type": "object",
             "properties": {
@@ -5666,6 +5838,56 @@
                 "exported"
             ]
         },
+        "v1WalletAccount": {
+            "type": "object",
+            "properties": {
+                "organizationId": {
+                    "type": "string",
+                    "description": "The Organization the Account belongs to."
+                },
+                "walletId": {
+                    "type": "string",
+                    "description": "The Wallet the Account was derived from."
+                },
+                "curve": {
+                    "$ref": "#/definitions/immutablecommonv1Curve",
+                    "description": "Cryptographic curve used to generate the Account."
+                },
+                "pathFormat": {
+                    "$ref": "#/definitions/v1PathFormat",
+                    "description": "Path format used to generate the Account."
+                },
+                "path": {
+                    "type": "string",
+                    "description": "Path used to generate the Account."
+                },
+                "addressFormat": {
+                    "$ref": "#/definitions/immutablecommonv1AddressFormat",
+                    "description": "Address format used to generate the Acccount."
+                },
+                "address": {
+                    "type": "string",
+                    "description": "Address generated using the Wallet seed and Account parameters."
+                },
+                "createdAt": {
+                    "$ref": "#/definitions/externaldatav1Timestamp"
+                },
+                "updatedAt": {
+                    "$ref": "#/definitions/externaldatav1Timestamp"
+                }
+            },
+            "required": [
+                "organizationId",
+                "walletId",
+                "curve",
+                "pathFormat",
+                "path",
+                "addressFormat",
+                "address",
+                "createdAt",
+                "updatedAt"
+            ]
+        },
         "v1WalletAccountParams": {
             "type": "object",
             "properties": {
@@ -5777,7 +5999,7 @@
         },
         {
             "name": "PRIVATE KEYS",
-            "tags": ["Wallets", "Signatures", "Private Keys", "Private Key Tags"]
+            "tags": ["Wallets", "Signers", "Private Keys", "Private Key Tags"]
         },
         {
             "name": "USERS",
@@ -5785,7 +6007,7 @@
         },
         {
             "name": "CREDENTIALS",
-            "tags": ["Authenticators", "API Keys", "Who am I?"]
+            "tags": ["Authenticators", "API Keys", "Sessions"]
         },
         {
             "name": "ACTIVITIES",

package/dist/__generated__/services/coordinator/public/v1/public_api.types.d.ts

@@ -31,6 +31,10 @@ export type paths = {
         /** Get details about a User */
         post: operations["PublicApiService_GetUser"];
     };
+    "/public/v1/query/get_wallet": {
+        /** Get details about a Wallet */
+        post: operations["PublicApiService_GetWallet"];
+    };
     "/public/v1/query/list_activities": {
         /** List all Activities within an Organization */
         post: operations["PublicApiService_GetActivities"];
@@ -47,6 +51,14 @@ export type paths = {
         /** List all Users within an Organization */
         post: operations["PublicApiService_GetUsers"];
     };
+    "/public/v1/query/list_wallet_accounts": {
+        /** List all Accounts wirhin a Wallet */
+        post: operations["PublicApiService_GetWalletAccounts"];
+    };
+    "/public/v1/query/list_wallets": {
+        /** List all Wallets within an Organization */
+        post: operations["PublicApiService_GetWallets"];
+    };
     "/public/v1/query/whoami": {
         /** Get basic information about your current API or WebAuthN user and their organization. Affords Sub-Organization look ups via Parent Organization for WebAuthN users. */
         post: operations["PublicApiService_GetWhoami"];
@@ -156,7 +168,7 @@ export type paths = {
         post: operations["PublicApiService_SignTransaction"];
     };
     "/public/v1/submit/update_allowed_origins": {
-        /** Update the allowable origins for credentials and requests */
+        /** Update the origins WebAuthN credentials are allowed to sign requests from. Setting this on a Parent-Organization applies to all Sub-Organizations. */
         post: operations["PublicApiService_UpdateAllowedOrigins"];
     };
     "/public/v1/submit/update_policy": {
@@ -1042,6 +1054,34 @@ export type definitions = {
         /** @description A list of Users. */
         users: definitions["v1User"][];
     };
+    v1GetWalletAccountsRequest: {
+        /** @description Unique identifier for a given Organization. */
+        organizationId: string;
+        /** @description Unique identifier for a given Wallet. */
+        walletId: string;
+    };
+    v1GetWalletAccountsResponse: {
+        /** @description A list of Accounts generated from a Wallet that share a common seed */
+        accounts: definitions["v1WalletAccount"][];
+    };
+    v1GetWalletRequest: {
+        /** @description Unique identifier for a given Organization. */
+        organizationId: string;
+        /** @description Unique identifier for a given Wallet. */
+        walletId: string;
+    };
+    v1GetWalletResponse: {
+        /** @description A collection of deterministically generated cryptographic public / private key pairs that share a common seed */
+        wallet: definitions["v1Wallet"];
+    };
+    v1GetWalletsRequest: {
+        /** @description Unique identifier for a given Organization. */
+        organizationId: string;
+    };
+    v1GetWalletsResponse: {
+        /** @description A list of Wallets. */
+        wallets: definitions["v1Wallet"][];
+    };
     v1GetWhoamiRequest: {
         /** @description Unique identifier for a given Organization. If the request is being made by a WebAuthN user and their Sub-Organization ID is unknown, this can be the Parent Organization ID; using the Sub-Organization ID when possible is preferred due to performance reasons. */
         organizationId: string;
@@ -1693,6 +1733,24 @@ export type definitions = {
         /** @description True when a given Wallet is exported, false otherwise. */
         exported: boolean;
     };
+    v1WalletAccount: {
+        /** @description The Organization the Account belongs to. */
+        organizationId: string;
+        /** @description The Wallet the Account was derived from. */
+        walletId: string;
+        /** @description Cryptographic curve used to generate the Account. */
+        curve: definitions["immutablecommonv1Curve"];
+        /** @description Path format used to generate the Account. */
+        pathFormat: definitions["v1PathFormat"];
+        /** @description Path used to generate the Account. */
+        path: string;
+        /** @description Address format used to generate the Acccount. */
+        addressFormat: definitions["immutablecommonv1AddressFormat"];
+        /** @description Address generated using the Wallet seed and Account parameters. */
+        address: string;
+        createdAt: definitions["externaldatav1Timestamp"];
+        updatedAt: definitions["externaldatav1Timestamp"];
+    };
     v1WalletAccountParams: {
         /** @description Cryptographic curve used to generate a wallet Account. */
         curve: definitions["immutablecommonv1Curve"];
@@ -1852,6 +1910,24 @@ export type operations = {
             };
         };
     };
+    /** Get details about a Wallet */
+    PublicApiService_GetWallet: {
+        parameters: {
+            body: {
+                body: definitions["v1GetWalletRequest"];
+            };
+        };
+        responses: {
+            /** A successful response. */
+            200: {
+                schema: definitions["v1GetWalletResponse"];
+            };
+            /** An unexpected error response. */
+            default: {
+                schema: definitions["rpcStatus"];
+            };
+        };
+    };
     /** List all Activities within an Organization */
     PublicApiService_GetActivities: {
         parameters: {
@@ -1924,6 +2000,42 @@ export type operations = {
             };
         };
     };
+    /** List all Accounts wirhin a Wallet */
+    PublicApiService_GetWalletAccounts: {
+        parameters: {
+            body: {
+                body: definitions["v1GetWalletAccountsRequest"];
+            };
+        };
+        responses: {
+            /** A successful response. */
+            200: {
+                schema: definitions["v1GetWalletAccountsResponse"];
+            };
+            /** An unexpected error response. */
+            default: {
+                schema: definitions["rpcStatus"];
+            };
+        };
+    };
+    /** List all Wallets within an Organization */
+    PublicApiService_GetWallets: {
+        parameters: {
+            body: {
+                body: definitions["v1GetWalletsRequest"];
+            };
+        };
+        responses: {
+            /** A successful response. */
+            200: {
+                schema: definitions["v1GetWalletsResponse"];
+            };
+            /** An unexpected error response. */
+            default: {
+                schema: definitions["rpcStatus"];
+            };
+        };
+    };
     /** Get basic information about your current API or WebAuthN user and their organization. Affords Sub-Organization look ups via Parent Organization for WebAuthN users. */
     PublicApiService_GetWhoami: {
         parameters: {
@@ -2410,7 +2522,7 @@ export type operations = {
             };
         };
     };
-    /** Update the allowable origins for credentials and requests */
+    /** Update the origins WebAuthN credentials are allowed to sign requests from. Setting this on a Parent-Organization applies to all Sub-Organizations. */
     PublicApiService_UpdateAllowedOrigins: {
         parameters: {
             body: {