@ricado/api-client 2.3.5 → 2.3.8

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
  /**
@@ -5513,6 +5749,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinControlle
5513
5749
  * The Packrun ID associated with this Bin
5514
5750
  */
5515
5751
  packrunId?: string;
5752
+ /**
5753
+ * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
5754
+ */
5755
+ binNumber?: string | null;
5756
+ /**
5757
+ * The Source of the Bin Number
5758
+ */
5759
+ binNumberSource?: string | null;
5516
5760
  /**
5517
5761
  * The `BinTipWeight` ID as the Source for the Full Weight of this Bin
5518
5762
  */
@@ -5550,6 +5794,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinControlle
5550
5794
  * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
5551
5795
  */
5552
5796
  binNumber?: string | null;
5797
+ /**
5798
+ * The Source of the Bin Number
5799
+ */
5800
+ binNumberSource?: string | null;
5553
5801
  /**
5554
5802
  * The Time Batch ID associated with this Bin
5555
5803
  */
@@ -5591,6 +5839,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinControlle
5591
5839
  * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
5592
5840
  */
5593
5841
  binNumber?: string | null;
5842
+ /**
5843
+ * The Source of the Bin Number
5844
+ */
5845
+ binNumberSource?: string | null;
5594
5846
  /**
5595
5847
  * The Time Batch ID associated with this Bin
5596
5848
  */
@@ -11683,6 +11935,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummar
11683
11935
  * The Shift ID this Quality Summary is asssociated with
11684
11936
  */
11685
11937
  shiftId?: string;
11938
+ /**
11939
+ * When this Quality Summary was Published
11940
+ */
11941
+ publishTimestamp?: Date | null;
11686
11942
  /**
11687
11943
  * The User ID of the Quality Manager for this Summary
11688
11944
  */
@@ -12432,84 +12688,376 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/SoftSortBeltContro
12432
12688
  import SoftSortBeltModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel";
12433
12689
  }
12434
12690
 
12435
- declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController' {
12436
- export default VarietyController;
12691
+ declare module '@ricado/api-client/Controllers/Packhouse/Site/SoftSortPackrunSummaryController' {
12692
+ export default SoftSortPackrunSummaryController;
12437
12693
  /**
12438
- * Controller Class for Varieties
12694
+ * Controller Class for Soft-Sort Packrun Summaries
12439
12695
  *
12440
12696
  * @class
12441
12697
  */
12442
- class VarietyController {
12698
+ class SoftSortPackrunSummaryController {
12443
12699
  /**
12444
- * Retrieve a Variety [GET /packhouse/sites/{siteId}/varieties/{id}]
12700
+ * Retrieve a Soft-Sort Packrun Summary [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
12445
12701
  *
12446
12702
  * @static
12447
12703
  * @public
12448
12704
  * @param {number} siteId The Site ID
12449
- * @param {string} id The Variety ID
12450
- * @return {Promise<VarietyModel>}
12705
+ * @param {string} id The Soft-Sort Packrun Summary ID
12706
+ * @return {Promise<SoftSortPackrunSummaryModel>}
12451
12707
  */
12452
- static getOne(siteId: number, id: string): Promise<VarietyModel>;
12708
+ static getOne(siteId: number, id: string): Promise<SoftSortPackrunSummaryModel>;
12453
12709
  /**
12454
- * Update a Variety [PATCH /packhouse/sites/{siteId}/varieties/{id}]
12710
+ * Update a Soft-Sort Packrun Summary [PATCH /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
12455
12711
  *
12456
12712
  * @static
12457
12713
  * @public
12458
12714
  * @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>}
12715
+ * @param {string} id The Soft-Sort Packrun Summary ID
12716
+ * @param {SoftSortPackrunSummaryController.UpdateData} updateData The Soft-Sort Packrun Summary Update Data
12717
+ * @return {Promise<SoftSortPackrunSummaryModel>}
12462
12718
  */
12463
- static update(siteId: number, id: string, updateData: VarietyController.UpdateData): Promise<VarietyModel>;
12719
+ static update(siteId: number, id: string, updateData: SoftSortPackrunSummaryController.UpdateData): Promise<SoftSortPackrunSummaryModel>;
12464
12720
  /**
12465
- * Delete a Variety [DELETE /packhouse/sites/{siteId}/varieties/{id}]
12721
+ * Delete a Soft-Sort Packrun Summary [DELETE /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
12466
12722
  *
12467
12723
  * @static
12468
12724
  * @public
12469
12725
  * @param {number} siteId The Site ID
12470
- * @param {string} id The Variety ID
12726
+ * @param {string} id The Soft-Sort Packrun Summary ID
12471
12727
  * @return {Promise<boolean>}
12472
12728
  */
12473
12729
  static delete(siteId: number, id: string): Promise<boolean>;
12474
12730
  /**
12475
- * List all Varieties [GET /packhouse/sites/{siteId}/varieties]
12731
+ * Retrieve Comments [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments]
12732
+ *
12733
+ * Retrieves Comments for a Soft-Sort Packrun Summary
12476
12734
  *
12477
12735
  * @static
12478
12736
  * @public
12479
12737
  * @param {number} siteId The Site ID
12480
- * @param {VarietyController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
12481
- * @return {Promise<VarietyModel[]>}
12738
+ * @param {string} id The Soft-Sort Packrun Summary ID
12739
+ * @return {Promise<Array<SoftSortPackrunSummaryController.CommentItem>>}
12482
12740
  */
12483
- static getAll(siteId: number, queryParameters?: VarietyController.GetAllQueryParameters | undefined): Promise<VarietyModel[]>;
12741
+ static getComments(siteId: number, id: string): Promise<Array<SoftSortPackrunSummaryController.CommentItem>>;
12484
12742
  /**
12485
- * Create a Variety [POST /packhouse/sites/{siteId}/varieties]
12743
+ * Create a Comment [POST /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments]
12744
+ *
12745
+ * Create a Comment for a Soft-Sort Packrun Summary
12486
12746
  *
12487
12747
  * @static
12488
12748
  * @public
12489
12749
  * @param {number} siteId The Site ID
12490
- * @param {VarietyController.CreateData} createData The Variety Create Data
12491
- * @return {Promise<VarietyModel>}
12750
+ * @param {string} id The Soft-Sort Packrun Summary ID
12751
+ * @param {string} content The Content of the New Comment
12752
+ * @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
12492
12753
  */
12493
- static create(siteId: number, createData: VarietyController.CreateData): Promise<VarietyModel>;
12754
+ static createComment(siteId: number, id: string, content: string): Promise<SoftSortPackrunSummaryController.CommentItem>;
12755
+ /**
12756
+ * Retrieve a Comment [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]
12757
+ *
12758
+ * Retrieves Comments for a Soft-Sort Packrun Summary
12759
+ *
12760
+ * @static
12761
+ * @public
12762
+ * @param {number} siteId The Site ID
12763
+ * @param {string} id The Soft-Sort Packrun Summary ID
12764
+ * @param {string} commentId The Comment ID
12765
+ * @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
12766
+ */
12767
+ static getOneComment(siteId: number, id: string, commentId: string): Promise<SoftSortPackrunSummaryController.CommentItem>;
12768
+ /**
12769
+ * Update a Comment [PATCH /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]
12770
+ *
12771
+ * Update a Comment for a Soft-Sort Packrun Summary
12772
+ *
12773
+ * @static
12774
+ * @public
12775
+ * @param {number} siteId The Site ID
12776
+ * @param {string} id The Soft-Sort Packrun Summary ID
12777
+ * @param {string} commentId The Comment ID
12778
+ * @param {string} content The Updated Content for the Comment
12779
+ * @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
12780
+ */
12781
+ static updateOneComment(siteId: number, id: string, commentId: string, content: string): Promise<SoftSortPackrunSummaryController.CommentItem>;
12782
+ /**
12783
+ * Delete a Comment [DELETE /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]
12784
+ *
12785
+ * Delete a Comment for a Soft-Sort Packrun Summary
12786
+ *
12787
+ * @static
12788
+ * @public
12789
+ * @param {number} siteId The Site ID
12790
+ * @param {string} id The Soft-Sort Packrun Summary ID
12791
+ * @param {string} commentId The Comment ID
12792
+ * @return {Promise<boolean>}
12793
+ */
12794
+ static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
12795
+ /**
12796
+ * List all Soft-Sort Packrun Summaries [GET /packhouse/sites/{siteId}/softsort-packrun-summaries]
12797
+ *
12798
+ * @static
12799
+ * @public
12800
+ * @param {number} siteId The Site ID
12801
+ * @param {SoftSortPackrunSummaryController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
12802
+ * @return {Promise<SoftSortPackrunSummaryModel[]>}
12803
+ */
12804
+ static getAll(siteId: number, queryParameters?: SoftSortPackrunSummaryController.GetAllQueryParameters | undefined): Promise<SoftSortPackrunSummaryModel[]>;
12805
+ /**
12806
+ * Create a Soft-Sort Packrun Summary [POST /packhouse/sites/{siteId}/softsort-packrun-summaries]
12807
+ *
12808
+ * @static
12809
+ * @public
12810
+ * @param {number} siteId The Site ID
12811
+ * @param {SoftSortPackrunSummaryController.CreateData} createData The Soft-Sort Packrun Summary Create Data
12812
+ * @return {Promise<SoftSortPackrunSummaryModel>}
12813
+ */
12814
+ static create(siteId: number, createData: SoftSortPackrunSummaryController.CreateData): Promise<SoftSortPackrunSummaryModel>;
12494
12815
  }
12495
- namespace VarietyController {
12816
+ namespace SoftSortPackrunSummaryController {
12496
12817
  /**
12497
12818
  * The Optional Query Parameters for the getAll Function
12498
12819
  */
12499
12820
  export type GetAllQueryParameters = {
12500
12821
  /**
12501
- * The Variety Code
12822
+ * The Packing Line ID this Summary is associated with
12502
12823
  */
12503
- code?: string;
12824
+ packingLineId?: string;
12504
12825
  /**
12505
- * The Variety Name
12826
+ * The Packrun ID this Summary is associated with
12506
12827
  */
12507
- name?: string;
12508
- };
12509
- /**
12510
- * The Create Data for a Variety
12511
- */
12512
- export type CreateData = {
12828
+ packrunId?: string;
12829
+ /**
12830
+ * Whether the Soft-Sort Events Data for this Summary has been Finalized
12831
+ */
12832
+ eventsFinalizedTimestamp?: Date | null;
12833
+ /**
12834
+ * Whether the Soft-Sort Events for this Summary are considered accurate or not
12835
+ */
12836
+ eventsAccurate?: boolean | null;
12837
+ /**
12838
+ * Filter by the Timestamp when this Soft-Sort Packrun Summary was Created. Results Greater than or Equal to Timestamp
12839
+ */
12840
+ createdTimestampBegin?: Date;
12841
+ /**
12842
+ * Filter by the Timestamp when this Soft-Sort Packrun Summary was Created. Results Less than or Equal to Timestamp
12843
+ */
12844
+ createdTimestampEnd?: Date;
12845
+ };
12846
+ /**
12847
+ * The Create Data for a Soft-Sort Packrun Summary
12848
+ */
12849
+ export type CreateData = {
12850
+ /**
12851
+ * The Packing Line ID this Summary is associated with
12852
+ */
12853
+ packingLineId: string;
12854
+ /**
12855
+ * The Packrun ID this Summary is associated with
12856
+ */
12857
+ packrunId?: string;
12858
+ /**
12859
+ * When this Summary was Created
12860
+ */
12861
+ createdTimestamp?: Date;
12862
+ /**
12863
+ * The Number of Soft-Sort Events per Bin Tipped
12864
+ */
12865
+ eventsPerBin: number;
12866
+ /**
12867
+ * The Number of Soft-Sort Events that occurred for the Packrun
12868
+ */
12869
+ totalEventsCount: number;
12870
+ /**
12871
+ * The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
12872
+ */
12873
+ averageEventsDuration: number;
12874
+ /**
12875
+ * The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
12876
+ */
12877
+ totalEventsDuration: number;
12878
+ /**
12879
+ * Whether the Soft-Sort Events Data for this Summary has been Finalized
12880
+ */
12881
+ eventsFinalizedTimestamp?: Date | null;
12882
+ /**
12883
+ * Whether the Soft-Sort Events for this Summary are considered accurate or not
12884
+ */
12885
+ eventsAccurate?: boolean | null;
12886
+ /**
12887
+ * A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
12888
+ */
12889
+ eventsNotAccurateReason?: string | null;
12890
+ /**
12891
+ * The FreshPack Soft-Sort API Data
12892
+ */
12893
+ freshPackSoftSortApi?: any;
12894
+ };
12895
+ /**
12896
+ * The Update Data for a Soft-Sort Packrun Summary
12897
+ */
12898
+ export type UpdateData = {
12899
+ /**
12900
+ * The Packing Line ID this Summary is associated with
12901
+ */
12902
+ packingLineId?: string;
12903
+ /**
12904
+ * When this Summary was Created
12905
+ */
12906
+ createdTimestamp?: Date;
12907
+ /**
12908
+ * The Number of Soft-Sort Events per Bin Tipped
12909
+ */
12910
+ eventsPerBin?: number;
12911
+ /**
12912
+ * The Number of Soft-Sort Events that occurred for the Packrun
12913
+ */
12914
+ totalEventsCount?: number;
12915
+ /**
12916
+ * The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
12917
+ */
12918
+ averageEventsDuration?: number;
12919
+ /**
12920
+ * The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
12921
+ */
12922
+ totalEventsDuration?: number;
12923
+ /**
12924
+ * Whether the Soft-Sort Events Data for this Summary has been Finalized
12925
+ */
12926
+ eventsFinalizedTimestamp?: Date | null;
12927
+ /**
12928
+ * Whether the Soft-Sort Events for this Summary are considered accurate or not
12929
+ */
12930
+ eventsAccurate?: boolean | null;
12931
+ /**
12932
+ * A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
12933
+ */
12934
+ eventsNotAccurateReason?: string | null;
12935
+ /**
12936
+ * The FreshPack Soft-Sort API Data
12937
+ */
12938
+ freshPackSoftSortApi?: any;
12939
+ };
12940
+ /**
12941
+ * A **UserAccount** Type
12942
+ */
12943
+ export type UserAccount = {
12944
+ /**
12945
+ * The User Account ID
12946
+ */
12947
+ id: string | null;
12948
+ /**
12949
+ * The User's First Name
12950
+ */
12951
+ firstName: string | null;
12952
+ /**
12953
+ * The User's Last Name
12954
+ */
12955
+ lastName: string | null;
12956
+ };
12957
+ /**
12958
+ * A **CommentItem** Type
12959
+ */
12960
+ export type CommentItem = {
12961
+ /**
12962
+ * The Comment ID
12963
+ */
12964
+ id: string;
12965
+ userAccount: UserAccount;
12966
+ /**
12967
+ * The Content of the Comment
12968
+ */
12969
+ content: string | null;
12970
+ /**
12971
+ * When the Comment was Created
12972
+ */
12973
+ createdTimestamp: Date | null;
12974
+ /**
12975
+ * When the Comment was last Updated
12976
+ */
12977
+ updatedTimestamp: Date | null;
12978
+ };
12979
+ }
12980
+ import SoftSortPackrunSummaryModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortPackrunSummaryModel";
12981
+ }
12982
+
12983
+ declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController' {
12984
+ export default VarietyController;
12985
+ /**
12986
+ * Controller Class for Varieties
12987
+ *
12988
+ * @class
12989
+ */
12990
+ class VarietyController {
12991
+ /**
12992
+ * Retrieve a Variety [GET /packhouse/sites/{siteId}/varieties/{id}]
12993
+ *
12994
+ * @static
12995
+ * @public
12996
+ * @param {number} siteId The Site ID
12997
+ * @param {string} id The Variety ID
12998
+ * @return {Promise<VarietyModel>}
12999
+ */
13000
+ static getOne(siteId: number, id: string): Promise<VarietyModel>;
13001
+ /**
13002
+ * Update a Variety [PATCH /packhouse/sites/{siteId}/varieties/{id}]
13003
+ *
13004
+ * @static
13005
+ * @public
13006
+ * @param {number} siteId The Site ID
13007
+ * @param {string} id The Variety ID
13008
+ * @param {VarietyController.UpdateData} updateData The Variety Update Data
13009
+ * @return {Promise<VarietyModel>}
13010
+ */
13011
+ static update(siteId: number, id: string, updateData: VarietyController.UpdateData): Promise<VarietyModel>;
13012
+ /**
13013
+ * Delete a Variety [DELETE /packhouse/sites/{siteId}/varieties/{id}]
13014
+ *
13015
+ * @static
13016
+ * @public
13017
+ * @param {number} siteId The Site ID
13018
+ * @param {string} id The Variety ID
13019
+ * @return {Promise<boolean>}
13020
+ */
13021
+ static delete(siteId: number, id: string): Promise<boolean>;
13022
+ /**
13023
+ * List all Varieties [GET /packhouse/sites/{siteId}/varieties]
13024
+ *
13025
+ * @static
13026
+ * @public
13027
+ * @param {number} siteId The Site ID
13028
+ * @param {VarietyController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
13029
+ * @return {Promise<VarietyModel[]>}
13030
+ */
13031
+ static getAll(siteId: number, queryParameters?: VarietyController.GetAllQueryParameters | undefined): Promise<VarietyModel[]>;
13032
+ /**
13033
+ * Create a Variety [POST /packhouse/sites/{siteId}/varieties]
13034
+ *
13035
+ * @static
13036
+ * @public
13037
+ * @param {number} siteId The Site ID
13038
+ * @param {VarietyController.CreateData} createData The Variety Create Data
13039
+ * @return {Promise<VarietyModel>}
13040
+ */
13041
+ static create(siteId: number, createData: VarietyController.CreateData): Promise<VarietyModel>;
13042
+ }
13043
+ namespace VarietyController {
13044
+ /**
13045
+ * The Optional Query Parameters for the getAll Function
13046
+ */
13047
+ export type GetAllQueryParameters = {
13048
+ /**
13049
+ * The Variety Code
13050
+ */
13051
+ code?: string;
13052
+ /**
13053
+ * The Variety Name
13054
+ */
13055
+ name?: string;
13056
+ };
13057
+ /**
13058
+ * The Create Data for a Variety
13059
+ */
13060
+ export type CreateData = {
12513
13061
  /**
12514
13062
  * The Variety Code
12515
13063
  */
@@ -12565,6 +13113,95 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController'
12565
13113
  import VarietyModel from "@ricado/api-client/Models/Packhouse/Site/VarietyModel";
12566
13114
  }
12567
13115
 
13116
+ declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel' {
13117
+ export default BinTipBinCardModel;
13118
+ /**
13119
+ * Model Class for a Bin Tip Bin Card
13120
+ *
13121
+ * @class
13122
+ * @hideconstructor
13123
+ * @extends BaseModel
13124
+ */
13125
+ class BinTipBinCardModel extends BaseModel {
13126
+ /**
13127
+ * Create a new **BinTipBinCardModel** from a JSON Object or JSON String
13128
+ *
13129
+ * @static
13130
+ * @public
13131
+ * @param {Object<string, any>|string} json A JSON Object or JSON String
13132
+ * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
13133
+ * @return {BinTipBinCardModel}
13134
+ */
13135
+ static fromJSON(json: {
13136
+ [x: string]: any;
13137
+ } | string, siteId: number): BinTipBinCardModel;
13138
+ /**
13139
+ * BinTipBinCardModel Constructor
13140
+ *
13141
+ * @protected
13142
+ * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
13143
+ */
13144
+ protected constructor();
13145
+ /**
13146
+ * The Bin Tip Bin Card ID
13147
+ *
13148
+ * @type {string}
13149
+ * @public
13150
+ */
13151
+ id: string;
13152
+ /**
13153
+ * The Bin Tip ID associated with this Bin Card
13154
+ *
13155
+ * @type {string}
13156
+ * @public
13157
+ */
13158
+ binTipId: string;
13159
+ /**
13160
+ * The Bin ID associated with this Bin Card
13161
+ *
13162
+ * @type {string}
13163
+ * @public
13164
+ */
13165
+ binTipBinId: string;
13166
+ /**
13167
+ * When this Bin Card was Created
13168
+ *
13169
+ * @type {Date}
13170
+ * @public
13171
+ */
13172
+ createdTimestamp: Date;
13173
+ /**
13174
+ * A Base64 Encoded Image of the Bin Card
13175
+ *
13176
+ * @type {?string}
13177
+ * @public
13178
+ */
13179
+ image: string | null;
13180
+ /**
13181
+ * Whether the Bin Tip Bin Card has been deleted
13182
+ *
13183
+ * @type {boolean}
13184
+ * @public
13185
+ */
13186
+ deleted: boolean;
13187
+ /**
13188
+ * When the Bin Tip Bin Card was last updated
13189
+ *
13190
+ * @type {Date}
13191
+ * @public
13192
+ */
13193
+ updateTimestamp: Date;
13194
+ /**
13195
+ * The Site ID associated with this Bin Tip Bin Card
13196
+ *
13197
+ * @type {number}
13198
+ * @public
13199
+ */
13200
+ siteId: number;
13201
+ }
13202
+ import BaseModel from "@ricado/api-client/Models/BaseModel";
13203
+ }
13204
+
12568
13205
  declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinModel' {
12569
13206
  export default BinTipBinModel;
12570
13207
  /**
@@ -12629,6 +13266,13 @@ declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinModel' {
12629
13266
  * @public
12630
13267
  */
12631
13268
  binNumber: string | null;
13269
+ /**
13270
+ * The Source of the Bin Number
13271
+ *
13272
+ * @type {?string}
13273
+ * @public
13274
+ */
13275
+ binNumberSource: string | null;
12632
13276
  /**
12633
13277
  * The Time Batch ID associated with this Bin
12634
13278
  *
@@ -15884,6 +16528,144 @@ declare module '@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel' {
15884
16528
  import BaseModel from "@ricado/api-client/Models/BaseModel";
15885
16529
  }
15886
16530
 
16531
+ declare module '@ricado/api-client/Models/Packhouse/Site/SoftSortPackrunSummaryModel' {
16532
+ export default SoftSortPackrunSummaryModel;
16533
+ /**
16534
+ * Model Class for a Soft-Sort Packrun Summary
16535
+ *
16536
+ * @class
16537
+ * @hideconstructor
16538
+ * @extends BaseModel
16539
+ */
16540
+ class SoftSortPackrunSummaryModel extends BaseModel {
16541
+ /**
16542
+ * Create a new **SoftSortPackrunSummaryModel** from a JSON Object or JSON String
16543
+ *
16544
+ * @static
16545
+ * @public
16546
+ * @param {Object<string, any>|string} json A JSON Object or JSON String
16547
+ * @param {number} siteId The Site ID associated with this Soft-Sort Packrun Summary
16548
+ * @return {SoftSortPackrunSummaryModel}
16549
+ */
16550
+ static fromJSON(json: {
16551
+ [x: string]: any;
16552
+ } | string, siteId: number): SoftSortPackrunSummaryModel;
16553
+ /**
16554
+ * SoftSortPackrunSummaryModel Constructor
16555
+ *
16556
+ * @protected
16557
+ * @param {number} siteId The Site ID associated with this Soft-Sort Packrun Summary
16558
+ */
16559
+ protected constructor();
16560
+ /**
16561
+ * The Soft-Sort Packrun Summary ID
16562
+ *
16563
+ * @type {string}
16564
+ * @public
16565
+ */
16566
+ id: string;
16567
+ /**
16568
+ * The Packing Line ID this Summary is associated with
16569
+ *
16570
+ * @type {string}
16571
+ * @public
16572
+ */
16573
+ packingLineId: string;
16574
+ /**
16575
+ * The Packrun ID this Summary is associated with
16576
+ *
16577
+ * @type {string}
16578
+ * @public
16579
+ */
16580
+ packrunId: string;
16581
+ /**
16582
+ * When this Summary was Created
16583
+ *
16584
+ * @type {Date}
16585
+ * @public
16586
+ */
16587
+ createdTimestamp: Date;
16588
+ /**
16589
+ * The Number of Soft-Sort Events per Bin Tipped
16590
+ *
16591
+ * @type {number}
16592
+ * @public
16593
+ */
16594
+ eventsPerBin: number;
16595
+ /**
16596
+ * The Number of Soft-Sort Events that occurred for the Packrun
16597
+ *
16598
+ * @type {number}
16599
+ * @public
16600
+ */
16601
+ totalEventsCount: number;
16602
+ /**
16603
+ * The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
16604
+ *
16605
+ * @type {number}
16606
+ * @public
16607
+ */
16608
+ averageEventsDuration: number;
16609
+ /**
16610
+ * The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
16611
+ *
16612
+ * @type {number}
16613
+ * @public
16614
+ */
16615
+ totalEventsDuration: number;
16616
+ /**
16617
+ * Whether the Soft-Sort Events Data for this Summary has been Finalized
16618
+ *
16619
+ * @type {?Date}
16620
+ * @public
16621
+ */
16622
+ eventsFinalizedTimestamp: Date | null;
16623
+ /**
16624
+ * Whether the Soft-Sort Events for this Summary are considered accurate or not
16625
+ *
16626
+ * @type {?boolean}
16627
+ * @public
16628
+ */
16629
+ eventsAccurate: boolean | null;
16630
+ /**
16631
+ * A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
16632
+ *
16633
+ * @type {?string}
16634
+ * @public
16635
+ */
16636
+ eventsNotAccurateReason: string | null;
16637
+ /**
16638
+ * The FreshPack Soft-Sort API Data
16639
+ *
16640
+ * @type {?Object}
16641
+ * @public
16642
+ */
16643
+ freshPackSoftSortApi: any | null;
16644
+ /**
16645
+ * Whether the Soft-Sort Packrun Summary has been deleted
16646
+ *
16647
+ * @type {boolean}
16648
+ * @public
16649
+ */
16650
+ deleted: boolean;
16651
+ /**
16652
+ * When the Soft-Sort Packrun Summary was last updated
16653
+ *
16654
+ * @type {Date}
16655
+ * @public
16656
+ */
16657
+ updateTimestamp: Date;
16658
+ /**
16659
+ * The Site ID associated with this Soft-Sort Packrun Summary
16660
+ *
16661
+ * @type {number}
16662
+ * @public
16663
+ */
16664
+ siteId: number;
16665
+ }
16666
+ import BaseModel from "@ricado/api-client/Models/BaseModel";
16667
+ }
16668
+
15887
16669
  declare module '@ricado/api-client/Models/Packhouse/Site/VarietyModel' {
15888
16670
  export default VarietyModel;
15889
16671
  /**