@daytonaio/api-client 0.109.0 → 0.110.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.
@@ -29,21 +29,21 @@ export declare const SandboxApiAxiosParamCreator: (configuration?: Configuration
29
29
  /**
30
30
  *
31
31
  * @summary Archive sandbox
32
- * @param {string} sandboxId
32
+ * @param {string} sandboxIdOrName
33
33
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
34
34
  * @param {*} [options] Override http request option.
35
35
  * @throws {RequiredError}
36
36
  */
37
- archiveSandbox: (sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
37
+ archiveSandbox: (sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
38
38
  /**
39
39
  *
40
40
  * @summary Create sandbox backup
41
- * @param {string} sandboxId ID of the sandbox
41
+ * @param {string} sandboxIdOrName ID or name of the sandbox
42
42
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
43
43
  * @param {*} [options] Override http request option.
44
44
  * @throws {RequiredError}
45
45
  */
46
- createBackup: (sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46
+ createBackup: (sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47
47
  /**
48
48
  *
49
49
  * @summary Create a new sandbox
@@ -56,52 +56,52 @@ export declare const SandboxApiAxiosParamCreator: (configuration?: Configuration
56
56
  /**
57
57
  *
58
58
  * @summary Create SSH access for sandbox
59
- * @param {string} sandboxId ID of the sandbox
59
+ * @param {string} sandboxIdOrName ID or name of the sandbox
60
60
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
61
61
  * @param {number} [expiresInMinutes] Expiration time in minutes (default: 60)
62
62
  * @param {*} [options] Override http request option.
63
63
  * @throws {RequiredError}
64
64
  */
65
- createSshAccess: (sandboxId: string, xDaytonaOrganizationID?: string, expiresInMinutes?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
65
+ createSshAccess: (sandboxIdOrName: string, xDaytonaOrganizationID?: string, expiresInMinutes?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
66
66
  /**
67
67
  *
68
68
  * @summary Delete sandbox
69
- * @param {string} sandboxId ID of the sandbox
69
+ * @param {string} sandboxIdOrName ID or name of the sandbox
70
70
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
71
71
  * @param {*} [options] Override http request option.
72
72
  * @throws {RequiredError}
73
73
  */
74
- deleteSandbox: (sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
74
+ deleteSandbox: (sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
75
75
  /**
76
76
  *
77
77
  * @summary Get build logs
78
- * @param {string} sandboxId ID of the sandbox
78
+ * @param {string} sandboxIdOrName ID or name of the sandbox
79
79
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
80
80
  * @param {boolean} [follow] Whether to follow the logs stream
81
81
  * @param {*} [options] Override http request option.
82
82
  * @throws {RequiredError}
83
83
  */
84
- getBuildLogs: (sandboxId: string, xDaytonaOrganizationID?: string, follow?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
84
+ getBuildLogs: (sandboxIdOrName: string, xDaytonaOrganizationID?: string, follow?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
85
85
  /**
86
86
  *
87
87
  * @summary Get preview URL for a sandbox port
88
- * @param {string} sandboxId ID of the sandbox
88
+ * @param {string} sandboxIdOrName ID or name of the sandbox
89
89
  * @param {number} port Port number to get preview URL for
90
90
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
91
91
  * @param {*} [options] Override http request option.
92
92
  * @throws {RequiredError}
93
93
  */
94
- getPortPreviewUrl: (sandboxId: string, port: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
94
+ getPortPreviewUrl: (sandboxIdOrName: string, port: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
95
95
  /**
96
96
  *
97
97
  * @summary Get sandbox details
98
- * @param {string} sandboxId ID of the sandbox
98
+ * @param {string} sandboxIdOrName ID or name of the sandbox
99
99
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
100
100
  * @param {boolean} [verbose] Include verbose output
101
101
  * @param {*} [options] Override http request option.
102
102
  * @throws {RequiredError}
103
103
  */
104
- getSandbox: (sandboxId: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
104
+ getSandbox: (sandboxIdOrName: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
105
105
  /**
106
106
  *
107
107
  * @summary List all regions where sandboxes have been created
@@ -138,6 +138,7 @@ export declare const SandboxApiAxiosParamCreator: (configuration?: Configuration
138
138
  * @param {number} [page] Page number of the results
139
139
  * @param {number} [limit] Number of results per page
140
140
  * @param {string} [id] Filter by partial ID match
141
+ * @param {string} [name] Filter by partial name match
141
142
  * @param {string} [labels] JSON encoded labels to filter by
142
143
  * @param {boolean} [includeErroredDeleted] Include results with errored state and deleted desired state
143
144
  * @param {Array<ListSandboxesPaginatedStatesEnum>} [states] List of states to filter by
@@ -156,85 +157,85 @@ export declare const SandboxApiAxiosParamCreator: (configuration?: Configuration
156
157
  * @param {*} [options] Override http request option.
157
158
  * @throws {RequiredError}
158
159
  */
159
- listSandboxesPaginated: (xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
160
+ listSandboxesPaginated: (xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, name?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
160
161
  /**
161
162
  *
162
163
  * @summary Replace sandbox labels
163
- * @param {string} sandboxId ID of the sandbox
164
+ * @param {string} sandboxIdOrName ID or name of the sandbox
164
165
  * @param {SandboxLabels} sandboxLabels
165
166
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
166
167
  * @param {*} [options] Override http request option.
167
168
  * @throws {RequiredError}
168
169
  */
169
- replaceLabels: (sandboxId: string, sandboxLabels: SandboxLabels, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
170
+ replaceLabels: (sandboxIdOrName: string, sandboxLabels: SandboxLabels, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
170
171
  /**
171
172
  *
172
173
  * @summary Revoke SSH access for sandbox
173
- * @param {string} sandboxId ID of the sandbox
174
+ * @param {string} sandboxIdOrName ID or name of the sandbox
174
175
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
175
176
  * @param {string} [token] SSH access token to revoke. If not provided, all SSH access for the sandbox will be revoked.
176
177
  * @param {*} [options] Override http request option.
177
178
  * @throws {RequiredError}
178
179
  */
179
- revokeSshAccess: (sandboxId: string, xDaytonaOrganizationID?: string, token?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
180
+ revokeSshAccess: (sandboxIdOrName: string, xDaytonaOrganizationID?: string, token?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
180
181
  /**
181
182
  *
182
183
  * @summary Set sandbox auto-archive interval
183
- * @param {string} sandboxId ID of the sandbox
184
+ * @param {string} sandboxIdOrName ID or name of the sandbox
184
185
  * @param {number} interval Auto-archive interval in minutes (0 means the maximum interval will be used)
185
186
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
186
187
  * @param {*} [options] Override http request option.
187
188
  * @throws {RequiredError}
188
189
  */
189
- setAutoArchiveInterval: (sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
190
+ setAutoArchiveInterval: (sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
190
191
  /**
191
192
  *
192
193
  * @summary Set sandbox auto-delete interval
193
- * @param {string} sandboxId ID of the sandbox
194
+ * @param {string} sandboxIdOrName ID or name of the sandbox
194
195
  * @param {number} interval Auto-delete interval in minutes (negative value means disabled, 0 means delete immediately upon stopping)
195
196
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
196
197
  * @param {*} [options] Override http request option.
197
198
  * @throws {RequiredError}
198
199
  */
199
- setAutoDeleteInterval: (sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
200
+ setAutoDeleteInterval: (sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
200
201
  /**
201
202
  *
202
203
  * @summary Set sandbox auto-stop interval
203
- * @param {string} sandboxId ID of the sandbox
204
+ * @param {string} sandboxIdOrName ID or name of the sandbox
204
205
  * @param {number} interval Auto-stop interval in minutes (0 to disable)
205
206
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
206
207
  * @param {*} [options] Override http request option.
207
208
  * @throws {RequiredError}
208
209
  */
209
- setAutostopInterval: (sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
210
+ setAutostopInterval: (sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
210
211
  /**
211
212
  *
212
213
  * @summary Start sandbox
213
- * @param {string} sandboxId ID of the sandbox
214
+ * @param {string} sandboxIdOrName ID or name of the sandbox
214
215
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
215
216
  * @param {*} [options] Override http request option.
216
217
  * @throws {RequiredError}
217
218
  */
218
- startSandbox: (sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
219
+ startSandbox: (sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
219
220
  /**
220
221
  *
221
222
  * @summary Stop sandbox
222
- * @param {string} sandboxId ID of the sandbox
223
+ * @param {string} sandboxIdOrName ID or name of the sandbox
223
224
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
224
225
  * @param {*} [options] Override http request option.
225
226
  * @throws {RequiredError}
226
227
  */
227
- stopSandbox: (sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
228
+ stopSandbox: (sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
228
229
  /**
229
230
  *
230
231
  * @summary Update public status
231
- * @param {string} sandboxId ID of the sandbox
232
+ * @param {string} sandboxIdOrName ID or name of the sandbox
232
233
  * @param {boolean} isPublic Public status to set
233
234
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
234
235
  * @param {*} [options] Override http request option.
235
236
  * @throws {RequiredError}
236
237
  */
237
- updatePublicStatus: (sandboxId: string, isPublic: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
238
+ updatePublicStatus: (sandboxIdOrName: string, isPublic: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
238
239
  /**
239
240
  *
240
241
  * @summary Update sandbox state
@@ -263,21 +264,21 @@ export declare const SandboxApiFp: (configuration?: Configuration) => {
263
264
  /**
264
265
  *
265
266
  * @summary Archive sandbox
266
- * @param {string} sandboxId
267
+ * @param {string} sandboxIdOrName
267
268
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
268
269
  * @param {*} [options] Override http request option.
269
270
  * @throws {RequiredError}
270
271
  */
271
- archiveSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
272
+ archiveSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
272
273
  /**
273
274
  *
274
275
  * @summary Create sandbox backup
275
- * @param {string} sandboxId ID of the sandbox
276
+ * @param {string} sandboxIdOrName ID or name of the sandbox
276
277
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
277
278
  * @param {*} [options] Override http request option.
278
279
  * @throws {RequiredError}
279
280
  */
280
- createBackup(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
281
+ createBackup(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
281
282
  /**
282
283
  *
283
284
  * @summary Create a new sandbox
@@ -290,52 +291,52 @@ export declare const SandboxApiFp: (configuration?: Configuration) => {
290
291
  /**
291
292
  *
292
293
  * @summary Create SSH access for sandbox
293
- * @param {string} sandboxId ID of the sandbox
294
+ * @param {string} sandboxIdOrName ID or name of the sandbox
294
295
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
295
296
  * @param {number} [expiresInMinutes] Expiration time in minutes (default: 60)
296
297
  * @param {*} [options] Override http request option.
297
298
  * @throws {RequiredError}
298
299
  */
299
- createSshAccess(sandboxId: string, xDaytonaOrganizationID?: string, expiresInMinutes?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SshAccessDto>>;
300
+ createSshAccess(sandboxIdOrName: string, xDaytonaOrganizationID?: string, expiresInMinutes?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SshAccessDto>>;
300
301
  /**
301
302
  *
302
303
  * @summary Delete sandbox
303
- * @param {string} sandboxId ID of the sandbox
304
+ * @param {string} sandboxIdOrName ID or name of the sandbox
304
305
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
305
306
  * @param {*} [options] Override http request option.
306
307
  * @throws {RequiredError}
307
308
  */
308
- deleteSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
309
+ deleteSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
309
310
  /**
310
311
  *
311
312
  * @summary Get build logs
312
- * @param {string} sandboxId ID of the sandbox
313
+ * @param {string} sandboxIdOrName ID or name of the sandbox
313
314
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
314
315
  * @param {boolean} [follow] Whether to follow the logs stream
315
316
  * @param {*} [options] Override http request option.
316
317
  * @throws {RequiredError}
317
318
  */
318
- getBuildLogs(sandboxId: string, xDaytonaOrganizationID?: string, follow?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
319
+ getBuildLogs(sandboxIdOrName: string, xDaytonaOrganizationID?: string, follow?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
319
320
  /**
320
321
  *
321
322
  * @summary Get preview URL for a sandbox port
322
- * @param {string} sandboxId ID of the sandbox
323
+ * @param {string} sandboxIdOrName ID or name of the sandbox
323
324
  * @param {number} port Port number to get preview URL for
324
325
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
325
326
  * @param {*} [options] Override http request option.
326
327
  * @throws {RequiredError}
327
328
  */
328
- getPortPreviewUrl(sandboxId: string, port: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortPreviewUrl>>;
329
+ getPortPreviewUrl(sandboxIdOrName: string, port: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortPreviewUrl>>;
329
330
  /**
330
331
  *
331
332
  * @summary Get sandbox details
332
- * @param {string} sandboxId ID of the sandbox
333
+ * @param {string} sandboxIdOrName ID or name of the sandbox
333
334
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
334
335
  * @param {boolean} [verbose] Include verbose output
335
336
  * @param {*} [options] Override http request option.
336
337
  * @throws {RequiredError}
337
338
  */
338
- getSandbox(sandboxId: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
339
+ getSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
339
340
  /**
340
341
  *
341
342
  * @summary List all regions where sandboxes have been created
@@ -372,6 +373,7 @@ export declare const SandboxApiFp: (configuration?: Configuration) => {
372
373
  * @param {number} [page] Page number of the results
373
374
  * @param {number} [limit] Number of results per page
374
375
  * @param {string} [id] Filter by partial ID match
376
+ * @param {string} [name] Filter by partial name match
375
377
  * @param {string} [labels] JSON encoded labels to filter by
376
378
  * @param {boolean} [includeErroredDeleted] Include results with errored state and deleted desired state
377
379
  * @param {Array<ListSandboxesPaginatedStatesEnum>} [states] List of states to filter by
@@ -390,85 +392,85 @@ export declare const SandboxApiFp: (configuration?: Configuration) => {
390
392
  * @param {*} [options] Override http request option.
391
393
  * @throws {RequiredError}
392
394
  */
393
- listSandboxesPaginated(xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedSandboxes>>;
395
+ listSandboxesPaginated(xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, name?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedSandboxes>>;
394
396
  /**
395
397
  *
396
398
  * @summary Replace sandbox labels
397
- * @param {string} sandboxId ID of the sandbox
399
+ * @param {string} sandboxIdOrName ID or name of the sandbox
398
400
  * @param {SandboxLabels} sandboxLabels
399
401
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
400
402
  * @param {*} [options] Override http request option.
401
403
  * @throws {RequiredError}
402
404
  */
403
- replaceLabels(sandboxId: string, sandboxLabels: SandboxLabels, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SandboxLabels>>;
405
+ replaceLabels(sandboxIdOrName: string, sandboxLabels: SandboxLabels, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SandboxLabels>>;
404
406
  /**
405
407
  *
406
408
  * @summary Revoke SSH access for sandbox
407
- * @param {string} sandboxId ID of the sandbox
409
+ * @param {string} sandboxIdOrName ID or name of the sandbox
408
410
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
409
411
  * @param {string} [token] SSH access token to revoke. If not provided, all SSH access for the sandbox will be revoked.
410
412
  * @param {*} [options] Override http request option.
411
413
  * @throws {RequiredError}
412
414
  */
413
- revokeSshAccess(sandboxId: string, xDaytonaOrganizationID?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
415
+ revokeSshAccess(sandboxIdOrName: string, xDaytonaOrganizationID?: string, token?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
414
416
  /**
415
417
  *
416
418
  * @summary Set sandbox auto-archive interval
417
- * @param {string} sandboxId ID of the sandbox
419
+ * @param {string} sandboxIdOrName ID or name of the sandbox
418
420
  * @param {number} interval Auto-archive interval in minutes (0 means the maximum interval will be used)
419
421
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
420
422
  * @param {*} [options] Override http request option.
421
423
  * @throws {RequiredError}
422
424
  */
423
- setAutoArchiveInterval(sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
425
+ setAutoArchiveInterval(sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
424
426
  /**
425
427
  *
426
428
  * @summary Set sandbox auto-delete interval
427
- * @param {string} sandboxId ID of the sandbox
429
+ * @param {string} sandboxIdOrName ID or name of the sandbox
428
430
  * @param {number} interval Auto-delete interval in minutes (negative value means disabled, 0 means delete immediately upon stopping)
429
431
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
430
432
  * @param {*} [options] Override http request option.
431
433
  * @throws {RequiredError}
432
434
  */
433
- setAutoDeleteInterval(sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
435
+ setAutoDeleteInterval(sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
434
436
  /**
435
437
  *
436
438
  * @summary Set sandbox auto-stop interval
437
- * @param {string} sandboxId ID of the sandbox
439
+ * @param {string} sandboxIdOrName ID or name of the sandbox
438
440
  * @param {number} interval Auto-stop interval in minutes (0 to disable)
439
441
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
440
442
  * @param {*} [options] Override http request option.
441
443
  * @throws {RequiredError}
442
444
  */
443
- setAutostopInterval(sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
445
+ setAutostopInterval(sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
444
446
  /**
445
447
  *
446
448
  * @summary Start sandbox
447
- * @param {string} sandboxId ID of the sandbox
449
+ * @param {string} sandboxIdOrName ID or name of the sandbox
448
450
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
449
451
  * @param {*} [options] Override http request option.
450
452
  * @throws {RequiredError}
451
453
  */
452
- startSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
454
+ startSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
453
455
  /**
454
456
  *
455
457
  * @summary Stop sandbox
456
- * @param {string} sandboxId ID of the sandbox
458
+ * @param {string} sandboxIdOrName ID or name of the sandbox
457
459
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
458
460
  * @param {*} [options] Override http request option.
459
461
  * @throws {RequiredError}
460
462
  */
461
- stopSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
463
+ stopSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
462
464
  /**
463
465
  *
464
466
  * @summary Update public status
465
- * @param {string} sandboxId ID of the sandbox
467
+ * @param {string} sandboxIdOrName ID or name of the sandbox
466
468
  * @param {boolean} isPublic Public status to set
467
469
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
468
470
  * @param {*} [options] Override http request option.
469
471
  * @throws {RequiredError}
470
472
  */
471
- updatePublicStatus(sandboxId: string, isPublic: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
473
+ updatePublicStatus(sandboxIdOrName: string, isPublic: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Sandbox>>;
472
474
  /**
473
475
  *
474
476
  * @summary Update sandbox state
@@ -497,21 +499,21 @@ export declare const SandboxApiFactory: (configuration?: Configuration, basePath
497
499
  /**
498
500
  *
499
501
  * @summary Archive sandbox
500
- * @param {string} sandboxId
502
+ * @param {string} sandboxIdOrName
501
503
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
502
504
  * @param {*} [options] Override http request option.
503
505
  * @throws {RequiredError}
504
506
  */
505
- archiveSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
507
+ archiveSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
506
508
  /**
507
509
  *
508
510
  * @summary Create sandbox backup
509
- * @param {string} sandboxId ID of the sandbox
511
+ * @param {string} sandboxIdOrName ID or name of the sandbox
510
512
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
511
513
  * @param {*} [options] Override http request option.
512
514
  * @throws {RequiredError}
513
515
  */
514
- createBackup(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
516
+ createBackup(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
515
517
  /**
516
518
  *
517
519
  * @summary Create a new sandbox
@@ -524,52 +526,52 @@ export declare const SandboxApiFactory: (configuration?: Configuration, basePath
524
526
  /**
525
527
  *
526
528
  * @summary Create SSH access for sandbox
527
- * @param {string} sandboxId ID of the sandbox
529
+ * @param {string} sandboxIdOrName ID or name of the sandbox
528
530
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
529
531
  * @param {number} [expiresInMinutes] Expiration time in minutes (default: 60)
530
532
  * @param {*} [options] Override http request option.
531
533
  * @throws {RequiredError}
532
534
  */
533
- createSshAccess(sandboxId: string, xDaytonaOrganizationID?: string, expiresInMinutes?: number, options?: RawAxiosRequestConfig): AxiosPromise<SshAccessDto>;
535
+ createSshAccess(sandboxIdOrName: string, xDaytonaOrganizationID?: string, expiresInMinutes?: number, options?: RawAxiosRequestConfig): AxiosPromise<SshAccessDto>;
534
536
  /**
535
537
  *
536
538
  * @summary Delete sandbox
537
- * @param {string} sandboxId ID of the sandbox
539
+ * @param {string} sandboxIdOrName ID or name of the sandbox
538
540
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
539
541
  * @param {*} [options] Override http request option.
540
542
  * @throws {RequiredError}
541
543
  */
542
- deleteSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
544
+ deleteSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
543
545
  /**
544
546
  *
545
547
  * @summary Get build logs
546
- * @param {string} sandboxId ID of the sandbox
548
+ * @param {string} sandboxIdOrName ID or name of the sandbox
547
549
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
548
550
  * @param {boolean} [follow] Whether to follow the logs stream
549
551
  * @param {*} [options] Override http request option.
550
552
  * @throws {RequiredError}
551
553
  */
552
- getBuildLogs(sandboxId: string, xDaytonaOrganizationID?: string, follow?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
554
+ getBuildLogs(sandboxIdOrName: string, xDaytonaOrganizationID?: string, follow?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<void>;
553
555
  /**
554
556
  *
555
557
  * @summary Get preview URL for a sandbox port
556
- * @param {string} sandboxId ID of the sandbox
558
+ * @param {string} sandboxIdOrName ID or name of the sandbox
557
559
  * @param {number} port Port number to get preview URL for
558
560
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
559
561
  * @param {*} [options] Override http request option.
560
562
  * @throws {RequiredError}
561
563
  */
562
- getPortPreviewUrl(sandboxId: string, port: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<PortPreviewUrl>;
564
+ getPortPreviewUrl(sandboxIdOrName: string, port: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<PortPreviewUrl>;
563
565
  /**
564
566
  *
565
567
  * @summary Get sandbox details
566
- * @param {string} sandboxId ID of the sandbox
568
+ * @param {string} sandboxIdOrName ID or name of the sandbox
567
569
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
568
570
  * @param {boolean} [verbose] Include verbose output
569
571
  * @param {*} [options] Override http request option.
570
572
  * @throws {RequiredError}
571
573
  */
572
- getSandbox(sandboxId: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
574
+ getSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
573
575
  /**
574
576
  *
575
577
  * @summary List all regions where sandboxes have been created
@@ -606,6 +608,7 @@ export declare const SandboxApiFactory: (configuration?: Configuration, basePath
606
608
  * @param {number} [page] Page number of the results
607
609
  * @param {number} [limit] Number of results per page
608
610
  * @param {string} [id] Filter by partial ID match
611
+ * @param {string} [name] Filter by partial name match
609
612
  * @param {string} [labels] JSON encoded labels to filter by
610
613
  * @param {boolean} [includeErroredDeleted] Include results with errored state and deleted desired state
611
614
  * @param {Array<ListSandboxesPaginatedStatesEnum>} [states] List of states to filter by
@@ -624,85 +627,85 @@ export declare const SandboxApiFactory: (configuration?: Configuration, basePath
624
627
  * @param {*} [options] Override http request option.
625
628
  * @throws {RequiredError}
626
629
  */
627
- listSandboxesPaginated(xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedSandboxes>;
630
+ listSandboxesPaginated(xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, name?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedSandboxes>;
628
631
  /**
629
632
  *
630
633
  * @summary Replace sandbox labels
631
- * @param {string} sandboxId ID of the sandbox
634
+ * @param {string} sandboxIdOrName ID or name of the sandbox
632
635
  * @param {SandboxLabels} sandboxLabels
633
636
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
634
637
  * @param {*} [options] Override http request option.
635
638
  * @throws {RequiredError}
636
639
  */
637
- replaceLabels(sandboxId: string, sandboxLabels: SandboxLabels, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<SandboxLabels>;
640
+ replaceLabels(sandboxIdOrName: string, sandboxLabels: SandboxLabels, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<SandboxLabels>;
638
641
  /**
639
642
  *
640
643
  * @summary Revoke SSH access for sandbox
641
- * @param {string} sandboxId ID of the sandbox
644
+ * @param {string} sandboxIdOrName ID or name of the sandbox
642
645
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
643
646
  * @param {string} [token] SSH access token to revoke. If not provided, all SSH access for the sandbox will be revoked.
644
647
  * @param {*} [options] Override http request option.
645
648
  * @throws {RequiredError}
646
649
  */
647
- revokeSshAccess(sandboxId: string, xDaytonaOrganizationID?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
650
+ revokeSshAccess(sandboxIdOrName: string, xDaytonaOrganizationID?: string, token?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
648
651
  /**
649
652
  *
650
653
  * @summary Set sandbox auto-archive interval
651
- * @param {string} sandboxId ID of the sandbox
654
+ * @param {string} sandboxIdOrName ID or name of the sandbox
652
655
  * @param {number} interval Auto-archive interval in minutes (0 means the maximum interval will be used)
653
656
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
654
657
  * @param {*} [options] Override http request option.
655
658
  * @throws {RequiredError}
656
659
  */
657
- setAutoArchiveInterval(sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
660
+ setAutoArchiveInterval(sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
658
661
  /**
659
662
  *
660
663
  * @summary Set sandbox auto-delete interval
661
- * @param {string} sandboxId ID of the sandbox
664
+ * @param {string} sandboxIdOrName ID or name of the sandbox
662
665
  * @param {number} interval Auto-delete interval in minutes (negative value means disabled, 0 means delete immediately upon stopping)
663
666
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
664
667
  * @param {*} [options] Override http request option.
665
668
  * @throws {RequiredError}
666
669
  */
667
- setAutoDeleteInterval(sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
670
+ setAutoDeleteInterval(sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
668
671
  /**
669
672
  *
670
673
  * @summary Set sandbox auto-stop interval
671
- * @param {string} sandboxId ID of the sandbox
674
+ * @param {string} sandboxIdOrName ID or name of the sandbox
672
675
  * @param {number} interval Auto-stop interval in minutes (0 to disable)
673
676
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
674
677
  * @param {*} [options] Override http request option.
675
678
  * @throws {RequiredError}
676
679
  */
677
- setAutostopInterval(sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
680
+ setAutostopInterval(sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
678
681
  /**
679
682
  *
680
683
  * @summary Start sandbox
681
- * @param {string} sandboxId ID of the sandbox
684
+ * @param {string} sandboxIdOrName ID or name of the sandbox
682
685
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
683
686
  * @param {*} [options] Override http request option.
684
687
  * @throws {RequiredError}
685
688
  */
686
- startSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
689
+ startSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
687
690
  /**
688
691
  *
689
692
  * @summary Stop sandbox
690
- * @param {string} sandboxId ID of the sandbox
693
+ * @param {string} sandboxIdOrName ID or name of the sandbox
691
694
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
692
695
  * @param {*} [options] Override http request option.
693
696
  * @throws {RequiredError}
694
697
  */
695
- stopSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
698
+ stopSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
696
699
  /**
697
700
  *
698
701
  * @summary Update public status
699
- * @param {string} sandboxId ID of the sandbox
702
+ * @param {string} sandboxIdOrName ID or name of the sandbox
700
703
  * @param {boolean} isPublic Public status to set
701
704
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
702
705
  * @param {*} [options] Override http request option.
703
706
  * @throws {RequiredError}
704
707
  */
705
- updatePublicStatus(sandboxId: string, isPublic: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
708
+ updatePublicStatus(sandboxIdOrName: string, isPublic: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): AxiosPromise<Sandbox>;
706
709
  /**
707
710
  *
708
711
  * @summary Update sandbox state
@@ -733,23 +736,23 @@ export declare class SandboxApi extends BaseAPI {
733
736
  /**
734
737
  *
735
738
  * @summary Archive sandbox
736
- * @param {string} sandboxId
739
+ * @param {string} sandboxIdOrName
737
740
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
738
741
  * @param {*} [options] Override http request option.
739
742
  * @throws {RequiredError}
740
743
  * @memberof SandboxApi
741
744
  */
742
- archiveSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
745
+ archiveSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
743
746
  /**
744
747
  *
745
748
  * @summary Create sandbox backup
746
- * @param {string} sandboxId ID of the sandbox
749
+ * @param {string} sandboxIdOrName ID or name of the sandbox
747
750
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
748
751
  * @param {*} [options] Override http request option.
749
752
  * @throws {RequiredError}
750
753
  * @memberof SandboxApi
751
754
  */
752
- createBackup(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
755
+ createBackup(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
753
756
  /**
754
757
  *
755
758
  * @summary Create a new sandbox
@@ -763,57 +766,57 @@ export declare class SandboxApi extends BaseAPI {
763
766
  /**
764
767
  *
765
768
  * @summary Create SSH access for sandbox
766
- * @param {string} sandboxId ID of the sandbox
769
+ * @param {string} sandboxIdOrName ID or name of the sandbox
767
770
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
768
771
  * @param {number} [expiresInMinutes] Expiration time in minutes (default: 60)
769
772
  * @param {*} [options] Override http request option.
770
773
  * @throws {RequiredError}
771
774
  * @memberof SandboxApi
772
775
  */
773
- createSshAccess(sandboxId: string, xDaytonaOrganizationID?: string, expiresInMinutes?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SshAccessDto, any, {}>>;
776
+ createSshAccess(sandboxIdOrName: string, xDaytonaOrganizationID?: string, expiresInMinutes?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SshAccessDto, any, {}>>;
774
777
  /**
775
778
  *
776
779
  * @summary Delete sandbox
777
- * @param {string} sandboxId ID of the sandbox
780
+ * @param {string} sandboxIdOrName ID or name of the sandbox
778
781
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
779
782
  * @param {*} [options] Override http request option.
780
783
  * @throws {RequiredError}
781
784
  * @memberof SandboxApi
782
785
  */
783
- deleteSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
786
+ deleteSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
784
787
  /**
785
788
  *
786
789
  * @summary Get build logs
787
- * @param {string} sandboxId ID of the sandbox
790
+ * @param {string} sandboxIdOrName ID or name of the sandbox
788
791
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
789
792
  * @param {boolean} [follow] Whether to follow the logs stream
790
793
  * @param {*} [options] Override http request option.
791
794
  * @throws {RequiredError}
792
795
  * @memberof SandboxApi
793
796
  */
794
- getBuildLogs(sandboxId: string, xDaytonaOrganizationID?: string, follow?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
797
+ getBuildLogs(sandboxIdOrName: string, xDaytonaOrganizationID?: string, follow?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
795
798
  /**
796
799
  *
797
800
  * @summary Get preview URL for a sandbox port
798
- * @param {string} sandboxId ID of the sandbox
801
+ * @param {string} sandboxIdOrName ID or name of the sandbox
799
802
  * @param {number} port Port number to get preview URL for
800
803
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
801
804
  * @param {*} [options] Override http request option.
802
805
  * @throws {RequiredError}
803
806
  * @memberof SandboxApi
804
807
  */
805
- getPortPreviewUrl(sandboxId: string, port: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortPreviewUrl, any, {}>>;
808
+ getPortPreviewUrl(sandboxIdOrName: string, port: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortPreviewUrl, any, {}>>;
806
809
  /**
807
810
  *
808
811
  * @summary Get sandbox details
809
- * @param {string} sandboxId ID of the sandbox
812
+ * @param {string} sandboxIdOrName ID or name of the sandbox
810
813
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
811
814
  * @param {boolean} [verbose] Include verbose output
812
815
  * @param {*} [options] Override http request option.
813
816
  * @throws {RequiredError}
814
817
  * @memberof SandboxApi
815
818
  */
816
- getSandbox(sandboxId: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
819
+ getSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, verbose?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
817
820
  /**
818
821
  *
819
822
  * @summary List all regions where sandboxes have been created
@@ -853,6 +856,7 @@ export declare class SandboxApi extends BaseAPI {
853
856
  * @param {number} [page] Page number of the results
854
857
  * @param {number} [limit] Number of results per page
855
858
  * @param {string} [id] Filter by partial ID match
859
+ * @param {string} [name] Filter by partial name match
856
860
  * @param {string} [labels] JSON encoded labels to filter by
857
861
  * @param {boolean} [includeErroredDeleted] Include results with errored state and deleted desired state
858
862
  * @param {Array<ListSandboxesPaginatedStatesEnum>} [states] List of states to filter by
@@ -872,93 +876,93 @@ export declare class SandboxApi extends BaseAPI {
872
876
  * @throws {RequiredError}
873
877
  * @memberof SandboxApi
874
878
  */
875
- listSandboxesPaginated(xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedSandboxes, any, {}>>;
879
+ listSandboxesPaginated(xDaytonaOrganizationID?: string, page?: number, limit?: number, id?: string, name?: string, labels?: string, includeErroredDeleted?: boolean, states?: Array<ListSandboxesPaginatedStatesEnum>, snapshots?: Array<string>, regions?: Array<string>, minCpu?: number, maxCpu?: number, minMemoryGiB?: number, maxMemoryGiB?: number, minDiskGiB?: number, maxDiskGiB?: number, lastEventAfter?: Date, lastEventBefore?: Date, sort?: ListSandboxesPaginatedSortEnum, order?: ListSandboxesPaginatedOrderEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedSandboxes, any, {}>>;
876
880
  /**
877
881
  *
878
882
  * @summary Replace sandbox labels
879
- * @param {string} sandboxId ID of the sandbox
883
+ * @param {string} sandboxIdOrName ID or name of the sandbox
880
884
  * @param {SandboxLabels} sandboxLabels
881
885
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
882
886
  * @param {*} [options] Override http request option.
883
887
  * @throws {RequiredError}
884
888
  * @memberof SandboxApi
885
889
  */
886
- replaceLabels(sandboxId: string, sandboxLabels: SandboxLabels, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SandboxLabels, any, {}>>;
890
+ replaceLabels(sandboxIdOrName: string, sandboxLabels: SandboxLabels, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SandboxLabels, any, {}>>;
887
891
  /**
888
892
  *
889
893
  * @summary Revoke SSH access for sandbox
890
- * @param {string} sandboxId ID of the sandbox
894
+ * @param {string} sandboxIdOrName ID or name of the sandbox
891
895
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
892
896
  * @param {string} [token] SSH access token to revoke. If not provided, all SSH access for the sandbox will be revoked.
893
897
  * @param {*} [options] Override http request option.
894
898
  * @throws {RequiredError}
895
899
  * @memberof SandboxApi
896
900
  */
897
- revokeSshAccess(sandboxId: string, xDaytonaOrganizationID?: string, token?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
901
+ revokeSshAccess(sandboxIdOrName: string, xDaytonaOrganizationID?: string, token?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
898
902
  /**
899
903
  *
900
904
  * @summary Set sandbox auto-archive interval
901
- * @param {string} sandboxId ID of the sandbox
905
+ * @param {string} sandboxIdOrName ID or name of the sandbox
902
906
  * @param {number} interval Auto-archive interval in minutes (0 means the maximum interval will be used)
903
907
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
904
908
  * @param {*} [options] Override http request option.
905
909
  * @throws {RequiredError}
906
910
  * @memberof SandboxApi
907
911
  */
908
- setAutoArchiveInterval(sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
912
+ setAutoArchiveInterval(sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
909
913
  /**
910
914
  *
911
915
  * @summary Set sandbox auto-delete interval
912
- * @param {string} sandboxId ID of the sandbox
916
+ * @param {string} sandboxIdOrName ID or name of the sandbox
913
917
  * @param {number} interval Auto-delete interval in minutes (negative value means disabled, 0 means delete immediately upon stopping)
914
918
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
915
919
  * @param {*} [options] Override http request option.
916
920
  * @throws {RequiredError}
917
921
  * @memberof SandboxApi
918
922
  */
919
- setAutoDeleteInterval(sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
923
+ setAutoDeleteInterval(sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
920
924
  /**
921
925
  *
922
926
  * @summary Set sandbox auto-stop interval
923
- * @param {string} sandboxId ID of the sandbox
927
+ * @param {string} sandboxIdOrName ID or name of the sandbox
924
928
  * @param {number} interval Auto-stop interval in minutes (0 to disable)
925
929
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
926
930
  * @param {*} [options] Override http request option.
927
931
  * @throws {RequiredError}
928
932
  * @memberof SandboxApi
929
933
  */
930
- setAutostopInterval(sandboxId: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
934
+ setAutostopInterval(sandboxIdOrName: string, interval: number, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
931
935
  /**
932
936
  *
933
937
  * @summary Start sandbox
934
- * @param {string} sandboxId ID of the sandbox
938
+ * @param {string} sandboxIdOrName ID or name of the sandbox
935
939
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
936
940
  * @param {*} [options] Override http request option.
937
941
  * @throws {RequiredError}
938
942
  * @memberof SandboxApi
939
943
  */
940
- startSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
944
+ startSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
941
945
  /**
942
946
  *
943
947
  * @summary Stop sandbox
944
- * @param {string} sandboxId ID of the sandbox
948
+ * @param {string} sandboxIdOrName ID or name of the sandbox
945
949
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
946
950
  * @param {*} [options] Override http request option.
947
951
  * @throws {RequiredError}
948
952
  * @memberof SandboxApi
949
953
  */
950
- stopSandbox(sandboxId: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
954
+ stopSandbox(sandboxIdOrName: string, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
951
955
  /**
952
956
  *
953
957
  * @summary Update public status
954
- * @param {string} sandboxId ID of the sandbox
958
+ * @param {string} sandboxIdOrName ID or name of the sandbox
955
959
  * @param {boolean} isPublic Public status to set
956
960
  * @param {string} [xDaytonaOrganizationID] Use with JWT to specify the organization ID
957
961
  * @param {*} [options] Override http request option.
958
962
  * @throws {RequiredError}
959
963
  * @memberof SandboxApi
960
964
  */
961
- updatePublicStatus(sandboxId: string, isPublic: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
965
+ updatePublicStatus(sandboxIdOrName: string, isPublic: boolean, xDaytonaOrganizationID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Sandbox, any, {}>>;
962
966
  /**
963
967
  *
964
968
  * @summary Update sandbox state
@@ -1007,6 +1011,7 @@ export type ListSandboxesPaginatedStatesEnum = (typeof ListSandboxesPaginatedSta
1007
1011
  */
1008
1012
  export declare const ListSandboxesPaginatedSortEnum: {
1009
1013
  readonly ID: "id";
1014
+ readonly NAME: "name";
1010
1015
  readonly STATE: "state";
1011
1016
  readonly SNAPSHOT: "snapshot";
1012
1017
  readonly REGION: "region";