@gpuai/sdk 0.5.4 → 0.5.6

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 (202) hide show
  1. package/.openapi-generator/FILES +56 -0
  2. package/README.md +50 -2
  3. package/dist/apis/EndpointsApi.d.ts +150 -0
  4. package/dist/apis/EndpointsApi.js +379 -0
  5. package/dist/apis/InstancesApi.d.ts +15 -0
  6. package/dist/apis/InstancesApi.js +45 -0
  7. package/dist/apis/JobsApi.d.ts +172 -0
  8. package/dist/apis/JobsApi.js +444 -0
  9. package/dist/apis/OperationsApi.d.ts +17 -0
  10. package/dist/apis/OperationsApi.js +48 -0
  11. package/dist/apis/SecretsApi.d.ts +123 -0
  12. package/dist/apis/SecretsApi.js +328 -0
  13. package/dist/apis/index.d.ts +3 -0
  14. package/dist/apis/index.js +3 -0
  15. package/dist/esm/apis/EndpointsApi.d.ts +150 -0
  16. package/dist/esm/apis/EndpointsApi.js +375 -0
  17. package/dist/esm/apis/InstancesApi.d.ts +15 -0
  18. package/dist/esm/apis/InstancesApi.js +45 -0
  19. package/dist/esm/apis/JobsApi.d.ts +172 -0
  20. package/dist/esm/apis/JobsApi.js +440 -0
  21. package/dist/esm/apis/OperationsApi.d.ts +17 -0
  22. package/dist/esm/apis/OperationsApi.js +48 -0
  23. package/dist/esm/apis/SecretsApi.d.ts +123 -0
  24. package/dist/esm/apis/SecretsApi.js +324 -0
  25. package/dist/esm/apis/index.d.ts +3 -0
  26. package/dist/esm/apis/index.js +3 -0
  27. package/dist/esm/models/DedicatedIPOffer.d.ts +98 -0
  28. package/dist/esm/models/DedicatedIPOffer.js +87 -0
  29. package/dist/esm/models/Endpoint.d.ts +147 -0
  30. package/dist/esm/models/Endpoint.js +121 -0
  31. package/dist/esm/models/EndpointCreate.d.ts +80 -0
  32. package/dist/esm/models/EndpointCreate.js +63 -0
  33. package/dist/esm/models/EndpointList.d.ts +33 -0
  34. package/dist/esm/models/EndpointList.js +44 -0
  35. package/dist/esm/models/EndpointMachine.d.ts +90 -0
  36. package/dist/esm/models/EndpointMachine.js +84 -0
  37. package/dist/esm/models/EndpointReplicaCounts.d.ts +38 -0
  38. package/dist/esm/models/EndpointReplicaCounts.js +47 -0
  39. package/dist/esm/models/Job.d.ts +352 -0
  40. package/dist/esm/models/Job.js +254 -0
  41. package/dist/esm/models/JobAttempt.d.ts +176 -0
  42. package/dist/esm/models/JobAttempt.js +147 -0
  43. package/dist/esm/models/JobCreate.d.ts +153 -0
  44. package/dist/esm/models/JobCreate.js +84 -0
  45. package/dist/esm/models/JobGpuTypes.d.ts +39 -0
  46. package/dist/esm/models/JobGpuTypes.js +48 -0
  47. package/dist/esm/models/JobGpuTypesDataInner.d.ts +58 -0
  48. package/dist/esm/models/JobGpuTypesDataInner.js +59 -0
  49. package/dist/esm/models/JobLogChunk.d.ts +50 -0
  50. package/dist/esm/models/JobLogChunk.js +55 -0
  51. package/dist/esm/models/JobLogs.d.ts +39 -0
  52. package/dist/esm/models/JobLogs.js +48 -0
  53. package/dist/esm/models/JobPage.d.ts +39 -0
  54. package/dist/esm/models/JobPage.js +48 -0
  55. package/dist/esm/models/JobSharingHint.d.ts +46 -0
  56. package/dist/esm/models/JobSharingHint.js +51 -0
  57. package/dist/esm/models/JobTelemetry.d.ts +51 -0
  58. package/dist/esm/models/JobTelemetry.js +56 -0
  59. package/dist/esm/models/JobTelemetryPoint.d.ts +56 -0
  60. package/dist/esm/models/JobTelemetryPoint.js +59 -0
  61. package/dist/esm/models/JobTrial.d.ts +79 -0
  62. package/dist/esm/models/JobTrial.js +73 -0
  63. package/dist/esm/models/Operation.d.ts +6 -0
  64. package/dist/esm/models/Operation.js +2 -0
  65. package/dist/esm/models/Secret.d.ts +62 -0
  66. package/dist/esm/models/Secret.js +63 -0
  67. package/dist/esm/models/SecretCreate.d.ts +44 -0
  68. package/dist/esm/models/SecretCreate.js +49 -0
  69. package/dist/esm/models/SecretImportItem.d.ts +38 -0
  70. package/dist/esm/models/SecretImportItem.js +47 -0
  71. package/dist/esm/models/SecretImportRequest.d.ts +39 -0
  72. package/dist/esm/models/SecretImportRequest.js +46 -0
  73. package/dist/esm/models/SecretImportResult.d.ts +44 -0
  74. package/dist/esm/models/SecretImportResult.js +51 -0
  75. package/dist/esm/models/SecretList.d.ts +33 -0
  76. package/dist/esm/models/SecretList.js +44 -0
  77. package/dist/esm/models/SecretPut.d.ts +38 -0
  78. package/dist/esm/models/SecretPut.js +45 -0
  79. package/dist/esm/models/index.d.ts +25 -0
  80. package/dist/esm/models/index.js +25 -0
  81. package/dist/esm/runtime.js +1 -1
  82. package/dist/models/DedicatedIPOffer.d.ts +98 -0
  83. package/dist/models/DedicatedIPOffer.js +94 -0
  84. package/dist/models/Endpoint.d.ts +147 -0
  85. package/dist/models/Endpoint.js +129 -0
  86. package/dist/models/EndpointCreate.d.ts +80 -0
  87. package/dist/models/EndpointCreate.js +70 -0
  88. package/dist/models/EndpointList.d.ts +33 -0
  89. package/dist/models/EndpointList.js +51 -0
  90. package/dist/models/EndpointMachine.d.ts +90 -0
  91. package/dist/models/EndpointMachine.js +92 -0
  92. package/dist/models/EndpointReplicaCounts.d.ts +38 -0
  93. package/dist/models/EndpointReplicaCounts.js +54 -0
  94. package/dist/models/Job.d.ts +352 -0
  95. package/dist/models/Job.js +262 -0
  96. package/dist/models/JobAttempt.d.ts +176 -0
  97. package/dist/models/JobAttempt.js +155 -0
  98. package/dist/models/JobCreate.d.ts +153 -0
  99. package/dist/models/JobCreate.js +92 -0
  100. package/dist/models/JobGpuTypes.d.ts +39 -0
  101. package/dist/models/JobGpuTypes.js +55 -0
  102. package/dist/models/JobGpuTypesDataInner.d.ts +58 -0
  103. package/dist/models/JobGpuTypesDataInner.js +66 -0
  104. package/dist/models/JobLogChunk.d.ts +50 -0
  105. package/dist/models/JobLogChunk.js +62 -0
  106. package/dist/models/JobLogs.d.ts +39 -0
  107. package/dist/models/JobLogs.js +55 -0
  108. package/dist/models/JobPage.d.ts +39 -0
  109. package/dist/models/JobPage.js +55 -0
  110. package/dist/models/JobSharingHint.d.ts +46 -0
  111. package/dist/models/JobSharingHint.js +58 -0
  112. package/dist/models/JobTelemetry.d.ts +51 -0
  113. package/dist/models/JobTelemetry.js +63 -0
  114. package/dist/models/JobTelemetryPoint.d.ts +56 -0
  115. package/dist/models/JobTelemetryPoint.js +66 -0
  116. package/dist/models/JobTrial.d.ts +79 -0
  117. package/dist/models/JobTrial.js +81 -0
  118. package/dist/models/Operation.d.ts +6 -0
  119. package/dist/models/Operation.js +2 -0
  120. package/dist/models/Secret.d.ts +62 -0
  121. package/dist/models/Secret.js +70 -0
  122. package/dist/models/SecretCreate.d.ts +44 -0
  123. package/dist/models/SecretCreate.js +56 -0
  124. package/dist/models/SecretImportItem.d.ts +38 -0
  125. package/dist/models/SecretImportItem.js +54 -0
  126. package/dist/models/SecretImportRequest.d.ts +39 -0
  127. package/dist/models/SecretImportRequest.js +53 -0
  128. package/dist/models/SecretImportResult.d.ts +44 -0
  129. package/dist/models/SecretImportResult.js +58 -0
  130. package/dist/models/SecretList.d.ts +33 -0
  131. package/dist/models/SecretList.js +51 -0
  132. package/dist/models/SecretPut.d.ts +38 -0
  133. package/dist/models/SecretPut.js +52 -0
  134. package/dist/models/index.d.ts +25 -0
  135. package/dist/models/index.js +25 -0
  136. package/dist/runtime.js +1 -1
  137. package/docs/DedicatedIPOffer.md +56 -0
  138. package/docs/Endpoint.md +68 -0
  139. package/docs/EndpointCreate.md +50 -0
  140. package/docs/EndpointList.md +34 -0
  141. package/docs/EndpointMachine.md +50 -0
  142. package/docs/EndpointReplicaCounts.md +36 -0
  143. package/docs/EndpointsApi.md +544 -0
  144. package/docs/InstancesApi.md +68 -1
  145. package/docs/Job.md +125 -0
  146. package/docs/JobAttempt.md +69 -0
  147. package/docs/JobCreate.md +66 -0
  148. package/docs/JobGpuTypes.md +36 -0
  149. package/docs/JobGpuTypesDataInner.md +42 -0
  150. package/docs/JobLogChunk.md +40 -0
  151. package/docs/JobLogs.md +36 -0
  152. package/docs/JobPage.md +36 -0
  153. package/docs/JobSharingHint.md +39 -0
  154. package/docs/JobTelemetry.md +40 -0
  155. package/docs/JobTelemetryPoint.md +42 -0
  156. package/docs/JobTrial.md +46 -0
  157. package/docs/JobsApi.md +609 -0
  158. package/docs/Operation.md +2 -0
  159. package/docs/OperationsApi.md +76 -0
  160. package/docs/Secret.md +45 -0
  161. package/docs/SecretCreate.md +38 -0
  162. package/docs/SecretImportItem.md +36 -0
  163. package/docs/SecretImportRequest.md +36 -0
  164. package/docs/SecretImportResult.md +38 -0
  165. package/docs/SecretList.md +34 -0
  166. package/docs/SecretPut.md +36 -0
  167. package/docs/SecretsApi.md +450 -0
  168. package/package.json +1 -1
  169. package/src/apis/EndpointsApi.ts +481 -0
  170. package/src/apis/InstancesApi.ts +52 -0
  171. package/src/apis/JobsApi.ts +551 -0
  172. package/src/apis/OperationsApi.ts +59 -0
  173. package/src/apis/SecretsApi.ts +413 -0
  174. package/src/apis/index.ts +3 -0
  175. package/src/models/DedicatedIPOffer.ts +165 -0
  176. package/src/models/Endpoint.ts +247 -0
  177. package/src/models/EndpointCreate.ts +132 -0
  178. package/src/models/EndpointList.ts +74 -0
  179. package/src/models/EndpointMachine.ts +151 -0
  180. package/src/models/EndpointReplicaCounts.ts +75 -0
  181. package/src/models/Job.ts +538 -0
  182. package/src/models/JobAttempt.ts +267 -0
  183. package/src/models/JobCreate.ts +221 -0
  184. package/src/models/JobGpuTypes.ts +83 -0
  185. package/src/models/JobGpuTypesDataInner.ts +104 -0
  186. package/src/models/JobLogChunk.ts +93 -0
  187. package/src/models/JobLogs.ts +83 -0
  188. package/src/models/JobPage.ts +83 -0
  189. package/src/models/JobSharingHint.ts +86 -0
  190. package/src/models/JobTelemetry.ts +101 -0
  191. package/src/models/JobTelemetryPoint.ts +102 -0
  192. package/src/models/JobTrial.ts +132 -0
  193. package/src/models/Operation.ts +8 -0
  194. package/src/models/Secret.ts +111 -0
  195. package/src/models/SecretCreate.ts +83 -0
  196. package/src/models/SecretImportItem.ts +75 -0
  197. package/src/models/SecretImportRequest.ts +82 -0
  198. package/src/models/SecretImportResult.ts +84 -0
  199. package/src/models/SecretList.ts +74 -0
  200. package/src/models/SecretPut.ts +74 -0
  201. package/src/models/index.ts +25 -0
  202. package/src/runtime.ts +1 -1
@@ -4,10 +4,86 @@ All URIs are relative to *https://api.gpu.ai/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
+ | [**cancelOperation**](OperationsApi.md#canceloperation) | **POST** /operations/{id}/cancel | Cancel a launch that has not created its instance yet |
7
8
  | [**getOperation**](OperationsApi.md#getoperation) | **GET** /operations/{id} | Get an async operation status |
8
9
 
9
10
 
10
11
 
12
+ ## cancelOperation
13
+
14
+ > Operation cancelOperation(id)
15
+
16
+ Cancel a launch that has not created its instance yet
17
+
18
+ Cancels an instance.create operation that is still pending or in_progress and has no resource_id yet. Nothing is created or billed for a cancelled launch; if the supplier finishes creating the machine after the cancel, it is terminated right away. Cancelling an operation that already finished returns it unchanged, so the call is safe to repeat. Scoped like GET /operations/{id}: only the key that started the operation can cancel it. Requires the `instances:write` scope.
19
+
20
+ ### Example
21
+
22
+ ```ts
23
+ import {
24
+ Configuration,
25
+ OperationsApi,
26
+ } from '@gpuai/sdk';
27
+ import type { CancelOperationRequest } from '@gpuai/sdk';
28
+
29
+ async function example() {
30
+ console.log("🚀 Testing @gpuai/sdk SDK...");
31
+ const config = new Configuration({
32
+ // Configure HTTP bearer authorization: bearerAuth
33
+ accessToken: "YOUR BEARER TOKEN",
34
+ });
35
+ const api = new OperationsApi(config);
36
+
37
+ const body = {
38
+ // string
39
+ id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
40
+ } satisfies CancelOperationRequest;
41
+
42
+ try {
43
+ const data = await api.cancelOperation(body);
44
+ console.log(data);
45
+ } catch (error) {
46
+ console.error(error);
47
+ }
48
+ }
49
+
50
+ // Run the test
51
+ example().catch(console.error);
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+
57
+ | Name | Type | Description | Notes |
58
+ |------------- | ------------- | ------------- | -------------|
59
+ | **id** | `string` | | [Defaults to `undefined`] |
60
+
61
+ ### Return type
62
+
63
+ [**Operation**](Operation.md)
64
+
65
+ ### Authorization
66
+
67
+ [bearerAuth](../README.md#bearerAuth)
68
+
69
+ ### HTTP request headers
70
+
71
+ - **Content-Type**: Not defined
72
+ - **Accept**: `application/json`, `application/problem+json`
73
+
74
+
75
+ ### HTTP response details
76
+ | Status code | Description | Response headers |
77
+ |-------------|-------------|------------------|
78
+ | **200** | The operation, `cancelled` unless it had already finished. | - |
79
+ | **404** | `not_found`. No operation with this id for this key. | - |
80
+ | **409** | `validation_failed`. The operation is not a launch, or the launch already created its instance. The detail names the instance to delete instead. | - |
81
+ | **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
82
+ | **0** | Error response (RFC 7807) | - |
83
+
84
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
85
+
86
+
11
87
  ## getOperation
12
88
 
13
89
  > Operation getOperation(id)
package/docs/Secret.md ADDED
@@ -0,0 +1,45 @@
1
+
2
+ # Secret
3
+
4
+ An organization secret\'s metadata. There is no value field: values are write-only and never returned.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `name` | string
11
+ `description` | string
12
+ `version` | number
13
+ `createdAt` | Date
14
+ `updatedAt` | Date
15
+ `lastUsedAt` | Date
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import type { Secret } from '@gpuai/sdk'
21
+
22
+ // TODO: Update the object below with actual values
23
+ const example = {
24
+ "name": HF_TOKEN,
25
+ "description": null,
26
+ "version": null,
27
+ "createdAt": null,
28
+ "updatedAt": null,
29
+ "lastUsedAt": null,
30
+ } satisfies Secret
31
+
32
+ console.log(example)
33
+
34
+ // Convert the instance to a JSON string
35
+ const exampleJSON: string = JSON.stringify(example)
36
+ console.log(exampleJSON)
37
+
38
+ // Parse the JSON string back to an object
39
+ const exampleParsed = JSON.parse(exampleJSON) as Secret
40
+ console.log(exampleParsed)
41
+ ```
42
+
43
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
44
+
45
+
@@ -0,0 +1,38 @@
1
+
2
+ # SecretCreate
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `value` | string
11
+ `description` | string
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { SecretCreate } from '@gpuai/sdk'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "name": HF_TOKEN,
21
+ "value": null,
22
+ "description": null,
23
+ } satisfies SecretCreate
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 SecretCreate
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,36 @@
1
+
2
+ # SecretImportItem
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `value` | string
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { SecretImportItem } from '@gpuai/sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "name": null,
20
+ "value": null,
21
+ } satisfies SecretImportItem
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 SecretImportItem
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
+
@@ -0,0 +1,36 @@
1
+
2
+ # SecretImportRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `secrets` | [Array&lt;SecretImportItem&gt;](SecretImportItem.md)
10
+ `overwrite` | boolean
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { SecretImportRequest } from '@gpuai/sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "secrets": null,
20
+ "overwrite": null,
21
+ } satisfies SecretImportRequest
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 SecretImportRequest
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
+
@@ -0,0 +1,38 @@
1
+
2
+ # SecretImportResult
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `created` | Array&lt;string&gt;
10
+ `updated` | Array&lt;string&gt;
11
+ `skipped` | Array&lt;string&gt;
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { SecretImportResult } from '@gpuai/sdk'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "created": null,
21
+ "updated": null,
22
+ "skipped": null,
23
+ } satisfies SecretImportResult
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 SecretImportResult
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,34 @@
1
+
2
+ # SecretList
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array&lt;Secret&gt;](Secret.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { SecretList } from '@gpuai/sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies SecretList
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as SecretList
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,36 @@
1
+
2
+ # SecretPut
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `value` | string
10
+ `description` | string
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { SecretPut } from '@gpuai/sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "value": null,
20
+ "description": null,
21
+ } satisfies SecretPut
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 SecretPut
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
+