@vindentech/api-client 0.3.0-next.73 → 0.3.0-next.75

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.
@@ -5367,13 +5367,24 @@ export interface PodDetailDto {
5367
5367
  labelId: string | null;
5368
5368
  /** pod_status value */
5369
5369
  status: string;
5370
- /** Unit width (mm) */
5371
- unitWidthMm: number;
5372
- unitHeightMm: number;
5373
- unitDepthMm: number;
5370
+ /**
5371
+ * Unit width (mm). The three dimensions are all set or all null; null means no size has been recorded for this unit yet, and volumeCm3 is then null too.
5372
+ * @nullable
5373
+ */
5374
+ unitWidthMm: number | null;
5375
+ /**
5376
+ * Unit height (mm); null with unitWidthMm.
5377
+ * @nullable
5378
+ */
5379
+ unitHeightMm: number | null;
5380
+ /**
5381
+ * Unit depth (mm); null with unitWidthMm.
5382
+ * @nullable
5383
+ */
5384
+ unitDepthMm: number | null;
5374
5385
  quantity: number;
5375
5386
  /**
5376
- * Volume in cm³ (generated projection)
5387
+ * Volume in cm³ (generated projection); null while the unit has no recorded size.
5377
5388
  * @nullable
5378
5389
  */
5379
5390
  volumeCm3: number | null;
@@ -5432,21 +5443,6 @@ export interface PickStateDto {
5432
5443
  packedQuantity: number | null;
5433
5444
  }
5434
5445
  export interface UpdatePodDto {
5435
- /**
5436
- * Unit width in millimetres.
5437
- * @minimum 1
5438
- */
5439
- unitWidthMm?: number;
5440
- /**
5441
- * Unit height in millimetres.
5442
- * @minimum 1
5443
- */
5444
- unitHeightMm?: number;
5445
- /**
5446
- * Unit depth in millimetres.
5447
- * @minimum 1
5448
- */
5449
- unitDepthMm?: number;
5450
5446
  /**
5451
5447
  * Physical label id (relabel).
5452
5448
  * @maxLength 200
@@ -5470,13 +5466,24 @@ export interface PodDto {
5470
5466
  labelId: string | null;
5471
5467
  /** pod_status value */
5472
5468
  status: string;
5473
- /** Unit width (mm) */
5474
- unitWidthMm: number;
5475
- unitHeightMm: number;
5476
- unitDepthMm: number;
5469
+ /**
5470
+ * Unit width (mm). The three dimensions are all set or all null; null means no size has been recorded for this unit yet, and volumeCm3 is then null too.
5471
+ * @nullable
5472
+ */
5473
+ unitWidthMm: number | null;
5474
+ /**
5475
+ * Unit height (mm); null with unitWidthMm.
5476
+ * @nullable
5477
+ */
5478
+ unitHeightMm: number | null;
5479
+ /**
5480
+ * Unit depth (mm); null with unitWidthMm.
5481
+ * @nullable
5482
+ */
5483
+ unitDepthMm: number | null;
5477
5484
  quantity: number;
5478
5485
  /**
5479
- * Volume in cm³ (generated projection)
5486
+ * Volume in cm³ (generated projection); null while the unit has no recorded size.
5480
5487
  * @nullable
5481
5488
  */
5482
5489
  volumeCm3: number | null;
@@ -6385,8 +6392,8 @@ export interface ReceiveNewProductCommandDto {
6385
6392
  placeholderName: string;
6386
6393
  /** Category FK; a bad id falls back to null + categoryFallbackUsed:true. */
6387
6394
  categoryId?: number;
6388
- /** User-estimated unit dimensions. */
6389
- userEstimatedUnitDimensions: UnitDimensionsDto;
6395
+ /** Measured unit dimensions of the received goods. The pod is recorded as warehouse-measured. */
6396
+ unitDimensions: UnitDimensionsDto;
6390
6397
  /** Destination container. */
6391
6398
  containerId: string;
6392
6399
  /**
@@ -6507,8 +6514,8 @@ export interface AdjustResultDto {
6507
6514
  }
6508
6515
  export interface SyncProductPodDimensionsDto {
6509
6516
  productId: string;
6510
- /** A pod of the product's item. */
6511
- podId: string;
6517
+ /** A pod of the product's item. Optional: the save measures every live pod of the product whose sales order has not completed, whether or not one is named. When sent it must belong to the product (else 404), and the response reports it back. */
6518
+ podId?: string;
6512
6519
  /** Measured unit dimensions. */
6513
6520
  unitDimensions: UnitDimensionsDto;
6514
6521
  /**
@@ -6530,7 +6537,15 @@ export interface SyncedPodDimensionsDto {
6530
6537
  }
6531
6538
  export interface SyncProductPodDimensionsResultDto {
6532
6539
  productId: string;
6533
- pod: SyncedPodDimensionsDto;
6540
+ /**
6541
+ * The pod named by podId, as written. Null when podId was omitted, or when that pod was skipped because its sales order has completed.
6542
+ * @nullable
6543
+ */
6544
+ pod: SyncedPodDimensionsDto | null;
6545
+ /** Live pods of the product this save sized and stamped as measured. */
6546
+ podsWritten: number;
6547
+ /** Live pods of the product left as they were because their sales order has completed: its billable volume is already fixed, and the pod must keep agreeing with it. */
6548
+ podsSkipped: number;
6534
6549
  /** True when this response replays a previous run of the key. */
6535
6550
  idempotent: boolean;
6536
6551
  }
@@ -6665,8 +6680,8 @@ export interface IdentifyPickupItemCommandDto {
6665
6680
  placeholderName: string;
6666
6681
  /** Category id (nullable FK). A bad id falls back to null with categoryFallbackUsed=true. */
6667
6682
  categoryId?: number;
6668
- /** Worker's estimated unit dimensions. */
6669
- userEstimatedUnitDimensions: UnitDimensionsDto;
6683
+ /** Optional estimate of one unit's size, e.g. the driver's. It is stored on the product created by the ad-hoc branch (as the product's estimated dimensions) and never sizes the pod: the pod is created without dimensions until a warehouse measures it. Ignored when salesOrderProductId is sent, since that product already exists. */
6684
+ userEstimatedUnitDimensions?: UnitDimensionsDto;
6670
6685
  /** Storage key of the product image. */
6671
6686
  productImageStorageKey: string;
6672
6687
  damageReport?: DamageReportInputDto;
@@ -6709,8 +6724,8 @@ export interface CheckInNewProductCommandDto {
6709
6724
  placeholderName: string;
6710
6725
  /** Category id (nullable FK). A bad id falls back to null with categoryFallbackUsed=true. */
6711
6726
  categoryId?: number;
6712
- /** Worker's estimated unit dimensions. */
6713
- userEstimatedUnitDimensions: UnitDimensionsDto;
6727
+ /** Measured unit dimensions of the item. The pod is recorded as warehouse-measured. */
6728
+ unitDimensions: UnitDimensionsDto;
6714
6729
  /** Storage key of the product image. */
6715
6730
  productImageStorageKey: string;
6716
6731
  /** Destination container — the pod is put away immediately, no separate check-in/place call. */
@@ -10929,8 +10944,16 @@ export interface NotificationDispatchDto {
10929
10944
  fromAddress: string | null;
10930
10945
  /** @nullable */
10931
10946
  subject: string | null;
10932
- /** @nullable */
10947
+ /**
10948
+ * The locale of the template version that was PINNED — the outcome of the locale fallback, not the request that entered it. Null on a pre-send terminal row and wherever no template resolved.
10949
+ * @nullable
10950
+ */
10933
10951
  locale: string | null;
10952
+ /**
10953
+ * The locale THIS RECIPIENT asked for. Differs from `locale` exactly when the send fell back to a template in another language — which is the one comparison that tells a wrong-language send from a correct one. Read from the recipient's kind, so two rows of one event legitimately differ: the customer's is the event's own locale, a staff member's is their profile preference, an ops mailbox's is the tenant default. Null where nothing was requested: a test send, where the operator named a template version directly, and any row written before this field existed.
10954
+ * @nullable
10955
+ */
10956
+ requestedLocale: string | null;
10934
10957
  status: NotificationDispatchDtoStatus;
10935
10958
  isTest: boolean;
10936
10959
  attemptCount: number;
@@ -11081,8 +11104,16 @@ export interface NotificationDispatchDetailDto {
11081
11104
  fromAddress: string | null;
11082
11105
  /** @nullable */
11083
11106
  subject: string | null;
11084
- /** @nullable */
11107
+ /**
11108
+ * The locale of the template version that was PINNED — the outcome of the locale fallback, not the request that entered it. Null on a pre-send terminal row and wherever no template resolved.
11109
+ * @nullable
11110
+ */
11085
11111
  locale: string | null;
11112
+ /**
11113
+ * The locale THIS RECIPIENT asked for. Differs from `locale` exactly when the send fell back to a template in another language — which is the one comparison that tells a wrong-language send from a correct one. Read from the recipient's kind, so two rows of one event legitimately differ: the customer's is the event's own locale, a staff member's is their profile preference, an ops mailbox's is the tenant default. Null where nothing was requested: a test send, where the operator named a template version directly, and any row written before this field existed.
11114
+ * @nullable
11115
+ */
11116
+ requestedLocale: string | null;
11086
11117
  status: NotificationDispatchDetailDtoStatus;
11087
11118
  isTest: boolean;
11088
11119
  attemptCount: number;
@@ -11533,6 +11564,10 @@ export interface SimulationTemplateCandidateDto {
11533
11564
  }
11534
11565
  export interface SimulationTemplateResolutionDto {
11535
11566
  ruleId: string;
11567
+ /** The locale this group ASKED for — the group key, not the pinned locale. Read per recipient from their kind: the event's leaf for the customer, the person's own preference for tenant staff, the tenant default for an ops mailbox. */
11568
+ requestedLocale: string;
11569
+ /** The normalized addresses that resolve to `requestedLocale` and would therefore be pinned to this template. Only recipients the preference/suppression matrix cleared — a blocked address is never rendered. */
11570
+ recipients: string[];
11536
11571
  /** @nullable */
11537
11572
  notificationTemplateId: string | null;
11538
11573
  /** @nullable */
@@ -11544,6 +11579,8 @@ export interface SimulationTemplateResolutionDto {
11544
11579
  }
11545
11580
  export interface SimulationRenderedPreviewDto {
11546
11581
  ruleId: string;
11582
+ /** Which locale group this render belongs to. */
11583
+ requestedLocale: string;
11547
11584
  subject: string;
11548
11585
  html: string;
11549
11586
  text: string;