build: generate client with openapi-typescript (#274)

* build: generate client with openapi-typescript * fix: bump breaking version
hirosystems · Oct 14, 2024 · b7e838d · b7e838d
1 parent 1aab466
commit b7e838d
Show file tree

Hide file tree

Showing 23 changed files with 7,953 additions and 12,864 deletions.
diff --git a/client/typescript/.gitignore → client/.gitignore b/client/typescript/.gitignore → client/.gitignore
@@ -2,3 +2,4 @@ wwwroot/*.js
 node_modules
 typings
 dist
+lib
diff --git a/client/README.md b/client/README.md
@@ -0,0 +1,24 @@
+## @hirosystems/token-metadata-api-client
+
+This is a client library for the [Token Metadata API](https://github.com/hirosystems/token-metadata-api).
+
+### Installation
+
+```
+npm install @hirosystems/token-metadata-api-client
+```
+
+### Example
+
+```typescript
+import { createClient } from '@hirosystems/token-metadata-api-client';
+
+const client = createClient({ baseUrl: 'https://api.mainnet.hiro.so' });
+const metadata = await client.GET('/metadata/v1/ft/{principal}', {
+  params: {
+    path: {
+      principal: 'SM26AQGZBMDPN2NTH0DJWFESFV0NJC744F1GQVZ6Y.token-btc',
+    },
+  },
+});
+```
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,3 +2,4 @@ wwwroot/*.js @@
     node_modules
     typings
     dist
+    lib