@bandada/api-sdk - npm Package Compare versions

Comparing version 0.14.0 to 1.0.0-alpha

dist/index.node.js

 /**
  * @module @bandada/api-sdk
- * @version 0.14.0
+ * @version 1.0.0-alpha
  * @file A Typescript SDK for the Bandada API.
@@ -5,0 +5,0 @@ * @copyright Ethereum Foundation 2023

package.json

 {
   "name": "@bandada/api-sdk",
-  "version": "0.14.0",
+  "version": "1.0.0-alpha",
   "description": "A Typescript SDK for the Bandada API.",
@@ -32,3 +32,3 @@ "license": "MIT",
   "dependencies": {
-    "@bandada/utils": "0.14.0"
+    "@bandada/utils": "1.0.0-alpha"
   },
@@ -35,0 +35,0 @@ "devDependencies": {

README.md

@@ -70,2 +70,30 @@ <p align="center">
 
+\# **new ApiSdk**(url: SupportedUrl | string, config?: object): _ApiSdk_
+
+Creates a new instance of ApiSdk using the API URL and the [config](https://axios-http.com/docs/req_config).
+
+-   Creates a new instance using the Bandada API URL and the default config.
+
+```ts
+const apiSdk = new ApiSdk()
+```
+
+-   Creates a new instance using a custom API URL.
+
+```ts
+const apiSdk = new ApiSdk("https://example.com/api")
+```
+
+-   Creates a new instance using a custom API URL and config.
+
+```ts
+const url = "https://example.com/api"
+const config = {
+    headers: {
+        "Content-Type": "text/html"
+    }
+}
+const apiSdk = new ApiSdk(url, config)
+```
+
 \# **getGroups**(): _Promise\<GroupResponse[]>_
@@ -76,3 +104,3 @@
 ```ts
-const groups = await getGroups()
+const groups = await apiSdk.getGroups()
 ```
@@ -87,3 +115,3 @@
 
-const group = await getGroup(groupId)
+const group = await apiSdk.getGroup(groupId)
 ```
@@ -99,3 +127,3 @@
 
-const isMember = await isGroupMember(groupId, memberId)
+const isMember = await apiSdk.isGroupMember(groupId, memberId)
 ```
@@ -111,3 +139,3 @@
 
-const proof = await generateMerkleProof(groupId, memberId)
+const proof = await apiSdk.generateMerkleProof(groupId, memberId)
 ```
@@ -124,3 +152,3 @@
 
-await addMemberByApiKey(groupId, memberId, apiKey)
+await apiSdk.addMemberByApiKey(groupId, memberId, apiKey)
 ```
@@ -137,3 +165,3 @@
 
-await addMemberByInviteCode(groupId, memberId, inviteCode)
+await apiSdk.addMemberByInviteCode(groupId, memberId, inviteCode)
 ```
@@ -150,3 +178,3 @@
 
-await removeMemberByApiKey(groupId, memberId, apiKey)
+await apiSdk.removeMemberByApiKey(groupId, memberId, apiKey)
 ```

No alert changes

Improved metrics

Total package byte prevSize

67515

increased by1.07%

Number of lines in readme file

173

increased by19.31%

Dependency changes

• + Added@bandada/utils@1.0.0-alpha(transitive)

• - Removed@bandada/utils@0.14.0(transitive)

• Updated@bandada/utils@1.0.0-alpha