@teemill/warehouse-prefab-applications 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts ADDED
@@ -0,0 +1,841 @@
1
+ /**
2
+ * Warehouse Prefab Applications API
3
+ * Manage Teemill Warehouse Prefab Applications Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
4
+ *
5
+ * The version of the OpenAPI document: 0.0.1
6
+ * Contact: hello@teemill.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from './configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import type { RequestArgs } from './base';
15
+ import { BaseAPI } from './base';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface ApiError
20
+ */
21
+ export interface ApiError {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof ApiError
26
+ */
27
+ 'code'?: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof ApiError
32
+ */
33
+ 'message': string;
34
+ }
35
+ /**
36
+ *
37
+ * @export
38
+ * @interface Batch
39
+ */
40
+ export interface Batch {
41
+ /**
42
+ * Unique object identifier
43
+ * @type {string}
44
+ * @memberof Batch
45
+ */
46
+ 'id'?: string;
47
+ /**
48
+ * A reference to the resource location
49
+ * @type {string}
50
+ * @memberof Batch
51
+ */
52
+ 'ref'?: string;
53
+ /**
54
+ * Number of applications in the batch
55
+ * @type {number}
56
+ * @memberof Batch
57
+ */
58
+ 'size'?: number;
59
+ /**
60
+ * A reference to the resource location
61
+ * @type {string}
62
+ * @memberof Batch
63
+ */
64
+ 'userRef'?: string | null;
65
+ /**
66
+ * A reference to the resource location
67
+ * @type {string}
68
+ * @memberof Batch
69
+ */
70
+ 'technologyRef'?: string;
71
+ /**
72
+ * ISO 8601 Timestamp
73
+ * @type {string}
74
+ * @memberof Batch
75
+ */
76
+ 'createdAt'?: string | null;
77
+ }
78
+ /**
79
+ *
80
+ * @export
81
+ * @interface CreateBatchRequest
82
+ */
83
+ export interface CreateBatchRequest {
84
+ /**
85
+ *
86
+ * @type {Array<string>}
87
+ * @memberof CreateBatchRequest
88
+ */
89
+ 'applicationRefs': Array<string>;
90
+ }
91
+ /**
92
+ *
93
+ * @export
94
+ * @interface ListBatchPrefabApplications200Response
95
+ */
96
+ export interface ListBatchPrefabApplications200Response {
97
+ /**
98
+ *
99
+ * @type {Array<PrefabApplication>}
100
+ * @memberof ListBatchPrefabApplications200Response
101
+ */
102
+ 'prefabApplications'?: Array<PrefabApplication>;
103
+ /**
104
+ *
105
+ * @type {number}
106
+ * @memberof ListBatchPrefabApplications200Response
107
+ */
108
+ 'nextPageToken'?: number;
109
+ }
110
+ /**
111
+ *
112
+ * @export
113
+ * @interface ListBatches200Response
114
+ */
115
+ export interface ListBatches200Response {
116
+ /**
117
+ *
118
+ * @type {Array<Batch>}
119
+ * @memberof ListBatches200Response
120
+ */
121
+ 'batches'?: Array<Batch>;
122
+ /**
123
+ *
124
+ * @type {number}
125
+ * @memberof ListBatches200Response
126
+ */
127
+ 'nextPageToken'?: number;
128
+ }
129
+ /**
130
+ *
131
+ * @export
132
+ * @interface ListTrays200Response
133
+ */
134
+ export interface ListTrays200Response {
135
+ /**
136
+ *
137
+ * @type {Array<Tray>}
138
+ * @memberof ListTrays200Response
139
+ */
140
+ 'trays'?: Array<Tray>;
141
+ /**
142
+ *
143
+ * @type {number}
144
+ * @memberof ListTrays200Response
145
+ */
146
+ 'nextPageToken'?: number;
147
+ }
148
+ /**
149
+ *
150
+ * @export
151
+ * @interface PrefabApplication
152
+ */
153
+ export interface PrefabApplication {
154
+ /**
155
+ * Unique object identifier
156
+ * @type {string}
157
+ * @memberof PrefabApplication
158
+ */
159
+ 'id': string;
160
+ /**
161
+ * A reference to the resource location
162
+ * @type {string}
163
+ * @memberof PrefabApplication
164
+ */
165
+ 'ref': string;
166
+ /**
167
+ * A reference to the batch that the prefab application was created in, if applicable.
168
+ * @type {string}
169
+ * @memberof PrefabApplication
170
+ */
171
+ 'batchRef'?: string | null;
172
+ /**
173
+ * Design file URL
174
+ * @type {string}
175
+ * @memberof PrefabApplication
176
+ */
177
+ 'design': string | null;
178
+ /**
179
+ * A reference to the warehouse application that the prefab application is assigned to.
180
+ * @type {string}
181
+ * @memberof PrefabApplication
182
+ */
183
+ 'applicationRef'?: string | null;
184
+ /**
185
+ * A reference to the tray that the prefab application is in.
186
+ * @type {string}
187
+ * @memberof PrefabApplication
188
+ */
189
+ 'trayRef'?: string | null;
190
+ /**
191
+ * The status of the prefab application
192
+ * @type {string}
193
+ * @memberof PrefabApplication
194
+ */
195
+ 'status': PrefabApplicationStatusEnum;
196
+ /**
197
+ * ISO 8601 Timestamp
198
+ * @type {string}
199
+ * @memberof PrefabApplication
200
+ */
201
+ 'createdAt': string | null;
202
+ /**
203
+ * ISO 8601 Timestamp
204
+ * @type {string}
205
+ * @memberof PrefabApplication
206
+ */
207
+ 'updatedAt': string | null;
208
+ }
209
+ export declare const PrefabApplicationStatusEnum: {
210
+ readonly Processing: "processing";
211
+ readonly Complete: "complete";
212
+ };
213
+ export type PrefabApplicationStatusEnum = typeof PrefabApplicationStatusEnum[keyof typeof PrefabApplicationStatusEnum];
214
+ /**
215
+ *
216
+ * @export
217
+ * @interface Tray
218
+ */
219
+ export interface Tray {
220
+ /**
221
+ * Unique object identifier
222
+ * @type {string}
223
+ * @memberof Tray
224
+ */
225
+ 'id': string;
226
+ /**
227
+ * A reference to the resource location
228
+ * @type {string}
229
+ * @memberof Tray
230
+ */
231
+ 'ref': string;
232
+ /**
233
+ * Tray label
234
+ * @type {string}
235
+ * @memberof Tray
236
+ */
237
+ 'label': string;
238
+ /**
239
+ * Number of applications in the tray
240
+ * @type {number}
241
+ * @memberof Tray
242
+ */
243
+ 'fillLevel': number;
244
+ /**
245
+ * ISO 8601 Timestamp
246
+ * @type {string}
247
+ * @memberof Tray
248
+ */
249
+ 'createdAt': string | null;
250
+ /**
251
+ * ISO 8601 Timestamp
252
+ * @type {string}
253
+ * @memberof Tray
254
+ */
255
+ 'updatedAt': string | null;
256
+ }
257
+ /**
258
+ *
259
+ * @export
260
+ * @interface ValidationError
261
+ */
262
+ export interface ValidationError {
263
+ /**
264
+ *
265
+ * @type {string}
266
+ * @memberof ValidationError
267
+ */
268
+ 'code'?: string;
269
+ /**
270
+ *
271
+ * @type {string}
272
+ * @memberof ValidationError
273
+ */
274
+ 'message': string;
275
+ }
276
+ /**
277
+ * BatchesApi - axios parameter creator
278
+ * @export
279
+ */
280
+ export declare const BatchesApiAxiosParamCreator: (configuration?: Configuration) => {
281
+ /**
282
+ * Create a batch of applications
283
+ * @summary Create batch
284
+ * @param {string} project What project it is
285
+ * @param {CreateBatchRequest} createBatchRequest Batch of application refs to create
286
+ * @param {*} [options] Override http request option.
287
+ * @throws {RequiredError}
288
+ */
289
+ createBatch: (project: string, createBatchRequest: CreateBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
290
+ /**
291
+ * Get a batch of applications
292
+ * @summary Get batch
293
+ * @param {string} project What project it is
294
+ * @param {string} batchId Batch ID
295
+ * @param {*} [options] Override http request option.
296
+ * @throws {RequiredError}
297
+ */
298
+ getBatch: (project: string, batchId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
299
+ /**
300
+ * Lists all prefab applications in a batch paginated into chunks
301
+ * @summary List batch applications
302
+ * @param {string} project What project it is
303
+ * @param {string} batchId Batch ID
304
+ * @param {number} [pageToken] Page reference token
305
+ * @param {number} [pageSize] The number of results requested per request
306
+ * @param {*} [options] Override http request option.
307
+ * @throws {RequiredError}
308
+ */
309
+ listBatchPrefabApplications: (project: string, batchId: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
310
+ /**
311
+ * Lists all batches available paginated into chunks
312
+ * @summary List batches
313
+ * @param {string} project What project it is
314
+ * @param {string} [search] Search term used to filter results by name or identifier
315
+ * @param {number} [pageToken] Page reference token
316
+ * @param {number} [pageSize] The number of results requested per request
317
+ * @param {*} [options] Override http request option.
318
+ * @throws {RequiredError}
319
+ */
320
+ listBatches: (project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
321
+ };
322
+ /**
323
+ * BatchesApi - functional programming interface
324
+ * @export
325
+ */
326
+ export declare const BatchesApiFp: (configuration?: Configuration) => {
327
+ /**
328
+ * Create a batch of applications
329
+ * @summary Create batch
330
+ * @param {string} project What project it is
331
+ * @param {CreateBatchRequest} createBatchRequest Batch of application refs to create
332
+ * @param {*} [options] Override http request option.
333
+ * @throws {RequiredError}
334
+ */
335
+ createBatch(project: string, createBatchRequest: CreateBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch>>;
336
+ /**
337
+ * Get a batch of applications
338
+ * @summary Get batch
339
+ * @param {string} project What project it is
340
+ * @param {string} batchId Batch ID
341
+ * @param {*} [options] Override http request option.
342
+ * @throws {RequiredError}
343
+ */
344
+ getBatch(project: string, batchId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch>>;
345
+ /**
346
+ * Lists all prefab applications in a batch paginated into chunks
347
+ * @summary List batch applications
348
+ * @param {string} project What project it is
349
+ * @param {string} batchId Batch ID
350
+ * @param {number} [pageToken] Page reference token
351
+ * @param {number} [pageSize] The number of results requested per request
352
+ * @param {*} [options] Override http request option.
353
+ * @throws {RequiredError}
354
+ */
355
+ listBatchPrefabApplications(project: string, batchId: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBatchPrefabApplications200Response>>;
356
+ /**
357
+ * Lists all batches available paginated into chunks
358
+ * @summary List batches
359
+ * @param {string} project What project it is
360
+ * @param {string} [search] Search term used to filter results by name or identifier
361
+ * @param {number} [pageToken] Page reference token
362
+ * @param {number} [pageSize] The number of results requested per request
363
+ * @param {*} [options] Override http request option.
364
+ * @throws {RequiredError}
365
+ */
366
+ listBatches(project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBatches200Response>>;
367
+ };
368
+ /**
369
+ * BatchesApi - factory interface
370
+ * @export
371
+ */
372
+ export declare const BatchesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
373
+ /**
374
+ * Create a batch of applications
375
+ * @summary Create batch
376
+ * @param {BatchesApiCreateBatchRequest} requestParameters Request parameters.
377
+ * @param {*} [options] Override http request option.
378
+ * @throws {RequiredError}
379
+ */
380
+ createBatch(requestParameters: BatchesApiCreateBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<Batch>;
381
+ /**
382
+ * Get a batch of applications
383
+ * @summary Get batch
384
+ * @param {BatchesApiGetBatchRequest} requestParameters Request parameters.
385
+ * @param {*} [options] Override http request option.
386
+ * @throws {RequiredError}
387
+ */
388
+ getBatch(requestParameters: BatchesApiGetBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<Batch>;
389
+ /**
390
+ * Lists all prefab applications in a batch paginated into chunks
391
+ * @summary List batch applications
392
+ * @param {BatchesApiListBatchPrefabApplicationsRequest} requestParameters Request parameters.
393
+ * @param {*} [options] Override http request option.
394
+ * @throws {RequiredError}
395
+ */
396
+ listBatchPrefabApplications(requestParameters: BatchesApiListBatchPrefabApplicationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListBatchPrefabApplications200Response>;
397
+ /**
398
+ * Lists all batches available paginated into chunks
399
+ * @summary List batches
400
+ * @param {BatchesApiListBatchesRequest} requestParameters Request parameters.
401
+ * @param {*} [options] Override http request option.
402
+ * @throws {RequiredError}
403
+ */
404
+ listBatches(requestParameters: BatchesApiListBatchesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListBatches200Response>;
405
+ };
406
+ /**
407
+ * Request parameters for createBatch operation in BatchesApi.
408
+ * @export
409
+ * @interface BatchesApiCreateBatchRequest
410
+ */
411
+ export interface BatchesApiCreateBatchRequest {
412
+ /**
413
+ * What project it is
414
+ * @type {string}
415
+ * @memberof BatchesApiCreateBatch
416
+ */
417
+ readonly project: string;
418
+ /**
419
+ * Batch of application refs to create
420
+ * @type {CreateBatchRequest}
421
+ * @memberof BatchesApiCreateBatch
422
+ */
423
+ readonly createBatchRequest: CreateBatchRequest;
424
+ }
425
+ /**
426
+ * Request parameters for getBatch operation in BatchesApi.
427
+ * @export
428
+ * @interface BatchesApiGetBatchRequest
429
+ */
430
+ export interface BatchesApiGetBatchRequest {
431
+ /**
432
+ * What project it is
433
+ * @type {string}
434
+ * @memberof BatchesApiGetBatch
435
+ */
436
+ readonly project: string;
437
+ /**
438
+ * Batch ID
439
+ * @type {string}
440
+ * @memberof BatchesApiGetBatch
441
+ */
442
+ readonly batchId: string;
443
+ }
444
+ /**
445
+ * Request parameters for listBatchPrefabApplications operation in BatchesApi.
446
+ * @export
447
+ * @interface BatchesApiListBatchPrefabApplicationsRequest
448
+ */
449
+ export interface BatchesApiListBatchPrefabApplicationsRequest {
450
+ /**
451
+ * What project it is
452
+ * @type {string}
453
+ * @memberof BatchesApiListBatchPrefabApplications
454
+ */
455
+ readonly project: string;
456
+ /**
457
+ * Batch ID
458
+ * @type {string}
459
+ * @memberof BatchesApiListBatchPrefabApplications
460
+ */
461
+ readonly batchId: string;
462
+ /**
463
+ * Page reference token
464
+ * @type {number}
465
+ * @memberof BatchesApiListBatchPrefabApplications
466
+ */
467
+ readonly pageToken?: number;
468
+ /**
469
+ * The number of results requested per request
470
+ * @type {number}
471
+ * @memberof BatchesApiListBatchPrefabApplications
472
+ */
473
+ readonly pageSize?: number;
474
+ }
475
+ /**
476
+ * Request parameters for listBatches operation in BatchesApi.
477
+ * @export
478
+ * @interface BatchesApiListBatchesRequest
479
+ */
480
+ export interface BatchesApiListBatchesRequest {
481
+ /**
482
+ * What project it is
483
+ * @type {string}
484
+ * @memberof BatchesApiListBatches
485
+ */
486
+ readonly project: string;
487
+ /**
488
+ * Search term used to filter results by name or identifier
489
+ * @type {string}
490
+ * @memberof BatchesApiListBatches
491
+ */
492
+ readonly search?: string;
493
+ /**
494
+ * Page reference token
495
+ * @type {number}
496
+ * @memberof BatchesApiListBatches
497
+ */
498
+ readonly pageToken?: number;
499
+ /**
500
+ * The number of results requested per request
501
+ * @type {number}
502
+ * @memberof BatchesApiListBatches
503
+ */
504
+ readonly pageSize?: number;
505
+ }
506
+ /**
507
+ * BatchesApi - object-oriented interface
508
+ * @export
509
+ * @class BatchesApi
510
+ * @extends {BaseAPI}
511
+ */
512
+ export declare class BatchesApi extends BaseAPI {
513
+ /**
514
+ * Create a batch of applications
515
+ * @summary Create batch
516
+ * @param {BatchesApiCreateBatchRequest} requestParameters Request parameters.
517
+ * @param {*} [options] Override http request option.
518
+ * @throws {RequiredError}
519
+ * @memberof BatchesApi
520
+ */
521
+ createBatch(requestParameters: BatchesApiCreateBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Batch, any>>;
522
+ /**
523
+ * Get a batch of applications
524
+ * @summary Get batch
525
+ * @param {BatchesApiGetBatchRequest} requestParameters Request parameters.
526
+ * @param {*} [options] Override http request option.
527
+ * @throws {RequiredError}
528
+ * @memberof BatchesApi
529
+ */
530
+ getBatch(requestParameters: BatchesApiGetBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Batch, any>>;
531
+ /**
532
+ * Lists all prefab applications in a batch paginated into chunks
533
+ * @summary List batch applications
534
+ * @param {BatchesApiListBatchPrefabApplicationsRequest} requestParameters Request parameters.
535
+ * @param {*} [options] Override http request option.
536
+ * @throws {RequiredError}
537
+ * @memberof BatchesApi
538
+ */
539
+ listBatchPrefabApplications(requestParameters: BatchesApiListBatchPrefabApplicationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBatchPrefabApplications200Response, any>>;
540
+ /**
541
+ * Lists all batches available paginated into chunks
542
+ * @summary List batches
543
+ * @param {BatchesApiListBatchesRequest} requestParameters Request parameters.
544
+ * @param {*} [options] Override http request option.
545
+ * @throws {RequiredError}
546
+ * @memberof BatchesApi
547
+ */
548
+ listBatches(requestParameters: BatchesApiListBatchesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBatches200Response, any>>;
549
+ }
550
+ /**
551
+ * PrefabApplicationsApi - axios parameter creator
552
+ * @export
553
+ */
554
+ export declare const PrefabApplicationsApiAxiosParamCreator: (configuration?: Configuration) => {
555
+ /**
556
+ * Get a prefab application
557
+ * @summary Get prefab application
558
+ * @param {string} project What project it is
559
+ * @param {string} prefabApplicationId Unique identifier of a prefab application
560
+ * @param {*} [options] Override http request option.
561
+ * @throws {RequiredError}
562
+ */
563
+ getPrefabApplication: (project: string, prefabApplicationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
564
+ /**
565
+ * Update a prefab application
566
+ * @summary Update prefab application
567
+ * @param {string} project What project it is
568
+ * @param {string} prefabApplicationId Unique identifier of a prefab application
569
+ * @param {PrefabApplication} prefabApplication Prefab application schema
570
+ * @param {*} [options] Override http request option.
571
+ * @throws {RequiredError}
572
+ */
573
+ updatePrefabApplication: (project: string, prefabApplicationId: string, prefabApplication: PrefabApplication, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
574
+ };
575
+ /**
576
+ * PrefabApplicationsApi - functional programming interface
577
+ * @export
578
+ */
579
+ export declare const PrefabApplicationsApiFp: (configuration?: Configuration) => {
580
+ /**
581
+ * Get a prefab application
582
+ * @summary Get prefab application
583
+ * @param {string} project What project it is
584
+ * @param {string} prefabApplicationId Unique identifier of a prefab application
585
+ * @param {*} [options] Override http request option.
586
+ * @throws {RequiredError}
587
+ */
588
+ getPrefabApplication(project: string, prefabApplicationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrefabApplication>>;
589
+ /**
590
+ * Update a prefab application
591
+ * @summary Update prefab application
592
+ * @param {string} project What project it is
593
+ * @param {string} prefabApplicationId Unique identifier of a prefab application
594
+ * @param {PrefabApplication} prefabApplication Prefab application schema
595
+ * @param {*} [options] Override http request option.
596
+ * @throws {RequiredError}
597
+ */
598
+ updatePrefabApplication(project: string, prefabApplicationId: string, prefabApplication: PrefabApplication, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrefabApplication>>;
599
+ };
600
+ /**
601
+ * PrefabApplicationsApi - factory interface
602
+ * @export
603
+ */
604
+ export declare const PrefabApplicationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
605
+ /**
606
+ * Get a prefab application
607
+ * @summary Get prefab application
608
+ * @param {PrefabApplicationsApiGetPrefabApplicationRequest} requestParameters Request parameters.
609
+ * @param {*} [options] Override http request option.
610
+ * @throws {RequiredError}
611
+ */
612
+ getPrefabApplication(requestParameters: PrefabApplicationsApiGetPrefabApplicationRequest, options?: RawAxiosRequestConfig): AxiosPromise<PrefabApplication>;
613
+ /**
614
+ * Update a prefab application
615
+ * @summary Update prefab application
616
+ * @param {PrefabApplicationsApiUpdatePrefabApplicationRequest} requestParameters Request parameters.
617
+ * @param {*} [options] Override http request option.
618
+ * @throws {RequiredError}
619
+ */
620
+ updatePrefabApplication(requestParameters: PrefabApplicationsApiUpdatePrefabApplicationRequest, options?: RawAxiosRequestConfig): AxiosPromise<PrefabApplication>;
621
+ };
622
+ /**
623
+ * Request parameters for getPrefabApplication operation in PrefabApplicationsApi.
624
+ * @export
625
+ * @interface PrefabApplicationsApiGetPrefabApplicationRequest
626
+ */
627
+ export interface PrefabApplicationsApiGetPrefabApplicationRequest {
628
+ /**
629
+ * What project it is
630
+ * @type {string}
631
+ * @memberof PrefabApplicationsApiGetPrefabApplication
632
+ */
633
+ readonly project: string;
634
+ /**
635
+ * Unique identifier of a prefab application
636
+ * @type {string}
637
+ * @memberof PrefabApplicationsApiGetPrefabApplication
638
+ */
639
+ readonly prefabApplicationId: string;
640
+ }
641
+ /**
642
+ * Request parameters for updatePrefabApplication operation in PrefabApplicationsApi.
643
+ * @export
644
+ * @interface PrefabApplicationsApiUpdatePrefabApplicationRequest
645
+ */
646
+ export interface PrefabApplicationsApiUpdatePrefabApplicationRequest {
647
+ /**
648
+ * What project it is
649
+ * @type {string}
650
+ * @memberof PrefabApplicationsApiUpdatePrefabApplication
651
+ */
652
+ readonly project: string;
653
+ /**
654
+ * Unique identifier of a prefab application
655
+ * @type {string}
656
+ * @memberof PrefabApplicationsApiUpdatePrefabApplication
657
+ */
658
+ readonly prefabApplicationId: string;
659
+ /**
660
+ * Prefab application schema
661
+ * @type {PrefabApplication}
662
+ * @memberof PrefabApplicationsApiUpdatePrefabApplication
663
+ */
664
+ readonly prefabApplication: PrefabApplication;
665
+ }
666
+ /**
667
+ * PrefabApplicationsApi - object-oriented interface
668
+ * @export
669
+ * @class PrefabApplicationsApi
670
+ * @extends {BaseAPI}
671
+ */
672
+ export declare class PrefabApplicationsApi extends BaseAPI {
673
+ /**
674
+ * Get a prefab application
675
+ * @summary Get prefab application
676
+ * @param {PrefabApplicationsApiGetPrefabApplicationRequest} requestParameters Request parameters.
677
+ * @param {*} [options] Override http request option.
678
+ * @throws {RequiredError}
679
+ * @memberof PrefabApplicationsApi
680
+ */
681
+ getPrefabApplication(requestParameters: PrefabApplicationsApiGetPrefabApplicationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrefabApplication, any>>;
682
+ /**
683
+ * Update a prefab application
684
+ * @summary Update prefab application
685
+ * @param {PrefabApplicationsApiUpdatePrefabApplicationRequest} requestParameters Request parameters.
686
+ * @param {*} [options] Override http request option.
687
+ * @throws {RequiredError}
688
+ * @memberof PrefabApplicationsApi
689
+ */
690
+ updatePrefabApplication(requestParameters: PrefabApplicationsApiUpdatePrefabApplicationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrefabApplication, any>>;
691
+ }
692
+ /**
693
+ * TraysApi - axios parameter creator
694
+ * @export
695
+ */
696
+ export declare const TraysApiAxiosParamCreator: (configuration?: Configuration) => {
697
+ /**
698
+ * Get a tray of applications
699
+ * @summary Get tray
700
+ * @param {string} project What project it is
701
+ * @param {string} trayId Tray ID
702
+ * @param {*} [options] Override http request option.
703
+ * @throws {RequiredError}
704
+ */
705
+ getTray: (project: string, trayId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
706
+ /**
707
+ * Lists all prefab application trays paginated into chunks
708
+ * @summary List trays
709
+ * @param {string} project What project it is
710
+ * @param {string} [search] Search term used to filter results by name or identifier
711
+ * @param {number} [pageToken] Page reference token
712
+ * @param {number} [pageSize] The number of results requested per request
713
+ * @param {*} [options] Override http request option.
714
+ * @throws {RequiredError}
715
+ */
716
+ listTrays: (project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
717
+ };
718
+ /**
719
+ * TraysApi - functional programming interface
720
+ * @export
721
+ */
722
+ export declare const TraysApiFp: (configuration?: Configuration) => {
723
+ /**
724
+ * Get a tray of applications
725
+ * @summary Get tray
726
+ * @param {string} project What project it is
727
+ * @param {string} trayId Tray ID
728
+ * @param {*} [options] Override http request option.
729
+ * @throws {RequiredError}
730
+ */
731
+ getTray(project: string, trayId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Tray>>;
732
+ /**
733
+ * Lists all prefab application trays paginated into chunks
734
+ * @summary List trays
735
+ * @param {string} project What project it is
736
+ * @param {string} [search] Search term used to filter results by name or identifier
737
+ * @param {number} [pageToken] Page reference token
738
+ * @param {number} [pageSize] The number of results requested per request
739
+ * @param {*} [options] Override http request option.
740
+ * @throws {RequiredError}
741
+ */
742
+ listTrays(project: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTrays200Response>>;
743
+ };
744
+ /**
745
+ * TraysApi - factory interface
746
+ * @export
747
+ */
748
+ export declare const TraysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
749
+ /**
750
+ * Get a tray of applications
751
+ * @summary Get tray
752
+ * @param {TraysApiGetTrayRequest} requestParameters Request parameters.
753
+ * @param {*} [options] Override http request option.
754
+ * @throws {RequiredError}
755
+ */
756
+ getTray(requestParameters: TraysApiGetTrayRequest, options?: RawAxiosRequestConfig): AxiosPromise<Tray>;
757
+ /**
758
+ * Lists all prefab application trays paginated into chunks
759
+ * @summary List trays
760
+ * @param {TraysApiListTraysRequest} requestParameters Request parameters.
761
+ * @param {*} [options] Override http request option.
762
+ * @throws {RequiredError}
763
+ */
764
+ listTrays(requestParameters: TraysApiListTraysRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTrays200Response>;
765
+ };
766
+ /**
767
+ * Request parameters for getTray operation in TraysApi.
768
+ * @export
769
+ * @interface TraysApiGetTrayRequest
770
+ */
771
+ export interface TraysApiGetTrayRequest {
772
+ /**
773
+ * What project it is
774
+ * @type {string}
775
+ * @memberof TraysApiGetTray
776
+ */
777
+ readonly project: string;
778
+ /**
779
+ * Tray ID
780
+ * @type {string}
781
+ * @memberof TraysApiGetTray
782
+ */
783
+ readonly trayId: string;
784
+ }
785
+ /**
786
+ * Request parameters for listTrays operation in TraysApi.
787
+ * @export
788
+ * @interface TraysApiListTraysRequest
789
+ */
790
+ export interface TraysApiListTraysRequest {
791
+ /**
792
+ * What project it is
793
+ * @type {string}
794
+ * @memberof TraysApiListTrays
795
+ */
796
+ readonly project: string;
797
+ /**
798
+ * Search term used to filter results by name or identifier
799
+ * @type {string}
800
+ * @memberof TraysApiListTrays
801
+ */
802
+ readonly search?: string;
803
+ /**
804
+ * Page reference token
805
+ * @type {number}
806
+ * @memberof TraysApiListTrays
807
+ */
808
+ readonly pageToken?: number;
809
+ /**
810
+ * The number of results requested per request
811
+ * @type {number}
812
+ * @memberof TraysApiListTrays
813
+ */
814
+ readonly pageSize?: number;
815
+ }
816
+ /**
817
+ * TraysApi - object-oriented interface
818
+ * @export
819
+ * @class TraysApi
820
+ * @extends {BaseAPI}
821
+ */
822
+ export declare class TraysApi extends BaseAPI {
823
+ /**
824
+ * Get a tray of applications
825
+ * @summary Get tray
826
+ * @param {TraysApiGetTrayRequest} requestParameters Request parameters.
827
+ * @param {*} [options] Override http request option.
828
+ * @throws {RequiredError}
829
+ * @memberof TraysApi
830
+ */
831
+ getTray(requestParameters: TraysApiGetTrayRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Tray, any>>;
832
+ /**
833
+ * Lists all prefab application trays paginated into chunks
834
+ * @summary List trays
835
+ * @param {TraysApiListTraysRequest} requestParameters Request parameters.
836
+ * @param {*} [options] Override http request option.
837
+ * @throws {RequiredError}
838
+ * @memberof TraysApi
839
+ */
840
+ listTrays(requestParameters: TraysApiListTraysRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTrays200Response, any>>;
841
+ }