@simpleapps-com/augur-api 2026.10.9 → 2026.10.11

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.
@@ -316,6 +316,12 @@ interface EndpointConfig {
316
316
  method: HTTPMethod;
317
317
  /** Endpoint path (will be prefixed with baseUrl) */
318
318
  path: string;
319
+ /**
320
+ * Path param → anchored regex its value MUST match (the endpoint's registry
321
+ * `pathPatterns`, shared/REGISTRY.md). A param without one only has to be
322
+ * non-empty and well-formed.
323
+ */
324
+ pathPatterns?: Readonly<Record<string, string>>;
319
325
  /** Valibot schema for validating request parameters */
320
326
  paramsSchema?: v.GenericSchema;
321
327
  /** Valibot schema for validating response data */
@@ -457,15 +463,19 @@ declare abstract class BaseServiceClient {
457
463
  */
458
464
  private createValidationError;
459
465
  /**
460
- * Build endpoint path with optional path parameter substitution
466
+ * Build endpoint path with optional path parameter substitution.
467
+ * Each value is validated against its placeholder's pattern, then
468
+ * percent-encoded per segment (`encodePathSegment`).
461
469
  *
462
470
  * @param pathTemplate Path template with {param} placeholders
463
471
  * @param pathParams Object containing parameter values
472
+ * @param pathPatterns Placeholder name → anchored regex its value MUST match
464
473
  * @returns Processed endpoint path
465
474
  *
466
475
  * @example
467
476
  * ```typescript
468
477
  * buildEndpointPath('/users/{id}', { id: '123' }) // returns '/users/123'
478
+ * buildEndpointPath('/bins/{bin}', { bin: 'D/S' }) // returns '/bins/D%2FS'
469
479
  * buildEndpointPath('/health-check') // returns '/health-check'
470
480
  * ```
471
481
  */
@@ -496,6 +506,8 @@ interface EndpointEntry {
496
506
  readonly path: string;
497
507
  /** Path params in URL order */
498
508
  readonly pathParams: readonly string[];
509
+ /** Path param → anchored regex its value MUST match; params without one are absent */
510
+ readonly pathPatterns: Readonly<Record<string, string>>;
499
511
  readonly queryParams: readonly string[];
500
512
  /** Alternative action names; an alias id is `service.chain.alias` */
501
513
  readonly aliases: readonly string[];
@@ -741,7 +753,7 @@ interface ActionLogsListItem {
741
753
  id: number;
742
754
  /** Joomla language key of the log message (max 255 chars) */
743
755
  messageLanguageKey: string;
744
- /** Log message data (JSON) (max 2147483647 chars) */
756
+ /** Log message data (JSON) */
745
757
  message: string;
746
758
  /** When the action happened (mysql-datetime, e.g. 2025-07-30 15:50:49) */
747
759
  logDate: string;
@@ -794,7 +806,7 @@ interface CategoriesListItem$1 {
794
806
  alias: string;
795
807
  /** Admin note (max 255 chars) */
796
808
  note: string;
797
- /** Category description (HTML) (max 16777215 chars) */
809
+ /** Category description (HTML) */
798
810
  description: string | null;
799
811
  /** Publish state (1 = published, 0 = unpublished, -2 = trashed) */
800
812
  published: number;
@@ -804,7 +816,7 @@ interface CategoriesListItem$1 {
804
816
  checkedOutTime: string;
805
817
  /** Access level ID */
806
818
  access: number;
807
- /** Joomla params JSON (max 16777215 chars) */
819
+ /** Joomla params JSON */
808
820
  params: string | null;
809
821
  /** Meta description (max 1024 chars) */
810
822
  metadesc: string;
@@ -956,7 +968,7 @@ interface MenuListItem {
956
968
  img: string;
957
969
  /** Template style; 0 for the default */
958
970
  templateStyleId: number;
959
- /** Joomla params JSON (max 16777215 chars) */
971
+ /** Joomla params JSON */
960
972
  params: string;
961
973
  /** Nested-set left value */
962
974
  lft: number;
@@ -1023,7 +1035,7 @@ interface ModulesListItem {
1023
1035
  title: string;
1024
1036
  /** Admin note (max 255 chars) */
1025
1037
  note: string;
1026
- /** Custom module content (HTML) (max 2147483647 chars) */
1038
+ /** Custom module content (HTML) */
1027
1039
  content: string | null;
1028
1040
  /** Sort position within the position */
1029
1041
  ordering: number;
@@ -1045,7 +1057,7 @@ interface ModulesListItem {
1045
1057
  access: number;
1046
1058
  /** 1 when the title is shown */
1047
1059
  showtitle: number;
1048
- /** Joomla params JSON (max 2147483647 chars) */
1060
+ /** Joomla params JSON */
1049
1061
  params: string;
1050
1062
  /** 0 = site, 1 = administrator */
1051
1063
  clientId: number;
@@ -1109,41 +1121,41 @@ interface UsersListItemGroupsItem {
1109
1121
  interface UsersListItemShipToItemAddress {
1110
1122
  /** Prophet 21 address ID */
1111
1123
  id: number;
1112
- /** Address name */
1124
+ /** Address name (max 50 chars) */
1113
1125
  name: string;
1114
- /** Mailing address line 1 */
1126
+ /** Mailing address line 1 (max 50 chars) */
1115
1127
  mailAddress1: string | null;
1116
- /** Mailing address line 2 */
1128
+ /** Mailing address line 2 (max 50 chars) */
1117
1129
  mailAddress2: string | null;
1118
- /** Mailing address line 3 */
1130
+ /** Mailing address line 3 (max 50 chars) */
1119
1131
  mailAddress3: string | null;
1120
- /** Mailing city */
1132
+ /** Mailing city (max 50 chars) */
1121
1133
  mailCity: string | null;
1122
- /** Mailing state or province */
1134
+ /** Mailing state or province (max 50 chars) */
1123
1135
  mailState: string | null;
1124
- /** Mailing postal code */
1136
+ /** Mailing postal code (max 10 chars) */
1125
1137
  mailPostalCode: string | null;
1126
- /** Mailing country */
1138
+ /** Mailing country (max 50 chars) */
1127
1139
  mailCountry: string | null;
1128
- /** Physical address line 1 */
1140
+ /** Physical address line 1 (max 50 chars) */
1129
1141
  physAddress1: string | null;
1130
- /** Physical address line 2 */
1142
+ /** Physical address line 2 (max 50 chars) */
1131
1143
  physAddress2: string | null;
1132
- /** Physical address line 3 */
1144
+ /** Physical address line 3 (max 50 chars) */
1133
1145
  physAddress3: string | null;
1134
- /** Physical city */
1146
+ /** Physical city (max 50 chars) */
1135
1147
  physCity: string | null;
1136
- /** Physical state or province */
1148
+ /** Physical state or province (max 50 chars) */
1137
1149
  physState: string | null;
1138
- /** Physical postal code */
1150
+ /** Physical postal code (max 10 chars) */
1139
1151
  physPostalCode: string | null;
1140
- /** Physical country */
1152
+ /** Physical country (max 50 chars) */
1141
1153
  physCountry: string | null;
1142
- /** Address class 5 */
1154
+ /** Address class 5 (max 8 chars) */
1143
1155
  class5Id: string | null;
1144
- /** Main phone number */
1156
+ /** Main phone number (max 20 chars) */
1145
1157
  centralPhoneNumber: string | null;
1146
- /** UPS code for the address */
1158
+ /** UPS code for the address (max 40 chars) */
1147
1159
  upsCode: string | null;
1148
1160
  [key: string]: unknown;
1149
1161
  }
@@ -1158,15 +1170,15 @@ interface UsersListItemShipToItem {
1158
1170
  shipToId: number;
1159
1171
  /** Prophet 21 customer the ship-to belongs to */
1160
1172
  customerId: number;
1161
- /** Prophet 21 company */
1173
+ /** Prophet 21 company (max 8 chars) */
1162
1174
  companyId: string;
1163
- /** Default branch for the ship-to */
1175
+ /** Default branch for the ship-to (max 8 chars) */
1164
1176
  defaultBranch: string;
1165
1177
  /** Prophet 21 address ID of the default carrier */
1166
1178
  defaultCarrierId: number | null;
1167
1179
  /** Prophet 21 location the ship-to prefers to ship from */
1168
1180
  preferredLocationId: number | null;
1169
- /** Delivery instructions for the carrier */
1181
+ /** Delivery instructions for the carrier (max 255 chars) */
1170
1182
  deliveryInstructions: string | null;
1171
1183
  /** Shipping route assigned to the ship-to */
1172
1184
  shippingRouteUid: number | null;
@@ -1471,29 +1483,29 @@ interface UsersTrinityListDataProfile {
1471
1483
  interface UsersTrinityListDataP21RoleAddress {
1472
1484
  /** Prophet 21 address ID */
1473
1485
  id: number;
1474
- /** Physical address line 1 */
1486
+ /** Physical address line 1 (max 50 chars) */
1475
1487
  physAddress1: string | null;
1476
- /** Physical address line 2 */
1488
+ /** Physical address line 2 (max 50 chars) */
1477
1489
  physAddress2: string | null;
1478
- /** Physical city */
1490
+ /** Physical city (max 50 chars) */
1479
1491
  physCity: string | null;
1480
- /** Physical state or province */
1492
+ /** Physical state or province (max 50 chars) */
1481
1493
  physState: string | null;
1482
- /** Physical postal code */
1494
+ /** Physical postal code (max 10 chars) */
1483
1495
  physPostalCode: string | null;
1484
- /** Physical country */
1496
+ /** Physical country (max 50 chars) */
1485
1497
  physCountry: string | null;
1486
- /** Mailing address line 1 */
1498
+ /** Mailing address line 1 (max 50 chars) */
1487
1499
  mailAddress1: string | null;
1488
- /** Mailing address line 2 */
1500
+ /** Mailing address line 2 (max 50 chars) */
1489
1501
  mailAddress2: string | null;
1490
- /** Mailing city */
1502
+ /** Mailing city (max 50 chars) */
1491
1503
  mailCity: string | null;
1492
- /** Mailing state or province */
1504
+ /** Mailing state or province (max 50 chars) */
1493
1505
  mailState: string | null;
1494
- /** Mailing postal code */
1506
+ /** Mailing postal code (max 10 chars) */
1495
1507
  mailPostalCode: string | null;
1496
- /** Mailing country */
1508
+ /** Mailing country (max 50 chars) */
1497
1509
  mailCountry: string | null;
1498
1510
  [key: string]: unknown;
1499
1511
  }
@@ -2248,15 +2260,15 @@ interface CartHdrAlsoBoughtListItemInventorySupplierItem {
2248
2260
  invMastUid: number;
2249
2261
  /** Supplier ID */
2250
2262
  supplierId: number;
2251
- /** Supplier UPC code; empty when none */
2263
+ /** Supplier UPC code; empty when none (max 14 chars) */
2252
2264
  upcCode: string;
2253
- /** UPC check digit; empty when none */
2254
- checkDigit: string;
2265
+ /** UPC check digit (P21 decimal(1,0)); null when none */
2266
+ checkDigit: number | null;
2255
2267
  /** upcCode followed by checkDigit */
2256
2268
  upc: string;
2257
- /** Supplier part number */
2269
+ /** Supplier part number (max 40 chars) */
2258
2270
  supplierPartNo: string | null;
2259
- /** Y when this is the item's primary supplier */
2271
+ /** Y when this is the item's primary supplier (max 1 chars) */
2260
2272
  primarySupplierFlag: string | null;
2261
2273
  /** Supplier list price */
2262
2274
  listPrice: number | null;
@@ -2269,7 +2281,7 @@ interface CartHdrAlsoBoughtListItemInventorySupplierItem {
2269
2281
  * Field `itemUom` of CartHdrAlsoBoughtListItem
2270
2282
  */
2271
2283
  interface CartHdrAlsoBoughtListItemItemUomItem {
2272
- /** Unit of measure code */
2284
+ /** Unit of measure code (max 8 chars) */
2273
2285
  unitOfMeasure: string;
2274
2286
  /** Base units per one of this unit */
2275
2287
  unitSize: number;
@@ -2412,25 +2424,27 @@ interface CartHdrAlsoBoughtListItemAttributesItem {
2412
2424
  interface CartHdrAlsoBoughtListItemStockStockDataItem {
2413
2425
  /** Location ID */
2414
2426
  locationId: number;
2415
- /** Company the location belongs to */
2427
+ /** Company the location belongs to (max 8 chars) */
2416
2428
  companyId: string;
2417
2429
  /** Quantity on hand, in base units */
2418
2430
  qtyOnHand: number;
2419
2431
  /** Quantity allocated, in base units */
2420
2432
  qtyAllocated: number;
2421
- /** Y when the item is stocked at the location */
2433
+ /** Y when the item is stocked at the location (max 1 chars) */
2422
2434
  stockable: string | null;
2423
- /** Y when the item is sold from the location */
2435
+ /** Y when the item is sold from the location (max 1 chars) */
2424
2436
  sellable: string | null;
2425
- /** Y when the item is discontinued at the location */
2437
+ /** Y when the item is discontinued at the location (max 1 chars) */
2426
2438
  discontinued: string;
2439
+ /** Y when the location record is deleted in P21 (inv_loc.delete_flag) (max 1 chars) */
2440
+ deleteFlag: string | null;
2427
2441
  /** qtyOnHand minus qtyAllocated */
2428
2442
  unallocated: number;
2429
2443
  /** Date (Y-m-d) the next purchase order is due in */
2430
2444
  nextDueInPoDate: string | null;
2431
2445
  /** Quantity backordered */
2432
2446
  qtyBackordered: number | null;
2433
- /** Primary bin */
2447
+ /** Primary bin (max 10 chars) */
2434
2448
  primaryBin: string | null;
2435
2449
  /** Quantity frozen */
2436
2450
  qtyFrozen: number;
@@ -2442,13 +2456,13 @@ interface CartHdrAlsoBoughtListItemStockStockDataItem {
2442
2456
  qtyAvailable: number;
2443
2457
  /** Order quantity */
2444
2458
  orderQuantity: number | null;
2445
- /** Product group at the location */
2459
+ /** Product group at the location (max 8 chars) */
2446
2460
  productGroupId: string | null;
2447
2461
  /** Item base unit */
2448
2462
  baseUnit: string;
2449
2463
  /** Base unit size (1 when unset) */
2450
2464
  baseUnitSize: number;
2451
- /** Item default selling unit */
2465
+ /** Item default selling unit (max 8 chars) */
2452
2466
  defaultSellingUnit: string | null;
2453
2467
  /** Default selling unit size */
2454
2468
  defaultSellingUnitSize: number;
@@ -2590,55 +2604,55 @@ interface CartHdrAlsoBoughtListItemFullSizedSamplesOption1 {
2590
2604
  interface CartHdrAlsoBoughtListItem {
2591
2605
  /** Item (inv_mast) ID */
2592
2606
  invMastUid: number;
2593
- /** Item ID */
2607
+ /** Item ID (max 40 chars) */
2594
2608
  itemId: string;
2595
- /** Item description */
2609
+ /** Item description (max 40 chars) */
2596
2610
  itemDesc: string | null;
2597
2611
  /** First web-displayed category description for the item */
2598
2612
  displayDesc: string | null;
2599
- /** Extended description */
2613
+ /** Extended description (max 255 chars) */
2600
2614
  extendedDesc: string | null;
2601
- /** Short code */
2615
+ /** Short code (max 30 chars) */
2602
2616
  shortCode: string | null;
2603
- /** Default selling unit */
2617
+ /** Default selling unit (max 8 chars) */
2604
2618
  defaultSellingUnit: string | null;
2605
- /** Default purchasing unit */
2619
+ /** Default purchasing unit (max 8 chars) */
2606
2620
  defaultPurchasingUnit: string | null;
2607
- /** Y when the item is deleted */
2621
+ /** Y when the item is deleted (max 1 chars) */
2608
2622
  deleteFlag: string;
2609
2623
  /** Online code (704 = online) */
2610
2624
  onlineCd: number;
2611
2625
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2612
2626
  statusCd: number;
2613
- /** Base unit */
2627
+ /** Base unit (max 8 chars) */
2614
2628
  baseUnit: string;
2615
2629
  /** Vendor stock quantity */
2616
2630
  vndrStock: number | null;
2617
- /** Item class 1 */
2631
+ /** Item class 1 (max 8 chars) */
2618
2632
  classId1: string | null;
2619
- /** Item class 2 */
2633
+ /** Item class 2 (max 8 chars) */
2620
2634
  classId2: string | null;
2621
- /** Item class 3 */
2635
+ /** Item class 3 (max 8 chars) */
2622
2636
  classId3: string | null;
2623
- /** Item class 4 */
2637
+ /** Item class 4 (max 8 chars) */
2624
2638
  classId4: string | null;
2625
- /** Item class 5 */
2639
+ /** Item class 5 (max 8 chars) */
2626
2640
  classId5: string | null;
2627
- /** Y when the item is serialized */
2641
+ /** Y when the item is serialized (max 1 chars) */
2628
2642
  serialized: string;
2629
- /** Y when the item is lot-tracked */
2643
+ /** Y when the item is lot-tracked (max 1 chars) */
2630
2644
  trackLots: string;
2631
2645
  /** Tracking pattern derived from serialized and trackLots */
2632
2646
  trackingPattern: string;
2633
- /** Default product group */
2647
+ /** Default product group (max 8 chars) */
2634
2648
  defaultProductGroup: string | null;
2635
- /** Default sales discount group */
2649
+ /** Default sales discount group (max 8 chars) */
2636
2650
  defaultSalesDiscountGroup: string | null;
2637
- /** Default purchase discount group */
2651
+ /** Default purchase discount group (max 8 chars) */
2638
2652
  defaultPurchaseDiscGroup: string | null;
2639
- /** UPC or EAN code type */
2653
+ /** UPC or EAN code type (max 3 chars) */
2640
2654
  upcOrEan: string | null;
2641
- /** UPC or EAN code */
2655
+ /** UPC or EAN code (max 15 chars) */
2642
2656
  upcOrEanId: string | null;
2643
2657
  /** Weight */
2644
2658
  weight: number | null;
@@ -2648,11 +2662,11 @@ interface CartHdrAlsoBoughtListItem {
2648
2662
  width: number | null;
2649
2663
  /** Height */
2650
2664
  height: number | null;
2651
- /** Parker product code */
2665
+ /** Parker product code (max 255 chars) */
2652
2666
  parkerProductCd: string | null;
2653
- /** Brand name */
2667
+ /** Brand name (max 255 chars) */
2654
2668
  brandName: string | null;
2655
- /** Manufacturer name */
2669
+ /** Manufacturer name (max 255 chars) */
2656
2670
  manufacturerName: string | null;
2657
2671
  /** The item's suppliers (not deleted) */
2658
2672
  inventorySupplier: CartHdrAlsoBoughtListItemInventorySupplierItem[];
@@ -2676,8 +2690,8 @@ interface CartHdrAlsoBoughtListItem {
2676
2690
  stock: CartHdrAlsoBoughtListItemStock;
2677
2691
  /** Category display description per item category ID */
2678
2692
  categoryDisplayDescriptions: Record<string, string>;
2679
- /** Non-empty user-defined field values, keyed by field name ([] when empty) */
2680
- userDefined: Record<string, unknown> | [];
2693
+ /** Non-empty user-defined field values, keyed by field name; {} when the item has none */
2694
+ userDefined: Record<string, unknown>;
2681
2695
  /** Prophet 21 item text blocks (empty unless the site has a p21_pim config) */
2682
2696
  invMastText: CartHdrAlsoBoughtListItemInvMastTextItem[];
2683
2697
  /** Descriptions in other languages */
@@ -2737,11 +2751,11 @@ interface CartLineGetItem {
2737
2751
  invMastUid: number;
2738
2752
  /** Quantity in unitOfMeasure */
2739
2753
  quantity: number | null;
2740
- /** Unit of measure */
2754
+ /** Unit of measure (max 8 chars) */
2741
2755
  unitOfMeasure: string | null;
2742
- /** Line note */
2756
+ /** Line note (max 255 chars) */
2743
2757
  lineNote: string | null;
2744
- /** Caller key that identifies the line, when the site enables cart line keys */
2758
+ /** Caller key that identifies the line, when the site enables cart line keys (max 255 chars) */
2745
2759
  key: string | null;
2746
2760
  /** Unit price stored on the line */
2747
2761
  unitPrice: number | null;
@@ -2781,17 +2795,17 @@ interface CartLineAddCreateBodyItem {
2781
2795
  invMastUid: number | null;
2782
2796
  /** Quantity in unitOfMeasure */
2783
2797
  quantity: number | null;
2784
- /** Unit of measure; upper-cased before it is stored */
2798
+ /** Unit of measure; upper-cased before it is stored (max 8 chars) */
2785
2799
  unitOfMeasure: string | null;
2786
2800
  /** Line number to write; absent or 0 lets the cart pick the line (by item, or by key on add) */
2787
2801
  lineNo?: number | null;
2788
- /** Line note, at most 255 characters kept */
2802
+ /** Line note, at most 255 characters kept (max 255 chars) */
2789
2803
  lineNote?: string | null;
2790
2804
  /** Unit price to store on the line; absent stores none */
2791
2805
  unitPrice?: number | null;
2792
2806
  /**
2793
2807
  * Caller key that identifies the line on add when the site enables cart line keys; ignored by
2794
- * update
2808
+ * update (max 255 chars)
2795
2809
  */
2796
2810
  key?: string | null;
2797
2811
  [key: string]: unknown;
@@ -2927,11 +2941,11 @@ interface CheckoutGetData {
2927
2941
  dateCreated: string;
2928
2942
  /** Date the record was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2929
2943
  dateLastModified: string;
2930
- /** Checkout properties as a JSON string (max 16777215 chars) */
2944
+ /** Checkout properties as a JSON string */
2931
2945
  properties: string | null;
2932
2946
  /** Checkout processor name; not set by the commerce service today (max 255 chars) */
2933
2947
  checkoutProcessor: string | null;
2934
- /** Storefront checkout payload as a JSON string, stored verbatim (max 16777215 chars) */
2948
+ /** Storefront checkout payload as a JSON string, stored verbatim */
2935
2949
  jsonData: string | null;
2936
2950
  /** Source system name for a checkout brought in from another service (legacy) (max 255 chars) */
2937
2951
  sourceName: string | null;
@@ -4137,15 +4151,17 @@ type WebPricingCreateData = WebPricingListItem;
4137
4151
  * Request body of: api.pricing.webPricing.create(data)
4138
4152
  */
4139
4153
  interface WebPricingCreateBody {
4140
- /** Rule name; required and MUST NOT be empty */
4154
+ /** Rule name; required and MUST NOT be empty (max 255 chars) */
4141
4155
  name: string | null;
4142
4156
  /** Percentage taken off the engine unit price; required, above 0 and at most 100 */
4143
4157
  discountPct: number | null;
4144
- /** Optional free-text note about the rule */
4158
+ /** Optional free-text note about the rule (max 255 chars) */
4145
4159
  description?: string | null;
4146
4160
  /** Evaluation order, ascending; the first matching rule wins (Default: 1) */
4147
4161
  sequenceNo?: number | null;
4148
- /** Which customers the rule applies to: NONE, ALL, ONLY or EXCEPT (Default: NONE) */
4162
+ /**
4163
+ * Which customers the rule applies to: NONE, ALL, ONLY or EXCEPT (Default: NONE) (max 255 chars)
4164
+ */
4149
4165
  customerMode?: string | null;
4150
4166
  /** Minimum cart quantity; 0 or less means no lower bound (Default: -1) */
4151
4167
  minQty?: number | null;
@@ -4183,13 +4199,13 @@ type WebPricingUpdateData = WebPricingListItem;
4183
4199
  * Request body of: api.pricing.webPricing.update(webPricingUid, data)
4184
4200
  */
4185
4201
  interface WebPricingUpdateBody {
4186
- /** Rule name; MUST NOT be empty when sent */
4202
+ /** Rule name; MUST NOT be empty when sent (max 255 chars) */
4187
4203
  name?: string | null;
4188
- /** Free-text note about the rule; sending null clears it */
4204
+ /** Free-text note about the rule; sending null clears it (max 255 chars) */
4189
4205
  description?: string | null;
4190
4206
  /** Evaluation order, ascending; the first matching rule wins */
4191
4207
  sequenceNo?: number | null;
4192
- /** Which customers the rule applies to: NONE, ALL, ONLY or EXCEPT */
4208
+ /** Which customers the rule applies to: NONE, ALL, ONLY or EXCEPT (max 255 chars) */
4193
4209
  customerMode?: string | null;
4194
4210
  /** Minimum cart quantity; 0 or less means no lower bound */
4195
4211
  minQty?: number | null;
@@ -5003,13 +5019,16 @@ type DistributorsCreateData = DistributorsListItem;
5003
5019
  interface DistributorsCreateBody {
5004
5020
  /** Prophet 21 customer the distributor belongs to; without it nothing is created */
5005
5021
  customerId: number | null;
5006
- /** Distributor name; distributors_id is derived from it. Without it nothing is created */
5022
+ /**
5023
+ * Distributor name; distributors_id is derived from it. Without it nothing is created (max 255
5024
+ * chars)
5025
+ */
5007
5026
  distributorsName: string | null;
5008
- /** Distributor description */
5027
+ /** Distributor description (max 255 chars) */
5009
5028
  distributorsDesc?: string | null;
5010
- /** Distributor contact email */
5029
+ /** Distributor contact email (max 255 chars) */
5011
5030
  distributorsEmail?: string | null;
5012
- /** Customer's account number with the distributor */
5031
+ /** Customer's account number with the distributor (max 255 chars) */
5013
5032
  distributorsAccount?: string | null;
5014
5033
  [key: string]: unknown;
5015
5034
  }
@@ -5036,13 +5055,13 @@ type DistributorsUpdateData = boolean;
5036
5055
  interface DistributorsUpdateBody {
5037
5056
  /** Prophet 21 customer the distributor belongs to */
5038
5057
  customerId?: number | null;
5039
- /** Distributor name; distributors_id is re-derived from it */
5058
+ /** Distributor name; distributors_id is re-derived from it (max 255 chars) */
5040
5059
  distributorsName?: string | null;
5041
- /** Distributor description */
5060
+ /** Distributor description (max 255 chars) */
5042
5061
  distributorsDesc?: string | null;
5043
- /** Distributor contact email */
5062
+ /** Distributor contact email (max 255 chars) */
5044
5063
  distributorsEmail?: string | null;
5045
- /** Customer's account number with the distributor */
5064
+ /** Customer's account number with the distributor (max 255 chars) */
5046
5065
  distributorsAccount?: string | null;
5047
5066
  [key: string]: unknown;
5048
5067
  }
@@ -5160,9 +5179,9 @@ interface DistributorsProductsCreateBody {
5160
5179
  interface InvProfileHdrListItem {
5161
5180
  /** Inventory profile ID */
5162
5181
  invProfileHdrUid: number;
5163
- /** Profile key derived from the description */
5182
+ /** Profile key derived from the description (max 255 chars) */
5164
5183
  invProfileHdrId: string;
5165
- /** Profile description */
5184
+ /** Profile description (max 255 chars) */
5166
5185
  invProfileHdrDesc: string;
5167
5186
  /** Prophet 21 customer the profile belongs to */
5168
5187
  customerId: number;
@@ -5211,7 +5230,10 @@ interface InvProfileHdrCreateData {
5211
5230
  * Request body of: api.vmi.invProfileHdr.create(data)
5212
5231
  */
5213
5232
  interface InvProfileHdrCreateBody {
5214
- /** Profile description; inv_profile_hdr_id is derived from it. Without it nothing is created */
5233
+ /**
5234
+ * Profile description; inv_profile_hdr_id is derived from it. Without it nothing is created (max
5235
+ * 255 chars)
5236
+ */
5215
5237
  invProfileHdrDesc: string | null;
5216
5238
  /** Prophet 21 customer the profile belongs to; without it nothing is created */
5217
5239
  customerId: number | null;
@@ -5360,7 +5382,7 @@ interface InvProfileHdrInvProfileLineCreateBodyItem {
5360
5382
  * skipped
5361
5383
  */
5362
5384
  invMastUid: number | null;
5363
- /** Item source: products or prophet21; without it the line is skipped */
5385
+ /** Item source: products or prophet21; without it the line is skipped (max 255 chars) */
5364
5386
  invProfileLineType: string | null;
5365
5387
  /** Minimum quantity to keep on hand; defaults to 1 */
5366
5388
  invProfileHdrMinQty?: number | null;
@@ -5404,7 +5426,7 @@ interface InvProfileHdrInvProfileLineUpdateBody {
5404
5426
  invProfileHdrUid?: number | null;
5405
5427
  /** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
5406
5428
  invMastUid?: number | null;
5407
- /** Item source: products or prophet21 */
5429
+ /** Item source: products or prophet21 (max 255 chars) */
5408
5430
  invProfileLineType?: string | null;
5409
5431
  /** Minimum quantity to keep on hand */
5410
5432
  invProfileHdrMinQty?: number | null;
@@ -5548,7 +5570,7 @@ interface RestockHdrListItem {
5548
5570
  statusCd: number;
5549
5571
  /** Process code (704 = Active, 1185 = Import Complete) */
5550
5572
  processCd: number;
5551
- /** The create request body, JSON-encoded (max 2147483647 chars) */
5573
+ /** The create request body, JSON-encoded */
5552
5574
  jsonData: string | null;
5553
5575
  /** Processing state of the restock order (max 30 chars) */
5554
5576
  processState: string;
@@ -5581,7 +5603,7 @@ interface RestockHdrCreateDataRestockItemsItem {
5581
5603
  lineNo: number;
5582
5604
  /** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
5583
5605
  invMastUid: number;
5584
- /** Item source: products or prophet21 */
5606
+ /** Item source: products or prophet21 (max 255 chars) */
5585
5607
  invProfileLineType: string;
5586
5608
  /** Quantity to restock */
5587
5609
  unitQty: number;
@@ -5627,17 +5649,17 @@ interface RestockHdrCreateData {
5627
5649
  processCd: number;
5628
5650
  /** The create request body, JSON-encoded */
5629
5651
  jsonData: string | null;
5630
- /** Processing state */
5652
+ /** Processing state (max 30 chars) */
5631
5653
  processState: string;
5632
- /** Customer purchase order number */
5654
+ /** Customer purchase order number (max 50 chars) */
5633
5655
  poNo: string | null;
5634
5656
  /** joomla.users.id of the requester */
5635
5657
  usersId: number;
5636
5658
  /** Prophet 21 customer placing the restock */
5637
5659
  customerId: number;
5638
- /** Prophet 21 contact placing the restock */
5660
+ /** Prophet 21 contact placing the restock (max 16 chars) */
5639
5661
  contactId: string | null;
5640
- /** Delivery instructions for the order */
5662
+ /** Delivery instructions for the order (max 255 chars) */
5641
5663
  deliveryInstructions: string | null;
5642
5664
  /** Items on the request */
5643
5665
  restockItems: RestockHdrCreateDataRestockItemsItem[];
@@ -5652,7 +5674,7 @@ interface RestockHdrCreateData {
5652
5674
  interface RestockHdrCreateBodyRestockItemsItem {
5653
5675
  /** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
5654
5676
  invMastUid: number | null;
5655
- /** Item source: products or prophet21 */
5677
+ /** Item source: products or prophet21 (max 255 chars) */
5656
5678
  invProfileLineType: string | null;
5657
5679
  /** Quantity to restock */
5658
5680
  unitQty: number | null;
@@ -5673,13 +5695,13 @@ interface RestockHdrCreateBody {
5673
5695
  usersId: number | null;
5674
5696
  /** Prophet 21 customer placing the restock */
5675
5697
  customerId: number | null;
5676
- /** Prophet 21 contact placing the restock */
5698
+ /** Prophet 21 contact placing the restock (max 16 chars) */
5677
5699
  contactId: string | null;
5678
5700
  /** Items to restock; an empty list creates nothing */
5679
5701
  restockItems: RestockHdrCreateBodyRestockItemsItem[];
5680
- /** Customer purchase order number */
5702
+ /** Customer purchase order number (max 50 chars) */
5681
5703
  poNo?: string | null;
5682
- /** Delivery instructions for the order */
5704
+ /** Delivery instructions for the order (max 255 chars) */
5683
5705
  deliveryInstructions?: string | null;
5684
5706
  [key: string]: unknown;
5685
5707
  }
@@ -5768,11 +5790,11 @@ type SectionsCreateData = SectionsListItem;
5768
5790
  * Request body of: api.vmi.sections.create(data)
5769
5791
  */
5770
5792
  interface SectionsCreateBody {
5771
- /** Section name; sections_id is derived from it. Without it nothing is created */
5793
+ /** Section name; sections_id is derived from it. Without it nothing is created (max 255 chars) */
5772
5794
  sectionsName: string | null;
5773
5795
  /** Prophet 21 customer the section belongs to; without it nothing is created */
5774
5796
  customerId: number | null;
5775
- /** Section description; defaults to the section name */
5797
+ /** Section description; defaults to the section name (max 255 chars) */
5776
5798
  sectionsDesc?: string | null;
5777
5799
  [key: string]: unknown;
5778
5800
  }
@@ -5835,11 +5857,11 @@ type SectionsEnableUpdateBody = DistributorsEnableUpdateBody;
5835
5857
  interface WarehouseListItem {
5836
5858
  /** Warehouse ID */
5837
5859
  warehouseUid: number;
5838
- /** Warehouse key derived from the name */
5860
+ /** Warehouse key derived from the name (max 255 chars) */
5839
5861
  warehouseId: string;
5840
- /** Warehouse name */
5862
+ /** Warehouse name (max 255 chars) */
5841
5863
  warehouseName: string;
5842
- /** Warehouse description */
5864
+ /** Warehouse description (max 255 chars) */
5843
5865
  warehouseDesc: string;
5844
5866
  /** When the warehouse was created (Y-m-d H:i:s) */
5845
5867
  dateCreated: string;
@@ -5905,9 +5927,9 @@ interface WarehouseCreateData {
5905
5927
  interface WarehouseCreateBody {
5906
5928
  /** Prophet 21 customer the warehouse belongs to */
5907
5929
  customerId: number | null;
5908
- /** Warehouse name; warehouse_id is derived from it */
5930
+ /** Warehouse name; warehouse_id is derived from it (max 255 chars) */
5909
5931
  warehouseName: string | null;
5910
- /** Warehouse description */
5932
+ /** Warehouse description (max 255 chars) */
5911
5933
  warehouseDesc: string | null;
5912
5934
  /** Inventory profile stocked in the warehouse; defaults to 0 (none) */
5913
5935
  invProfileHdrUid?: number | null;
@@ -5934,9 +5956,9 @@ type WarehouseUpdateData = WarehouseCreateData;
5934
5956
  * Request body of: api.vmi.warehouse.update(warehouseUid, data)
5935
5957
  */
5936
5958
  interface WarehouseUpdateBody {
5937
- /** Warehouse name; warehouse_id is re-derived from it */
5959
+ /** Warehouse name; warehouse_id is re-derived from it (max 255 chars) */
5938
5960
  warehouseName?: string | null;
5939
- /** Warehouse description */
5961
+ /** Warehouse description (max 255 chars) */
5940
5962
  warehouseDesc?: string | null;
5941
5963
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
5942
5964
  statusCd?: number | null;
@@ -6009,7 +6031,7 @@ interface WarehouseAdjustCreateBody {
6009
6031
  interface WarehouseAvailabilityListDataSectionsValueItemsItem {
6010
6032
  /** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
6011
6033
  invMastUid: number;
6012
- /** Item source: products or prophet21 */
6034
+ /** Item source: products or prophet21 (max 255 chars) */
6013
6035
  invProfileLineType: string;
6014
6036
  /** Quantity on hand in the warehouse */
6015
6037
  qtyOnHand: number;
@@ -6204,7 +6226,7 @@ interface WarehouseUsageCreateDataUsageItemsItemWarranty {
6204
6226
  interface WarehouseUsageCreateDataUsageItemsItem {
6205
6227
  /** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
6206
6228
  invMastUid: number;
6207
- /** Item source: products or prophet21 */
6229
+ /** Item source: products or prophet21 (max 255 chars) */
6208
6230
  invProfileLineType: string;
6209
6231
  /** Line number, starting at 1 */
6210
6232
  lineNo: number;
@@ -6269,7 +6291,7 @@ interface WarehouseUsageCreateBodyUsageItemsItem {
6269
6291
  invMastUid: number | null;
6270
6292
  /** Quantity used; subtracted from on hand, never below zero */
6271
6293
  qtyUsed: number | null;
6272
- /** Item source: products or prophet21; defaults to prophet21 */
6294
+ /** Item source: products or prophet21; defaults to prophet21 (max 255 chars) */
6273
6295
  invProfileLineType?: string | null;
6274
6296
  /** Warranty claim for the item */
6275
6297
  warranty?: WarehouseUsageCreateBodyUsageItemsItemWarranty | null;
@@ -8060,7 +8082,7 @@ interface ItemsListItem {
8060
8082
  updateCd: number;
8061
8083
  /**
8062
8084
  * Search document JSON written to openSearch; over 500 bytes it is stored on EFS and this holds
8063
- * efs:{path} (max 4294967295 chars)
8085
+ * efs:{path}
8064
8086
  */
8065
8087
  doc: string | null;
8066
8088
  /** Marked items to have the index updated in openSearch */
@@ -8179,7 +8201,7 @@ interface QueryStringRedirectListItem {
8179
8201
  statusCd: number;
8180
8202
  /** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
8181
8203
  processCd: number;
8182
- /** Cleaned search text that triggers the redirect (max 65535 chars) */
8204
+ /** Cleaned search text that triggers the redirect */
8183
8205
  queryString: string | null;
8184
8206
  [key: string]: unknown;
8185
8207
  }
@@ -9103,7 +9125,7 @@ interface InvLocListParams extends EdgeCacheParams {
9103
9125
  /** Limit number of results (Default: 10) */
9104
9126
  limit?: number;
9105
9127
  /** Location ID (inv_loc.location_id); returns only rows for that location */
9106
- locationId?: string;
9128
+ locationId?: number;
9107
9129
  /** Return only rows modified on or after this date (YYYY-MM-DD HH:MM:SS) */
9108
9130
  modifiedSince?: string;
9109
9131
  /** Starting offset results (Default: 0) */
@@ -10753,7 +10775,7 @@ interface CategoriesImagesListData {
10753
10775
  * Field `itemUom` of InvMastSimilarListItem
10754
10776
  */
10755
10777
  interface CategoriesItemsListDataItemsItemItemUomItem {
10756
- /** Unit of measure code */
10778
+ /** Unit of measure code (max 8 chars) */
10757
10779
  unitOfMeasure: string;
10758
10780
  /** Base units per one of this unit */
10759
10781
  unitSize: number;
@@ -10773,15 +10795,15 @@ interface CategoriesItemsListDataItemsItemInventorySupplierItem {
10773
10795
  invMastUid: number;
10774
10796
  /** Supplier ID */
10775
10797
  supplierId: number;
10776
- /** Supplier UPC code; empty when none */
10798
+ /** Supplier UPC code; empty when none (max 14 chars) */
10777
10799
  upcCode: string;
10778
- /** UPC check digit; empty when none */
10779
- checkDigit: string;
10800
+ /** UPC check digit (P21 decimal(1,0)); null when none */
10801
+ checkDigit: number | null;
10780
10802
  /** upcCode followed by checkDigit */
10781
10803
  upc: string;
10782
- /** Supplier part number */
10804
+ /** Supplier part number (max 40 chars) */
10783
10805
  supplierPartNo: string | null;
10784
- /** Y when this is the item's primary supplier */
10806
+ /** Y when this is the item's primary supplier (max 1 chars) */
10785
10807
  primarySupplierFlag: string | null;
10786
10808
  /** Supplier list price */
10787
10809
  listPrice: number | null;
@@ -11256,55 +11278,55 @@ interface InvMastListItemLanguagesItem {
11256
11278
  interface InvMastListItem {
11257
11279
  /** Item (inv_mast) ID */
11258
11280
  invMastUid: number;
11259
- /** Item ID */
11281
+ /** Item ID (max 40 chars) */
11260
11282
  itemId: string;
11261
- /** Item description */
11283
+ /** Item description (max 40 chars) */
11262
11284
  itemDesc: string | null;
11263
11285
  /** First web-displayed category description for the item */
11264
11286
  displayDesc: string | null;
11265
- /** Extended description */
11287
+ /** Extended description (max 255 chars) */
11266
11288
  extendedDesc: string | null;
11267
- /** Short code */
11289
+ /** Short code (max 30 chars) */
11268
11290
  shortCode: string | null;
11269
- /** Default selling unit */
11291
+ /** Default selling unit (max 8 chars) */
11270
11292
  defaultSellingUnit: string | null;
11271
- /** Default purchasing unit */
11293
+ /** Default purchasing unit (max 8 chars) */
11272
11294
  defaultPurchasingUnit: string | null;
11273
- /** Y when the item is deleted */
11295
+ /** Y when the item is deleted (max 1 chars) */
11274
11296
  deleteFlag: string;
11275
11297
  /** Online code (704 = online) */
11276
11298
  onlineCd: number;
11277
11299
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
11278
11300
  statusCd: number;
11279
- /** Base unit */
11301
+ /** Base unit (max 8 chars) */
11280
11302
  baseUnit: string;
11281
11303
  /** Vendor stock quantity */
11282
11304
  vndrStock: number | null;
11283
- /** Item class 1 */
11305
+ /** Item class 1 (max 8 chars) */
11284
11306
  classId1: string | null;
11285
- /** Item class 2 */
11307
+ /** Item class 2 (max 8 chars) */
11286
11308
  classId2: string | null;
11287
- /** Item class 3 */
11309
+ /** Item class 3 (max 8 chars) */
11288
11310
  classId3: string | null;
11289
- /** Item class 4 */
11311
+ /** Item class 4 (max 8 chars) */
11290
11312
  classId4: string | null;
11291
- /** Item class 5 */
11313
+ /** Item class 5 (max 8 chars) */
11292
11314
  classId5: string | null;
11293
- /** Y when the item is serialized */
11315
+ /** Y when the item is serialized (max 1 chars) */
11294
11316
  serialized: string;
11295
- /** Y when the item is lot-tracked */
11317
+ /** Y when the item is lot-tracked (max 1 chars) */
11296
11318
  trackLots: string;
11297
11319
  /** Tracking pattern derived from serialized and trackLots */
11298
11320
  trackingPattern: string;
11299
- /** Default product group */
11321
+ /** Default product group (max 8 chars) */
11300
11322
  defaultProductGroup: string | null;
11301
- /** Default sales discount group */
11323
+ /** Default sales discount group (max 8 chars) */
11302
11324
  defaultSalesDiscountGroup: string | null;
11303
- /** Default purchase discount group */
11325
+ /** Default purchase discount group (max 8 chars) */
11304
11326
  defaultPurchaseDiscGroup: string | null;
11305
- /** UPC or EAN code type */
11327
+ /** UPC or EAN code type (max 3 chars) */
11306
11328
  upcOrEan: string | null;
11307
- /** UPC or EAN code */
11329
+ /** UPC or EAN code (max 15 chars) */
11308
11330
  upcOrEanId: string | null;
11309
11331
  /** Weight */
11310
11332
  weight: number | null;
@@ -11314,11 +11336,11 @@ interface InvMastListItem {
11314
11336
  width: number | null;
11315
11337
  /** Height */
11316
11338
  height: number | null;
11317
- /** Parker product code */
11339
+ /** Parker product code (max 255 chars) */
11318
11340
  parkerProductCd: string | null;
11319
- /** Brand name */
11341
+ /** Brand name (max 255 chars) */
11320
11342
  brandName: string | null;
11321
- /** Manufacturer name */
11343
+ /** Manufacturer name (max 255 chars) */
11322
11344
  manufacturerName: string | null;
11323
11345
  /** The item's suppliers (not deleted) */
11324
11346
  inventorySupplier: CategoriesItemsListDataItemsItemInventorySupplierItem[];
@@ -11626,7 +11648,7 @@ interface InvMastGetData {
11626
11648
  defaultSellingUnit: string | null;
11627
11649
  /** Y when the item is a hazardous material (max 1 chars) */
11628
11650
  hazMatFlag: string;
11629
- /** Search keywords (max 2147483647 chars) */
11651
+ /** Search keywords */
11630
11652
  keywords: string | null;
11631
11653
  /** Prophet 21 disposition code (max 1 chars) */
11632
11654
  disposition: string | null;
@@ -11920,9 +11942,9 @@ interface InvMastFaqListItem {
11920
11942
  invMastUid: number;
11921
11943
  /** The question (max 255 chars) */
11922
11944
  question: string;
11923
- /** The published answer (max 65535 chars) */
11945
+ /** The published answer */
11924
11946
  answer: string;
11925
- /** The machine-generated answer (max 65535 chars) */
11947
+ /** The machine-generated answer */
11926
11948
  generatedAnswer: string;
11927
11949
  /** Number of sources used to generate the answer */
11928
11950
  sourceCount: number;
@@ -11940,7 +11962,7 @@ interface InvMastFaqListItem {
11940
11962
  relatedQuestionsUid: number;
11941
11963
  /** Generate answer */
11942
11964
  generateCd: number;
11943
- /** Extra instructions used when generating the answer (max 65535 chars) */
11965
+ /** Extra instructions used when generating the answer */
11944
11966
  extraPrompt: string;
11945
11967
  /** Y/N flag: whether the answer was reviewed as accurate (max 1 chars) */
11946
11968
  accurateFlag: string;
@@ -11984,7 +12006,7 @@ interface InvMastFaqUpdateBody {
11984
12006
  generateCd?: number | null;
11985
12007
  /** Extra instructions used when generating the answer */
11986
12008
  extraPrompt?: string | null;
11987
- /** Y/N: whether the answer was reviewed as accurate */
12009
+ /** Y/N: whether the answer was reviewed as accurate (max 1 chars) */
11988
12010
  accurateFlag?: string | null;
11989
12011
  /** Quality score of the answer */
11990
12012
  qualityScore?: number | null;
@@ -12093,7 +12115,7 @@ interface InvMastLocationsBinsListItem {
12093
12115
  itemId: string;
12094
12116
  /** Prophet 21 location ID */
12095
12117
  locationId: number;
12096
- /** Bin */
12118
+ /** Bin (max 10 chars) */
12097
12119
  bin: string;
12098
12120
  /** Quantity in the bin */
12099
12121
  quantity: number;
@@ -12101,7 +12123,7 @@ interface InvMastLocationsBinsListItem {
12101
12123
  dateCreated: AttributeGroupsAttributesListItemDateCreated | null;
12102
12124
  /** When the row last changed (raw PHP DateTime object) */
12103
12125
  dateLastModified: AttributeGroupsAttributesListItemDateCreated | null;
12104
- /** User who last changed the row */
12126
+ /** User who last changed the row (max 30 chars) */
12105
12127
  lastMaintainedBy: string;
12106
12128
  [key: string]: unknown;
12107
12129
  }
@@ -12170,25 +12192,27 @@ type InvMastSimilarListData = InvMastSimilarListItem[];
12170
12192
  interface InvMastStockGetDataStockDataItem {
12171
12193
  /** Location ID */
12172
12194
  locationId: number;
12173
- /** Company the location belongs to */
12195
+ /** Company the location belongs to (max 8 chars) */
12174
12196
  companyId: string;
12175
12197
  /** Quantity on hand, in base units */
12176
12198
  qtyOnHand: number;
12177
12199
  /** Quantity allocated, in base units */
12178
12200
  qtyAllocated: number;
12179
- /** Y when the item is stocked at the location */
12201
+ /** Y when the item is stocked at the location (max 1 chars) */
12180
12202
  stockable: string | null;
12181
- /** Y when the item is sold from the location */
12203
+ /** Y when the item is sold from the location (max 1 chars) */
12182
12204
  sellable: string | null;
12183
- /** Y when the item is discontinued at the location */
12205
+ /** Y when the item is discontinued at the location (max 1 chars) */
12184
12206
  discontinued: string;
12207
+ /** Y when the location record is deleted in P21 (inv_loc.delete_flag) (max 1 chars) */
12208
+ deleteFlag: string | null;
12185
12209
  /** qtyOnHand minus qtyAllocated */
12186
12210
  unallocated: number;
12187
12211
  /** Date (Y-m-d) the next purchase order is due in */
12188
12212
  nextDueInPoDate: string | null;
12189
12213
  /** Quantity backordered */
12190
12214
  qtyBackordered: number | null;
12191
- /** Primary bin */
12215
+ /** Primary bin (max 10 chars) */
12192
12216
  primaryBin: string | null;
12193
12217
  /** Quantity frozen */
12194
12218
  qtyFrozen: number;
@@ -12200,13 +12224,13 @@ interface InvMastStockGetDataStockDataItem {
12200
12224
  qtyAvailable: number;
12201
12225
  /** Order quantity */
12202
12226
  orderQuantity: number | null;
12203
- /** Product group at the location */
12227
+ /** Product group at the location (max 8 chars) */
12204
12228
  productGroupId: string | null;
12205
12229
  /** Item base unit */
12206
12230
  baseUnit: string;
12207
12231
  /** Base unit size (1 when unset) */
12208
12232
  baseUnitSize: number;
12209
- /** Item default selling unit */
12233
+ /** Item default selling unit (max 8 chars) */
12210
12234
  defaultSellingUnit: string | null;
12211
12235
  /** Default selling unit size */
12212
12236
  defaultSellingUnitSize: number;
@@ -12767,7 +12791,7 @@ interface VariantsListItem {
12767
12791
  id: string;
12768
12792
  /** Variant group description (max 255 chars) */
12769
12793
  description: string;
12770
- /** The 1536 dimensional vector that represents the variant data (max 4294967295 chars) */
12794
+ /** The 1536 dimensional vector that represents the variant data */
12771
12795
  vector: string | null;
12772
12796
  /** When the row was created (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
12773
12797
  dateCreated: string;
@@ -12781,7 +12805,7 @@ interface VariantsListItem {
12781
12805
  processCd: number;
12782
12806
  /** Hash of content; changes when the group content changes (max 64 chars) */
12783
12807
  contentHash: string | null;
12784
- /** Text built from the group items, used for the similarity vector (max 4294967295 chars) */
12808
+ /** Text built from the group items, used for the similarity vector */
12785
12809
  content: string | null;
12786
12810
  /** Vector code: 704 when the similarity vector needs a rebuild */
12787
12811
  vectorCd: number;
@@ -15943,15 +15967,15 @@ interface InvMastAlsoBoughtListItemInventorySupplierItem {
15943
15967
  invMastUid: number;
15944
15968
  /** Supplier ID */
15945
15969
  supplierId: number;
15946
- /** Supplier UPC code; empty when none */
15970
+ /** Supplier UPC code; empty when none (max 14 chars) */
15947
15971
  upcCode: string;
15948
- /** UPC check digit; empty when none */
15949
- checkDigit: string;
15972
+ /** UPC check digit (P21 decimal(1,0)); null when none */
15973
+ checkDigit: number | null;
15950
15974
  /** upcCode followed by checkDigit */
15951
15975
  upc: string;
15952
- /** Supplier part number */
15976
+ /** Supplier part number (max 40 chars) */
15953
15977
  supplierPartNo: string | null;
15954
- /** Y when this is the item's primary supplier */
15978
+ /** Y when this is the item's primary supplier (max 1 chars) */
15955
15979
  primarySupplierFlag: string | null;
15956
15980
  /** Supplier list price */
15957
15981
  listPrice: number | null;
@@ -15964,7 +15988,7 @@ interface InvMastAlsoBoughtListItemInventorySupplierItem {
15964
15988
  * Field `itemUom` of InvMastAlsoBoughtListItem
15965
15989
  */
15966
15990
  interface InvMastAlsoBoughtListItemItemUomItem {
15967
- /** Unit of measure code */
15991
+ /** Unit of measure code (max 8 chars) */
15968
15992
  unitOfMeasure: string;
15969
15993
  /** Base units per one of this unit */
15970
15994
  unitSize: number;
@@ -16107,25 +16131,27 @@ interface InvMastAlsoBoughtListItemAttributesItem {
16107
16131
  interface InvMastAlsoBoughtListItemStockStockDataItem {
16108
16132
  /** Location ID */
16109
16133
  locationId: number;
16110
- /** Company the location belongs to */
16134
+ /** Company the location belongs to (max 8 chars) */
16111
16135
  companyId: string;
16112
16136
  /** Quantity on hand, in base units */
16113
16137
  qtyOnHand: number;
16114
16138
  /** Quantity allocated, in base units */
16115
16139
  qtyAllocated: number;
16116
- /** Y when the item is stocked at the location */
16140
+ /** Y when the item is stocked at the location (max 1 chars) */
16117
16141
  stockable: string | null;
16118
- /** Y when the item is sold from the location */
16142
+ /** Y when the item is sold from the location (max 1 chars) */
16119
16143
  sellable: string | null;
16120
- /** Y when the item is discontinued at the location */
16144
+ /** Y when the item is discontinued at the location (max 1 chars) */
16121
16145
  discontinued: string;
16146
+ /** Y when the location record is deleted in P21 (inv_loc.delete_flag) (max 1 chars) */
16147
+ deleteFlag: string | null;
16122
16148
  /** qtyOnHand minus qtyAllocated */
16123
16149
  unallocated: number;
16124
16150
  /** Date (Y-m-d) the next purchase order is due in */
16125
16151
  nextDueInPoDate: string | null;
16126
16152
  /** Quantity backordered */
16127
16153
  qtyBackordered: number | null;
16128
- /** Primary bin */
16154
+ /** Primary bin (max 10 chars) */
16129
16155
  primaryBin: string | null;
16130
16156
  /** Quantity frozen */
16131
16157
  qtyFrozen: number;
@@ -16137,13 +16163,13 @@ interface InvMastAlsoBoughtListItemStockStockDataItem {
16137
16163
  qtyAvailable: number;
16138
16164
  /** Order quantity */
16139
16165
  orderQuantity: number | null;
16140
- /** Product group at the location */
16166
+ /** Product group at the location (max 8 chars) */
16141
16167
  productGroupId: string | null;
16142
16168
  /** Item base unit */
16143
16169
  baseUnit: string;
16144
16170
  /** Base unit size (1 when unset) */
16145
16171
  baseUnitSize: number;
16146
- /** Item default selling unit */
16172
+ /** Item default selling unit (max 8 chars) */
16147
16173
  defaultSellingUnit: string | null;
16148
16174
  /** Default selling unit size */
16149
16175
  defaultSellingUnitSize: number;
@@ -16285,55 +16311,55 @@ interface InvMastAlsoBoughtListItemFullSizedSamples {
16285
16311
  interface InvMastAlsoBoughtListItem {
16286
16312
  /** Item (inv_mast) ID */
16287
16313
  invMastUid: number;
16288
- /** Item ID */
16314
+ /** Item ID (max 40 chars) */
16289
16315
  itemId: string;
16290
- /** Item description */
16316
+ /** Item description (max 40 chars) */
16291
16317
  itemDesc: string | null;
16292
16318
  /** First web-displayed category description for the item */
16293
16319
  displayDesc: string | null;
16294
- /** Extended description */
16320
+ /** Extended description (max 255 chars) */
16295
16321
  extendedDesc: string | null;
16296
- /** Short code */
16322
+ /** Short code (max 30 chars) */
16297
16323
  shortCode: string | null;
16298
- /** Default selling unit */
16324
+ /** Default selling unit (max 8 chars) */
16299
16325
  defaultSellingUnit: string | null;
16300
- /** Default purchasing unit */
16326
+ /** Default purchasing unit (max 8 chars) */
16301
16327
  defaultPurchasingUnit: string | null;
16302
- /** Y when the item is deleted */
16328
+ /** Y when the item is deleted (max 1 chars) */
16303
16329
  deleteFlag: string;
16304
16330
  /** Online code (704 = online) */
16305
16331
  onlineCd: number;
16306
16332
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
16307
16333
  statusCd: number;
16308
- /** Base unit */
16334
+ /** Base unit (max 8 chars) */
16309
16335
  baseUnit: string;
16310
16336
  /** Vendor stock quantity */
16311
16337
  vndrStock: number | null;
16312
- /** Item class 1 */
16338
+ /** Item class 1 (max 8 chars) */
16313
16339
  classId1: string | null;
16314
- /** Item class 2 */
16340
+ /** Item class 2 (max 8 chars) */
16315
16341
  classId2: string | null;
16316
- /** Item class 3 */
16342
+ /** Item class 3 (max 8 chars) */
16317
16343
  classId3: string | null;
16318
- /** Item class 4 */
16344
+ /** Item class 4 (max 8 chars) */
16319
16345
  classId4: string | null;
16320
- /** Item class 5 */
16346
+ /** Item class 5 (max 8 chars) */
16321
16347
  classId5: string | null;
16322
- /** Y when the item is serialized */
16348
+ /** Y when the item is serialized (max 1 chars) */
16323
16349
  serialized: string;
16324
- /** Y when the item is lot-tracked */
16350
+ /** Y when the item is lot-tracked (max 1 chars) */
16325
16351
  trackLots: string;
16326
16352
  /** Tracking pattern derived from serialized and trackLots */
16327
16353
  trackingPattern: string;
16328
- /** Default product group */
16354
+ /** Default product group (max 8 chars) */
16329
16355
  defaultProductGroup: string | null;
16330
- /** Default sales discount group */
16356
+ /** Default sales discount group (max 8 chars) */
16331
16357
  defaultSalesDiscountGroup: string | null;
16332
- /** Default purchase discount group */
16358
+ /** Default purchase discount group (max 8 chars) */
16333
16359
  defaultPurchaseDiscGroup: string | null;
16334
- /** UPC or EAN code type */
16360
+ /** UPC or EAN code type (max 3 chars) */
16335
16361
  upcOrEan: string | null;
16336
- /** UPC or EAN code */
16362
+ /** UPC or EAN code (max 15 chars) */
16337
16363
  upcOrEanId: string | null;
16338
16364
  /** Weight */
16339
16365
  weight: number | null;
@@ -16343,11 +16369,11 @@ interface InvMastAlsoBoughtListItem {
16343
16369
  width: number | null;
16344
16370
  /** Height */
16345
16371
  height: number | null;
16346
- /** Parker product code */
16372
+ /** Parker product code (max 255 chars) */
16347
16373
  parkerProductCd: string | null;
16348
- /** Brand name */
16374
+ /** Brand name (max 255 chars) */
16349
16375
  brandName: string | null;
16350
- /** Manufacturer name */
16376
+ /** Manufacturer name (max 255 chars) */
16351
16377
  manufacturerName: string | null;
16352
16378
  /** The item's suppliers (not deleted) */
16353
16379
  inventorySupplier: InvMastAlsoBoughtListItemInventorySupplierItem[];
@@ -16371,8 +16397,8 @@ interface InvMastAlsoBoughtListItem {
16371
16397
  stock: InvMastAlsoBoughtListItemStock;
16372
16398
  /** Category display description per item category ID */
16373
16399
  categoryDisplayDescriptions: Record<string, string>;
16374
- /** Non-empty user-defined field values, keyed by field name ([] when empty) */
16375
- userDefined: Record<string, unknown> | [];
16400
+ /** Non-empty user-defined field values, keyed by field name; {} when the item has none */
16401
+ userDefined: Record<string, unknown>;
16376
16402
  /** Prophet 21 item text blocks (empty unless the site has a p21_pim config) */
16377
16403
  invMastText: InvMastAlsoBoughtListItemInvMastTextItem[];
16378
16404
  /** Descriptions in other languages */
@@ -16525,15 +16551,15 @@ interface InvMastWebDescListItem {
16525
16551
  invMastWebDescUid: number;
16526
16552
  /** Item (inv_mast) the web description belongs to */
16527
16553
  invMastUid: number;
16528
- /** Web description 1 (max 16777215 chars) */
16554
+ /** Web description 1 */
16529
16555
  webDesc1: string | null;
16530
- /** Web description 2 (max 16777215 chars) */
16556
+ /** Web description 2 */
16531
16557
  webDesc2: string | null;
16532
- /** Web description 3 (max 16777215 chars) */
16558
+ /** Web description 3 */
16533
16559
  webDesc3: string | null;
16534
- /** Web description 4 (max 16777215 chars) */
16560
+ /** Web description 4 */
16535
16561
  webDesc4: string | null;
16536
- /** Full web description (max 16777215 chars) */
16562
+ /** Full web description */
16537
16563
  webDescFull: string | null;
16538
16564
  /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
16539
16565
  dateCreated: string;
@@ -16642,7 +16668,7 @@ interface ItemCategoryGetData {
16642
16668
  itemCategoryId: string;
16643
16669
  /** Item category description (max 255 chars) */
16644
16670
  itemCategoryDesc: string;
16645
- /** Category article text 1 (max 16777215 chars) */
16671
+ /** Category article text 1 */
16646
16672
  article: string | null;
16647
16673
  /** Box folder ID for the category (max 255 chars) */
16648
16674
  boxFolderId: string | null;
@@ -16660,13 +16686,13 @@ interface ItemCategoryGetData {
16660
16686
  dateLastModified: string;
16661
16687
  /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
16662
16688
  dateLastChecked: string;
16663
- /** Category article text 2 (max 16777215 chars) */
16689
+ /** Category article text 2 */
16664
16690
  article2: string | null;
16665
- /** Category article text 3 (max 16777215 chars) */
16691
+ /** Category article text 3 */
16666
16692
  article3: string | null;
16667
- /** Category article text 4 (max 16777215 chars) */
16693
+ /** Category article text 4 */
16668
16694
  article4: string | null;
16669
- /** Category article text 5 (max 16777215 chars) */
16695
+ /** Category article text 5 */
16670
16696
  article5: string | null;
16671
16697
  /** Sample item ID shown for the category (max 255 chars) */
16672
16698
  sampleItemId: string | null;
@@ -16753,13 +16779,13 @@ type LegacyStateCreateData = LegacyStateListItem;
16753
16779
  * Request body of: api.legacy.legacy.state.create(data)
16754
16780
  */
16755
16781
  interface LegacyStateCreateBody {
16756
- /** State name */
16782
+ /** State name (max 255 chars) */
16757
16783
  stateName: string;
16758
- /** Two-letter state code */
16784
+ /** Two-letter state code (max 2 chars) */
16759
16785
  twoLetterCode: string;
16760
16786
  /** Country the state belongs to */
16761
16787
  countryUid?: number | null;
16762
- /** User who created the state; defaults to empty */
16788
+ /** User who created the state; defaults to empty (max 255 chars) */
16763
16789
  createdBy?: string | null;
16764
16790
  /** Combined Federal/State 1099 program number */
16765
16791
  combinedFederalState1099No?: number | null;
@@ -17541,9 +17567,9 @@ interface FyxerTranscriptListItem {
17541
17567
  fyxerTranscriptHdrUid: number;
17542
17568
  /** Recording link (max 255 chars) */
17543
17569
  link: string;
17544
- /** Meeting summary (max 4294967295 chars) */
17570
+ /** Meeting summary */
17545
17571
  summary: string | null;
17546
- /** Full transcript text (max 4294967295 chars) */
17572
+ /** Full transcript text */
17547
17573
  transcript: string | null;
17548
17574
  /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
17549
17575
  dateRecorded: string;
@@ -17814,7 +17840,7 @@ type PostalCodesXShiptosCreateData = PostalCodesXShiptosListItem;
17814
17840
  * Request body of: api.agrSite.postalCodesXShiptos.create(data)
17815
17841
  */
17816
17842
  interface PostalCodesXShiptosCreateBody {
17817
- /** Postal code */
17843
+ /** Postal code (max 20 chars) */
17818
17844
  postalCode?: string | null;
17819
17845
  /** Prophet 21 ship-to ID */
17820
17846
  shipToId?: number | null;
@@ -17844,7 +17870,7 @@ type PostalCodesXShiptosUpdateData = PostalCodesXShiptosListItem;
17844
17870
  * Request body of: api.agrSite.postalCodesXShiptos.update(postalCodesXShiptosUid, data)
17845
17871
  */
17846
17872
  interface PostalCodesXShiptosUpdateBody {
17847
- /** Postal code */
17873
+ /** Postal code (max 20 chars) */
17848
17874
  postalCode?: string | null;
17849
17875
  /** Prophet 21 ship-to ID */
17850
17876
  shipToId?: number | null;
@@ -19165,9 +19191,9 @@ interface ContactsUdGetData {
19165
19191
  interface ContactsCustomersListItem {
19166
19192
  /** Prophet 21 customer ID */
19167
19193
  customerId: number;
19168
- /** Prophet 21 company */
19194
+ /** Prophet 21 company (max 8 chars) */
19169
19195
  companyId: string;
19170
- /** Customer name */
19196
+ /** Customer name (max 255 chars) */
19171
19197
  customerName: string | null;
19172
19198
  /** Customer class 1 */
19173
19199
  class1Id: string | null;
@@ -19179,23 +19205,23 @@ interface ContactsCustomersListItem {
19179
19205
  class4Id: string | null;
19180
19206
  /** Customer class 5 */
19181
19207
  class5Id: string | null;
19182
- /** Y when the customer may order on the web */
19208
+ /** Y when the customer may order on the web (max 1 chars) */
19183
19209
  webEnabledFlag: string;
19184
- /** Y when the customer is deleted in Prophet 21 */
19210
+ /** Y when the customer is deleted in Prophet 21 (max 1 chars) */
19185
19211
  deleteFlag: string;
19186
19212
  /** Prophet 21 contact ID of the customer's salesrep */
19187
19213
  salesRepId: string | null;
19188
- /** Y when orders require a purchase order number */
19214
+ /** Y when orders require a purchase order number (max 1 chars) */
19189
19215
  poNoRequired: string;
19190
- /** Prophet 21 payment terms */
19216
+ /** Prophet 21 payment terms (max 2 chars) */
19191
19217
  termsId: string | null;
19192
19218
  /** Payment terms description; empty when the customer has no terms */
19193
19219
  termsDesc: string;
19194
- /** Y when the customer is taxable */
19220
+ /** Y when the customer is taxable (max 1 chars) */
19195
19221
  taxableFlag: string;
19196
19222
  /** Augur status code */
19197
19223
  statusCd: number;
19198
- /** Y when the customer uses job pricing */
19224
+ /** Y when the customer uses job pricing (max 1 chars) */
19199
19225
  jobPricing: string;
19200
19226
  /**
19201
19227
  * Prophet 21 user-defined fields keyed by field name; [] when the customer has none ([] when
@@ -19215,29 +19241,29 @@ type ContactsCustomersListData = ContactsCustomersListItem[];
19215
19241
  interface ContactsDocListDataAddress {
19216
19242
  /** Prophet 21 address ID */
19217
19243
  id: number;
19218
- /** Physical address line 1 */
19244
+ /** Physical address line 1 (max 50 chars) */
19219
19245
  physAddress1: string | null;
19220
- /** Physical address line 2 */
19246
+ /** Physical address line 2 (max 50 chars) */
19221
19247
  physAddress2: string | null;
19222
- /** Physical city */
19248
+ /** Physical city (max 50 chars) */
19223
19249
  physCity: string | null;
19224
- /** Physical state or province */
19250
+ /** Physical state or province (max 50 chars) */
19225
19251
  physState: string | null;
19226
- /** Physical postal code */
19252
+ /** Physical postal code (max 10 chars) */
19227
19253
  physPostalCode: string | null;
19228
- /** Physical country */
19254
+ /** Physical country (max 50 chars) */
19229
19255
  physCountry: string | null;
19230
- /** Mailing address line 1 */
19256
+ /** Mailing address line 1 (max 50 chars) */
19231
19257
  mailAddress1: string | null;
19232
- /** Mailing address line 2 */
19258
+ /** Mailing address line 2 (max 50 chars) */
19233
19259
  mailAddress2: string | null;
19234
- /** Mailing city */
19260
+ /** Mailing city (max 50 chars) */
19235
19261
  mailCity: string | null;
19236
- /** Mailing state or province */
19262
+ /** Mailing state or province (max 50 chars) */
19237
19263
  mailState: string | null;
19238
- /** Mailing postal code */
19264
+ /** Mailing postal code (max 10 chars) */
19239
19265
  mailPostalCode: string | null;
19240
- /** Mailing country */
19266
+ /** Mailing country (max 50 chars) */
19241
19267
  mailCountry: string | null;
19242
19268
  [key: string]: unknown;
19243
19269
  }
@@ -19248,15 +19274,15 @@ interface ContactsDocListDataAddress {
19248
19274
  * Returned by: api.customers.contacts.doc.list(id)
19249
19275
  */
19250
19276
  interface ContactsDocListData {
19251
- /** Prophet 21 contact ID */
19277
+ /** Prophet 21 contact ID (max 16 chars) */
19252
19278
  id: string;
19253
- /** First name */
19279
+ /** First name (max 15 chars) */
19254
19280
  firstName: string;
19255
- /** Last name */
19281
+ /** Last name (max 24 chars) */
19256
19282
  lastName: string;
19257
- /** Email address */
19283
+ /** Email address (max 255 chars) */
19258
19284
  emailAddress: string | null;
19259
- /** Direct phone number */
19285
+ /** Direct phone number (max 20 chars) */
19260
19286
  directPhone: string | null;
19261
19287
  /** Contact role */
19262
19288
  contactRoleUid: number | null;
@@ -19318,7 +19344,7 @@ type CustomerListData = CustomerListItem[];
19318
19344
  interface CustomerLookupGetItem {
19319
19345
  /** Prophet 21 customer ID */
19320
19346
  customerId: number;
19321
- /** Customer name */
19347
+ /** Customer name (max 255 chars) */
19322
19348
  customerName: string | null;
19323
19349
  [key: string]: unknown;
19324
19350
  }
@@ -19333,19 +19359,19 @@ type CustomerLookupGetData = CustomerLookupGetItem[];
19333
19359
  interface CustomerAddressListItem {
19334
19360
  /** Prophet 21 address (ship-to) ID */
19335
19361
  id: number;
19336
- /** Address name */
19362
+ /** Address name (max 50 chars) */
19337
19363
  name: string;
19338
- /** Mailing address line 1 */
19364
+ /** Mailing address line 1 (max 50 chars) */
19339
19365
  mailAddress1: string;
19340
- /** Mailing address line 2 */
19366
+ /** Mailing address line 2 (max 50 chars) */
19341
19367
  mailAddress2: string | null;
19342
- /** Mailing city */
19368
+ /** Mailing city (max 50 chars) */
19343
19369
  mailCity: string | null;
19344
- /** Mailing state or province */
19370
+ /** Mailing state or province (max 50 chars) */
19345
19371
  mailState: string | null;
19346
- /** Mailing postal code */
19372
+ /** Mailing postal code (max 10 chars) */
19347
19373
  mailPostalCode: string | null;
19348
- /** Mailing country */
19374
+ /** Mailing country (max 50 chars) */
19349
19375
  mailCountry: string | null;
19350
19376
  [key: string]: unknown;
19351
19377
  }
@@ -19528,13 +19554,13 @@ interface CustomerAgingListDataTotalsItem {
19528
19554
  * Field `data` of CustomerAgingListData
19529
19555
  */
19530
19556
  interface CustomerAgingListDataDataItem {
19531
- /** Prophet 21 invoice number */
19557
+ /** Prophet 21 invoice number (max 10 chars) */
19532
19558
  invoiceNo: string;
19533
- /** Order the invoice was raised for */
19559
+ /** Order the invoice was raised for (max 8 chars) */
19534
19560
  orderNo: string | null;
19535
- /** Customer purchase order number */
19561
+ /** Customer purchase order number (max 255 chars) */
19536
19562
  poNo: string | null;
19537
- /** Ship-to name */
19563
+ /** Ship-to name (max 50 chars) */
19538
19564
  ship2Name: string | null;
19539
19565
  /** Invoice date the age is measured from (Y-m-d) */
19540
19566
  invoiceDate: string;
@@ -19580,21 +19606,21 @@ interface CustomerAgingListData {
19580
19606
  * Returned by: api.customers.customer.contacts.list(customerId, params) (array items)
19581
19607
  */
19582
19608
  interface CustomerContactsListItem {
19583
- /** Prophet 21 contact ID */
19609
+ /** Prophet 21 contact ID (max 16 chars) */
19584
19610
  id: string;
19585
- /** Email address */
19611
+ /** Email address (max 255 chars) */
19586
19612
  emailAddress: string | null;
19587
- /** First name */
19613
+ /** First name (max 15 chars) */
19588
19614
  firstName: string;
19589
- /** Last name */
19615
+ /** Last name (max 24 chars) */
19590
19616
  lastName: string;
19591
- /** Job title */
19617
+ /** Job title (max 40 chars) */
19592
19618
  title: string | null;
19593
19619
  /** Direct phone number */
19594
19620
  phone: string | null;
19595
19621
  /** Phone extension */
19596
19622
  ext: string | null;
19597
- /** Mobile phone number */
19623
+ /** Mobile phone number (max 20 chars) */
19598
19624
  cellular: string | null;
19599
19625
  /** Prophet 21 address the contact belongs to */
19600
19626
  addressId: number;
@@ -19646,13 +19672,13 @@ interface CustomerInvoicesListItemLinesItem {
19646
19672
  lineNo: number;
19647
19673
  /** Item (inv_mast) on the line; null for a non-stock line */
19648
19674
  invMastUid: number | null;
19649
- /** Item ID */
19675
+ /** Item ID (max 40 chars) */
19650
19676
  itemId: string | null;
19651
- /** Item description */
19677
+ /** Item description (max 40 chars) */
19652
19678
  itemDesc: string;
19653
19679
  /** Item short code; null when the line has no item */
19654
19680
  shortCode: string | null;
19655
- /** Unit of measure */
19681
+ /** Unit of measure (max 10 chars) */
19656
19682
  unitOfMeasure: string | null;
19657
19683
  /** Unit price */
19658
19684
  unitPrice: number;
@@ -19664,7 +19690,7 @@ interface CustomerInvoicesListItemLinesItem {
19664
19690
  qtyShipped: number;
19665
19691
  /** Order the line came from; misspelled duplicate of orderNo, kept for existing consumers */
19666
19692
  oderNo: string | null;
19667
- /** Order the line came from */
19693
+ /** Order the line came from (max 8 chars) */
19668
19694
  orderNo: string | null;
19669
19695
  /** Order line number the invoice line came from */
19670
19696
  oeLineNumber: number | null;
@@ -19678,63 +19704,63 @@ interface CustomerInvoicesListItemLinesItem {
19678
19704
  * Returned by: api.customers.customer.invoices.get(customerId, invoiceNo)
19679
19705
  */
19680
19706
  interface CustomerInvoicesListItem {
19681
- /** Invoice number */
19707
+ /** Invoice number (max 10 chars) */
19682
19708
  invoiceNo: string;
19683
19709
  /** Prophet 21 customer invoiced */
19684
19710
  customerId: number;
19685
19711
  /** Customer name */
19686
19712
  customerName: string | null;
19687
- /** Order the invoice bills */
19713
+ /** Order the invoice bills (max 8 chars) */
19688
19714
  orderNo: string | null;
19689
19715
  /** Invoice date (Y-m-d) */
19690
19716
  invoiceDate: string;
19691
- /** Customer purchase order number */
19717
+ /** Customer purchase order number (max 255 chars) */
19692
19718
  poNo: string | null;
19693
- /** Ship-to name */
19719
+ /** Ship-to name (max 50 chars) */
19694
19720
  ship2Name: string | null;
19695
- /** Ship-to contact */
19721
+ /** Ship-to contact (max 30 chars) */
19696
19722
  ship2Contact: string | null;
19697
- /** Ship-to address line 1 */
19723
+ /** Ship-to address line 1 (max 50 chars) */
19698
19724
  ship2Address1: string | null;
19699
- /** Ship-to address line 2 */
19725
+ /** Ship-to address line 2 (max 50 chars) */
19700
19726
  ship2Address2: string | null;
19701
- /** Ship-to address line 3 */
19727
+ /** Ship-to address line 3 (max 50 chars) */
19702
19728
  ship2Address3: string | null;
19703
- /** Ship-to city */
19729
+ /** Ship-to city (max 50 chars) */
19704
19730
  ship2City: string | null;
19705
- /** Ship-to state or province */
19731
+ /** Ship-to state or province (max 50 chars) */
19706
19732
  ship2State: string | null;
19707
- /** Ship-to postal code */
19733
+ /** Ship-to postal code (max 10 chars) */
19708
19734
  ship2PostalCode: string | null;
19709
- /** Ship-to country */
19735
+ /** Ship-to country (max 50 chars) */
19710
19736
  ship2Country: string | null;
19711
- /** Ship-to email address */
19737
+ /** Ship-to email address (max 255 chars) */
19712
19738
  ship2EmailAddress: string | null;
19713
- /** Ship-to phone number */
19739
+ /** Ship-to phone number (max 20 chars) */
19714
19740
  shipToPhone: string | null;
19715
- /** Bill-to name */
19741
+ /** Bill-to name (max 50 chars) */
19716
19742
  bill2Name: string | null;
19717
- /** Bill-to contact */
19743
+ /** Bill-to contact (max 30 chars) */
19718
19744
  bill2Contact: string | null;
19719
- /** Bill-to address line 1 */
19745
+ /** Bill-to address line 1 (max 50 chars) */
19720
19746
  bill2Address1: string | null;
19721
- /** Bill-to address line 2 */
19747
+ /** Bill-to address line 2 (max 50 chars) */
19722
19748
  bill2Address2: string | null;
19723
- /** Bill-to address line 3 */
19749
+ /** Bill-to address line 3 (max 50 chars) */
19724
19750
  bill2Address3: string | null;
19725
- /** Bill-to city */
19751
+ /** Bill-to city (max 50 chars) */
19726
19752
  bill2City: string | null;
19727
- /** Bill-to state or province */
19753
+ /** Bill-to state or province (max 50 chars) */
19728
19754
  bill2State: string | null;
19729
- /** Bill-to postal code */
19755
+ /** Bill-to postal code (max 10 chars) */
19730
19756
  bill2PostalCode: string | null;
19731
- /** Bill-to country */
19757
+ /** Bill-to country (max 50 chars) */
19732
19758
  bill2Country: string | null;
19733
19759
  /** Invoice total */
19734
19760
  totalAmount: number;
19735
19761
  /** Amount paid so far */
19736
19762
  amountPaid: number;
19737
- /** Y when the invoice is paid in full */
19763
+ /** Y when the invoice is paid in full (max 1 chars) */
19738
19764
  paidInFullFlag: string | null;
19739
19765
  /** Tax on the invoice */
19740
19766
  taxAmount: number;
@@ -20021,13 +20047,13 @@ type CustomerOrdersListData = Array<CustomerOrdersGetData | CustomerOrdersListDa
20021
20047
  interface CustomerOrdersGetDataLinesItem {
20022
20048
  /** Item (inv_mast) ordered on the line */
20023
20049
  invMastUid: number;
20024
- /** Y when the line is canceled */
20050
+ /** Y when the line is canceled (max 1 chars) */
20025
20051
  cancelFlag: string | null;
20026
- /** Y when the line is complete */
20052
+ /** Y when the line is complete (max 1 chars) */
20027
20053
  complete: string | null;
20028
- /** Y when the line is deleted in Prophet 21 */
20054
+ /** Y when the line is deleted in Prophet 21 (max 1 chars) */
20029
20055
  deleteFlag: string;
20030
- /** Prophet 21 disposition code for unallocated quantity (e.g. B = backorder) */
20056
+ /** Prophet 21 disposition code for unallocated quantity (e.g. B = backorder) (max 1 chars) */
20031
20057
  disposition: string | null;
20032
20058
  /** Item description */
20033
20059
  itemDesc: string | null;
@@ -20039,7 +20065,7 @@ interface CustomerOrdersGetDataLinesItem {
20039
20065
  shortCode: string | null;
20040
20066
  /** Line number on the order */
20041
20067
  lineNo: number;
20042
- /** Order the line belongs to */
20068
+ /** Order the line belongs to (max 8 chars) */
20043
20069
  orderNo: string;
20044
20070
  /** Quantity on the line when it was entered */
20045
20071
  originalQtyOrdered: number | null;
@@ -20053,7 +20079,7 @@ interface CustomerOrdersGetDataLinesItem {
20053
20079
  qtyOnPickTickets: number | null;
20054
20080
  /** Quantity ordered */
20055
20081
  qtyOrdered: number | null;
20056
- /** Unit of measure the line was sold in */
20082
+ /** Unit of measure the line was sold in (max 8 chars) */
20057
20083
  unitOfMeasure: string | null;
20058
20084
  /** Quantity in the line's unit of measure */
20059
20085
  unitQuantity: number;
@@ -20117,19 +20143,19 @@ interface CustomerOrdersGetDataPickTicketsItemLinesItem {
20117
20143
  interface CustomerOrdersGetDataPickTicketsItem {
20118
20144
  /** Pick ticket number */
20119
20145
  pickTicketNo: number;
20120
- /** Carrier tracking number */
20146
+ /** Carrier tracking number (max 40 chars) */
20121
20147
  trackingNo: string | null;
20122
- /** Order the pick ticket belongs to */
20148
+ /** Order the pick ticket belongs to (max 8 chars) */
20123
20149
  orderNo: string;
20124
20150
  /** Invoice raised for the pick ticket; null until invoiced */
20125
20151
  invoiceNo: number | null;
20126
20152
  /** Date the pick ticket shipped (Y-m-d) */
20127
20153
  shipDate: string | null;
20128
- /** Y when the pick ticket has been printed */
20154
+ /** Y when the pick ticket has been printed (max 1 chars) */
20129
20155
  printedFlag: string | null;
20130
20156
  /** Date the pick ticket was printed (Y-m-d) */
20131
20157
  printDate: string | null;
20132
- /** Picking or shipping instructions */
20158
+ /** Picking or shipping instructions (max 255 chars) */
20133
20159
  instructions: string | null;
20134
20160
  /** Prophet 21 address id of the pick ticket's carrier */
20135
20161
  carrierId: number | null;
@@ -20152,47 +20178,47 @@ interface CustomerOrdersGetDataPickTicketsItem {
20152
20178
  * Returned by: api.customers.customer.rmas.get(customerId, rmaNo)
20153
20179
  */
20154
20180
  interface CustomerOrdersGetData {
20155
- /** Prophet 21 order number */
20181
+ /** Prophet 21 order number (max 8 chars) */
20156
20182
  orderNo: string;
20157
20183
  /** Prophet 21 customer the order belongs to */
20158
20184
  customerId: number;
20159
20185
  /** Customer name */
20160
20186
  customerName: string | null;
20161
- /** Job name entered on the order */
20187
+ /** Job name entered on the order (max 40 chars) */
20162
20188
  jobName: string | null;
20163
20189
  /** Date the order was placed (Y-m-d) */
20164
20190
  orderDate: string | null;
20165
20191
  /** Date the customer requested delivery (Y-m-d) */
20166
20192
  requestedDate: string | null;
20167
- /** Y when the order is canceled */
20193
+ /** Y when the order is canceled (max 1 chars) */
20168
20194
  cancelFlag: string | null;
20169
- /** Y when the order is complete (fully shipped) */
20195
+ /** Y when the order is complete (fully shipped) (max 1 chars) */
20170
20196
  completed: string | null;
20171
- /** Y when the order is deleted in Prophet 21 */
20197
+ /** Y when the order is deleted in Prophet 21 (max 1 chars) */
20172
20198
  deleteFlag: string;
20173
- /** Customer purchase order number */
20199
+ /** Customer purchase order number (max 50 chars) */
20174
20200
  poNo: string | null;
20175
- /** Ship-to name */
20201
+ /** Ship-to name (max 50 chars) */
20176
20202
  ship2Name: string | null;
20177
- /** Ship-to address line 1 */
20203
+ /** Ship-to address line 1 (max 50 chars) */
20178
20204
  ship2Add1: string | null;
20179
- /** Ship-to address line 2 */
20205
+ /** Ship-to address line 2 (max 50 chars) */
20180
20206
  ship2Add2: string | null;
20181
- /** Ship-to address line 3 */
20207
+ /** Ship-to address line 3 (max 50 chars) */
20182
20208
  ship2Add3: string | null;
20183
- /** Ship-to city */
20209
+ /** Ship-to city (max 50 chars) */
20184
20210
  ship2City: string | null;
20185
- /** Ship-to state or province */
20211
+ /** Ship-to state or province (max 50 chars) */
20186
20212
  ship2State: string | null;
20187
- /** Ship-to postal code */
20213
+ /** Ship-to postal code (max 10 chars) */
20188
20214
  ship2Zip: string | null;
20189
- /** Ship-to country */
20215
+ /** Ship-to country (max 50 chars) */
20190
20216
  ship2Country: string | null;
20191
- /** Ship-to email address */
20217
+ /** Ship-to email address (max 255 chars) */
20192
20218
  ship2EmailAddress: string | null;
20193
- /** Ship-to phone number */
20219
+ /** Ship-to phone number (max 20 chars) */
20194
20220
  shipToPhone: string | null;
20195
- /** Delivery instructions for the carrier */
20221
+ /** Delivery instructions for the carrier (max 255 chars) */
20196
20222
  deliveryInstructions: string | null;
20197
20223
  /** Order class 1 */
20198
20224
  class1Id: string | null;
@@ -20204,16 +20230,16 @@ interface CustomerOrdersGetData {
20204
20230
  class4Id: string | null;
20205
20231
  /** Order class 5 */
20206
20232
  class5Id: string | null;
20207
- /** Prophet 21 contact who placed the order */
20233
+ /** Prophet 21 contact who placed the order (max 16 chars) */
20208
20234
  contactId: string | null;
20209
- /** Web order reference number from the storefront */
20235
+ /** Web order reference number from the storefront (max 255 chars) */
20210
20236
  webReferenceNo: string | null;
20211
20237
  /**
20212
20238
  * PENDING, SUBMITTED, IN PROCESS, ON HOLD or SHIPPED, derived from the completed, approved,
20213
20239
  * cancel and validation flags
20214
20240
  */
20215
20241
  orderStatus: string;
20216
- /** User who entered the order */
20242
+ /** User who entered the order (max 30 chars) */
20217
20243
  taker: string | null;
20218
20244
  /** First name of the ordering contact; null when the order has no contact */
20219
20245
  contactFirstName: string | null;
@@ -20316,11 +20342,11 @@ interface CustomerSalesUsageListDataDataItemBucketsItem {
20316
20342
  * Field `data` of CustomerSalesUsageListData
20317
20343
  */
20318
20344
  interface CustomerSalesUsageListDataDataItem {
20319
- /** Item ID */
20345
+ /** Item ID (max 40 chars) */
20320
20346
  itemId: string;
20321
- /** Item description */
20347
+ /** Item description (max 40 chars) */
20322
20348
  itemDesc: string;
20323
- /** Unit of measure the item was sold in */
20349
+ /** Unit of measure the item was sold in (max 10 chars) */
20324
20350
  unitOfMeasure: string | null;
20325
20351
  /** Base units per sales unit */
20326
20352
  salesUnitSize: number | null;
@@ -20384,41 +20410,41 @@ interface CustomerShipToCreateBody {
20384
20410
  interface CustomerShipToListItemAddress {
20385
20411
  /** Prophet 21 address ID */
20386
20412
  id: number;
20387
- /** Address name */
20413
+ /** Address name (max 50 chars) */
20388
20414
  name: string;
20389
- /** Mailing address line 1 */
20415
+ /** Mailing address line 1 (max 50 chars) */
20390
20416
  mailAddress1: string | null;
20391
- /** Mailing address line 2 */
20417
+ /** Mailing address line 2 (max 50 chars) */
20392
20418
  mailAddress2: string | null;
20393
- /** Mailing address line 3 */
20419
+ /** Mailing address line 3 (max 50 chars) */
20394
20420
  mailAddress3: string | null;
20395
- /** Mailing city */
20421
+ /** Mailing city (max 50 chars) */
20396
20422
  mailCity: string | null;
20397
- /** Mailing state or province */
20423
+ /** Mailing state or province (max 50 chars) */
20398
20424
  mailState: string | null;
20399
- /** Mailing postal code */
20425
+ /** Mailing postal code (max 10 chars) */
20400
20426
  mailPostalCode: string | null;
20401
- /** Mailing country */
20427
+ /** Mailing country (max 50 chars) */
20402
20428
  mailCountry: string | null;
20403
- /** Physical address line 1 */
20429
+ /** Physical address line 1 (max 50 chars) */
20404
20430
  physAddress1: string | null;
20405
- /** Physical address line 2 */
20431
+ /** Physical address line 2 (max 50 chars) */
20406
20432
  physAddress2: string | null;
20407
- /** Physical address line 3 */
20433
+ /** Physical address line 3 (max 50 chars) */
20408
20434
  physAddress3: string | null;
20409
- /** Physical city */
20435
+ /** Physical city (max 50 chars) */
20410
20436
  physCity: string | null;
20411
- /** Physical state or province */
20437
+ /** Physical state or province (max 50 chars) */
20412
20438
  physState: string | null;
20413
- /** Physical postal code */
20439
+ /** Physical postal code (max 10 chars) */
20414
20440
  physPostalCode: string | null;
20415
- /** Physical country */
20441
+ /** Physical country (max 50 chars) */
20416
20442
  physCountry: string | null;
20417
- /** Address class 5 */
20443
+ /** Address class 5 (max 8 chars) */
20418
20444
  class5Id: string | null;
20419
- /** Main phone number */
20445
+ /** Main phone number (max 20 chars) */
20420
20446
  centralPhoneNumber: string | null;
20421
- /** UPS code for the address */
20447
+ /** UPS code for the address (max 40 chars) */
20422
20448
  upsCode: string | null;
20423
20449
  [key: string]: unknown;
20424
20450
  }
@@ -20433,15 +20459,15 @@ interface CustomerShipToListItem {
20433
20459
  shipToId: number;
20434
20460
  /** Prophet 21 customer the ship-to belongs to */
20435
20461
  customerId: number;
20436
- /** Prophet 21 company */
20462
+ /** Prophet 21 company (max 8 chars) */
20437
20463
  companyId: string;
20438
- /** Default branch for the ship-to */
20464
+ /** Default branch for the ship-to (max 8 chars) */
20439
20465
  defaultBranch: string;
20440
20466
  /** Prophet 21 address ID of the default carrier */
20441
20467
  defaultCarrierId: number | null;
20442
20468
  /** Prophet 21 location the ship-to prefers to ship from */
20443
20469
  preferredLocationId: number | null;
20444
- /** Delivery instructions for the carrier */
20470
+ /** Delivery instructions for the carrier (max 255 chars) */
20445
20471
  deliveryInstructions: string | null;
20446
20472
  /** Shipping route assigned to the ship-to */
20447
20473
  shippingRouteUid: number | null;
@@ -20464,41 +20490,41 @@ type CustomerShipToListData = CustomerShipToListItem[];
20464
20490
  interface CustomerShipToLookupGetItem {
20465
20491
  /** Prophet 21 ship-to (address) ID */
20466
20492
  id: number;
20467
- /** Ship-to name */
20493
+ /** Ship-to name (max 50 chars) */
20468
20494
  name: string;
20469
- /** Mailing address line 1 */
20495
+ /** Mailing address line 1 (max 50 chars) */
20470
20496
  mailAddress1: string;
20471
- /** Mailing address line 2 */
20497
+ /** Mailing address line 2 (max 50 chars) */
20472
20498
  mailAddress2: string | null;
20473
- /** Mailing address line 3 */
20499
+ /** Mailing address line 3 (max 50 chars) */
20474
20500
  mailAddress3: string | null;
20475
- /** Mailing city */
20501
+ /** Mailing city (max 50 chars) */
20476
20502
  mailCity: string | null;
20477
- /** Mailing state or province */
20503
+ /** Mailing state or province (max 50 chars) */
20478
20504
  mailState: string | null;
20479
- /** Mailing postal code */
20505
+ /** Mailing postal code (max 10 chars) */
20480
20506
  mailPostalCode: string | null;
20481
- /** Mailing country */
20507
+ /** Mailing country (max 50 chars) */
20482
20508
  mailCountry: string | null;
20483
- /** Physical address line 1 */
20509
+ /** Physical address line 1 (max 50 chars) */
20484
20510
  physAddress1: string | null;
20485
- /** Physical address line 2 */
20511
+ /** Physical address line 2 (max 50 chars) */
20486
20512
  physAddress2: string | null;
20487
- /** Physical address line 3 */
20513
+ /** Physical address line 3 (max 50 chars) */
20488
20514
  physAddress3: string | null;
20489
- /** Physical city */
20515
+ /** Physical city (max 50 chars) */
20490
20516
  physCity: string | null;
20491
- /** Physical state or province */
20517
+ /** Physical state or province (max 50 chars) */
20492
20518
  physState: string | null;
20493
- /** Physical postal code */
20519
+ /** Physical postal code (max 10 chars) */
20494
20520
  physPostalCode: string | null;
20495
- /** Physical country */
20521
+ /** Physical country (max 50 chars) */
20496
20522
  physCountry: string | null;
20497
- /** Address class 5 */
20523
+ /** Address class 5 (max 8 chars) */
20498
20524
  class5Id: string | null;
20499
20525
  /** Prophet 21 location the ship-to prefers to ship from */
20500
20526
  preferredLocationId: number | null;
20501
- /** Default branch for the ship-to */
20527
+ /** Default branch for the ship-to (max 8 chars) */
20502
20528
  defaultBranch: string;
20503
20529
  [key: string]: unknown;
20504
20530
  }
@@ -20712,7 +20738,7 @@ interface CustomersClientSpec {
20712
20738
  * @param params ContactsCustomersListParams (query string)
20713
20739
  * @returns BaseResponse whose `data` is ContactsCustomersListData
20714
20740
  */
20715
- list: (id: number, params?: ContactsCustomersListParams) => Promise<BaseResponse$1<ContactsCustomersListData>>;
20741
+ list: (id: string, params?: ContactsCustomersListParams) => Promise<BaseResponse$1<ContactsCustomersListData>>;
20716
20742
  };
20717
20743
  doc: {
20718
20744
  /**
@@ -20731,9 +20757,9 @@ interface CustomersClientSpec {
20731
20757
  * @param params ContactsDocListParams (query string)
20732
20758
  * @returns BaseResponse whose `data` is ContactsDocListData
20733
20759
  */
20734
- list: (id: number, params?: ContactsDocListParams) => Promise<BaseResponse$1<ContactsDocListData>>;
20760
+ list: (id: string, params?: ContactsDocListParams) => Promise<BaseResponse$1<ContactsDocListData>>;
20735
20761
  /** Alias for `list`: GET /contacts/{id}/doc. Call: api.customers.contacts.doc.get(id) */
20736
- get: (id: number, params?: ContactsDocListParams) => Promise<BaseResponse$1<ContactsDocListData>>;
20762
+ get: (id: string, params?: ContactsDocListParams) => Promise<BaseResponse$1<ContactsDocListData>>;
20737
20763
  };
20738
20764
  webAllowance: {
20739
20765
  /**
@@ -20754,7 +20780,7 @@ interface CustomersClientSpec {
20754
20780
  * @param params ContactsWebAllowanceListParams (query string)
20755
20781
  * @returns BaseResponse whose `data` is ContactsWebAllowanceListData
20756
20782
  */
20757
- list: (id: number, params?: ContactsWebAllowanceListParams) => Promise<BaseResponse$1<ContactsWebAllowanceListData>>;
20783
+ list: (id: string, params?: ContactsWebAllowanceListParams) => Promise<BaseResponse$1<ContactsWebAllowanceListData>>;
20758
20784
  };
20759
20785
  };
20760
20786
  contactsUd: {
@@ -20775,7 +20801,7 @@ interface CustomersClientSpec {
20775
20801
  * @param params ContactsUdGetParams (query string)
20776
20802
  * @returns BaseResponse whose `data` is ContactsUdGetData
20777
20803
  */
20778
- get: (id: number, params?: ContactsUdGetParams) => Promise<BaseResponse$1<ContactsUdGetData>>;
20804
+ get: (id: string, params?: ContactsUdGetParams) => Promise<BaseResponse$1<ContactsUdGetData>>;
20779
20805
  };
20780
20806
  customer: {
20781
20807
  /**
@@ -21748,29 +21774,29 @@ type InvoiceHdrReprintListData = InvoiceHdrReprintListDataOption1 | false;
21748
21774
  interface OeHdrLookupGetItem {
21749
21775
  /** Order header ID */
21750
21776
  oeHdrUid: number;
21751
- /** Prophet 21 order number */
21777
+ /** Prophet 21 order number (max 8 chars) */
21752
21778
  orderNo: string;
21753
- /** Customer purchase order number */
21779
+ /** Customer purchase order number (max 50 chars) */
21754
21780
  poNo: string | null;
21755
21781
  /** Prophet 21 customer the order belongs to */
21756
21782
  customerId: number;
21757
- /** Ship-to name */
21783
+ /** Ship-to name (max 50 chars) */
21758
21784
  ship2Name: string | null;
21759
- /** Ship-to email address */
21785
+ /** Ship-to email address (max 255 chars) */
21760
21786
  ship2EmailAddress: string | null;
21761
- /** Web order reference number from the storefront */
21787
+ /** Web order reference number from the storefront (max 255 chars) */
21762
21788
  webReferenceNo: string | null;
21763
21789
  /** Customer name */
21764
21790
  customerName: string | null;
21765
- /** Y when the order is complete (fully shipped) */
21791
+ /** Y when the order is complete (fully shipped) (max 1 chars) */
21766
21792
  completed: string | null;
21767
21793
  /** Date the order was placed (Y-m-d); empty when unknown */
21768
21794
  orderDate: string;
21769
- /** User who entered the order */
21795
+ /** User who entered the order (max 30 chars) */
21770
21796
  taker: string | null;
21771
21797
  /** Order class 1 */
21772
21798
  class1Id: string | null;
21773
- /** Job name entered on the order */
21799
+ /** Job name entered on the order (max 40 chars) */
21774
21800
  jobName: string | null;
21775
21801
  /**
21776
21802
  * PENDING, SUBMITTED, IN PROCESS, ON HOLD or SHIPPED, derived from the completed, approved,
@@ -21790,13 +21816,13 @@ type OeHdrLookupGetData = OeHdrLookupGetItem[];
21790
21816
  interface OeHdrDocListDataLinesItem {
21791
21817
  /** Item (inv_mast) ordered on the line */
21792
21818
  invMastUid: number;
21793
- /** Y when the line is canceled */
21819
+ /** Y when the line is canceled (max 1 chars) */
21794
21820
  cancelFlag: string | null;
21795
- /** Y when the line is complete */
21821
+ /** Y when the line is complete (max 1 chars) */
21796
21822
  complete: string | null;
21797
- /** Y when the line is deleted in Prophet 21 */
21823
+ /** Y when the line is deleted in Prophet 21 (max 1 chars) */
21798
21824
  deleteFlag: string;
21799
- /** Prophet 21 disposition code for unallocated quantity (e.g. B = backorder) */
21825
+ /** Prophet 21 disposition code for unallocated quantity (e.g. B = backorder) (max 1 chars) */
21800
21826
  disposition: string | null;
21801
21827
  /** Item description */
21802
21828
  itemDesc: string | null;
@@ -21808,7 +21834,7 @@ interface OeHdrDocListDataLinesItem {
21808
21834
  shortCode: string | null;
21809
21835
  /** Line number on the order */
21810
21836
  lineNo: number;
21811
- /** Order the line belongs to */
21837
+ /** Order the line belongs to (max 8 chars) */
21812
21838
  orderNo: string;
21813
21839
  /** Quantity on the line when it was entered */
21814
21840
  originalQtyOrdered: number | null;
@@ -21822,7 +21848,7 @@ interface OeHdrDocListDataLinesItem {
21822
21848
  qtyOnPickTickets: number | null;
21823
21849
  /** Quantity ordered */
21824
21850
  qtyOrdered: number | null;
21825
- /** Unit of measure the line was sold in */
21851
+ /** Unit of measure the line was sold in (max 8 chars) */
21826
21852
  unitOfMeasure: string | null;
21827
21853
  /** Quantity in the line's unit of measure */
21828
21854
  unitQuantity: number;
@@ -21886,19 +21912,19 @@ interface OeHdrDocListDataPickTicketsItemLinesItem {
21886
21912
  interface OeHdrDocListDataPickTicketsItem {
21887
21913
  /** Pick ticket number */
21888
21914
  pickTicketNo: number;
21889
- /** Carrier tracking number */
21915
+ /** Carrier tracking number (max 40 chars) */
21890
21916
  trackingNo: string | null;
21891
- /** Order the pick ticket belongs to */
21917
+ /** Order the pick ticket belongs to (max 8 chars) */
21892
21918
  orderNo: string;
21893
21919
  /** Invoice raised for the pick ticket; null until invoiced */
21894
21920
  invoiceNo: number | null;
21895
21921
  /** Date the pick ticket shipped (Y-m-d) */
21896
21922
  shipDate: string | null;
21897
- /** Y when the pick ticket has been printed */
21923
+ /** Y when the pick ticket has been printed (max 1 chars) */
21898
21924
  printedFlag: string | null;
21899
21925
  /** Date the pick ticket was printed (Y-m-d) */
21900
21926
  printDate: string | null;
21901
- /** Picking or shipping instructions */
21927
+ /** Picking or shipping instructions (max 255 chars) */
21902
21928
  instructions: string | null;
21903
21929
  /** Prophet 21 address id of the pick ticket's carrier */
21904
21930
  carrierId: number | null;
@@ -21915,47 +21941,47 @@ interface OeHdrDocListDataPickTicketsItem {
21915
21941
  * Returned by: api.orders.oeHdr.doc.list(orderNo, params)
21916
21942
  */
21917
21943
  interface OeHdrDocListData {
21918
- /** Prophet 21 order number */
21944
+ /** Prophet 21 order number (max 8 chars) */
21919
21945
  orderNo: string;
21920
21946
  /** Prophet 21 customer the order belongs to */
21921
21947
  customerId: number;
21922
21948
  /** Customer name */
21923
21949
  customerName: string | null;
21924
- /** Job name entered on the order */
21950
+ /** Job name entered on the order (max 40 chars) */
21925
21951
  jobName: string | null;
21926
21952
  /** Date the order was placed (Y-m-d) */
21927
21953
  orderDate: string | null;
21928
21954
  /** Date the customer requested delivery (Y-m-d) */
21929
21955
  requestedDate: string | null;
21930
- /** Y when the order is canceled */
21956
+ /** Y when the order is canceled (max 1 chars) */
21931
21957
  cancelFlag: string | null;
21932
- /** Y when the order is complete (fully shipped) */
21958
+ /** Y when the order is complete (fully shipped) (max 1 chars) */
21933
21959
  completed: string | null;
21934
- /** Y when the order is deleted in Prophet 21 */
21960
+ /** Y when the order is deleted in Prophet 21 (max 1 chars) */
21935
21961
  deleteFlag: string;
21936
- /** Customer purchase order number */
21962
+ /** Customer purchase order number (max 50 chars) */
21937
21963
  poNo: string | null;
21938
- /** Ship-to name */
21964
+ /** Ship-to name (max 50 chars) */
21939
21965
  ship2Name: string | null;
21940
- /** Ship-to address line 1 */
21966
+ /** Ship-to address line 1 (max 50 chars) */
21941
21967
  ship2Add1: string | null;
21942
- /** Ship-to address line 2 */
21968
+ /** Ship-to address line 2 (max 50 chars) */
21943
21969
  ship2Add2: string | null;
21944
- /** Ship-to address line 3 */
21970
+ /** Ship-to address line 3 (max 50 chars) */
21945
21971
  ship2Add3: string | null;
21946
- /** Ship-to city */
21972
+ /** Ship-to city (max 50 chars) */
21947
21973
  ship2City: string | null;
21948
- /** Ship-to state or province */
21974
+ /** Ship-to state or province (max 50 chars) */
21949
21975
  ship2State: string | null;
21950
- /** Ship-to postal code */
21976
+ /** Ship-to postal code (max 10 chars) */
21951
21977
  ship2Zip: string | null;
21952
- /** Ship-to country */
21978
+ /** Ship-to country (max 50 chars) */
21953
21979
  ship2Country: string | null;
21954
- /** Ship-to email address */
21980
+ /** Ship-to email address (max 255 chars) */
21955
21981
  ship2EmailAddress: string | null;
21956
- /** Ship-to phone number */
21982
+ /** Ship-to phone number (max 20 chars) */
21957
21983
  shipToPhone: string | null;
21958
- /** Delivery instructions for the carrier */
21984
+ /** Delivery instructions for the carrier (max 255 chars) */
21959
21985
  deliveryInstructions: string | null;
21960
21986
  /** Order class 1 */
21961
21987
  class1Id: string | null;
@@ -21967,16 +21993,16 @@ interface OeHdrDocListData {
21967
21993
  class4Id: string | null;
21968
21994
  /** Order class 5 */
21969
21995
  class5Id: string | null;
21970
- /** Prophet 21 contact who placed the order */
21996
+ /** Prophet 21 contact who placed the order (max 16 chars) */
21971
21997
  contactId: string | null;
21972
- /** Web order reference number from the storefront */
21998
+ /** Web order reference number from the storefront (max 255 chars) */
21973
21999
  webReferenceNo: string | null;
21974
22000
  /**
21975
22001
  * PENDING, SUBMITTED, IN PROCESS, ON HOLD or SHIPPED, derived from the completed, approved,
21976
22002
  * cancel and validation flags
21977
22003
  */
21978
22004
  orderStatus: string;
21979
- /** User who entered the order */
22005
+ /** User who entered the order (max 30 chars) */
21980
22006
  taker: string | null;
21981
22007
  /** First name of the ordering contact; null when the order has no contact */
21982
22008
  contactFirstName: string | null;
@@ -22061,7 +22087,7 @@ interface PickTicketsLinesListItem {
22061
22087
  pickTicketNo: number;
22062
22088
  /** Line number on the pick ticket */
22063
22089
  lineNumber: number;
22064
- /** Prophet 21 company */
22090
+ /** Prophet 21 company (max 8 chars) */
22065
22091
  companyId: string;
22066
22092
  /** Quantity printed on the pick ticket */
22067
22093
  printQuantity: number | null;
@@ -22071,7 +22097,7 @@ interface PickTicketsLinesListItem {
22071
22097
  dateCreated: string;
22072
22098
  /** When the line last changed (Y-m-d H:i:s) */
22073
22099
  dateLastModified: string;
22074
- /** Unit of measure the line is picked in */
22100
+ /** Unit of measure the line is picked in (max 8 chars) */
22075
22101
  unitOfMeasure: string;
22076
22102
  /** Base units per unit of measure */
22077
22103
  unitSize: number;
@@ -22089,7 +22115,7 @@ interface PickTicketsLinesListItem {
22089
22115
  invoiceLineUid: number | null;
22090
22116
  /** Quantity scanned while picking */
22091
22117
  qtyScanned: number | null;
22092
- /** Box the line was packed in */
22118
+ /** Box the line was packed in (max 255 chars) */
22093
22119
  boxNumber: string | null;
22094
22120
  /** Quantity to pick when the pick ticket was created */
22095
22121
  originalQtyToPick: number | null;
@@ -22168,7 +22194,7 @@ interface PoHdrListItemLinesItem {
22168
22194
  interface PoHdrListItem {
22169
22195
  /** Purchase order header ID */
22170
22196
  poHdrUid: number;
22171
- /** Y when the purchase order is complete */
22197
+ /** Y when the purchase order is complete (max 1 chars) */
22172
22198
  complete: string | null;
22173
22199
  /** Prophet 21 purchase order number */
22174
22200
  poNo: number;
@@ -22184,15 +22210,15 @@ interface PoHdrListItem {
22184
22210
  divisionId: number | null;
22185
22211
  /** When the purchase order was placed */
22186
22212
  orderDate: PoHdrListItemOrderDate | null;
22187
- /** Prophet 21 company */
22213
+ /** Prophet 21 company (max 8 chars) */
22188
22214
  companyNo: string;
22189
- /** Ship-to name */
22215
+ /** Ship-to name (max 50 chars) */
22190
22216
  ship2Name: string | null;
22191
- /** Vendor packing slip number */
22217
+ /** Vendor packing slip number (max 50 chars) */
22192
22218
  packingSlipNumber: string | null;
22193
- /** Ship-to address line 1 */
22219
+ /** Ship-to address line 1 (max 50 chars) */
22194
22220
  ship2Add1: string | null;
22195
- /** Ship-to address line 2 */
22221
+ /** Ship-to address line 2 (max 50 chars) */
22196
22222
  ship2Add2: string | null;
22197
22223
  /** Prophet 21 location receiving the purchase order */
22198
22224
  locationId: number;
@@ -22413,7 +22439,7 @@ interface OrdersClientSpec {
22413
22439
  * @param params InvoiceHdrReprintListParams (query string)
22414
22440
  * @returns BaseResponse whose `data` is InvoiceHdrReprintListData
22415
22441
  */
22416
- list: (invoiceNo: number, params?: InvoiceHdrReprintListParams) => Promise<BaseResponse$1<InvoiceHdrReprintListData>>;
22442
+ list: (invoiceNo: string, params?: InvoiceHdrReprintListParams) => Promise<BaseResponse$1<InvoiceHdrReprintListData>>;
22417
22443
  };
22418
22444
  };
22419
22445
  oeHdr: {
@@ -23084,7 +23110,7 @@ interface InvMastTextListItem {
23084
23110
  invMastUid: number;
23085
23111
  /** Display order among the item texts */
23086
23112
  sequenceNo: number;
23087
- /** The text (max 2147483647 chars) */
23113
+ /** The text */
23088
23114
  textValue: string;
23089
23115
  /** Y to show the text on the web (max 1 chars) */
23090
23116
  displayOnWebFlag: string;
@@ -23220,7 +23246,7 @@ interface PodcastsListItem {
23220
23246
  title: string | null;
23221
23247
  /** Path of the audio file (max 255 chars) */
23222
23248
  path: string | null;
23223
- /** Podcast transcript (max 2147483647 chars) */
23249
+ /** Podcast transcript */
23224
23250
  transcript: string;
23225
23251
  /** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
23226
23252
  dateCreated: string;
@@ -25396,6 +25422,25 @@ interface RubricsListParams extends EdgeCacheParams {
25396
25422
  }
25397
25423
  /** Params for GET /rubrics/{rubricsUid} */
25398
25424
  type RubricsGetParams = EdgeCacheParams;
25425
+ /** Params for GET /sites */
25426
+ interface SitesListParams extends EdgeCacheParams {
25427
+ /**
25428
+ * Active code mirrored from sites_table.active (704=active, 705=inactive), sent comma-joined
25429
+ * (704,705); -1 for every site. Default: 704
25430
+ */
25431
+ legacyActiveCd?: number | number[];
25432
+ /** Limit number of results (Default: 10) */
25433
+ limit?: number;
25434
+ /** Starting offset results (Default: 0) */
25435
+ offset?: number;
25436
+ /** Order By (Default: sites_uid|ASC) */
25437
+ orderBy?: string;
25438
+ /**
25439
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
25440
+ * (704,705); -1 for every status. Default: 704
25441
+ */
25442
+ statusCd?: number | number[];
25443
+ }
25399
25444
  /** Params for GET /workflows */
25400
25445
  interface WorkflowsListParams extends EdgeCacheParams {
25401
25446
  /** Limit number of results (Default: 10) */
@@ -25598,7 +25643,7 @@ interface RubricsListItem {
25598
25643
  title: string | null;
25599
25644
  /** Rubric id (slug) callers look the rubric up by (max 255 chars) */
25600
25645
  id: string | null;
25601
- /** Prompt template text (max 4294967295 chars) */
25646
+ /** Prompt template text */
25602
25647
  content: string | null;
25603
25648
  /** Update code (1185 = Import Complete) */
25604
25649
  updateCd: number;
@@ -25682,6 +25727,35 @@ interface RubricsUpdateBody {
25682
25727
  * Returned by: api.agrInfo.rubrics.delete(rubricsUid)
25683
25728
  */
25684
25729
  type RubricsDeleteData = RubricsListItem;
25730
+ /**
25731
+ * List sites
25732
+ * Response data for GET /sites — MINIMUM fields, extras pass through
25733
+ *
25734
+ * Returned by: api.agrInfo.sites.list(params) (array items)
25735
+ */
25736
+ interface SitesListItem {
25737
+ /** agr_info sites row ID */
25738
+ sitesUid: number;
25739
+ /** Site ID */
25740
+ siteId: string;
25741
+ /** Row status (704 = Active, 705 = Inactive, 700 = Deleted) */
25742
+ statusCd: number;
25743
+ /** 704 when sites_table.active is 1, else 705 */
25744
+ legacyActiveCd: number;
25745
+ /** Services configured for the site (a config file with a non-empty prefix), sorted by name */
25746
+ services: string[];
25747
+ /** Prophet 21 version last reported by the site */
25748
+ prophet21Version: string | null;
25749
+ /** SQL Server version last reported by the site */
25750
+ sqlserverVersion: string | null;
25751
+ /** Where the site's Prophet 21 is hosted */
25752
+ prophet21Hosting: string;
25753
+ /** Last successful connection to the site's Prophet 21 */
25754
+ dateLastConnect: string;
25755
+ [key: string]: unknown;
25756
+ }
25757
+ /** Returned by: api.agrInfo.sites.list(params) */
25758
+ type SitesListData = SitesListItem[];
25685
25759
  /**
25686
25760
  * Shape of `user` (MINIMUM fields; reused wherever the same shape appears)
25687
25761
  * The token's user; null for a site token or a refused caller
@@ -25721,7 +25795,11 @@ interface SitesP21ApiCreateDataP21 {
25721
25795
  password: string;
25722
25796
  /** P21 consumer key for the token endpoint; null while sites use user credentials */
25723
25797
  clientSecret: string | null;
25724
- /** True when the site allows write-back through the P21 API; false until write-back exists */
25798
+ /**
25799
+ * True when the site allows write-back through the P21 API: always true here, since this block
25800
+ * exists only when the site has P21 API credentials; the P21 user's permissions decide what a
25801
+ * write may do
25802
+ */
25725
25803
  writable: boolean;
25726
25804
  [key: string]: unknown;
25727
25805
  }
@@ -25857,11 +25935,11 @@ interface WorkflowsListItem {
25857
25935
  workflowsId: string;
25858
25936
  /** Workflow title (max 255 chars) */
25859
25937
  title: string;
25860
- /** Workflow description (max 4294967295 chars) */
25938
+ /** Workflow description */
25861
25939
  description: string | null;
25862
25940
  /** Services the workflow covers (max 255 chars) */
25863
25941
  services: string;
25864
- /** Workflow content (max 4294967295 chars) */
25942
+ /** Workflow content */
25865
25943
  workflow: string;
25866
25944
  /** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
25867
25945
  dateCreated: string;
@@ -26198,6 +26276,27 @@ interface AgrInfoClientSpec {
26198
26276
  delete: (rubricsUid: number) => Promise<BaseResponse$1<RubricsDeleteData>>;
26199
26277
  };
26200
26278
  sites: {
26279
+ /**
26280
+ * List sites
26281
+ * Call: api.agrInfo.sites.list(params)
26282
+ *
26283
+ * List sites with the services each is configured for (a per-site service config file with a
26284
+ * non-empty prefix). Active means sites_table.active. augur_info only
26285
+ *
26286
+ * Response data, each item: One site with the services it is configured for
26287
+ * (SitesHelper::generateDoc)
26288
+ *
26289
+ * Errors:
26290
+ * 400: orderBy is not column|ASC or column|DESC on a sites column.
26291
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26292
+ *
26293
+ * GET https://agr-info.augur-api.com/sites
26294
+ * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1sites/get
26295
+ *
26296
+ * @param params SitesListParams (query string)
26297
+ * @returns BaseResponse whose `data` is SitesListData
26298
+ */
26299
+ list: (params?: SitesListParams) => Promise<BaseResponse$1<SitesListData>>;
26201
26300
  p21Api: {
26202
26301
  /**
26203
26302
  * P21 API credentials
@@ -26393,6 +26492,9 @@ type types$c_RubricsListItem = RubricsListItem;
26393
26492
  type types$c_RubricsListParams = RubricsListParams;
26394
26493
  type types$c_RubricsUpdateBody = RubricsUpdateBody;
26395
26494
  type types$c_RubricsUpdateData = RubricsUpdateData;
26495
+ type types$c_SitesListData = SitesListData;
26496
+ type types$c_SitesListItem = SitesListItem;
26497
+ type types$c_SitesListParams = SitesListParams;
26396
26498
  type types$c_SitesP21ApiCreateBody = SitesP21ApiCreateBody;
26397
26499
  type types$c_SitesP21ApiCreateData = SitesP21ApiCreateData;
26398
26500
  type types$c_SitesP21ApiCreateDataP21 = SitesP21ApiCreateDataP21;
@@ -26413,7 +26515,7 @@ type types$c_WorkflowsListParams = WorkflowsListParams;
26413
26515
  type types$c_WorkflowsUpdateBody = WorkflowsUpdateBody;
26414
26516
  type types$c_WorkflowsUpdateData = WorkflowsUpdateData;
26415
26517
  declare namespace types$c {
26416
- export type { types$c_AgrInfoClientSpec as AgrInfoClientSpec, types$c_AkashaGenerateCreateBody as AkashaGenerateCreateBody, types$c_AkashaGenerateCreateData as AkashaGenerateCreateData, types$c_ContextGetData as ContextGetData, types$c_ContextGetDataOption1 as ContextGetDataOption1, types$c_ContextGetDataOption1ServicesItem as ContextGetDataOption1ServicesItem, types$c_ContextGetParams as ContextGetParams, types$c_JoomlaGenerateCreateBody as JoomlaGenerateCreateBody, types$c_JoomlaGenerateCreateData as JoomlaGenerateCreateData, types$c_MicroservicesCreateBody as MicroservicesCreateBody, types$c_MicroservicesCreateData as MicroservicesCreateData, types$c_MicroservicesDeleteData as MicroservicesDeleteData, types$c_MicroservicesGetData as MicroservicesGetData, types$c_MicroservicesGetParams as MicroservicesGetParams, types$c_MicroservicesListData as MicroservicesListData, types$c_MicroservicesListItem as MicroservicesListItem, types$c_MicroservicesListParams as MicroservicesListParams, types$c_MicroservicesUpdateBody as MicroservicesUpdateBody, types$c_MicroservicesUpdateData as MicroservicesUpdateData, types$c_RubricsCreateBody as RubricsCreateBody, types$c_RubricsCreateData as RubricsCreateData, types$c_RubricsDeleteData as RubricsDeleteData, types$c_RubricsGetData as RubricsGetData, types$c_RubricsGetParams as RubricsGetParams, types$c_RubricsListData as RubricsListData, types$c_RubricsListItem as RubricsListItem, types$c_RubricsListParams as RubricsListParams, types$c_RubricsUpdateBody as RubricsUpdateBody, types$c_RubricsUpdateData as RubricsUpdateData, types$c_SitesP21ApiCreateBody as SitesP21ApiCreateBody, types$c_SitesP21ApiCreateData as SitesP21ApiCreateData, types$c_SitesP21ApiCreateDataP21 as SitesP21ApiCreateDataP21, types$c_SitesStaffTokenCreateBody as SitesStaffTokenCreateBody, types$c_SitesStaffTokenCreateData as SitesStaffTokenCreateData, types$c_SitesValidateCreateBody as SitesValidateCreateBody, types$c_SitesValidateCreateData as SitesValidateCreateData, types$c_SitesValidateCreateDataConnection as SitesValidateCreateDataConnection, types$c_SitesValidateCreateDataUser as SitesValidateCreateDataUser, types$c_WorkflowsCreateBody as WorkflowsCreateBody, types$c_WorkflowsCreateData as WorkflowsCreateData, types$c_WorkflowsDeleteData as WorkflowsDeleteData, types$c_WorkflowsGetData as WorkflowsGetData, types$c_WorkflowsGetParams as WorkflowsGetParams, types$c_WorkflowsListData as WorkflowsListData, types$c_WorkflowsListItem as WorkflowsListItem, types$c_WorkflowsListParams as WorkflowsListParams, types$c_WorkflowsUpdateBody as WorkflowsUpdateBody, types$c_WorkflowsUpdateData as WorkflowsUpdateData };
26518
+ export type { types$c_AgrInfoClientSpec as AgrInfoClientSpec, types$c_AkashaGenerateCreateBody as AkashaGenerateCreateBody, types$c_AkashaGenerateCreateData as AkashaGenerateCreateData, types$c_ContextGetData as ContextGetData, types$c_ContextGetDataOption1 as ContextGetDataOption1, types$c_ContextGetDataOption1ServicesItem as ContextGetDataOption1ServicesItem, types$c_ContextGetParams as ContextGetParams, types$c_JoomlaGenerateCreateBody as JoomlaGenerateCreateBody, types$c_JoomlaGenerateCreateData as JoomlaGenerateCreateData, types$c_MicroservicesCreateBody as MicroservicesCreateBody, types$c_MicroservicesCreateData as MicroservicesCreateData, types$c_MicroservicesDeleteData as MicroservicesDeleteData, types$c_MicroservicesGetData as MicroservicesGetData, types$c_MicroservicesGetParams as MicroservicesGetParams, types$c_MicroservicesListData as MicroservicesListData, types$c_MicroservicesListItem as MicroservicesListItem, types$c_MicroservicesListParams as MicroservicesListParams, types$c_MicroservicesUpdateBody as MicroservicesUpdateBody, types$c_MicroservicesUpdateData as MicroservicesUpdateData, types$c_RubricsCreateBody as RubricsCreateBody, types$c_RubricsCreateData as RubricsCreateData, types$c_RubricsDeleteData as RubricsDeleteData, types$c_RubricsGetData as RubricsGetData, types$c_RubricsGetParams as RubricsGetParams, types$c_RubricsListData as RubricsListData, types$c_RubricsListItem as RubricsListItem, types$c_RubricsListParams as RubricsListParams, types$c_RubricsUpdateBody as RubricsUpdateBody, types$c_RubricsUpdateData as RubricsUpdateData, types$c_SitesListData as SitesListData, types$c_SitesListItem as SitesListItem, types$c_SitesListParams as SitesListParams, types$c_SitesP21ApiCreateBody as SitesP21ApiCreateBody, types$c_SitesP21ApiCreateData as SitesP21ApiCreateData, types$c_SitesP21ApiCreateDataP21 as SitesP21ApiCreateDataP21, types$c_SitesStaffTokenCreateBody as SitesStaffTokenCreateBody, types$c_SitesStaffTokenCreateData as SitesStaffTokenCreateData, types$c_SitesValidateCreateBody as SitesValidateCreateBody, types$c_SitesValidateCreateData as SitesValidateCreateData, types$c_SitesValidateCreateDataConnection as SitesValidateCreateDataConnection, types$c_SitesValidateCreateDataUser as SitesValidateCreateDataUser, types$c_WorkflowsCreateBody as WorkflowsCreateBody, types$c_WorkflowsCreateData as WorkflowsCreateData, types$c_WorkflowsDeleteData as WorkflowsDeleteData, types$c_WorkflowsGetData as WorkflowsGetData, types$c_WorkflowsGetParams as WorkflowsGetParams, types$c_WorkflowsListData as WorkflowsListData, types$c_WorkflowsListItem as WorkflowsListItem, types$c_WorkflowsListParams as WorkflowsListParams, types$c_WorkflowsUpdateBody as WorkflowsUpdateBody, types$c_WorkflowsUpdateData as WorkflowsUpdateData };
26417
26519
  }
26418
26520
 
26419
26521
  /**
@@ -26453,6 +26555,7 @@ declare namespace types$c {
26453
26555
  * GET /rubrics/{rubricsUid} → api.agrInfo.rubrics.get(rubricsUid) → RubricsGetData
26454
26556
  * PUT /rubrics/{rubricsUid} → api.agrInfo.rubrics.update(rubricsUid, data) → RubricsUpdateData
26455
26557
  * DELETE /rubrics/{rubricsUid} → api.agrInfo.rubrics.delete(rubricsUid) → RubricsDeleteData
26558
+ * GET /sites → api.agrInfo.sites.list(params) → SitesListData
26456
26559
  * POST /sites/p21-api → api.agrInfo.sites.p21Api.create(data) → SitesP21ApiCreateData
26457
26560
  * POST /sites/staff-token → api.agrInfo.sites.staffToken.create(data) → SitesStaffTokenCreateData
26458
26561
  * POST /sites/validate → api.agrInfo.sites.validate.create(data) → SitesValidateCreateData
@@ -29625,9 +29728,9 @@ type ShippingMethodsUpdateData = ShippingMethodsListItem;
29625
29728
  * Request body of: api.logistics.shippingMethods.update(shippingMethodsUid, data)
29626
29729
  */
29627
29730
  interface ShippingMethodsUpdateBody {
29628
- /** Web display name for the carrier; "" or null clears it */
29731
+ /** Web display name for the carrier; "" or null clears it (max 255 chars) */
29629
29732
  nickname?: string | null;
29630
- /** Shipping type label; "" or null clears it */
29733
+ /** Shipping type label; "" or null clears it (max 255 chars) */
29631
29734
  shippingType?: string | null;
29632
29735
  /** Flat handling fee added to the rate; "" or null clears it */
29633
29736
  handlingFee?: number | null;
@@ -29676,11 +29779,12 @@ interface ShippingMethodsUpdateBody {
29676
29779
  sequenceNo?: number | null;
29677
29780
  /**
29678
29781
  * How the storefront prices the carrier at checkout (ups, fedex, ltl, free); "" or null clears it
29782
+ * (max 16 chars)
29679
29783
  */
29680
29784
  rateSource?: string | null;
29681
29785
  /**
29682
29786
  * Carrier service code (UPS 03, FedEx FEDEX_GROUND), sent as a string to keep leading zeros; ""
29683
- * or null clears it
29787
+ * or null clears it (max 64 chars)
29684
29788
  */
29685
29789
  serviceCode?: string | null;
29686
29790
  [key: string]: unknown;
@@ -30242,7 +30346,7 @@ interface P21ApisClientSpec {
30242
30346
  * @param params TransPurchaseOrderReceiptGetParams (query string)
30243
30347
  * @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
30244
30348
  */
30245
- get: (poNo: string, params?: TransPurchaseOrderReceiptGetParams) => Promise<BaseResponse$1<Record<string, unknown>>>;
30349
+ get: (poNo: number, params?: TransPurchaseOrderReceiptGetParams) => Promise<BaseResponse$1<Record<string, unknown>>>;
30246
30350
  };
30247
30351
  transUser: {
30248
30352
  /**
@@ -30600,33 +30704,33 @@ interface PaymentTypesListParams extends EdgeCacheParams {
30600
30704
  interface AddressListItem {
30601
30705
  /** Prophet 21 address ID */
30602
30706
  id: number;
30603
- /** Address name */
30707
+ /** Address name (max 50 chars) */
30604
30708
  name: string;
30605
- /** Mailing address line 1 */
30709
+ /** Mailing address line 1 (max 50 chars) */
30606
30710
  mailAddress1: string | null;
30607
- /** Mailing address line 2 */
30711
+ /** Mailing address line 2 (max 50 chars) */
30608
30712
  mailAddress2: string | null;
30609
- /** Mailing city */
30713
+ /** Mailing city (max 50 chars) */
30610
30714
  mailCity: string | null;
30611
- /** Mailing state or province */
30715
+ /** Mailing state or province (max 50 chars) */
30612
30716
  mailState: string | null;
30613
- /** Mailing postal code */
30717
+ /** Mailing postal code (max 10 chars) */
30614
30718
  mailPostalCode: string | null;
30615
- /** Mailing country */
30719
+ /** Mailing country (max 50 chars) */
30616
30720
  mailCountry: string | null;
30617
- /** Physical address line 1 */
30721
+ /** Physical address line 1 (max 50 chars) */
30618
30722
  physAddress1: string | null;
30619
- /** Physical address line 2 */
30723
+ /** Physical address line 2 (max 50 chars) */
30620
30724
  physAddress2: string | null;
30621
- /** Physical city */
30725
+ /** Physical city (max 50 chars) */
30622
30726
  physCity: string | null;
30623
- /** Physical state or province */
30727
+ /** Physical state or province (max 50 chars) */
30624
30728
  physState: string | null;
30625
- /** Physical postal code */
30729
+ /** Physical postal code (max 10 chars) */
30626
30730
  physPostalCode: string | null;
30627
- /** Physical country */
30731
+ /** Physical country (max 50 chars) */
30628
30732
  physCountry: string | null;
30629
- /** Y when the address is a carrier */
30733
+ /** Y when the address is a carrier (max 1 chars) */
30630
30734
  carrierFlag: string | null;
30631
30735
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
30632
30736
  statusCd: number;
@@ -30928,39 +31032,39 @@ type FreightCodeGetData = FreightCodeListItem;
30928
31032
  interface LocationListItem {
30929
31033
  /** Prophet 21 location ID (also its address ID) */
30930
31034
  locationId: number;
30931
- /** Prophet 21 company */
31035
+ /** Prophet 21 company (max 8 chars) */
30932
31036
  companyId: string;
30933
- /** Default branch for the location */
31037
+ /** Default branch for the location (max 8 chars) */
30934
31038
  defaultBranchId: string | null;
30935
- /** Y when the location is deleted in Prophet 21 */
31039
+ /** Y when the location is deleted in Prophet 21 (max 1 chars) */
30936
31040
  deleteFlag: string;
30937
31041
  /** When the record was created (Y-m-d H:i:s) */
30938
31042
  dateCreated: string;
30939
31043
  /** When the record last changed (Y-m-d H:i:s) */
30940
31044
  dateLastModified: string;
30941
- /** Prophet 21 user who last changed the record */
31045
+ /** Prophet 21 user who last changed the record (max 30 chars) */
30942
31046
  lastMaintainedBy: string;
30943
- /** Location name */
31047
+ /** Location name (max 255 chars) */
30944
31048
  locationName: string | null;
30945
- /** Y when lots are tracked by bin at the location */
31049
+ /** Y when lots are tracked by bin at the location (max 1 chars) */
30946
31050
  lotBinIntegration: string | null;
30947
- /** FedEx account number for the location */
31051
+ /** FedEx account number for the location (max 255 chars) */
30948
31052
  fedexLocAcctNo: string | null;
30949
- /** FedEx meter number for the location */
31053
+ /** FedEx meter number for the location (max 255 chars) */
30950
31054
  fedexMeterNo: string | null;
30951
- /** UPS account number for the location */
31055
+ /** UPS account number for the location (max 255 chars) */
30952
31056
  upsAccountNo: string | null;
30953
31057
  /** Prophet 21 code for the UPS pickup type */
30954
31058
  upsPickupTypeCd: number | null;
30955
31059
  /** Prophet 21 code for the UPS customer type */
30956
31060
  upsCustomerTypeCd: number | null;
30957
- /** UPS OnLine Tools access key, as Prophet 21 stores it */
31061
+ /** UPS OnLine Tools access key, as Prophet 21 stores it (max 255 chars) */
30958
31062
  upsOltAccessKey: string | null;
30959
- /** UPS OnLine Tools password, as Prophet 21 stores it */
31063
+ /** UPS OnLine Tools password, as Prophet 21 stores it (max 255 chars) */
30960
31064
  upsOltPassword: string | null;
30961
- /** UPS OnLine Tools user ID, as Prophet 21 stores it */
31065
+ /** UPS OnLine Tools user ID, as Prophet 21 stores it (max 255 chars) */
30962
31066
  upsOltUserId: string | null;
30963
- /** Y when the location is a distribution center */
31067
+ /** Y when the location is a distribution center (max 1 chars) */
30964
31068
  distributionCenter: string;
30965
31069
  /** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
30966
31070
  updateCd: number;
@@ -30986,13 +31090,13 @@ type LocationGetData = LocationListItem;
30986
31090
  interface PaymentTypesListItem {
30987
31091
  /** Prophet 21 payment type ID */
30988
31092
  paymentTypeId: number;
30989
- /** Payment type description */
31093
+ /** Payment type description (max 30 chars) */
30990
31094
  paymentTypeDesc: string;
30991
- /** Prophet 21 company */
31095
+ /** Prophet 21 company (max 8 chars) */
30992
31096
  companyId: string;
30993
- /** Prophet 21 payment method the type belongs to */
31097
+ /** Prophet 21 payment method the type belongs to (max 2 chars) */
30994
31098
  paymentMethodId: string;
30995
- /** Y when the payment type is deleted in Prophet 21 */
31099
+ /** Y when the payment type is deleted in Prophet 21 (max 1 chars) */
30996
31100
  deleteFlag: string;
30997
31101
  [key: string]: unknown;
30998
31102
  }
@@ -31526,11 +31630,11 @@ interface ImportListItem {
31526
31630
  * chars)
31527
31631
  */
31528
31632
  importState: string;
31529
- /** Order payload as a JSON string, stored and returned as-is (max 16777215 chars) */
31633
+ /** Order payload as a JSON string, stored and returned as-is */
31530
31634
  jsonData: string | null;
31531
31635
  /** Import status code: 704 = pending, 1185 = Import Complete */
31532
31636
  importStatusCd: number;
31533
- /** Free-text result or failure cause recorded by the pipeline (max 16777215 chars) */
31637
+ /** Free-text result or failure cause recorded by the pipeline */
31534
31638
  importResults: string | null;
31535
31639
  /** Prophet 21 reference once imported, usually the order number (max 255 chars) */
31536
31640
  referenceNo: string | null;
@@ -31836,9 +31940,9 @@ interface ImportImpOeHdrListData {
31836
31940
  orderType830: number | null;
31837
31941
  /** Ship-to address line 3 (max 50 chars) */
31838
31942
  shipToAddress3: string | null;
31839
- /** Extra import properties, stored and returned as text (max 16777215 chars) */
31943
+ /** Extra import properties, stored and returned as text */
31840
31944
  properties: string | null;
31841
- /** Prophet 21 user-defined fields, stored and returned as text (max 16777215 chars) */
31945
+ /** Prophet 21 user-defined fields, stored and returned as text */
31842
31946
  userDefined: string | null;
31843
31947
  [key: string]: unknown;
31844
31948
  }
@@ -31858,15 +31962,15 @@ type ImportImpOeHdrUpdateData = ImportImpOeHdrListData;
31858
31962
  interface ImportImpOeHdrUpdateBody {
31859
31963
  /** Prophet 21 customer the order is for */
31860
31964
  customerId?: number | null;
31861
- /** Prophet 21 contact on the order */
31965
+ /** Prophet 21 contact on the order (max 16 chars) */
31862
31966
  contactId?: string | null;
31863
- /** Prophet 21 company the order belongs to */
31967
+ /** Prophet 21 company the order belongs to (max 8 chars) */
31864
31968
  companyId?: string | null;
31865
31969
  /** Prophet 21 ship-to address the order ships to */
31866
31970
  shipToId?: number | null;
31867
- /** Customer purchase order number */
31971
+ /** Customer purchase order number (max 50 chars) */
31868
31972
  customerPoNo?: string | null;
31869
- /** Customer contract number */
31973
+ /** Customer contract number (max 255 chars) */
31870
31974
  contractNumber?: string | null;
31871
31975
  /** Prophet 21 sales location for the order */
31872
31976
  salesLocationId?: number | null;
@@ -31899,9 +32003,9 @@ interface ImportImpOeHdrSalesrepListData {
31899
32003
  commissionSplit: number | null;
31900
32004
  /** Y when the salesrep receives full commission (max 1 chars) */
31901
32005
  fullCommission: string | null;
31902
- /** Extra import properties, stored and returned as text (max 16777215 chars) */
32006
+ /** Extra import properties, stored and returned as text */
31903
32007
  properties: string | null;
31904
- /** Prophet 21 user-defined fields, stored and returned as text (max 16777215 chars) */
32008
+ /** Prophet 21 user-defined fields, stored and returned as text */
31905
32009
  userDefined: string | null;
31906
32010
  [key: string]: unknown;
31907
32011
  }
@@ -31921,19 +32025,19 @@ type ImportImpOeHdrSalesrepUpdateData = ImportImpOeHdrSalesrepListData;
31921
32025
  * Request body of: api.p21Sism.import.impOeHdrSalesrep.update(importUid, data)
31922
32026
  */
31923
32027
  interface ImportImpOeHdrSalesrepUpdateBody {
31924
- /** Prophet 21 salesrep ID */
32028
+ /** Prophet 21 salesrep ID (max 16 chars) */
31925
32029
  salesrepId?: string | null;
31926
- /** Salesrep first name */
32030
+ /** Salesrep first name (max 15 chars) */
31927
32031
  salesrepFirstName?: string | null;
31928
- /** Salesrep middle initial */
32032
+ /** Salesrep middle initial (max 2 chars) */
31929
32033
  salesrepMi?: string | null;
31930
- /** Salesrep last name */
32034
+ /** Salesrep last name (max 24 chars) */
31931
32035
  salesrepLastName?: string | null;
31932
- /** Y when this is the primary salesrep on the order */
32036
+ /** Y when this is the primary salesrep on the order (max 1 chars) */
31933
32037
  primarySalesrep?: string | null;
31934
32038
  /** Percentage of the commission this salesrep receives */
31935
32039
  commissionSplit?: number | null;
31936
- /** Y when the salesrep receives full commission */
32040
+ /** Y when the salesrep receives full commission (max 1 chars) */
31937
32041
  fullCommission?: string | null;
31938
32042
  [key: string]: unknown;
31939
32043
  }
@@ -31960,9 +32064,9 @@ interface ImportImpOeHdrWebListData {
31960
32064
  unknown3: string | null;
31961
32065
  /** Unnamed field 4 of the Prophet 21 order web-header import layout (max 255 chars) */
31962
32066
  unknown4: string | null;
31963
- /** Extra import properties, stored and returned as text (max 16777215 chars) */
32067
+ /** Extra import properties, stored and returned as text */
31964
32068
  properties: string | null;
31965
- /** Prophet 21 user-defined fields, stored and returned as text (max 16777215 chars) */
32069
+ /** Prophet 21 user-defined fields, stored and returned as text */
31966
32070
  userDefined: string | null;
31967
32071
  /** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
31968
32072
  dateCreated: string;
@@ -32045,7 +32149,7 @@ interface ScheduledImportMasterMetadataCreateData {
32045
32149
  deliveryMethod: string;
32046
32150
  /**
32047
32151
  * FTP/SFTP connection as a JSON string (host, port, username, password, path); pending_import
32048
- * does not read it (max 16777215 chars)
32152
+ * does not read it
32049
32153
  */
32050
32154
  properties: string | null;
32051
32155
  /** Date the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
@@ -32200,7 +32304,7 @@ interface P21SismClientSpec {
32200
32304
  * @param params ImportGetParams (query string)
32201
32305
  * @returns BaseResponse whose `data` is ImportGetData
32202
32306
  */
32203
- get: (importUid: string, params?: ImportGetParams) => Promise<BaseResponse$1<ImportGetData>>;
32307
+ get: (importUid: number, params?: ImportGetParams) => Promise<BaseResponse$1<ImportGetData>>;
32204
32308
  /**
32205
32309
  * Update an import
32206
32310
  * Call: api.p21Sism.import.update(importUid, data)
@@ -32218,7 +32322,7 @@ interface P21SismClientSpec {
32218
32322
  * @param data ImportUpdateBody (request body)
32219
32323
  * @returns BaseResponse whose `data` is ImportUpdateData
32220
32324
  */
32221
- update: (importUid: string, data: ImportUpdateBody) => Promise<BaseResponse$1<ImportUpdateData>>;
32325
+ update: (importUid: number, data: ImportUpdateBody) => Promise<BaseResponse$1<ImportUpdateData>>;
32222
32326
  /**
32223
32327
  * clean pending_import for an import
32224
32328
  * Call: api.p21Sism.import.delete(importUid)
@@ -32235,7 +32339,7 @@ interface P21SismClientSpec {
32235
32339
  * @param importUid import.import_uid
32236
32340
  * @returns BaseResponse whose `data` is ImportDeleteData
32237
32341
  */
32238
- delete: (importUid: string) => Promise<BaseResponse$1<ImportDeleteData>>;
32342
+ delete: (importUid: number) => Promise<BaseResponse$1<ImportDeleteData>>;
32239
32343
  dailySummary: {
32240
32344
  /**
32241
32345
  * Get daily import counts by state
@@ -32267,7 +32371,7 @@ interface P21SismClientSpec {
32267
32371
  * @param params ImportImpOeHdrListParams (query string)
32268
32372
  * @returns BaseResponse whose `data` is ImportImpOeHdrListData
32269
32373
  */
32270
- list: (importUid: string, params?: ImportImpOeHdrListParams) => Promise<BaseResponse$1<ImportImpOeHdrListData>>;
32374
+ list: (importUid: number, params?: ImportImpOeHdrListParams) => Promise<BaseResponse$1<ImportImpOeHdrListData>>;
32271
32375
  /**
32272
32376
  * Update imp_oe_hdr table
32273
32377
  * Call: api.p21Sism.import.impOeHdr.update(importUid, data)
@@ -32286,7 +32390,7 @@ interface P21SismClientSpec {
32286
32390
  * @param data ImportImpOeHdrUpdateBody (request body)
32287
32391
  * @returns BaseResponse whose `data` is ImportImpOeHdrUpdateData
32288
32392
  */
32289
- update: (importUid: string, data: ImportImpOeHdrUpdateBody) => Promise<BaseResponse$1<ImportImpOeHdrUpdateData>>;
32393
+ update: (importUid: number, data: ImportImpOeHdrUpdateBody) => Promise<BaseResponse$1<ImportImpOeHdrUpdateData>>;
32290
32394
  };
32291
32395
  impOeHdrSalesrep: {
32292
32396
  /**
@@ -32304,7 +32408,7 @@ interface P21SismClientSpec {
32304
32408
  * @param params ImportImpOeHdrSalesrepListParams (query string)
32305
32409
  * @returns BaseResponse whose `data` is ImportImpOeHdrSalesrepListData
32306
32410
  */
32307
- list: (importUid: string, params?: ImportImpOeHdrSalesrepListParams) => Promise<BaseResponse$1<ImportImpOeHdrSalesrepListData>>;
32411
+ list: (importUid: number, params?: ImportImpOeHdrSalesrepListParams) => Promise<BaseResponse$1<ImportImpOeHdrSalesrepListData>>;
32308
32412
  /**
32309
32413
  * Update imp_oe_hdr_salesrep table
32310
32414
  * Call: api.p21Sism.import.impOeHdrSalesrep.update(importUid, data)
@@ -32323,7 +32427,7 @@ interface P21SismClientSpec {
32323
32427
  * @param data ImportImpOeHdrSalesrepUpdateBody (request body)
32324
32428
  * @returns BaseResponse whose `data` is ImportImpOeHdrSalesrepUpdateData
32325
32429
  */
32326
- update: (importUid: string, data: ImportImpOeHdrSalesrepUpdateBody) => Promise<BaseResponse$1<ImportImpOeHdrSalesrepUpdateData>>;
32430
+ update: (importUid: number, data: ImportImpOeHdrSalesrepUpdateBody) => Promise<BaseResponse$1<ImportImpOeHdrSalesrepUpdateData>>;
32327
32431
  };
32328
32432
  impOeHdrWeb: {
32329
32433
  /**
@@ -32341,7 +32445,7 @@ interface P21SismClientSpec {
32341
32445
  * @param params ImportImpOeHdrWebListParams (query string)
32342
32446
  * @returns BaseResponse whose `data` is ImportImpOeHdrWebListData
32343
32447
  */
32344
- list: (importUid: string, params?: ImportImpOeHdrWebListParams) => Promise<BaseResponse$1<ImportImpOeHdrWebListData>>;
32448
+ list: (importUid: number, params?: ImportImpOeHdrWebListParams) => Promise<BaseResponse$1<ImportImpOeHdrWebListData>>;
32345
32449
  };
32346
32450
  recent: {
32347
32451
  /**
@@ -32414,7 +32518,7 @@ interface P21SismClientSpec {
32414
32518
  * @param params ScheduledImportMasterGetParams (query string)
32415
32519
  * @returns BaseResponse whose `data` is ScheduledImportMasterGetData
32416
32520
  */
32417
- get: (scheduledImportMasterUid: string, params?: ScheduledImportMasterGetParams) => Promise<BaseResponse$1<ScheduledImportMasterGetData>>;
32521
+ get: (scheduledImportMasterUid: number, params?: ScheduledImportMasterGetParams) => Promise<BaseResponse$1<ScheduledImportMasterGetData>>;
32418
32522
  metadata: {
32419
32523
  /**
32420
32524
  * Set the delivery method of a scheduled import master
@@ -32442,7 +32546,7 @@ interface P21SismClientSpec {
32442
32546
  * @param data ScheduledImportMasterMetadataCreateBody (request body)
32443
32547
  * @returns BaseResponse whose `data` is ScheduledImportMasterMetadataCreateData
32444
32548
  */
32445
- create: (scheduledImportMasterUid: string, data: ScheduledImportMasterMetadataCreateBody) => Promise<BaseResponse$1<ScheduledImportMasterMetadataCreateData>>;
32549
+ create: (scheduledImportMasterUid: number, data: ScheduledImportMasterMetadataCreateBody) => Promise<BaseResponse$1<ScheduledImportMasterMetadataCreateData>>;
32446
32550
  sftp: {
32447
32551
  /**
32448
32552
  * Create SFTP metadata for a scheduled import master
@@ -32466,7 +32570,7 @@ interface P21SismClientSpec {
32466
32570
  * @param data ScheduledImportMasterMetadataSftpCreateBody (request body)
32467
32571
  * @returns BaseResponse whose `data` is ScheduledImportMasterMetadataSftpCreateData
32468
32572
  */
32469
- create: (scheduledImportMasterUid: string, data: ScheduledImportMasterMetadataSftpCreateBody) => Promise<BaseResponse$1<ScheduledImportMasterMetadataSftpCreateData>>;
32573
+ create: (scheduledImportMasterUid: number, data: ScheduledImportMasterMetadataSftpCreateBody) => Promise<BaseResponse$1<ScheduledImportMasterMetadataSftpCreateData>>;
32470
32574
  };
32471
32575
  };
32472
32576
  };
@@ -32505,7 +32609,7 @@ interface P21SismClientSpec {
32505
32609
  * @param params ScheduledImportMetadataGetParams (query string)
32506
32610
  * @returns BaseResponse whose `data` is ScheduledImportMetadataGetData
32507
32611
  */
32508
- get: (scheduledImportMetadataUid: string, params?: ScheduledImportMetadataGetParams) => Promise<BaseResponse$1<ScheduledImportMetadataGetData>>;
32612
+ get: (scheduledImportMetadataUid: number, params?: ScheduledImportMetadataGetParams) => Promise<BaseResponse$1<ScheduledImportMetadataGetData>>;
32509
32613
  /**
32510
32614
  * Change a scheduled import metadata record
32511
32615
  * Call: api.p21Sism.scheduledImportMetadata.update(scheduledImportMetadataUid, data)
@@ -32529,7 +32633,7 @@ interface P21SismClientSpec {
32529
32633
  * @param data ScheduledImportMetadataUpdateBody (request body)
32530
32634
  * @returns BaseResponse whose `data` is ScheduledImportMetadataUpdateData
32531
32635
  */
32532
- update: (scheduledImportMetadataUid: string, data: ScheduledImportMetadataUpdateBody) => Promise<BaseResponse$1<ScheduledImportMetadataUpdateData>>;
32636
+ update: (scheduledImportMetadataUid: number, data: ScheduledImportMetadataUpdateBody) => Promise<BaseResponse$1<ScheduledImportMetadataUpdateData>>;
32533
32637
  /**
32534
32638
  * Soft delete a scheduled import metadata record
32535
32639
  * Call: api.p21Sism.scheduledImportMetadata.delete(scheduledImportMetadataUid)
@@ -32546,7 +32650,7 @@ interface P21SismClientSpec {
32546
32650
  * @param scheduledImportMetadataUid Scheduled import metadata record to soft delete
32547
32651
  * @returns BaseResponse whose `data` is ScheduledImportMetadataDeleteData
32548
32652
  */
32549
- delete: (scheduledImportMetadataUid: string) => Promise<BaseResponse$1<ScheduledImportMetadataDeleteData>>;
32653
+ delete: (scheduledImportMetadataUid: number) => Promise<BaseResponse$1<ScheduledImportMetadataDeleteData>>;
32550
32654
  };
32551
32655
  }
32552
32656
 
@@ -33555,7 +33659,7 @@ type TodosSessionsGetParams = EdgeCacheParams;
33555
33659
  interface CommentsListItem {
33556
33660
  /** Basecamp comment ID */
33557
33661
  id: number;
33558
- /** Comment HTML, or efs:{hash} when the body is stored in EFS (max 65535 chars) */
33662
+ /** Comment HTML, or efs:{hash} when the body is stored in EFS */
33559
33663
  content: string;
33560
33664
  /** When the record was last updated in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
33561
33665
  updatedAt: string;
@@ -33571,7 +33675,7 @@ interface CommentsListItem {
33571
33675
  processCd: number;
33572
33676
  /** To-do the comment belongs to */
33573
33677
  todosId: number | null;
33574
- /** The 1536 dimensional vector that represents the comment (max 65535 chars) */
33678
+ /** The 1536 dimensional vector that represents the comment */
33575
33679
  vector: string | null;
33576
33680
  /** Embedding queue code (704 = queued, 1185 = done) */
33577
33681
  vectorCd: number;
@@ -33653,7 +33757,7 @@ interface MetricsListItem {
33653
33757
  assigneeId: number | null;
33654
33758
  /** FK to people.id (creator) */
33655
33759
  creatorId: number;
33656
- /** Todos title/content (max 65535 chars) */
33760
+ /** Todos title/content */
33657
33761
  todosContent: string | null;
33658
33762
  /** Status (1=open, 2=completed) */
33659
33763
  todosStatusCd: number;
@@ -33985,7 +34089,7 @@ interface TodosListItem {
33985
34089
  position: number;
33986
34090
  /** Project the to-do belongs to */
33987
34091
  projectsId: number;
33988
- /** Full Basecamp to-do detail as JSON (max 4294967295 chars) */
34092
+ /** Full Basecamp to-do detail as JSON */
33989
34093
  detailJson: string | null;
33990
34094
  /** Detail fetch queue code (704 = queued, 1185 = fetched) */
33991
34095
  pullDetailCd: number;
@@ -33997,7 +34101,7 @@ interface TodosListItem {
33997
34101
  statusCd: number;
33998
34102
  /** When the latest comment was posted (mysql-datetime, e.g. 2025-07-30 15:50:49) */
33999
34103
  lastCommentAt: string;
34000
- /** The 1536 dimensional vector that represents the comment (max 65535 chars) */
34104
+ /** The 1536 dimensional vector that represents the comment */
34001
34105
  vector: string | null;
34002
34106
  /** Comments embedding queue code (704 = queued, 1185 = done) */
34003
34107
  vectorCd: number;
@@ -34019,11 +34123,11 @@ type TodosListData = TodosListItem[];
34019
34123
  interface TodosSummaryListItem {
34020
34124
  /** Primary key - same value as todos.id, enforced in code */
34021
34125
  id: number;
34022
- /** AI-generated summary of ticket and comments (max 65535 chars) */
34126
+ /** AI-generated summary of ticket and comments */
34023
34127
  summary: string | null;
34024
34128
  /** Token estimate for summary size */
34025
34129
  summaryTokens: number;
34026
- /** Full context blob in YAML format for knowledge base (max 4294967295 chars) */
34130
+ /** Full context blob in YAML format for knowledge base */
34027
34131
  context: string | null;
34028
34132
  /** Token estimate for context size */
34029
34133
  contextTokens: number;
@@ -34126,13 +34230,13 @@ interface TodosSessionsListItem {
34126
34230
  sessionStatusCd: number;
34127
34231
  /** Session subject/title (max 255 chars) */
34128
34232
  subject: string | null;
34129
- /** Problem statement (max 65535 chars) */
34233
+ /** Problem statement */
34130
34234
  problem: string | null;
34131
- /** Investigation notes (max 65535 chars) */
34235
+ /** Investigation notes */
34132
34236
  investigation: string | null;
34133
- /** Execution plan (max 65535 chars) */
34237
+ /** Execution plan */
34134
34238
  plan: string | null;
34135
- /** Session outcome/result (max 65535 chars) */
34239
+ /** Session outcome/result */
34136
34240
  outcome: string | null;
34137
34241
  /** Record creation timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
34138
34242
  dateCreated: string;