@ricado/api-client 2.3.4 → 2.3.7

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/lib/index.d.ts CHANGED
@@ -3131,6 +3131,7 @@ declare module '@ricado/api-client/Models/Site' {
3131
3131
  declare module '@ricado/api-client/Controllers/Packhouse/Site' {
3132
3132
  export default Site;
3133
3133
  namespace Site {
3134
+ export { BinTipBinCardController };
3134
3135
  export { BinTipBinController };
3135
3136
  export { BinTipWeightController };
3136
3137
  export { CompacSizerBatchController };
@@ -3155,8 +3156,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
3155
3156
  export { ShiftQualitySummaryController };
3156
3157
  export { ShiftTaskController };
3157
3158
  export { SoftSortBeltController };
3159
+ export { SoftSortPackrunSummaryController };
3158
3160
  export { VarietyController };
3159
3161
  }
3162
+ import BinTipBinCardController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipBinCardController";
3160
3163
  import BinTipBinController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipBinController";
3161
3164
  import BinTipWeightController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipWeightController";
3162
3165
  import CompacSizerBatchController from "@ricado/api-client/Controllers/Packhouse/Site/CompacSizerBatchController";
@@ -3181,6 +3184,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
3181
3184
  import ShiftQualitySummaryController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummaryController";
3182
3185
  import ShiftTaskController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftTaskController";
3183
3186
  import SoftSortBeltController from "@ricado/api-client/Controllers/Packhouse/Site/SoftSortBeltController";
3187
+ import SoftSortPackrunSummaryController from "@ricado/api-client/Controllers/Packhouse/Site/SoftSortPackrunSummaryController";
3184
3188
  import VarietyController from "@ricado/api-client/Controllers/Packhouse/Site/VarietyController";
3185
3189
  }
3186
3190
 
@@ -4722,6 +4726,7 @@ declare module '@ricado/api-client/Controllers/Site/TemporaryObjectController' {
4722
4726
  declare module '@ricado/api-client/Models/Packhouse/Site' {
4723
4727
  export default Site;
4724
4728
  namespace Site {
4729
+ export { BinTipBinCardModel };
4725
4730
  export { BinTipBinModel };
4726
4731
  export { BinTipWeightModel };
4727
4732
  export { CompacSizerBatchModel };
@@ -4746,8 +4751,10 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
4746
4751
  export { ShiftQualitySummaryModel };
4747
4752
  export { ShiftTaskModel };
4748
4753
  export { SoftSortBeltModel };
4754
+ export { SoftSortPackrunSummaryModel };
4749
4755
  export { VarietyModel };
4750
4756
  }
4757
+ import BinTipBinCardModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel";
4751
4758
  import BinTipBinModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBinModel";
4752
4759
  import BinTipWeightModel from "@ricado/api-client/Models/Packhouse/Site/BinTipWeightModel";
4753
4760
  import CompacSizerBatchModel from "@ricado/api-client/Models/Packhouse/Site/CompacSizerBatchModel";
@@ -4772,6 +4779,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
4772
4779
  import ShiftQualitySummaryModel from "@ricado/api-client/Models/Packhouse/Site/ShiftQualitySummaryModel";
4773
4780
  import ShiftTaskModel from "@ricado/api-client/Models/Packhouse/Site/ShiftTaskModel";
4774
4781
  import SoftSortBeltModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel";
4782
+ import SoftSortPackrunSummaryModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortPackrunSummaryModel";
4775
4783
  import VarietyModel from "@ricado/api-client/Models/Packhouse/Site/VarietyModel";
4776
4784
  }
4777
4785
 
@@ -5375,6 +5383,234 @@ declare module '@ricado/api-client/Models/Site/TemporaryObjectModel' {
5375
5383
  import BaseModel from "@ricado/api-client/Models/BaseModel";
5376
5384
  }
5377
5385
 
5386
+ declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinCardController' {
5387
+ export default BinTipBinCardController;
5388
+ /**
5389
+ * Controller Class for Bin Tip Bin Cards
5390
+ *
5391
+ * @class
5392
+ */
5393
+ class BinTipBinCardController {
5394
+ /**
5395
+ * Retrieve a Bin Tip Bin Card [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]
5396
+ *
5397
+ * @static
5398
+ * @public
5399
+ * @param {number} siteId The Site ID
5400
+ * @param {string} id The Bin Tip Bin Card ID
5401
+ * @return {Promise<BinTipBinCardModel>}
5402
+ */
5403
+ static getOne(siteId: number, id: string): Promise<BinTipBinCardModel>;
5404
+ /**
5405
+ * Update a Bin Tip Bin Card [PATCH /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]
5406
+ *
5407
+ * @static
5408
+ * @public
5409
+ * @param {number} siteId The Site ID
5410
+ * @param {string} id The Bin Tip Bin Card ID
5411
+ * @param {BinTipBinCardController.UpdateData} updateData The Bin Tip Bin Card Update Data
5412
+ * @return {Promise<BinTipBinCardModel>}
5413
+ */
5414
+ static update(siteId: number, id: string, updateData: BinTipBinCardController.UpdateData): Promise<BinTipBinCardModel>;
5415
+ /**
5416
+ * Delete a Bin Tip Bin Card [DELETE /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]
5417
+ *
5418
+ * @static
5419
+ * @public
5420
+ * @param {number} siteId The Site ID
5421
+ * @param {string} id The Bin Tip Bin Card ID
5422
+ * @return {Promise<boolean>}
5423
+ */
5424
+ static delete(siteId: number, id: string): Promise<boolean>;
5425
+ /**
5426
+ * Retrieve Comments [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments]
5427
+ *
5428
+ * Retrieves Comments for a Bin Tip Bin Card
5429
+ *
5430
+ * @static
5431
+ * @public
5432
+ * @param {number} siteId The Site ID
5433
+ * @param {string} id The Bin Tip Bin Card ID
5434
+ * @return {Promise<Array<BinTipBinCardController.CommentItem>>}
5435
+ */
5436
+ static getComments(siteId: number, id: string): Promise<Array<BinTipBinCardController.CommentItem>>;
5437
+ /**
5438
+ * Create a Comment [POST /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments]
5439
+ *
5440
+ * Create a Comment for a Bin Tip Bin Card
5441
+ *
5442
+ * @static
5443
+ * @public
5444
+ * @param {number} siteId The Site ID
5445
+ * @param {string} id The Bin Tip Bin Card ID
5446
+ * @param {string} content The Content of the New Comment
5447
+ * @return {Promise<BinTipBinCardController.CommentItem>}
5448
+ */
5449
+ static createComment(siteId: number, id: string, content: string): Promise<BinTipBinCardController.CommentItem>;
5450
+ /**
5451
+ * Retrieve a Comment [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments/{commentId}]
5452
+ *
5453
+ * Retrieves Comments for a Bin Tip Bin Card
5454
+ *
5455
+ * @static
5456
+ * @public
5457
+ * @param {number} siteId The Site ID
5458
+ * @param {string} id The Bin Tip Bin Card ID
5459
+ * @param {string} commentId The Comment ID
5460
+ * @return {Promise<BinTipBinCardController.CommentItem>}
5461
+ */
5462
+ static getOneComment(siteId: number, id: string, commentId: string): Promise<BinTipBinCardController.CommentItem>;
5463
+ /**
5464
+ * Update a Comment [PATCH /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments/{commentId}]
5465
+ *
5466
+ * Update a Comment for a Bin Tip Bin Card
5467
+ *
5468
+ * @static
5469
+ * @public
5470
+ * @param {number} siteId The Site ID
5471
+ * @param {string} id The Bin Tip Bin Card ID
5472
+ * @param {string} commentId The Comment ID
5473
+ * @param {string} content The Updated Content for the Comment
5474
+ * @return {Promise<BinTipBinCardController.CommentItem>}
5475
+ */
5476
+ static updateOneComment(siteId: number, id: string, commentId: string, content: string): Promise<BinTipBinCardController.CommentItem>;
5477
+ /**
5478
+ * Delete a Comment [DELETE /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments/{commentId}]
5479
+ *
5480
+ * Delete a Comment for a Bin Tip Bin Card
5481
+ *
5482
+ * @static
5483
+ * @public
5484
+ * @param {number} siteId The Site ID
5485
+ * @param {string} id The Bin Tip Bin Card ID
5486
+ * @param {string} commentId The Comment ID
5487
+ * @return {Promise<boolean>}
5488
+ */
5489
+ static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
5490
+ /**
5491
+ * List all Bin Tip Bin Cards [GET /packhouse/sites/{siteId}/bin-tip-bin-cards]
5492
+ *
5493
+ * @static
5494
+ * @public
5495
+ * @param {number} siteId The Site ID
5496
+ * @param {BinTipBinCardController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
5497
+ * @return {Promise<BinTipBinCardModel[]>}
5498
+ */
5499
+ static getAll(siteId: number, queryParameters?: BinTipBinCardController.GetAllQueryParameters | undefined): Promise<BinTipBinCardModel[]>;
5500
+ /**
5501
+ * Create a Bin Tip Bin Card [POST /packhouse/sites/{siteId}/bin-tip-bin-cards]
5502
+ *
5503
+ * @static
5504
+ * @public
5505
+ * @param {number} siteId The Site ID
5506
+ * @param {BinTipBinCardController.CreateData} createData The Bin Tip Bin Card Create Data
5507
+ * @return {Promise<BinTipBinCardModel>}
5508
+ */
5509
+ static create(siteId: number, createData: BinTipBinCardController.CreateData): Promise<BinTipBinCardModel>;
5510
+ }
5511
+ namespace BinTipBinCardController {
5512
+ /**
5513
+ * The Optional Query Parameters for the getAll Function
5514
+ */
5515
+ export type GetAllQueryParameters = {
5516
+ /**
5517
+ * The Bin Tip ID associated with this Bin Card
5518
+ */
5519
+ binTipId?: string;
5520
+ /**
5521
+ * The Bin ID associated with this Bin Card
5522
+ */
5523
+ binTipBinId?: string;
5524
+ /**
5525
+ * Filter by the Timestamp when this Bin Card was Created. Results Greater than or Equal to Timestamp
5526
+ */
5527
+ createdTimestampBegin?: Date;
5528
+ /**
5529
+ * Filter by the Timestamp when this Bin Card was Created. Results Less than or Equal to Timestamp
5530
+ */
5531
+ createdTimestampEnd?: Date;
5532
+ };
5533
+ /**
5534
+ * The Create Data for a Bin Tip Bin Card
5535
+ */
5536
+ export type CreateData = {
5537
+ /**
5538
+ * The Bin Tip ID associated with this Bin Card
5539
+ */
5540
+ binTipId: string;
5541
+ /**
5542
+ * The Bin ID associated with this Bin Card
5543
+ */
5544
+ binTipBinId?: string;
5545
+ /**
5546
+ * When this Bin Card was Created
5547
+ */
5548
+ createdTimestamp?: Date;
5549
+ /**
5550
+ * A Base64 Encoded Image of the Bin Card
5551
+ */
5552
+ image?: string | null;
5553
+ };
5554
+ /**
5555
+ * The Update Data for a Bin Tip Bin Card
5556
+ */
5557
+ export type UpdateData = {
5558
+ /**
5559
+ * The Bin Tip ID associated with this Bin Card
5560
+ */
5561
+ binTipId?: string;
5562
+ /**
5563
+ * When this Bin Card was Created
5564
+ */
5565
+ createdTimestamp?: Date;
5566
+ /**
5567
+ * A Base64 Encoded Image of the Bin Card
5568
+ */
5569
+ image?: string | null;
5570
+ };
5571
+ /**
5572
+ * A **UserAccount** Type
5573
+ */
5574
+ export type UserAccount = {
5575
+ /**
5576
+ * The User Account ID
5577
+ */
5578
+ id: string | null;
5579
+ /**
5580
+ * The User's First Name
5581
+ */
5582
+ firstName: string | null;
5583
+ /**
5584
+ * The User's Last Name
5585
+ */
5586
+ lastName: string | null;
5587
+ };
5588
+ /**
5589
+ * A **CommentItem** Type
5590
+ */
5591
+ export type CommentItem = {
5592
+ /**
5593
+ * The Comment ID
5594
+ */
5595
+ id: string;
5596
+ userAccount: UserAccount;
5597
+ /**
5598
+ * The Content of the Comment
5599
+ */
5600
+ content: string | null;
5601
+ /**
5602
+ * When the Comment was Created
5603
+ */
5604
+ createdTimestamp: Date | null;
5605
+ /**
5606
+ * When the Comment was last Updated
5607
+ */
5608
+ updatedTimestamp: Date | null;
5609
+ };
5610
+ }
5611
+ import BinTipBinCardModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel";
5612
+ }
5613
+
5378
5614
  declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinController' {
5379
5615
  export default BinTipBinController;
5380
5616
  /**
@@ -11683,10 +11919,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummar
11683
11919
  * The Shift ID this Quality Summary is asssociated with
11684
11920
  */
11685
11921
  shiftId?: string;
11922
+ /**
11923
+ * When this Quality Summary was Published
11924
+ */
11925
+ publishTimestamp?: Date | null;
11686
11926
  /**
11687
11927
  * The User ID of the Quality Manager for this Summary
11688
11928
  */
11689
- qualityManagerUserId?: string | null;
11929
+ qualityManagerUserId?: string;
11690
11930
  /**
11691
11931
  * The Name of the Quality Manager for this Summary
11692
11932
  */
@@ -11731,7 +11971,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummar
11731
11971
  /**
11732
11972
  * The User ID of the Quality Manager for this Summary
11733
11973
  */
11734
- qualityManagerUserId?: string | null;
11974
+ qualityManagerUserId: string;
11735
11975
  /**
11736
11976
  * The Name of the Quality Manager for this Summary
11737
11977
  */
@@ -11772,7 +12012,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummar
11772
12012
  /**
11773
12013
  * The User ID of the Quality Manager for this Summary
11774
12014
  */
11775
- qualityManagerUserId?: string | null;
12015
+ qualityManagerUserId?: string;
11776
12016
  /**
11777
12017
  * The Name of the Quality Manager for this Summary
11778
12018
  */
@@ -12432,101 +12672,393 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/SoftSortBeltContro
12432
12672
  import SoftSortBeltModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel";
12433
12673
  }
12434
12674
 
12435
- declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController' {
12436
- export default VarietyController;
12675
+ declare module '@ricado/api-client/Controllers/Packhouse/Site/SoftSortPackrunSummaryController' {
12676
+ export default SoftSortPackrunSummaryController;
12437
12677
  /**
12438
- * Controller Class for Varieties
12678
+ * Controller Class for Soft-Sort Packrun Summaries
12439
12679
  *
12440
12680
  * @class
12441
12681
  */
12442
- class VarietyController {
12682
+ class SoftSortPackrunSummaryController {
12443
12683
  /**
12444
- * Retrieve a Variety [GET /packhouse/sites/{siteId}/varieties/{id}]
12684
+ * Retrieve a Soft-Sort Packrun Summary [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
12445
12685
  *
12446
12686
  * @static
12447
12687
  * @public
12448
12688
  * @param {number} siteId The Site ID
12449
- * @param {string} id The Variety ID
12450
- * @return {Promise<VarietyModel>}
12689
+ * @param {string} id The Soft-Sort Packrun Summary ID
12690
+ * @return {Promise<SoftSortPackrunSummaryModel>}
12451
12691
  */
12452
- static getOne(siteId: number, id: string): Promise<VarietyModel>;
12692
+ static getOne(siteId: number, id: string): Promise<SoftSortPackrunSummaryModel>;
12453
12693
  /**
12454
- * Update a Variety [PATCH /packhouse/sites/{siteId}/varieties/{id}]
12694
+ * Update a Soft-Sort Packrun Summary [PATCH /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
12455
12695
  *
12456
12696
  * @static
12457
12697
  * @public
12458
12698
  * @param {number} siteId The Site ID
12459
- * @param {string} id The Variety ID
12460
- * @param {VarietyController.UpdateData} updateData The Variety Update Data
12461
- * @return {Promise<VarietyModel>}
12699
+ * @param {string} id The Soft-Sort Packrun Summary ID
12700
+ * @param {SoftSortPackrunSummaryController.UpdateData} updateData The Soft-Sort Packrun Summary Update Data
12701
+ * @return {Promise<SoftSortPackrunSummaryModel>}
12462
12702
  */
12463
- static update(siteId: number, id: string, updateData: VarietyController.UpdateData): Promise<VarietyModel>;
12703
+ static update(siteId: number, id: string, updateData: SoftSortPackrunSummaryController.UpdateData): Promise<SoftSortPackrunSummaryModel>;
12464
12704
  /**
12465
- * Delete a Variety [DELETE /packhouse/sites/{siteId}/varieties/{id}]
12705
+ * Delete a Soft-Sort Packrun Summary [DELETE /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
12466
12706
  *
12467
12707
  * @static
12468
12708
  * @public
12469
12709
  * @param {number} siteId The Site ID
12470
- * @param {string} id The Variety ID
12710
+ * @param {string} id The Soft-Sort Packrun Summary ID
12471
12711
  * @return {Promise<boolean>}
12472
12712
  */
12473
12713
  static delete(siteId: number, id: string): Promise<boolean>;
12474
12714
  /**
12475
- * List all Varieties [GET /packhouse/sites/{siteId}/varieties]
12715
+ * Retrieve Comments [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments]
12716
+ *
12717
+ * Retrieves Comments for a Soft-Sort Packrun Summary
12476
12718
  *
12477
12719
  * @static
12478
12720
  * @public
12479
12721
  * @param {number} siteId The Site ID
12480
- * @param {VarietyController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
12481
- * @return {Promise<VarietyModel[]>}
12722
+ * @param {string} id The Soft-Sort Packrun Summary ID
12723
+ * @return {Promise<Array<SoftSortPackrunSummaryController.CommentItem>>}
12482
12724
  */
12483
- static getAll(siteId: number, queryParameters?: VarietyController.GetAllQueryParameters | undefined): Promise<VarietyModel[]>;
12725
+ static getComments(siteId: number, id: string): Promise<Array<SoftSortPackrunSummaryController.CommentItem>>;
12484
12726
  /**
12485
- * Create a Variety [POST /packhouse/sites/{siteId}/varieties]
12727
+ * Create a Comment [POST /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments]
12728
+ *
12729
+ * Create a Comment for a Soft-Sort Packrun Summary
12486
12730
  *
12487
12731
  * @static
12488
12732
  * @public
12489
12733
  * @param {number} siteId The Site ID
12490
- * @param {VarietyController.CreateData} createData The Variety Create Data
12491
- * @return {Promise<VarietyModel>}
12734
+ * @param {string} id The Soft-Sort Packrun Summary ID
12735
+ * @param {string} content The Content of the New Comment
12736
+ * @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
12492
12737
  */
12493
- static create(siteId: number, createData: VarietyController.CreateData): Promise<VarietyModel>;
12738
+ static createComment(siteId: number, id: string, content: string): Promise<SoftSortPackrunSummaryController.CommentItem>;
12739
+ /**
12740
+ * Retrieve a Comment [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]
12741
+ *
12742
+ * Retrieves Comments for a Soft-Sort Packrun Summary
12743
+ *
12744
+ * @static
12745
+ * @public
12746
+ * @param {number} siteId The Site ID
12747
+ * @param {string} id The Soft-Sort Packrun Summary ID
12748
+ * @param {string} commentId The Comment ID
12749
+ * @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
12750
+ */
12751
+ static getOneComment(siteId: number, id: string, commentId: string): Promise<SoftSortPackrunSummaryController.CommentItem>;
12752
+ /**
12753
+ * Update a Comment [PATCH /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]
12754
+ *
12755
+ * Update a Comment for a Soft-Sort Packrun Summary
12756
+ *
12757
+ * @static
12758
+ * @public
12759
+ * @param {number} siteId The Site ID
12760
+ * @param {string} id The Soft-Sort Packrun Summary ID
12761
+ * @param {string} commentId The Comment ID
12762
+ * @param {string} content The Updated Content for the Comment
12763
+ * @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
12764
+ */
12765
+ static updateOneComment(siteId: number, id: string, commentId: string, content: string): Promise<SoftSortPackrunSummaryController.CommentItem>;
12766
+ /**
12767
+ * Delete a Comment [DELETE /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]
12768
+ *
12769
+ * Delete a Comment for a Soft-Sort Packrun Summary
12770
+ *
12771
+ * @static
12772
+ * @public
12773
+ * @param {number} siteId The Site ID
12774
+ * @param {string} id The Soft-Sort Packrun Summary ID
12775
+ * @param {string} commentId The Comment ID
12776
+ * @return {Promise<boolean>}
12777
+ */
12778
+ static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
12779
+ /**
12780
+ * List all Soft-Sort Packrun Summaries [GET /packhouse/sites/{siteId}/softsort-packrun-summaries]
12781
+ *
12782
+ * @static
12783
+ * @public
12784
+ * @param {number} siteId The Site ID
12785
+ * @param {SoftSortPackrunSummaryController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
12786
+ * @return {Promise<SoftSortPackrunSummaryModel[]>}
12787
+ */
12788
+ static getAll(siteId: number, queryParameters?: SoftSortPackrunSummaryController.GetAllQueryParameters | undefined): Promise<SoftSortPackrunSummaryModel[]>;
12789
+ /**
12790
+ * Create a Soft-Sort Packrun Summary [POST /packhouse/sites/{siteId}/softsort-packrun-summaries]
12791
+ *
12792
+ * @static
12793
+ * @public
12794
+ * @param {number} siteId The Site ID
12795
+ * @param {SoftSortPackrunSummaryController.CreateData} createData The Soft-Sort Packrun Summary Create Data
12796
+ * @return {Promise<SoftSortPackrunSummaryModel>}
12797
+ */
12798
+ static create(siteId: number, createData: SoftSortPackrunSummaryController.CreateData): Promise<SoftSortPackrunSummaryModel>;
12494
12799
  }
12495
- namespace VarietyController {
12800
+ namespace SoftSortPackrunSummaryController {
12496
12801
  /**
12497
12802
  * The Optional Query Parameters for the getAll Function
12498
12803
  */
12499
12804
  export type GetAllQueryParameters = {
12500
12805
  /**
12501
- * The Variety Code
12806
+ * The Packing Line ID this Summary is associated with
12502
12807
  */
12503
- code?: string;
12808
+ packingLineId?: string;
12504
12809
  /**
12505
- * The Variety Name
12810
+ * The Packrun ID this Summary is associated with
12506
12811
  */
12507
- name?: string;
12508
- };
12509
- /**
12510
- * The Create Data for a Variety
12511
- */
12512
- export type CreateData = {
12812
+ packrunId?: string;
12513
12813
  /**
12514
- * The Variety Code
12814
+ * Whether the Soft-Sort Events Data for this Summary has been Finalized
12515
12815
  */
12516
- code?: string;
12816
+ eventsFinalizedTimestamp?: Date | null;
12517
12817
  /**
12518
- * The Variety Name
12818
+ * Whether the Soft-Sort Events for this Summary are considered accurate or not
12519
12819
  */
12520
- name: string;
12820
+ eventsAccurate?: boolean | null;
12521
12821
  /**
12522
- * The Variety Description
12822
+ * Filter by the Timestamp when this Soft-Sort Packrun Summary was Created. Results Greater than or Equal to Timestamp
12523
12823
  */
12524
- description: string;
12824
+ createdTimestampBegin?: Date;
12525
12825
  /**
12526
- * The Variety Image Source
12826
+ * Filter by the Timestamp when this Soft-Sort Packrun Summary was Created. Results Less than or Equal to Timestamp
12527
12827
  */
12528
- image: string;
12529
- /**
12828
+ createdTimestampEnd?: Date;
12829
+ };
12830
+ /**
12831
+ * The Create Data for a Soft-Sort Packrun Summary
12832
+ */
12833
+ export type CreateData = {
12834
+ /**
12835
+ * The Packing Line ID this Summary is associated with
12836
+ */
12837
+ packingLineId: string;
12838
+ /**
12839
+ * The Packrun ID this Summary is associated with
12840
+ */
12841
+ packrunId?: string;
12842
+ /**
12843
+ * When this Summary was Created
12844
+ */
12845
+ createdTimestamp?: Date;
12846
+ /**
12847
+ * The Number of Soft-Sort Events per Bin Tipped
12848
+ */
12849
+ eventsPerBin: number;
12850
+ /**
12851
+ * The Number of Soft-Sort Events that occurred for the Packrun
12852
+ */
12853
+ totalEventsCount: number;
12854
+ /**
12855
+ * The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
12856
+ */
12857
+ averageEventsDuration: number;
12858
+ /**
12859
+ * The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
12860
+ */
12861
+ totalEventsDuration: number;
12862
+ /**
12863
+ * Whether the Soft-Sort Events Data for this Summary has been Finalized
12864
+ */
12865
+ eventsFinalizedTimestamp?: Date | null;
12866
+ /**
12867
+ * Whether the Soft-Sort Events for this Summary are considered accurate or not
12868
+ */
12869
+ eventsAccurate?: boolean | null;
12870
+ /**
12871
+ * A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
12872
+ */
12873
+ eventsNotAccurateReason?: string | null;
12874
+ /**
12875
+ * The FreshPack Soft-Sort API Data
12876
+ */
12877
+ freshPackSoftSortApi?: any;
12878
+ };
12879
+ /**
12880
+ * The Update Data for a Soft-Sort Packrun Summary
12881
+ */
12882
+ export type UpdateData = {
12883
+ /**
12884
+ * The Packing Line ID this Summary is associated with
12885
+ */
12886
+ packingLineId?: string;
12887
+ /**
12888
+ * When this Summary was Created
12889
+ */
12890
+ createdTimestamp?: Date;
12891
+ /**
12892
+ * The Number of Soft-Sort Events per Bin Tipped
12893
+ */
12894
+ eventsPerBin?: number;
12895
+ /**
12896
+ * The Number of Soft-Sort Events that occurred for the Packrun
12897
+ */
12898
+ totalEventsCount?: number;
12899
+ /**
12900
+ * The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
12901
+ */
12902
+ averageEventsDuration?: number;
12903
+ /**
12904
+ * The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
12905
+ */
12906
+ totalEventsDuration?: number;
12907
+ /**
12908
+ * Whether the Soft-Sort Events Data for this Summary has been Finalized
12909
+ */
12910
+ eventsFinalizedTimestamp?: Date | null;
12911
+ /**
12912
+ * Whether the Soft-Sort Events for this Summary are considered accurate or not
12913
+ */
12914
+ eventsAccurate?: boolean | null;
12915
+ /**
12916
+ * A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
12917
+ */
12918
+ eventsNotAccurateReason?: string | null;
12919
+ /**
12920
+ * The FreshPack Soft-Sort API Data
12921
+ */
12922
+ freshPackSoftSortApi?: any;
12923
+ };
12924
+ /**
12925
+ * A **UserAccount** Type
12926
+ */
12927
+ export type UserAccount = {
12928
+ /**
12929
+ * The User Account ID
12930
+ */
12931
+ id: string | null;
12932
+ /**
12933
+ * The User's First Name
12934
+ */
12935
+ firstName: string | null;
12936
+ /**
12937
+ * The User's Last Name
12938
+ */
12939
+ lastName: string | null;
12940
+ };
12941
+ /**
12942
+ * A **CommentItem** Type
12943
+ */
12944
+ export type CommentItem = {
12945
+ /**
12946
+ * The Comment ID
12947
+ */
12948
+ id: string;
12949
+ userAccount: UserAccount;
12950
+ /**
12951
+ * The Content of the Comment
12952
+ */
12953
+ content: string | null;
12954
+ /**
12955
+ * When the Comment was Created
12956
+ */
12957
+ createdTimestamp: Date | null;
12958
+ /**
12959
+ * When the Comment was last Updated
12960
+ */
12961
+ updatedTimestamp: Date | null;
12962
+ };
12963
+ }
12964
+ import SoftSortPackrunSummaryModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortPackrunSummaryModel";
12965
+ }
12966
+
12967
+ declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController' {
12968
+ export default VarietyController;
12969
+ /**
12970
+ * Controller Class for Varieties
12971
+ *
12972
+ * @class
12973
+ */
12974
+ class VarietyController {
12975
+ /**
12976
+ * Retrieve a Variety [GET /packhouse/sites/{siteId}/varieties/{id}]
12977
+ *
12978
+ * @static
12979
+ * @public
12980
+ * @param {number} siteId The Site ID
12981
+ * @param {string} id The Variety ID
12982
+ * @return {Promise<VarietyModel>}
12983
+ */
12984
+ static getOne(siteId: number, id: string): Promise<VarietyModel>;
12985
+ /**
12986
+ * Update a Variety [PATCH /packhouse/sites/{siteId}/varieties/{id}]
12987
+ *
12988
+ * @static
12989
+ * @public
12990
+ * @param {number} siteId The Site ID
12991
+ * @param {string} id The Variety ID
12992
+ * @param {VarietyController.UpdateData} updateData The Variety Update Data
12993
+ * @return {Promise<VarietyModel>}
12994
+ */
12995
+ static update(siteId: number, id: string, updateData: VarietyController.UpdateData): Promise<VarietyModel>;
12996
+ /**
12997
+ * Delete a Variety [DELETE /packhouse/sites/{siteId}/varieties/{id}]
12998
+ *
12999
+ * @static
13000
+ * @public
13001
+ * @param {number} siteId The Site ID
13002
+ * @param {string} id The Variety ID
13003
+ * @return {Promise<boolean>}
13004
+ */
13005
+ static delete(siteId: number, id: string): Promise<boolean>;
13006
+ /**
13007
+ * List all Varieties [GET /packhouse/sites/{siteId}/varieties]
13008
+ *
13009
+ * @static
13010
+ * @public
13011
+ * @param {number} siteId The Site ID
13012
+ * @param {VarietyController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
13013
+ * @return {Promise<VarietyModel[]>}
13014
+ */
13015
+ static getAll(siteId: number, queryParameters?: VarietyController.GetAllQueryParameters | undefined): Promise<VarietyModel[]>;
13016
+ /**
13017
+ * Create a Variety [POST /packhouse/sites/{siteId}/varieties]
13018
+ *
13019
+ * @static
13020
+ * @public
13021
+ * @param {number} siteId The Site ID
13022
+ * @param {VarietyController.CreateData} createData The Variety Create Data
13023
+ * @return {Promise<VarietyModel>}
13024
+ */
13025
+ static create(siteId: number, createData: VarietyController.CreateData): Promise<VarietyModel>;
13026
+ }
13027
+ namespace VarietyController {
13028
+ /**
13029
+ * The Optional Query Parameters for the getAll Function
13030
+ */
13031
+ export type GetAllQueryParameters = {
13032
+ /**
13033
+ * The Variety Code
13034
+ */
13035
+ code?: string;
13036
+ /**
13037
+ * The Variety Name
13038
+ */
13039
+ name?: string;
13040
+ };
13041
+ /**
13042
+ * The Create Data for a Variety
13043
+ */
13044
+ export type CreateData = {
13045
+ /**
13046
+ * The Variety Code
13047
+ */
13048
+ code?: string;
13049
+ /**
13050
+ * The Variety Name
13051
+ */
13052
+ name: string;
13053
+ /**
13054
+ * The Variety Description
13055
+ */
13056
+ description: string;
13057
+ /**
13058
+ * The Variety Image Source
13059
+ */
13060
+ image: string;
13061
+ /**
12530
13062
  * An Array of Fruit Sizes Defined for this Variety
12531
13063
  */
12532
13064
  fruitSizes: VarietyFruitSize[];
@@ -12565,6 +13097,95 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController'
12565
13097
  import VarietyModel from "@ricado/api-client/Models/Packhouse/Site/VarietyModel";
12566
13098
  }
12567
13099
 
13100
+ declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel' {
13101
+ export default BinTipBinCardModel;
13102
+ /**
13103
+ * Model Class for a Bin Tip Bin Card
13104
+ *
13105
+ * @class
13106
+ * @hideconstructor
13107
+ * @extends BaseModel
13108
+ */
13109
+ class BinTipBinCardModel extends BaseModel {
13110
+ /**
13111
+ * Create a new **BinTipBinCardModel** from a JSON Object or JSON String
13112
+ *
13113
+ * @static
13114
+ * @public
13115
+ * @param {Object<string, any>|string} json A JSON Object or JSON String
13116
+ * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
13117
+ * @return {BinTipBinCardModel}
13118
+ */
13119
+ static fromJSON(json: {
13120
+ [x: string]: any;
13121
+ } | string, siteId: number): BinTipBinCardModel;
13122
+ /**
13123
+ * BinTipBinCardModel Constructor
13124
+ *
13125
+ * @protected
13126
+ * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
13127
+ */
13128
+ protected constructor();
13129
+ /**
13130
+ * The Bin Tip Bin Card ID
13131
+ *
13132
+ * @type {string}
13133
+ * @public
13134
+ */
13135
+ id: string;
13136
+ /**
13137
+ * The Bin Tip ID associated with this Bin Card
13138
+ *
13139
+ * @type {string}
13140
+ * @public
13141
+ */
13142
+ binTipId: string;
13143
+ /**
13144
+ * The Bin ID associated with this Bin Card
13145
+ *
13146
+ * @type {string}
13147
+ * @public
13148
+ */
13149
+ binTipBinId: string;
13150
+ /**
13151
+ * When this Bin Card was Created
13152
+ *
13153
+ * @type {Date}
13154
+ * @public
13155
+ */
13156
+ createdTimestamp: Date;
13157
+ /**
13158
+ * A Base64 Encoded Image of the Bin Card
13159
+ *
13160
+ * @type {?string}
13161
+ * @public
13162
+ */
13163
+ image: string | null;
13164
+ /**
13165
+ * Whether the Bin Tip Bin Card has been deleted
13166
+ *
13167
+ * @type {boolean}
13168
+ * @public
13169
+ */
13170
+ deleted: boolean;
13171
+ /**
13172
+ * When the Bin Tip Bin Card was last updated
13173
+ *
13174
+ * @type {Date}
13175
+ * @public
13176
+ */
13177
+ updateTimestamp: Date;
13178
+ /**
13179
+ * The Site ID associated with this Bin Tip Bin Card
13180
+ *
13181
+ * @type {number}
13182
+ * @public
13183
+ */
13184
+ siteId: number;
13185
+ }
13186
+ import BaseModel from "@ricado/api-client/Models/BaseModel";
13187
+ }
13188
+
12568
13189
  declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinModel' {
12569
13190
  export default BinTipBinModel;
12570
13191
  /**
@@ -15567,10 +16188,10 @@ declare module '@ricado/api-client/Models/Packhouse/Site/ShiftQualitySummaryMode
15567
16188
  /**
15568
16189
  * The User ID of the Quality Manager for this Summary
15569
16190
  *
15570
- * @type {?string}
16191
+ * @type {string}
15571
16192
  * @public
15572
16193
  */
15573
- qualityManagerUserId: string | null;
16194
+ qualityManagerUserId: string;
15574
16195
  /**
15575
16196
  * The Name of the Quality Manager for this Summary
15576
16197
  *
@@ -15884,6 +16505,144 @@ declare module '@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel' {
15884
16505
  import BaseModel from "@ricado/api-client/Models/BaseModel";
15885
16506
  }
15886
16507
 
16508
+ declare module '@ricado/api-client/Models/Packhouse/Site/SoftSortPackrunSummaryModel' {
16509
+ export default SoftSortPackrunSummaryModel;
16510
+ /**
16511
+ * Model Class for a Soft-Sort Packrun Summary
16512
+ *
16513
+ * @class
16514
+ * @hideconstructor
16515
+ * @extends BaseModel
16516
+ */
16517
+ class SoftSortPackrunSummaryModel extends BaseModel {
16518
+ /**
16519
+ * Create a new **SoftSortPackrunSummaryModel** from a JSON Object or JSON String
16520
+ *
16521
+ * @static
16522
+ * @public
16523
+ * @param {Object<string, any>|string} json A JSON Object or JSON String
16524
+ * @param {number} siteId The Site ID associated with this Soft-Sort Packrun Summary
16525
+ * @return {SoftSortPackrunSummaryModel}
16526
+ */
16527
+ static fromJSON(json: {
16528
+ [x: string]: any;
16529
+ } | string, siteId: number): SoftSortPackrunSummaryModel;
16530
+ /**
16531
+ * SoftSortPackrunSummaryModel Constructor
16532
+ *
16533
+ * @protected
16534
+ * @param {number} siteId The Site ID associated with this Soft-Sort Packrun Summary
16535
+ */
16536
+ protected constructor();
16537
+ /**
16538
+ * The Soft-Sort Packrun Summary ID
16539
+ *
16540
+ * @type {string}
16541
+ * @public
16542
+ */
16543
+ id: string;
16544
+ /**
16545
+ * The Packing Line ID this Summary is associated with
16546
+ *
16547
+ * @type {string}
16548
+ * @public
16549
+ */
16550
+ packingLineId: string;
16551
+ /**
16552
+ * The Packrun ID this Summary is associated with
16553
+ *
16554
+ * @type {string}
16555
+ * @public
16556
+ */
16557
+ packrunId: string;
16558
+ /**
16559
+ * When this Summary was Created
16560
+ *
16561
+ * @type {Date}
16562
+ * @public
16563
+ */
16564
+ createdTimestamp: Date;
16565
+ /**
16566
+ * The Number of Soft-Sort Events per Bin Tipped
16567
+ *
16568
+ * @type {number}
16569
+ * @public
16570
+ */
16571
+ eventsPerBin: number;
16572
+ /**
16573
+ * The Number of Soft-Sort Events that occurred for the Packrun
16574
+ *
16575
+ * @type {number}
16576
+ * @public
16577
+ */
16578
+ totalEventsCount: number;
16579
+ /**
16580
+ * The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
16581
+ *
16582
+ * @type {number}
16583
+ * @public
16584
+ */
16585
+ averageEventsDuration: number;
16586
+ /**
16587
+ * The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
16588
+ *
16589
+ * @type {number}
16590
+ * @public
16591
+ */
16592
+ totalEventsDuration: number;
16593
+ /**
16594
+ * Whether the Soft-Sort Events Data for this Summary has been Finalized
16595
+ *
16596
+ * @type {?Date}
16597
+ * @public
16598
+ */
16599
+ eventsFinalizedTimestamp: Date | null;
16600
+ /**
16601
+ * Whether the Soft-Sort Events for this Summary are considered accurate or not
16602
+ *
16603
+ * @type {?boolean}
16604
+ * @public
16605
+ */
16606
+ eventsAccurate: boolean | null;
16607
+ /**
16608
+ * A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
16609
+ *
16610
+ * @type {?string}
16611
+ * @public
16612
+ */
16613
+ eventsNotAccurateReason: string | null;
16614
+ /**
16615
+ * The FreshPack Soft-Sort API Data
16616
+ *
16617
+ * @type {?Object}
16618
+ * @public
16619
+ */
16620
+ freshPackSoftSortApi: any | null;
16621
+ /**
16622
+ * Whether the Soft-Sort Packrun Summary has been deleted
16623
+ *
16624
+ * @type {boolean}
16625
+ * @public
16626
+ */
16627
+ deleted: boolean;
16628
+ /**
16629
+ * When the Soft-Sort Packrun Summary was last updated
16630
+ *
16631
+ * @type {Date}
16632
+ * @public
16633
+ */
16634
+ updateTimestamp: Date;
16635
+ /**
16636
+ * The Site ID associated with this Soft-Sort Packrun Summary
16637
+ *
16638
+ * @type {number}
16639
+ * @public
16640
+ */
16641
+ siteId: number;
16642
+ }
16643
+ import BaseModel from "@ricado/api-client/Models/BaseModel";
16644
+ }
16645
+
15887
16646
  declare module '@ricado/api-client/Models/Packhouse/Site/VarietyModel' {
15888
16647
  export default VarietyModel;
15889
16648
  /**