@gpuai/sdk 0.2.5 → 0.3.1
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.
- package/.openapi-generator/FILES +6 -6
- package/README.md +15 -10
- package/dist/apis/BillingApi.d.ts +51 -0
- package/dist/apis/BillingApi.js +144 -0
- package/dist/apis/CommunityApi.d.ts +0 -55
- package/dist/apis/CommunityApi.js +0 -151
- package/dist/esm/apis/BillingApi.d.ts +51 -0
- package/dist/esm/apis/BillingApi.js +144 -0
- package/dist/esm/apis/CommunityApi.d.ts +0 -55
- package/dist/esm/apis/CommunityApi.js +0 -151
- package/dist/esm/models/CreateCryptoDepositRequest.d.ts +64 -0
- package/dist/esm/models/CreateCryptoDepositRequest.js +68 -0
- package/dist/esm/models/CryptoDeposit.d.ts +114 -0
- package/dist/esm/models/CryptoDeposit.js +90 -0
- package/dist/esm/models/Instance.d.ts +8 -1
- package/dist/esm/models/Instance.js +3 -0
- package/dist/esm/models/ListDeposits200Response.d.ts +39 -0
- package/dist/esm/models/ListDeposits200Response.js +48 -0
- package/dist/esm/models/index.d.ts +3 -3
- package/dist/esm/models/index.js +3 -3
- package/dist/models/CreateCryptoDepositRequest.d.ts +64 -0
- package/dist/models/CreateCryptoDepositRequest.js +76 -0
- package/dist/models/CryptoDeposit.d.ts +114 -0
- package/dist/models/CryptoDeposit.js +98 -0
- package/dist/models/Instance.d.ts +8 -1
- package/dist/models/Instance.js +3 -0
- package/dist/models/ListDeposits200Response.d.ts +39 -0
- package/dist/models/ListDeposits200Response.js +55 -0
- package/dist/models/index.d.ts +3 -3
- package/dist/models/index.js +3 -3
- package/docs/BillingApi.md +220 -0
- package/docs/CommunityApi.md +0 -230
- package/docs/CreateCryptoDepositRequest.md +38 -0
- package/docs/CryptoDeposit.md +55 -0
- package/docs/Instance.md +2 -0
- package/docs/InstancesApi.md +2 -2
- package/docs/ListDeposits200Response.md +36 -0
- package/package.json +1 -1
- package/src/apis/BillingApi.ts +182 -0
- package/src/apis/CommunityApi.ts +0 -199
- package/src/models/CreateCryptoDepositRequest.ts +108 -0
- package/src/models/CryptoDeposit.ts +177 -0
- package/src/models/Instance.ts +10 -1
- package/src/models/ListDeposits200Response.ts +83 -0
- package/src/models/index.ts +3 -3
package/docs/BillingApi.md
CHANGED
|
@@ -4,11 +4,165 @@ All URIs are relative to *https://api.gpu.ai/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**createCryptoDeposit**](BillingApi.md#createcryptodepositoperation) | **POST** /billing/deposits/crypto | Create a stablecoin deposit |
|
|
8
|
+
| [**getDeposit**](BillingApi.md#getdeposit) | **GET** /billing/deposits/{id} | Get one stablecoin deposit |
|
|
7
9
|
| [**getSpendingLimit**](BillingApi.md#getspendinglimit) | **GET** /billing/spending-limit | Get the org spending limit |
|
|
10
|
+
| [**listDeposits**](BillingApi.md#listdeposits) | **GET** /billing/deposits | List stablecoin deposits |
|
|
8
11
|
| [**updateSpendingLimit**](BillingApi.md#updatespendinglimitoperation) | **PUT** /billing/spending-limit | Set the org spending limit |
|
|
9
12
|
|
|
10
13
|
|
|
11
14
|
|
|
15
|
+
## createCryptoDeposit
|
|
16
|
+
|
|
17
|
+
> CryptoDeposit createCryptoDeposit(createCryptoDepositRequest)
|
|
18
|
+
|
|
19
|
+
Create a stablecoin deposit
|
|
20
|
+
|
|
21
|
+
Creates a deposit intent and returns the payment address and the exact token amount to send. Requires the `billing:write` scope; any member of the organization may add funds. Send the exact `pay_amount` of `asset` on `chain` and no other network — funds sent on a different network are not detected automatically. Returns 404 when stablecoin deposits are not enabled for this deployment.
|
|
22
|
+
|
|
23
|
+
### Example
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import {
|
|
27
|
+
Configuration,
|
|
28
|
+
BillingApi,
|
|
29
|
+
} from '@gpuai/sdk';
|
|
30
|
+
import type { CreateCryptoDepositOperationRequest } from '@gpuai/sdk';
|
|
31
|
+
|
|
32
|
+
async function example() {
|
|
33
|
+
console.log("🚀 Testing @gpuai/sdk SDK...");
|
|
34
|
+
const config = new Configuration({
|
|
35
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
36
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
37
|
+
});
|
|
38
|
+
const api = new BillingApi(config);
|
|
39
|
+
|
|
40
|
+
const body = {
|
|
41
|
+
// CreateCryptoDepositRequest
|
|
42
|
+
createCryptoDepositRequest: ...,
|
|
43
|
+
} satisfies CreateCryptoDepositOperationRequest;
|
|
44
|
+
|
|
45
|
+
try {
|
|
46
|
+
const data = await api.createCryptoDeposit(body);
|
|
47
|
+
console.log(data);
|
|
48
|
+
} catch (error) {
|
|
49
|
+
console.error(error);
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
// Run the test
|
|
54
|
+
example().catch(console.error);
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Parameters
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
| Name | Type | Description | Notes |
|
|
61
|
+
|------------- | ------------- | ------------- | -------------|
|
|
62
|
+
| **createCryptoDepositRequest** | [CreateCryptoDepositRequest](CreateCryptoDepositRequest.md) | | |
|
|
63
|
+
|
|
64
|
+
### Return type
|
|
65
|
+
|
|
66
|
+
[**CryptoDeposit**](CryptoDeposit.md)
|
|
67
|
+
|
|
68
|
+
### Authorization
|
|
69
|
+
|
|
70
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
71
|
+
|
|
72
|
+
### HTTP request headers
|
|
73
|
+
|
|
74
|
+
- **Content-Type**: `application/json`
|
|
75
|
+
- **Accept**: `application/json`, `application/problem+json`
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
### HTTP response details
|
|
79
|
+
| Status code | Description | Response headers |
|
|
80
|
+
|-------------|-------------|------------------|
|
|
81
|
+
| **201** | Created | - |
|
|
82
|
+
| **400** | `validation-error` — `amount_cents` is below the configured minimum. `unsupported-chain-asset` — the chain/asset pair is not available. `invalid-request` — malformed JSON body. | - |
|
|
83
|
+
| **403** | `org-frozen` — the organization cannot add funds; contact support. | - |
|
|
84
|
+
| **404** | Error response (RFC 7807) | - |
|
|
85
|
+
| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
|
|
86
|
+
| **503** | `payment-source-unavailable` — deposits are temporarily unavailable; retry shortly. | - |
|
|
87
|
+
| **0** | Error response (RFC 7807) | - |
|
|
88
|
+
|
|
89
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
## getDeposit
|
|
93
|
+
|
|
94
|
+
> CryptoDeposit getDeposit(id)
|
|
95
|
+
|
|
96
|
+
Get one stablecoin deposit
|
|
97
|
+
|
|
98
|
+
Returns a single deposit belonging to the caller\'s organization. Requires the `billing:read` scope. A deposit belonging to another organization returns the same `404 deposit-not-found` as one that does not exist — deliberately, so this endpoint cannot be used to test whether a deposit id is real. Also 404 when stablecoin deposits are not enabled for this deployment.
|
|
99
|
+
|
|
100
|
+
### Example
|
|
101
|
+
|
|
102
|
+
```ts
|
|
103
|
+
import {
|
|
104
|
+
Configuration,
|
|
105
|
+
BillingApi,
|
|
106
|
+
} from '@gpuai/sdk';
|
|
107
|
+
import type { GetDepositRequest } from '@gpuai/sdk';
|
|
108
|
+
|
|
109
|
+
async function example() {
|
|
110
|
+
console.log("🚀 Testing @gpuai/sdk SDK...");
|
|
111
|
+
const config = new Configuration({
|
|
112
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
113
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
114
|
+
});
|
|
115
|
+
const api = new BillingApi(config);
|
|
116
|
+
|
|
117
|
+
const body = {
|
|
118
|
+
// string | The deposit id.
|
|
119
|
+
id: id_example,
|
|
120
|
+
} satisfies GetDepositRequest;
|
|
121
|
+
|
|
122
|
+
try {
|
|
123
|
+
const data = await api.getDeposit(body);
|
|
124
|
+
console.log(data);
|
|
125
|
+
} catch (error) {
|
|
126
|
+
console.error(error);
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
// Run the test
|
|
131
|
+
example().catch(console.error);
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Parameters
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
| Name | Type | Description | Notes |
|
|
138
|
+
|------------- | ------------- | ------------- | -------------|
|
|
139
|
+
| **id** | `string` | The deposit id. | [Defaults to `undefined`] |
|
|
140
|
+
|
|
141
|
+
### Return type
|
|
142
|
+
|
|
143
|
+
[**CryptoDeposit**](CryptoDeposit.md)
|
|
144
|
+
|
|
145
|
+
### Authorization
|
|
146
|
+
|
|
147
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
148
|
+
|
|
149
|
+
### HTTP request headers
|
|
150
|
+
|
|
151
|
+
- **Content-Type**: Not defined
|
|
152
|
+
- **Accept**: `application/json`, `application/problem+json`
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
### HTTP response details
|
|
156
|
+
| Status code | Description | Response headers |
|
|
157
|
+
|-------------|-------------|------------------|
|
|
158
|
+
| **200** | OK | - |
|
|
159
|
+
| **404** | `deposit-not-found` — no such deposit, or it belongs to another organization. `not-found` — the feature is not enabled. | - |
|
|
160
|
+
| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
|
|
161
|
+
| **0** | Error response (RFC 7807) | - |
|
|
162
|
+
|
|
163
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
164
|
+
|
|
165
|
+
|
|
12
166
|
## getSpendingLimit
|
|
13
167
|
|
|
14
168
|
> SpendingLimit getSpendingLimit()
|
|
@@ -75,6 +229,72 @@ This endpoint does not need any parameter.
|
|
|
75
229
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
76
230
|
|
|
77
231
|
|
|
232
|
+
## listDeposits
|
|
233
|
+
|
|
234
|
+
> ListDeposits200Response listDeposits()
|
|
235
|
+
|
|
236
|
+
List stablecoin deposits
|
|
237
|
+
|
|
238
|
+
Returns the organization\'s stablecoin deposits, newest first, capped at 50. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter. Returns 404 when stablecoin deposits are not enabled for this deployment.
|
|
239
|
+
|
|
240
|
+
### Example
|
|
241
|
+
|
|
242
|
+
```ts
|
|
243
|
+
import {
|
|
244
|
+
Configuration,
|
|
245
|
+
BillingApi,
|
|
246
|
+
} from '@gpuai/sdk';
|
|
247
|
+
import type { ListDepositsRequest } from '@gpuai/sdk';
|
|
248
|
+
|
|
249
|
+
async function example() {
|
|
250
|
+
console.log("🚀 Testing @gpuai/sdk SDK...");
|
|
251
|
+
const config = new Configuration({
|
|
252
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
253
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
254
|
+
});
|
|
255
|
+
const api = new BillingApi(config);
|
|
256
|
+
|
|
257
|
+
try {
|
|
258
|
+
const data = await api.listDeposits();
|
|
259
|
+
console.log(data);
|
|
260
|
+
} catch (error) {
|
|
261
|
+
console.error(error);
|
|
262
|
+
}
|
|
263
|
+
}
|
|
264
|
+
|
|
265
|
+
// Run the test
|
|
266
|
+
example().catch(console.error);
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Parameters
|
|
270
|
+
|
|
271
|
+
This endpoint does not need any parameter.
|
|
272
|
+
|
|
273
|
+
### Return type
|
|
274
|
+
|
|
275
|
+
[**ListDeposits200Response**](ListDeposits200Response.md)
|
|
276
|
+
|
|
277
|
+
### Authorization
|
|
278
|
+
|
|
279
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
280
|
+
|
|
281
|
+
### HTTP request headers
|
|
282
|
+
|
|
283
|
+
- **Content-Type**: Not defined
|
|
284
|
+
- **Accept**: `application/json`, `application/problem+json`
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
### HTTP response details
|
|
288
|
+
| Status code | Description | Response headers |
|
|
289
|
+
|-------------|-------------|------------------|
|
|
290
|
+
| **200** | OK | - |
|
|
291
|
+
| **404** | Error response (RFC 7807) | - |
|
|
292
|
+
| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
|
|
293
|
+
| **0** | Error response (RFC 7807) | - |
|
|
294
|
+
|
|
295
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
296
|
+
|
|
297
|
+
|
|
78
298
|
## updateSpendingLimit
|
|
79
299
|
|
|
80
300
|
> SpendingLimit updateSpendingLimit(updateSpendingLimitRequest)
|
package/docs/CommunityApi.md
CHANGED
|
@@ -6,13 +6,10 @@ All URIs are relative to *https://api.gpu.ai/v1*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**delistCommunityMachine**](CommunityApi.md#delistcommunitymachine) | **POST** /community/machines/{id}/delist | Delist a Community Cloud machine |
|
|
8
8
|
| [**enableCommunitySupplier**](CommunityApi.md#enablecommunitysupplier) | **POST** /community/suppliers | Enable the Community Cloud supplier role |
|
|
9
|
-
| [**getCommunityEarnings**](CommunityApi.md#getcommunityearnings) | **GET** /community/earnings | Get your Community Cloud earnings |
|
|
10
|
-
| [**getCommunityMachine**](CommunityApi.md#getcommunitymachine) | **GET** /community/machines/{id} | Get one of your Community Cloud machines |
|
|
11
9
|
| [**getCommunitySupplierMe**](CommunityApi.md#getcommunitysupplierme) | **GET** /community/suppliers/me | Get the caller\'s Community Cloud supplier |
|
|
12
10
|
| [**listCommunityMachines**](CommunityApi.md#listcommunitymachines) | **GET** /community/machines | List your Community Cloud machines |
|
|
13
11
|
| [**reclaimCommunityMachine**](CommunityApi.md#reclaimcommunitymachine) | **POST** /community/machines/{id}/reclaim | Reclaim a spot-tier Community Cloud machine |
|
|
14
12
|
| [**registerCommunityMachine**](CommunityApi.md#registercommunitymachineoperation) | **POST** /community/machines | Register a Community Cloud machine |
|
|
15
|
-
| [**updateCommunityMachine**](CommunityApi.md#updatecommunitymachineoperation) | **PATCH** /community/machines/{id} | Update a Community Cloud machine\'s price |
|
|
16
13
|
|
|
17
14
|
|
|
18
15
|
|
|
@@ -165,154 +162,6 @@ example().catch(console.error);
|
|
|
165
162
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
166
163
|
|
|
167
164
|
|
|
168
|
-
## getCommunityEarnings
|
|
169
|
-
|
|
170
|
-
> CommunityEarnings getCommunityEarnings(limit)
|
|
171
|
-
|
|
172
|
-
Get your Community Cloud earnings
|
|
173
|
-
|
|
174
|
-
Returns the caller org\'s supplier earnings — lifetime accrued and unpaid totals in cents plus recent ledger entries, newest first. An optional `limit` caps the ledger rows (server-clamped). Requires the `community` scope (read).
|
|
175
|
-
|
|
176
|
-
### Example
|
|
177
|
-
|
|
178
|
-
```ts
|
|
179
|
-
import {
|
|
180
|
-
Configuration,
|
|
181
|
-
CommunityApi,
|
|
182
|
-
} from '@gpuai/sdk';
|
|
183
|
-
import type { GetCommunityEarningsRequest } from '@gpuai/sdk';
|
|
184
|
-
|
|
185
|
-
async function example() {
|
|
186
|
-
console.log("🚀 Testing @gpuai/sdk SDK...");
|
|
187
|
-
const config = new Configuration({
|
|
188
|
-
// Configure HTTP bearer authorization: bearerAuth
|
|
189
|
-
accessToken: "YOUR BEARER TOKEN",
|
|
190
|
-
});
|
|
191
|
-
const api = new CommunityApi(config);
|
|
192
|
-
|
|
193
|
-
const body = {
|
|
194
|
-
// number | Maximum ledger entries to return (default 100, max 500). (optional)
|
|
195
|
-
limit: 56,
|
|
196
|
-
} satisfies GetCommunityEarningsRequest;
|
|
197
|
-
|
|
198
|
-
try {
|
|
199
|
-
const data = await api.getCommunityEarnings(body);
|
|
200
|
-
console.log(data);
|
|
201
|
-
} catch (error) {
|
|
202
|
-
console.error(error);
|
|
203
|
-
}
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
// Run the test
|
|
207
|
-
example().catch(console.error);
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
### Parameters
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
| Name | Type | Description | Notes |
|
|
214
|
-
|------------- | ------------- | ------------- | -------------|
|
|
215
|
-
| **limit** | `number` | Maximum ledger entries to return (default 100, max 500). | [Optional] [Defaults to `undefined`] |
|
|
216
|
-
|
|
217
|
-
### Return type
|
|
218
|
-
|
|
219
|
-
[**CommunityEarnings**](CommunityEarnings.md)
|
|
220
|
-
|
|
221
|
-
### Authorization
|
|
222
|
-
|
|
223
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
224
|
-
|
|
225
|
-
### HTTP request headers
|
|
226
|
-
|
|
227
|
-
- **Content-Type**: Not defined
|
|
228
|
-
- **Accept**: `application/json`, `application/problem+json`
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
### HTTP response details
|
|
232
|
-
| Status code | Description | Response headers |
|
|
233
|
-
|-------------|-------------|------------------|
|
|
234
|
-
| **200** | The earnings view. | - |
|
|
235
|
-
| **404** | The organization has not enabled the community supplier role. | - |
|
|
236
|
-
| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
|
|
237
|
-
| **0** | Error response (RFC 7807) | - |
|
|
238
|
-
|
|
239
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
## getCommunityMachine
|
|
243
|
-
|
|
244
|
-
> SupplierMachineView getCommunityMachine(id)
|
|
245
|
-
|
|
246
|
-
Get one of your Community Cloud machines
|
|
247
|
-
|
|
248
|
-
Returns one machine the caller\'s org owns, as a supplier-facing view (`occupied`/`online` projections — the renting customer\'s instance id is never exposed). A missing or cross-org machine returns 404 with an indistinguishable body. Requires the `community` scope (read).
|
|
249
|
-
|
|
250
|
-
### Example
|
|
251
|
-
|
|
252
|
-
```ts
|
|
253
|
-
import {
|
|
254
|
-
Configuration,
|
|
255
|
-
CommunityApi,
|
|
256
|
-
} from '@gpuai/sdk';
|
|
257
|
-
import type { GetCommunityMachineRequest } from '@gpuai/sdk';
|
|
258
|
-
|
|
259
|
-
async function example() {
|
|
260
|
-
console.log("🚀 Testing @gpuai/sdk SDK...");
|
|
261
|
-
const config = new Configuration({
|
|
262
|
-
// Configure HTTP bearer authorization: bearerAuth
|
|
263
|
-
accessToken: "YOUR BEARER TOKEN",
|
|
264
|
-
});
|
|
265
|
-
const api = new CommunityApi(config);
|
|
266
|
-
|
|
267
|
-
const body = {
|
|
268
|
-
// string | The machine id.
|
|
269
|
-
id: id_example,
|
|
270
|
-
} satisfies GetCommunityMachineRequest;
|
|
271
|
-
|
|
272
|
-
try {
|
|
273
|
-
const data = await api.getCommunityMachine(body);
|
|
274
|
-
console.log(data);
|
|
275
|
-
} catch (error) {
|
|
276
|
-
console.error(error);
|
|
277
|
-
}
|
|
278
|
-
}
|
|
279
|
-
|
|
280
|
-
// Run the test
|
|
281
|
-
example().catch(console.error);
|
|
282
|
-
```
|
|
283
|
-
|
|
284
|
-
### Parameters
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
| Name | Type | Description | Notes |
|
|
288
|
-
|------------- | ------------- | ------------- | -------------|
|
|
289
|
-
| **id** | `string` | The machine id. | [Defaults to `undefined`] |
|
|
290
|
-
|
|
291
|
-
### Return type
|
|
292
|
-
|
|
293
|
-
[**SupplierMachineView**](SupplierMachineView.md)
|
|
294
|
-
|
|
295
|
-
### Authorization
|
|
296
|
-
|
|
297
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
298
|
-
|
|
299
|
-
### HTTP request headers
|
|
300
|
-
|
|
301
|
-
- **Content-Type**: Not defined
|
|
302
|
-
- **Accept**: `application/json`, `application/problem+json`
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
### HTTP response details
|
|
306
|
-
| Status code | Description | Response headers |
|
|
307
|
-
|-------------|-------------|------------------|
|
|
308
|
-
| **200** | The supplier-facing machine view. | - |
|
|
309
|
-
| **404** | The machine does not exist or is not owned by the caller\'s org. | - |
|
|
310
|
-
| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
|
|
311
|
-
| **0** | Error response (RFC 7807) | - |
|
|
312
|
-
|
|
313
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
314
|
-
|
|
315
|
-
|
|
316
165
|
## getCommunitySupplierMe
|
|
317
166
|
|
|
318
167
|
> CommunitySupplier getCommunitySupplierMe()
|
|
@@ -598,82 +447,3 @@ example().catch(console.error);
|
|
|
598
447
|
|
|
599
448
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
600
449
|
|
|
601
|
-
|
|
602
|
-
## updateCommunityMachine
|
|
603
|
-
|
|
604
|
-
> SupplierMachineView updateCommunityMachine(id, updateCommunityMachineRequest)
|
|
605
|
-
|
|
606
|
-
Update a Community Cloud machine\'s price
|
|
607
|
-
|
|
608
|
-
Sets the machine\'s hourly price. `price_per_hour` is the WHOLE-MACHINE rate (never per-GPU). Prices below the platform floor are rejected with a `price-below-floor` problem carrying the concrete `floor_per_hour` extension member. A price change never affects an in-flight rental (its rate was snapshotted at provision); the catalog reprices on the next poll. Requires the `community` scope (or `full_access`).
|
|
609
|
-
|
|
610
|
-
### Example
|
|
611
|
-
|
|
612
|
-
```ts
|
|
613
|
-
import {
|
|
614
|
-
Configuration,
|
|
615
|
-
CommunityApi,
|
|
616
|
-
} from '@gpuai/sdk';
|
|
617
|
-
import type { UpdateCommunityMachineOperationRequest } from '@gpuai/sdk';
|
|
618
|
-
|
|
619
|
-
async function example() {
|
|
620
|
-
console.log("🚀 Testing @gpuai/sdk SDK...");
|
|
621
|
-
const config = new Configuration({
|
|
622
|
-
// Configure HTTP bearer authorization: bearerAuth
|
|
623
|
-
accessToken: "YOUR BEARER TOKEN",
|
|
624
|
-
});
|
|
625
|
-
const api = new CommunityApi(config);
|
|
626
|
-
|
|
627
|
-
const body = {
|
|
628
|
-
// string | The machine id.
|
|
629
|
-
id: id_example,
|
|
630
|
-
// UpdateCommunityMachineRequest
|
|
631
|
-
updateCommunityMachineRequest: ...,
|
|
632
|
-
} satisfies UpdateCommunityMachineOperationRequest;
|
|
633
|
-
|
|
634
|
-
try {
|
|
635
|
-
const data = await api.updateCommunityMachine(body);
|
|
636
|
-
console.log(data);
|
|
637
|
-
} catch (error) {
|
|
638
|
-
console.error(error);
|
|
639
|
-
}
|
|
640
|
-
}
|
|
641
|
-
|
|
642
|
-
// Run the test
|
|
643
|
-
example().catch(console.error);
|
|
644
|
-
```
|
|
645
|
-
|
|
646
|
-
### Parameters
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
| Name | Type | Description | Notes |
|
|
650
|
-
|------------- | ------------- | ------------- | -------------|
|
|
651
|
-
| **id** | `string` | The machine id. | [Defaults to `undefined`] |
|
|
652
|
-
| **updateCommunityMachineRequest** | [UpdateCommunityMachineRequest](UpdateCommunityMachineRequest.md) | | |
|
|
653
|
-
|
|
654
|
-
### Return type
|
|
655
|
-
|
|
656
|
-
[**SupplierMachineView**](SupplierMachineView.md)
|
|
657
|
-
|
|
658
|
-
### Authorization
|
|
659
|
-
|
|
660
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
661
|
-
|
|
662
|
-
### HTTP request headers
|
|
663
|
-
|
|
664
|
-
- **Content-Type**: `application/json`
|
|
665
|
-
- **Accept**: `application/json`, `application/problem+json`
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
### HTTP response details
|
|
669
|
-
| Status code | Description | Response headers |
|
|
670
|
-
|-------------|-------------|------------------|
|
|
671
|
-
| **200** | The updated supplier-facing machine view. | - |
|
|
672
|
-
| **400** | Validation failure, including `price-below-floor` (the problem doc then carries `floor_per_hour`). | - |
|
|
673
|
-
| **403** | The community supplier role is suspended. | - |
|
|
674
|
-
| **404** | The machine does not exist or is not owned by the caller\'s org. | - |
|
|
675
|
-
| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
|
|
676
|
-
| **0** | Error response (RFC 7807) | - |
|
|
677
|
-
|
|
678
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
679
|
-
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateCryptoDepositRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`amountCents` | number
|
|
10
|
+
`chain` | string
|
|
11
|
+
`asset` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { CreateCryptoDepositRequest } from '@gpuai/sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"amountCents": null,
|
|
21
|
+
"chain": null,
|
|
22
|
+
"asset": null,
|
|
23
|
+
} satisfies CreateCryptoDepositRequest
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateCryptoDepositRequest
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
|
|
2
|
+
# CryptoDeposit
|
|
3
|
+
|
|
4
|
+
A stablecoin deposit. Mirrors the Go DTO field for field. Like that struct, this schema deliberately has NO payment-processor property — the processor is an implementation detail and is structurally absent from the customer contract, not merely filtered out.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`depositId` | string
|
|
11
|
+
`status` | string
|
|
12
|
+
`chain` | string
|
|
13
|
+
`asset` | string
|
|
14
|
+
`payAddress` | string
|
|
15
|
+
`payAmount` | string
|
|
16
|
+
`amountUsdCents` | number
|
|
17
|
+
`creditedCents` | number
|
|
18
|
+
`txHash` | string
|
|
19
|
+
`expiresAt` | Date
|
|
20
|
+
`createdAt` | Date
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import type { CryptoDeposit } from '@gpuai/sdk'
|
|
26
|
+
|
|
27
|
+
// TODO: Update the object below with actual values
|
|
28
|
+
const example = {
|
|
29
|
+
"depositId": null,
|
|
30
|
+
"status": null,
|
|
31
|
+
"chain": null,
|
|
32
|
+
"asset": null,
|
|
33
|
+
"payAddress": null,
|
|
34
|
+
"payAmount": null,
|
|
35
|
+
"amountUsdCents": null,
|
|
36
|
+
"creditedCents": null,
|
|
37
|
+
"txHash": null,
|
|
38
|
+
"expiresAt": null,
|
|
39
|
+
"createdAt": null,
|
|
40
|
+
} satisfies CryptoDeposit
|
|
41
|
+
|
|
42
|
+
console.log(example)
|
|
43
|
+
|
|
44
|
+
// Convert the instance to a JSON string
|
|
45
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
46
|
+
console.log(exampleJSON)
|
|
47
|
+
|
|
48
|
+
// Parse the JSON string back to an object
|
|
49
|
+
const exampleParsed = JSON.parse(exampleJSON) as CryptoDeposit
|
|
50
|
+
console.log(exampleParsed)
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
54
|
+
|
|
55
|
+
|
package/docs/Instance.md
CHANGED
|
@@ -21,6 +21,7 @@ Name | Type
|
|
|
21
21
|
`readyAt` | Date
|
|
22
22
|
`terminatedAt` | Date
|
|
23
23
|
`lastReachableAt` | Date
|
|
24
|
+
`unreachableSince` | Date
|
|
24
25
|
|
|
25
26
|
## Example
|
|
26
27
|
|
|
@@ -44,6 +45,7 @@ const example = {
|
|
|
44
45
|
"readyAt": null,
|
|
45
46
|
"terminatedAt": null,
|
|
46
47
|
"lastReachableAt": null,
|
|
48
|
+
"unreachableSince": null,
|
|
47
49
|
} satisfies Instance
|
|
48
50
|
|
|
49
51
|
console.log(example)
|
package/docs/InstancesApi.md
CHANGED
|
@@ -268,7 +268,7 @@ async function example() {
|
|
|
268
268
|
cursor: cursor_example,
|
|
269
269
|
// number (optional)
|
|
270
270
|
limit: 56,
|
|
271
|
-
// 'allocating' | 'starting' | 'running' | 'stopping' | 'stopped' | 'terminated' | 'error' | 'all' | Filter by customer-facing status (default = all non-terminated) (optional)
|
|
271
|
+
// 'allocating' | 'starting' | 'running' | 'stopping' | 'stopped' | 'terminated' | 'error' | 'all' | Filter by customer-facing status (default = all non-terminated). There is no \"unreachable\" filter value: an unreachable instance is a running instance with a dead tunnel, so it is listed under status=running and reads \"unreachable\" in the response body. (optional)
|
|
272
272
|
status: status_example,
|
|
273
273
|
} satisfies ListInstancesRequest;
|
|
274
274
|
|
|
@@ -291,7 +291,7 @@ example().catch(console.error);
|
|
|
291
291
|
|------------- | ------------- | ------------- | -------------|
|
|
292
292
|
| **cursor** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
293
293
|
| **limit** | `number` | | [Optional] [Defaults to `50`] |
|
|
294
|
-
| **status** | `allocating`, `starting`, `running`, `stopping`, `stopped`, `terminated`, `error`, `all` | Filter by customer-facing status (default = all non-terminated) | [Optional] [Defaults to `undefined`] [Enum: allocating, starting, running, stopping, stopped, terminated, error, all] |
|
|
294
|
+
| **status** | `allocating`, `starting`, `running`, `stopping`, `stopped`, `terminated`, `error`, `all` | Filter by customer-facing status (default = all non-terminated). There is no \"unreachable\" filter value: an unreachable instance is a running instance with a dead tunnel, so it is listed under status=running and reads \"unreachable\" in the response body. | [Optional] [Defaults to `undefined`] [Enum: allocating, starting, running, stopping, stopped, terminated, error, all] |
|
|
295
295
|
|
|
296
296
|
### Return type
|
|
297
297
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# ListDeposits200Response
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`deposits` | [Array<CryptoDeposit>](CryptoDeposit.md)
|
|
10
|
+
`minDepositCents` | number
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { ListDeposits200Response } from '@gpuai/sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"deposits": null,
|
|
20
|
+
"minDepositCents": 500,
|
|
21
|
+
} satisfies ListDeposits200Response
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListDeposits200Response
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|