@settlemint/sdk-js 2.1.3 → 2.1.4

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.
Files changed (2) hide show
  1. package/README.md +18 -18
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -61,7 +61,7 @@ The SettleMint JavaScript SDK provides a type-safe wrapper around the SettleMint
61
61
 
62
62
  > **createSettleMintClient**(`options`): [`SettlemintClient`](#settlemintclient)
63
63
 
64
- Defined in: [settlemint.ts:223](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/settlemint.ts#L223)
64
+ Defined in: [settlemint.ts:223](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L223)
65
65
 
66
66
  Creates a SettleMint client with the provided options. The client provides methods to interact with
67
67
  various SettleMint resources like workspaces, applications, blockchain networks, blockchain nodes, middleware,
@@ -108,7 +108,7 @@ const workspace = await client.workspace.read('workspace-unique-name');
108
108
 
109
109
  #### SettlemintClient
110
110
 
111
- Defined in: [settlemint.ts:117](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/settlemint.ts#L117)
111
+ Defined in: [settlemint.ts:117](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L117)
112
112
 
113
113
  Client interface for interacting with the SettleMint platform.
114
114
 
@@ -116,7 +116,7 @@ Client interface for interacting with the SettleMint platform.
116
116
 
117
117
  #### SettlemintClientOptions
118
118
 
119
- Defined in: [settlemint.ts:109](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/settlemint.ts#L109)
119
+ Defined in: [settlemint.ts:109](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L109)
120
120
 
121
121
  Options for the Settlemint client.
122
122
 
@@ -128,9 +128,9 @@ Options for the Settlemint client.
128
128
 
129
129
  | Property | Type | Default value | Description | Inherited from | Defined in |
130
130
  | ------ | ------ | ------ | ------ | ------ | ------ |
131
- | <a id="accesstoken"></a> `accessToken` | `string` | `AccessTokenSchema` | The access token used to authenticate with the SettleMint platform | `ClientOptions.accessToken` | [helpers/client-options.schema.ts:9](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/helpers/client-options.schema.ts#L9) |
132
- | <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:111](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/settlemint.ts#L111) |
133
- | <a id="instance"></a> `instance` | `string` | `UrlSchema` | The URL of the SettleMint instance to connect to | `ClientOptions.instance` | [helpers/client-options.schema.ts:11](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/helpers/client-options.schema.ts#L11) |
131
+ | <a id="accesstoken"></a> `accessToken` | `string` | `AccessTokenSchema` | The access token used to authenticate with the SettleMint platform | `ClientOptions.accessToken` | [helpers/client-options.schema.ts:9](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/helpers/client-options.schema.ts#L9) |
132
+ | <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:111](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L111) |
133
+ | <a id="instance"></a> `instance` | `string` | `UrlSchema` | The URL of the SettleMint instance to connect to | `ClientOptions.instance` | [helpers/client-options.schema.ts:11](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/helpers/client-options.schema.ts#L11) |
134
134
 
135
135
  ### Type Aliases
136
136
 
@@ -138,7 +138,7 @@ Options for the Settlemint client.
138
138
 
139
139
  > **Application** = `ResultOf`\<*typeof* `ApplicationFragment`\>
140
140
 
141
- Defined in: [graphql/application.ts:24](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/application.ts#L24)
141
+ Defined in: [graphql/application.ts:24](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/application.ts#L24)
142
142
 
143
143
  Type representing an application entity.
144
144
 
@@ -148,7 +148,7 @@ Type representing an application entity.
148
148
 
149
149
  > **BlockchainNetwork** = `ResultOf`\<*typeof* `BlockchainNetworkFragment`\>
150
150
 
151
- Defined in: [graphql/blockchain-network.ts:32](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/blockchain-network.ts#L32)
151
+ Defined in: [graphql/blockchain-network.ts:32](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/blockchain-network.ts#L32)
152
152
 
153
153
  Type representing a blockchain network entity.
154
154
 
@@ -158,7 +158,7 @@ Type representing a blockchain network entity.
158
158
 
159
159
  > **BlockchainNode** = `ResultOf`\<*typeof* `BlockchainNodeFragment`\>
160
160
 
161
- Defined in: [graphql/blockchain-node.ts:51](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/blockchain-node.ts#L51)
161
+ Defined in: [graphql/blockchain-node.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/blockchain-node.ts#L51)
162
162
 
163
163
  Type representing a blockchain node entity.
164
164
 
@@ -168,7 +168,7 @@ Type representing a blockchain node entity.
168
168
 
169
169
  > **CustomDeployment** = `ResultOf`\<*typeof* `CustomDeploymentFragment`\>
170
170
 
171
- Defined in: [graphql/custom-deployment.ts:33](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/custom-deployment.ts#L33)
171
+ Defined in: [graphql/custom-deployment.ts:33](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/custom-deployment.ts#L33)
172
172
 
173
173
  Type representing a custom deployment entity.
174
174
 
@@ -178,7 +178,7 @@ Type representing a custom deployment entity.
178
178
 
179
179
  > **Insights** = `ResultOf`\<*typeof* `InsightsFragment`\>
180
180
 
181
- Defined in: [graphql/insights.ts:37](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/insights.ts#L37)
181
+ Defined in: [graphql/insights.ts:37](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/insights.ts#L37)
182
182
 
183
183
  Type representing an insights entity.
184
184
 
@@ -188,7 +188,7 @@ Type representing an insights entity.
188
188
 
189
189
  > **IntegrationTool** = `ResultOf`\<*typeof* `IntegrationFragment`\>
190
190
 
191
- Defined in: [graphql/integration-tool.ts:35](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/integration-tool.ts#L35)
191
+ Defined in: [graphql/integration-tool.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/integration-tool.ts#L35)
192
192
 
193
193
  Type representing an integration tool entity.
194
194
 
@@ -198,7 +198,7 @@ Type representing an integration tool entity.
198
198
 
199
199
  > **Middleware** = `ResultOf`\<*typeof* `MiddlewareFragment`\>
200
200
 
201
- Defined in: [graphql/middleware.ts:43](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/middleware.ts#L43)
201
+ Defined in: [graphql/middleware.ts:43](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/middleware.ts#L43)
202
202
 
203
203
  Type representing a middleware entity.
204
204
 
@@ -208,7 +208,7 @@ Type representing a middleware entity.
208
208
 
209
209
  > **MiddlewareWithSubgraphs** = `ResultOf`\<*typeof* `getGraphMiddlewareSubgraphs`\>\[`"middlewareByUniqueName"`\]
210
210
 
211
- Defined in: [graphql/middleware.ts:101](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/middleware.ts#L101)
211
+ Defined in: [graphql/middleware.ts:101](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/middleware.ts#L101)
212
212
 
213
213
  Type representing a middleware entity with subgraphs.
214
214
 
@@ -218,7 +218,7 @@ Type representing a middleware entity with subgraphs.
218
218
 
219
219
  > **PlatformConfig** = `ResultOf`\<*typeof* `getPlatformConfigQuery`\>\[`"config"`\]
220
220
 
221
- Defined in: [graphql/platform.ts:51](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/platform.ts#L51)
221
+ Defined in: [graphql/platform.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/platform.ts#L51)
222
222
 
223
223
  Type representing the platform configuration.
224
224
 
@@ -228,7 +228,7 @@ Type representing the platform configuration.
228
228
 
229
229
  > **PrivateKey** = `ResultOf`\<*typeof* `PrivateKeyFragment`\>
230
230
 
231
- Defined in: [graphql/private-key.ts:27](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/private-key.ts#L27)
231
+ Defined in: [graphql/private-key.ts:27](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/private-key.ts#L27)
232
232
 
233
233
  Type representing a private key entity.
234
234
 
@@ -238,7 +238,7 @@ Type representing a private key entity.
238
238
 
239
239
  > **Storage** = `ResultOf`\<*typeof* `StorageFragment`\>
240
240
 
241
- Defined in: [graphql/storage.ts:35](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/storage.ts#L35)
241
+ Defined in: [graphql/storage.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/storage.ts#L35)
242
242
 
243
243
  Type representing a storage entity.
244
244
 
@@ -248,7 +248,7 @@ Type representing a storage entity.
248
248
 
249
249
  > **Workspace** = `ResultOf`\<*typeof* `WorkspaceFragment`\>
250
250
 
251
- Defined in: [graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v2.1.3/sdk/js/src/graphql/workspace.ts#L26)
251
+ Defined in: [graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/workspace.ts#L26)
252
252
 
253
253
  Type representing a workspace entity.
254
254
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@settlemint/sdk-js",
3
3
  "description": "Core JavaScript SDK for integrating SettleMint's blockchain platform services into your applications",
4
- "version": "2.1.3",
4
+ "version": "2.1.4",
5
5
  "type": "module",
6
6
  "private": false,
7
7
  "license": "FSL-1.1-MIT",
@@ -55,7 +55,7 @@
55
55
  "gql.tada": "^1",
56
56
  "graphql-request": "^7",
57
57
  "zod": "^3",
58
- "@settlemint/sdk-utils": "2.1.3"
58
+ "@settlemint/sdk-utils": "2.1.4"
59
59
  },
60
60
  "peerDependencies": {},
61
61
  "engines": {