@scenario-labs/sdk 0.3.0 → 1.0.0

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 (180) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/README.md +40 -6
  3. package/client.d.mts +34 -14
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +34 -14
  6. package/client.d.ts.map +1 -1
  7. package/client.js +10 -0
  8. package/client.js.map +1 -1
  9. package/client.mjs +10 -0
  10. package/client.mjs.map +1 -1
  11. package/core/pagination.d.mts +153 -0
  12. package/core/pagination.d.mts.map +1 -0
  13. package/core/pagination.d.ts +153 -0
  14. package/core/pagination.d.ts.map +1 -0
  15. package/core/pagination.js +276 -0
  16. package/core/pagination.js.map +1 -0
  17. package/core/pagination.mjs +263 -0
  18. package/core/pagination.mjs.map +1 -0
  19. package/index.d.mts +2 -0
  20. package/index.d.mts.map +1 -1
  21. package/index.d.ts +2 -0
  22. package/index.d.ts.map +1 -1
  23. package/index.js +7 -1
  24. package/index.js.map +1 -1
  25. package/index.mjs +2 -0
  26. package/index.mjs.map +1 -1
  27. package/lib/models.d.mts +34 -2
  28. package/lib/models.d.mts.map +1 -1
  29. package/lib/models.d.ts +34 -2
  30. package/lib/models.d.ts.map +1 -1
  31. package/lib/models.js +39 -2
  32. package/lib/models.js.map +1 -1
  33. package/lib/models.mjs +37 -1
  34. package/lib/models.mjs.map +1 -1
  35. package/lib/scenario.d.mts +2 -0
  36. package/lib/scenario.d.mts.map +1 -1
  37. package/lib/scenario.d.ts +2 -0
  38. package/lib/scenario.d.ts.map +1 -1
  39. package/lib/scenario.js +2 -0
  40. package/lib/scenario.js.map +1 -1
  41. package/lib/scenario.mjs +2 -0
  42. package/lib/scenario.mjs.map +1 -1
  43. package/lib/upload.d.mts +89 -0
  44. package/lib/upload.d.mts.map +1 -0
  45. package/lib/upload.d.ts +89 -0
  46. package/lib/upload.d.ts.map +1 -0
  47. package/lib/upload.js +193 -0
  48. package/lib/upload.js.map +1 -0
  49. package/lib/upload.mjs +156 -0
  50. package/lib/upload.mjs.map +1 -0
  51. package/lib/workflow.d.mts +13 -2
  52. package/lib/workflow.d.mts.map +1 -1
  53. package/lib/workflow.d.ts +13 -2
  54. package/lib/workflow.d.ts.map +1 -1
  55. package/lib/workflow.js +17 -4
  56. package/lib/workflow.js.map +1 -1
  57. package/lib/workflow.mjs +17 -4
  58. package/lib/workflow.mjs.map +1 -1
  59. package/lib/workflow_import_validator.d.mts +40 -0
  60. package/lib/workflow_import_validator.d.mts.map +1 -0
  61. package/lib/workflow_import_validator.d.ts +40 -0
  62. package/lib/workflow_import_validator.d.ts.map +1 -0
  63. package/lib/workflow_import_validator.js +69 -0
  64. package/lib/workflow_import_validator.js.map +1 -0
  65. package/lib/workflow_import_validator.mjs +64 -0
  66. package/lib/workflow_import_validator.mjs.map +1 -0
  67. package/package.json +11 -1
  68. package/pagination.d.mts +2 -0
  69. package/pagination.d.mts.map +1 -0
  70. package/pagination.d.ts +2 -0
  71. package/pagination.d.ts.map +1 -0
  72. package/pagination.js +6 -0
  73. package/pagination.js.map +1 -0
  74. package/pagination.mjs +2 -0
  75. package/pagination.mjs.map +1 -0
  76. package/resources/assets/assets.d.mts +623 -646
  77. package/resources/assets/assets.d.mts.map +1 -1
  78. package/resources/assets/assets.d.ts +623 -646
  79. package/resources/assets/assets.d.ts.map +1 -1
  80. package/resources/assets/assets.js +3 -2
  81. package/resources/assets/assets.js.map +1 -1
  82. package/resources/assets/assets.mjs +3 -2
  83. package/resources/assets/assets.mjs.map +1 -1
  84. package/resources/assets/index.d.mts +1 -1
  85. package/resources/assets/index.d.mts.map +1 -1
  86. package/resources/assets/index.d.ts +1 -1
  87. package/resources/assets/index.d.ts.map +1 -1
  88. package/resources/assets/index.js.map +1 -1
  89. package/resources/assets/index.mjs.map +1 -1
  90. package/resources/collections/collections.d.mts +38 -49
  91. package/resources/collections/collections.d.mts.map +1 -1
  92. package/resources/collections/collections.d.ts +38 -49
  93. package/resources/collections/collections.d.ts.map +1 -1
  94. package/resources/collections/collections.js +5 -1
  95. package/resources/collections/collections.js.map +1 -1
  96. package/resources/collections/collections.mjs +5 -1
  97. package/resources/collections/collections.mjs.map +1 -1
  98. package/resources/collections/index.d.mts +1 -1
  99. package/resources/collections/index.d.mts.map +1 -1
  100. package/resources/collections/index.d.ts +1 -1
  101. package/resources/collections/index.d.ts.map +1 -1
  102. package/resources/collections/index.js.map +1 -1
  103. package/resources/collections/index.mjs.map +1 -1
  104. package/resources/index.d.mts +7 -7
  105. package/resources/index.d.mts.map +1 -1
  106. package/resources/index.d.ts +7 -7
  107. package/resources/index.d.ts.map +1 -1
  108. package/resources/index.js.map +1 -1
  109. package/resources/index.mjs.map +1 -1
  110. package/resources/jobs.d.mts +369 -380
  111. package/resources/jobs.d.mts.map +1 -1
  112. package/resources/jobs.d.ts +369 -380
  113. package/resources/jobs.d.ts.map +1 -1
  114. package/resources/jobs.js +2 -1
  115. package/resources/jobs.js.map +1 -1
  116. package/resources/jobs.mjs +2 -1
  117. package/resources/jobs.mjs.map +1 -1
  118. package/resources/models/index.d.mts +1 -1
  119. package/resources/models/index.d.mts.map +1 -1
  120. package/resources/models/index.d.ts +1 -1
  121. package/resources/models/index.d.ts.map +1 -1
  122. package/resources/models/index.js.map +1 -1
  123. package/resources/models/index.mjs.map +1 -1
  124. package/resources/models/models.d.mts +839 -850
  125. package/resources/models/models.d.mts.map +1 -1
  126. package/resources/models/models.d.ts +839 -850
  127. package/resources/models/models.d.ts.map +1 -1
  128. package/resources/models/models.js +2 -1
  129. package/resources/models/models.js.map +1 -1
  130. package/resources/models/models.mjs +2 -1
  131. package/resources/models/models.mjs.map +1 -1
  132. package/resources/search.d.mts +215 -295
  133. package/resources/search.d.mts.map +1 -1
  134. package/resources/search.d.ts +215 -295
  135. package/resources/search.d.ts.map +1 -1
  136. package/resources/search.js +9 -2
  137. package/resources/search.js.map +1 -1
  138. package/resources/search.mjs +9 -2
  139. package/resources/search.mjs.map +1 -1
  140. package/resources/tags.d.mts +23 -35
  141. package/resources/tags.d.mts.map +1 -1
  142. package/resources/tags.d.ts +23 -35
  143. package/resources/tags.d.ts.map +1 -1
  144. package/resources/tags.js +2 -1
  145. package/resources/tags.js.map +1 -1
  146. package/resources/tags.mjs +2 -1
  147. package/resources/tags.mjs.map +1 -1
  148. package/resources/workflows.d.mts +688 -704
  149. package/resources/workflows.d.mts.map +1 -1
  150. package/resources/workflows.d.ts +688 -704
  151. package/resources/workflows.d.ts.map +1 -1
  152. package/resources/workflows.js +5 -1
  153. package/resources/workflows.js.map +1 -1
  154. package/resources/workflows.mjs +5 -1
  155. package/resources/workflows.mjs.map +1 -1
  156. package/src/client.ts +103 -2
  157. package/src/core/pagination.ts +497 -0
  158. package/src/index.ts +8 -0
  159. package/src/lib/models.ts +62 -2
  160. package/src/lib/scenario.ts +2 -0
  161. package/src/lib/upload.ts +250 -0
  162. package/src/lib/workflow.ts +29 -4
  163. package/src/lib/workflow_import_validator.ts +104 -0
  164. package/src/pagination.ts +2 -0
  165. package/src/resources/assets/assets.ts +887 -902
  166. package/src/resources/assets/index.ts +2 -0
  167. package/src/resources/collections/collections.ts +45 -54
  168. package/src/resources/collections/index.ts +1 -0
  169. package/src/resources/index.ts +9 -1
  170. package/src/resources/jobs.ts +613 -622
  171. package/src/resources/models/index.ts +1 -0
  172. package/src/resources/models/models.ts +1052 -1064
  173. package/src/resources/search.ts +239 -327
  174. package/src/resources/tags.ts +32 -39
  175. package/src/resources/workflows.ts +850 -864
  176. package/src/version.ts +1 -1
  177. package/version.d.mts +1 -1
  178. package/version.d.ts +1 -1
  179. package/version.js +1 -1
  180. package/version.mjs +1 -1
@@ -24,6 +24,8 @@ export {
24
24
  type AssetUnlockParams,
25
25
  type AssetUpdateTagsParams,
26
26
  type AssetUploadParams,
27
+ type AssetListResponsesAssetsCursor,
28
+ type AssetListSnapshotsResponsesSnapshotsCursor,
27
29
  } from './assets';
28
30
  export {
29
31
  Download,
@@ -6,6 +6,7 @@ import { AssetAddParams, AssetAddResponse, AssetRemoveParams, AssetRemoveRespons
6
6
  import * as ModelsAPI from './models';
7
7
  import { ModelAddParams, ModelAddResponse, ModelRemoveParams, ModelRemoveResponse, Models } from './models';
8
8
  import { APIPromise } from '../../core/api-promise';
9
+ import { CollectionsCursor, type CollectionsCursorParams, PagePromise } from '../../core/pagination';
9
10
  import { RequestOptions } from '../../internal/request-options';
10
11
  import { path } from '../../internal/utils/path';
11
12
 
@@ -44,8 +45,11 @@ export class Collections extends APIResource {
44
45
  list(
45
46
  query: CollectionListParams | null | undefined = {},
46
47
  options?: RequestOptions,
47
- ): APIPromise<CollectionListResponse> {
48
- return this._client.get('/collections', { query, ...options });
48
+ ): PagePromise<CollectionListResponsesCollectionsCursor, CollectionListResponse> {
49
+ return this._client.getAPIList('/collections', CollectionsCursor<CollectionListResponse>, {
50
+ query,
51
+ ...options,
52
+ });
49
53
  }
50
54
 
51
55
  /**
@@ -56,6 +60,8 @@ export class Collections extends APIResource {
56
60
  }
57
61
  }
58
62
 
63
+ export type CollectionListResponsesCollectionsCursor = CollectionsCursor<CollectionListResponse>;
64
+
59
65
  export interface CollectionCreateResponse {
60
66
  collection: CollectionCreateResponse.Collection;
61
67
  }
@@ -228,64 +234,53 @@ export namespace CollectionUpdateResponse {
228
234
  }
229
235
 
230
236
  export interface CollectionListResponse {
231
- collections: Array<CollectionListResponse.Collection>;
232
-
233
237
  /**
234
- * A token to query the next page of collections
238
+ * The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
235
239
  */
236
- nextPaginationToken?: string;
237
- }
238
-
239
- export namespace CollectionListResponse {
240
- export interface Collection {
241
- /**
242
- * The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
243
- */
244
- id: string;
240
+ id: string;
245
241
 
246
- assetCount: number;
242
+ assetCount: number;
247
243
 
248
- /**
249
- * The collection creation date as an ISO string (example:
250
- * "2023-02-03T11:19:41.579Z")
251
- */
252
- createdAt: string;
244
+ /**
245
+ * The collection creation date as an ISO string (example:
246
+ * "2023-02-03T11:19:41.579Z")
247
+ */
248
+ createdAt: string;
253
249
 
254
- itemCount: number;
250
+ itemCount: number;
255
251
 
256
- modelCount: number;
252
+ modelCount: number;
257
253
 
258
- /**
259
- * The collection name
260
- */
261
- name: string;
254
+ /**
255
+ * The collection name
256
+ */
257
+ name: string;
262
258
 
263
- /**
264
- * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
265
- */
266
- ownerId: string;
259
+ /**
260
+ * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
261
+ */
262
+ ownerId: string;
267
263
 
268
- /**
269
- * The collection last update date as an ISO string (example:
270
- * "2023-02-03T11:19:41.579Z")
271
- */
272
- updatedAt: string;
264
+ /**
265
+ * The collection last update date as an ISO string (example:
266
+ * "2023-02-03T11:19:41.579Z")
267
+ */
268
+ updatedAt: string;
273
269
 
274
- /**
275
- * The thumbnail for the collection (if any)
276
- */
277
- thumbnail?: Collection.Thumbnail;
278
- }
270
+ /**
271
+ * The thumbnail for the collection (if any)
272
+ */
273
+ thumbnail?: CollectionListResponse.Thumbnail;
274
+ }
279
275
 
280
- export namespace Collection {
281
- /**
282
- * The thumbnail for the collection (if any)
283
- */
284
- export interface Thumbnail {
285
- assetId: string;
276
+ export namespace CollectionListResponse {
277
+ /**
278
+ * The thumbnail for the collection (if any)
279
+ */
280
+ export interface Thumbnail {
281
+ assetId: string;
286
282
 
287
- url: string;
288
- }
283
+ url: string;
289
284
  }
290
285
  }
291
286
 
@@ -311,17 +306,12 @@ export interface CollectionUpdateParams {
311
306
  thumbnail?: string;
312
307
  }
313
308
 
314
- export interface CollectionListParams {
309
+ export interface CollectionListParams extends CollectionsCursorParams {
315
310
  /**
316
311
  * The number of items to return in the response. The default value is 10, maximum
317
312
  * value is 100, minimum value is 1
318
313
  */
319
314
  pageSize?: number;
320
-
321
- /**
322
- * A token you received in a previous request to query the next page of items
323
- */
324
- paginationToken?: string;
325
315
  }
326
316
 
327
317
  Collections.Assets = Assets;
@@ -334,6 +324,7 @@ export declare namespace Collections {
334
324
  type CollectionUpdateResponse as CollectionUpdateResponse,
335
325
  type CollectionListResponse as CollectionListResponse,
336
326
  type CollectionDeleteResponse as CollectionDeleteResponse,
327
+ type CollectionListResponsesCollectionsCursor as CollectionListResponsesCollectionsCursor,
337
328
  type CollectionCreateParams as CollectionCreateParams,
338
329
  type CollectionUpdateParams as CollectionUpdateParams,
339
330
  type CollectionListParams as CollectionListParams,
@@ -17,6 +17,7 @@ export {
17
17
  type CollectionCreateParams,
18
18
  type CollectionUpdateParams,
19
19
  type CollectionListParams,
20
+ type CollectionListResponsesCollectionsCursor,
20
21
  } from './collections';
21
22
  export {
22
23
  Models,
@@ -24,6 +24,8 @@ export {
24
24
  type AssetUnlockParams,
25
25
  type AssetUpdateTagsParams,
26
26
  type AssetUploadParams,
27
+ type AssetListResponsesAssetsCursor,
28
+ type AssetListSnapshotsResponsesSnapshotsCursor,
27
29
  } from './assets/assets';
28
30
  export {
29
31
  Collections,
@@ -35,6 +37,7 @@ export {
35
37
  type CollectionCreateParams,
36
38
  type CollectionUpdateParams,
37
39
  type CollectionListParams,
40
+ type CollectionListResponsesCollectionsCursor,
38
41
  } from './collections/collections';
39
42
  export {
40
43
  Generate,
@@ -60,6 +63,7 @@ export {
60
63
  type JobTriggerActionResponse,
61
64
  type JobListParams,
62
65
  type JobTriggerActionParams,
66
+ type JobListResponsesJobsCursor,
63
67
  } from './jobs';
64
68
  export {
65
69
  Models,
@@ -84,6 +88,7 @@ export {
84
88
  type ModelGetBulkParams,
85
89
  type ModelTransferParams,
86
90
  type ModelUpdateTagsParams,
91
+ type ModelListResponsesModelsCursor,
87
92
  } from './models/models';
88
93
  export { Oscu, type OscuRetrievePricesResponse } from './oscu';
89
94
  export {
@@ -92,8 +97,10 @@ export {
92
97
  type SearchModelSearchResponse,
93
98
  type SearchAssetSearchParams,
94
99
  type SearchModelSearchParams,
100
+ type SearchAssetSearchResponsesSearchHitsOffset,
101
+ type SearchModelSearchResponsesSearchHitsOffset,
95
102
  } from './search';
96
- export { Tags, type TagListResponse, type TagListParams } from './tags';
103
+ export { Tags, type TagListResponse, type TagListParams, type TagListResponsesTagsCursor } from './tags';
97
104
  export {
98
105
  Uploads,
99
106
  type UploadCreateResponse,
@@ -119,4 +126,5 @@ export {
119
126
  type WorkflowApproveUserParams,
120
127
  type WorkflowGetTagsParams,
121
128
  type WorkflowRunParams,
129
+ type WorkflowListResponsesWorkflowsCursor,
122
130
  } from './workflows';