@simpleapps-com/augur-api 2026.10.7 → 2026.10.9

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.
@@ -250,6 +250,16 @@ type BaseResponse$1<T> = {
250
250
  total: number;
251
251
  totalResults: number;
252
252
  };
253
+ /**
254
+ * The documented fields of a response type, without its `[key: string]: unknown` pass-through.
255
+ *
256
+ * Response types are the MINIMUM shape, so a misspelled field still compiles as `unknown`.
257
+ * Read rows through `Known<T>` to make any undocumented name a compile error, destructuring
258
+ * included: `const row: Known<ItemsTypes.InvMastInvSubListItem> = sub;`
259
+ */
260
+ type Known<T> = {
261
+ [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K];
262
+ };
253
263
  type HealthCheckData = v.InferOutput<typeof HealthCheckDataSchema>;
254
264
  type PingData = v.InferOutput<typeof PingDataSchema>;
255
265
  type WhoamiData = v.InferOutput<typeof WhoamiDataSchema>;
@@ -1165,7 +1175,7 @@ interface UsersListItemShipToItem {
1165
1175
  /** Shipping route description */
1166
1176
  routeDescription: string | null;
1167
1177
  /** The ship-to's address; null when no address row matches */
1168
- address: UsersListItemShipToItemAddress;
1178
+ address: UsersListItemShipToItemAddress | null;
1169
1179
  [key: string]: unknown;
1170
1180
  }
1171
1181
  /**
@@ -1192,7 +1202,7 @@ interface UsersListItem$1 {
1192
1202
  username: string;
1193
1203
  /** 1 when the user is blocked */
1194
1204
  block: number;
1195
- /** Profile values keyed by profile key; [] when the user has none */
1205
+ /** Profile values keyed by profile key; {} when the user has none */
1196
1206
  profileValues: Record<string, string>;
1197
1207
  /** Prophet 21 customer ID from the profile; empty when unset */
1198
1208
  customerId: string;
@@ -1264,8 +1274,8 @@ interface UsersVerifyPasswordCreateData {
1264
1274
  isVerified: boolean;
1265
1275
  /** Username sent */
1266
1276
  username: string;
1267
- /** User JWT; false when the password did not match */
1268
- token: string | boolean;
1277
+ /** User JWT; null when the password did not match */
1278
+ token: string | null;
1269
1279
  /** Email address; empty when the password did not match */
1270
1280
  email: string;
1271
1281
  /** True when the user's profile has a Prophet 21 customer ID */
@@ -1521,14 +1531,14 @@ interface UsersTrinityListDataP21Role {
1521
1531
  interface UsersTrinityListData {
1522
1532
  /** Account fields and profile values */
1523
1533
  profile: UsersTrinityListDataProfile;
1524
- /** Prophet 21 contact role; the key is absent when the user has no contact ID */
1525
- p21Role: UsersTrinityListDataP21Role;
1526
1534
  /** User groups the user belongs to */
1527
1535
  groups: UsersListItemGroupsItem[];
1528
1536
  /** trinitysurfaces, trinitytile, or empty when neither matches */
1529
1537
  territory: string;
1530
1538
  /** A&D, contractor, or empty */
1531
1539
  role: string;
1540
+ /** Prophet 21 contact role; the key is absent when the user has no contact ID */
1541
+ p21Role?: UsersTrinityListDataP21Role | null;
1532
1542
  [key: string]: unknown;
1533
1543
  }
1534
1544
  interface JoomlaClientSpec {
@@ -2673,21 +2683,21 @@ interface CartHdrAlsoBoughtListItem {
2673
2683
  /** Descriptions in other languages */
2674
2684
  languages: CartHdrAlsoBoughtListItemLanguagesItem[];
2675
2685
  /** Brandfolder assets (trinitysurfaces only) */
2676
- brandFolder?: CartHdrAlsoBoughtListItemBrandFolder;
2686
+ brandFolder?: CartHdrAlsoBoughtListItemBrandFolder | null;
2677
2687
  /** Category trees for the item's non-root categories (trinitysurfaces only) */
2678
2688
  docCatTrees?: Array<number[]> | null;
2679
2689
  /** Product collection of the item's category under root 3 (trinitysurfaces only) */
2680
2690
  productCollection?: string | null;
2681
2691
  /** Leaf category under root 3, or false (trinitysurfaces only) */
2682
- tsItemCategoryUid?: number | boolean | null;
2692
+ tsItemCategoryUid?: number | null | false;
2683
2693
  /** Leaf category under root 5, or false (trinitysurfaces only) */
2684
- ttItemCategoryUid?: number | boolean | null;
2694
+ ttItemCategoryUid?: number | null | false;
2685
2695
  /** True when the trim user-defined field is Y (trinitysurfaces only) */
2686
2696
  trim?: boolean | null;
2687
2697
  /** Full-sized sample item, or false (trinitysurfaces only) */
2688
- fullSizedSamples?: CartHdrAlsoBoughtListItemFullSizedSamplesOption1 | boolean | null;
2698
+ fullSizedSamples?: CartHdrAlsoBoughtListItemFullSizedSamplesOption1 | null | false;
2689
2699
  /** Swatch sample item, or false (trinitysurfaces only) */
2690
- swatchSample?: CartHdrAlsoBoughtListItemFullSizedSamplesOption1 | boolean | null;
2700
+ swatchSample?: CartHdrAlsoBoughtListItemFullSizedSamplesOption1 | null | false;
2691
2701
  /** Variant group the item belongs to */
2692
2702
  itemVariantHdrUid?: number | null;
2693
2703
  /** List price 1 (only with includePricing=Y) */
@@ -2873,7 +2883,7 @@ interface CheckoutCreateBody {
2873
2883
  /** Alias of oeLine */
2874
2884
  lines?: Array<Record<string, unknown>> | null;
2875
2885
  /** Order-level note */
2876
- notes?: CheckoutCreateBodyNotes;
2886
+ notes?: CheckoutCreateBodyNotes | null;
2877
2887
  /** Order notepad entries, passed through to the import as sent */
2878
2888
  oeHdrNotepad?: unknown;
2879
2889
  /** Alias of oeHdrNotepad */
@@ -3416,8 +3426,11 @@ interface WebPricingListParams extends EdgeCacheParams {
3416
3426
  offset?: number;
3417
3427
  /** Order By (Default: web_pricing_uid|ASC) */
3418
3428
  orderBy?: string;
3419
- /** Status Code (status_cd) [(704)|(705)|(700)] */
3420
- statusCd?: number;
3429
+ /**
3430
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
3431
+ * (704,705); -1 for every status. Default: 704
3432
+ */
3433
+ statusCd?: number | number[];
3421
3434
  }
3422
3435
  /** Params for GET /web-pricing/{webPricingUid} */
3423
3436
  type WebPricingGetParams = EdgeCacheParams;
@@ -3429,8 +3442,11 @@ interface WebPricingCustomersListParams extends EdgeCacheParams {
3429
3442
  offset?: number;
3430
3443
  /** Order By (Default: web_pricing_x_customer_uid|ASC) */
3431
3444
  orderBy?: string;
3432
- /** Status Code (status_cd) [(704)|(705)|(700)] */
3433
- statusCd?: number;
3445
+ /**
3446
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
3447
+ * (704,705); -1 for every status. Default: 704
3448
+ */
3449
+ statusCd?: number | number[];
3434
3450
  }
3435
3451
  /** Params for GET /web-pricing/{webPricingUid}/customers/{customerId} */
3436
3452
  type WebPricingCustomersGetParams = EdgeCacheParams;
@@ -3663,7 +3679,7 @@ interface PriceEngineListDataCustomer {
3663
3679
  /** True when the customer was found */
3664
3680
  valid: boolean;
3665
3681
  /** Customer's source price code, or false when none is set */
3666
- sourcePriceCd: number | boolean;
3682
+ sourcePriceCd: number | false;
3667
3683
  /** Description of the source price code */
3668
3684
  sourcePriceDesc: string | null;
3669
3685
  /** Customer's pricing method code (211 Multiplier, 234 Libraries) */
@@ -3703,7 +3719,7 @@ interface PriceEngineListDataItem {
3703
3719
  }
3704
3720
  /**
3705
3721
  * Shape of `breaks` (MINIMUM fields; reused wherever the same shape appears)
3706
- * Quantity break tiers of the matched page
3722
+ * Quantity break tiers of the matched page, lowest quantity first
3707
3723
  *
3708
3724
  * Field `breaks` of PriceEngineListDataLibraryPriceDataOption1
3709
3725
  */
@@ -3717,7 +3733,7 @@ interface PriceEngineListDataLibraryPriceDataOption1BreaksItem {
3717
3733
  /** Last quantity this tier applies to, or null when open-ended */
3718
3734
  endQuantity: number | null;
3719
3735
  /** Unit price at this tier, or false when it could not be calculated */
3720
- unitPrice: number | boolean;
3736
+ unitPrice: number | false;
3721
3737
  [key: string]: unknown;
3722
3738
  }
3723
3739
  /**
@@ -3728,9 +3744,9 @@ interface PriceEngineListDataLibraryPriceDataOption1BreaksItem {
3728
3744
  */
3729
3745
  interface PriceEngineListDataLibraryPriceDataOption1 {
3730
3746
  /** Unit price in the requested unit of measure, or false when no page produced a price */
3731
- unitPrice: number | boolean;
3747
+ unitPrice: number | false;
3732
3748
  /** Source price the page calculation started from */
3733
- sourcePrice: number | boolean | null;
3749
+ sourcePrice: number | null | false;
3734
3750
  /** Quantity used to select the break tier */
3735
3751
  quantity: number;
3736
3752
  /** Price page UID that matched */
@@ -3793,40 +3809,40 @@ interface PriceEngineListDataLibraryPriceDataOption1 {
3793
3809
  baseUnitSize: number | null;
3794
3810
  /** Calculation value applied for the quantity (multiplier or markup percent) */
3795
3811
  multiplier: number;
3796
- /** Quantity break tiers of the matched page */
3812
+ /** Quantity break tiers of the matched page, lowest quantity first */
3797
3813
  breaks: PriceEngineListDataLibraryPriceDataOption1BreaksItem[];
3798
3814
  /** Base size the source price is divided by, set when the calculation runs */
3799
- baseSize?: number | null;
3815
+ baseSize: number | null;
3800
3816
  /** Price per base unit, set when the calculation runs */
3801
- basePrice?: number | null;
3817
+ basePrice: number | null;
3802
3818
  /** Candidate cost value on the cost path, committed as source price only after a page match */
3803
- potentialCostValue?: number | null;
3819
+ potentialCostValue: number | null;
3804
3820
  /** Cost page UID used on the cost path */
3805
- costPageUid?: number | null;
3821
+ costPageUid: number | null;
3806
3822
  /** Description of the cost page */
3807
- costPageDescription?: string | null;
3823
+ costPageDescription: string | null;
3808
3824
  /** True when a cost page matched on the cost path */
3809
- costPageMatched?: boolean | null;
3825
+ costPageMatched: boolean | null;
3810
3826
  /** Where the cost came from when a fallback was used */
3811
- costSource?: string | null;
3827
+ costSource: string | null;
3812
3828
  /** Supplier ID whose last received PO cost was used (source code 204) */
3813
- lastReceivedPoCostSupplierId?: number | null;
3829
+ lastReceivedPoCostSupplierId: number | null;
3814
3830
  /** Item's product group at the pricing location */
3815
- invLocProductGroupId?: string | null;
3831
+ invLocProductGroupId: string | null;
3816
3832
  /** Product group on the matched page */
3817
- pricePageProductGroupId?: string | null;
3833
+ pricePageProductGroupId: string | null;
3818
3834
  /** Supplier ID on the matched page */
3819
- pricePageSupplierId?: number | null;
3835
+ pricePageSupplierId: number | null;
3820
3836
  /** Discount group on the matched page */
3821
- pricePageDiscountGroupId?: string | null;
3837
+ pricePageDiscountGroupId: string | null;
3822
3838
  /** Manufacturer class on the matched page */
3823
- pricePageMfgClassId?: string | null;
3839
+ pricePageMfgClassId: string | null;
3824
3840
  /** Price family UID on the matched page */
3825
- pricePagePriceFamilyUid?: number | null;
3841
+ pricePagePriceFamilyUid: number | null;
3826
3842
  /** Item's sales discount group at the pricing location */
3827
- invLocSalesDiscountGroup?: string | null;
3843
+ invLocSalesDiscountGroup: string | null;
3828
3844
  /** Item's price family UID at the pricing location */
3829
- invLocPriceFamilyUid?: number | null;
3845
+ invLocPriceFamilyUid: number | null;
3830
3846
  [key: string]: unknown;
3831
3847
  }
3832
3848
  /**
@@ -3837,19 +3853,19 @@ interface PriceEngineListDataLibraryPriceDataOption1 {
3837
3853
  */
3838
3854
  interface PriceEngineListDataLibraryPriceDataOption2 {
3839
3855
  /** Unit price, or false when the library produced no price */
3840
- unitPrice: number | boolean;
3856
+ unitPrice: number | false;
3841
3857
  /** Pricing source label, libraryMultiplier when a price was found */
3842
- pricedFrom?: string | null;
3858
+ pricedFrom: string | null;
3843
3859
  /** Source price the multiplier was applied to */
3844
- sourcePrice?: number | null;
3860
+ sourcePrice: number | null;
3845
3861
  /** Source price code the source price came from */
3846
- sourcePriceCd?: number | null;
3862
+ sourcePriceCd: number | null;
3847
3863
  /** Library multiplier applied to the source price */
3848
- multiplier?: number | null;
3864
+ multiplier: number | null;
3849
3865
  /** Price library UID that produced the price */
3850
- priceLibraryUid?: number | null;
3866
+ priceLibraryUid: number | null;
3851
3867
  /** Unit of measure size applied to the base price */
3852
- unitOfMeasureSize?: number | null;
3868
+ unitOfMeasureSize: number | null;
3853
3869
  [key: string]: unknown;
3854
3870
  }
3855
3871
  /**
@@ -3860,7 +3876,7 @@ interface PriceEngineListDataLibraryPriceDataOption2 {
3860
3876
  */
3861
3877
  interface PriceEngineListDataDefaultCompanyPrice {
3862
3878
  /** Unit price in the requested unit of measure, or false when none was found */
3863
- unitPrice: number | boolean;
3879
+ unitPrice: number | false;
3864
3880
  /** Item's purchase pricing unit size from inv_mast */
3865
3881
  purchasePricingUnitSize: number | null;
3866
3882
  /** Company price source code (PRICE_1 to PRICE_10 or supplier list price), 0 when none */
@@ -3892,7 +3908,7 @@ interface PriceEngineListData {
3892
3908
  /** Short code of the winning stage (J, S, L, C), or false when none did */
3893
3909
  priceType: 'J' | 'S' | 'L' | 'C' | false;
3894
3910
  /** Job or contract price when job pricing matched, otherwise false */
3895
- jobPrice: number | boolean;
3911
+ jobPrice: number | false;
3896
3912
  /** Primary supplier list price, always calculated for reference */
3897
3913
  listPrice: number;
3898
3914
  /** Customer pricing setup used by the engine */
@@ -3907,17 +3923,17 @@ interface PriceEngineListData {
3907
3923
  /** Diagnostic messages collected while pricing */
3908
3924
  messages: string[];
3909
3925
  /** Job number when job pricing matched */
3910
- jobNo?: string | null;
3926
+ jobNo: string | null;
3911
3927
  /** Job price header UID when job pricing matched */
3912
- jobPriceHdrUid?: number | null;
3928
+ jobPriceHdrUid: number | null;
3913
3929
  /** Contract number when job pricing matched */
3914
- contractNo?: string | null;
3930
+ contractNo: string | null;
3915
3931
  /** Library pricing detail whenever the library stage ran, including when it found no price */
3916
- libraryPriceData?: PriceEngineListDataLibraryPriceDataOption1 | PriceEngineListDataLibraryPriceDataOption2 | null;
3932
+ libraryPriceData: PriceEngineListDataLibraryPriceDataOption1 | PriceEngineListDataLibraryPriceDataOption2 | null;
3917
3933
  /** Default company pricing detail when that stage ran */
3918
- defaultCompanyPrice?: PriceEngineListDataDefaultCompanyPrice;
3934
+ defaultCompanyPrice: PriceEngineListDataDefaultCompanyPrice | null;
3919
3935
  /** Web discount price for the customer, or false when no web pricing rule applies */
3920
- webPrice?: number | boolean;
3936
+ webPrice: number | false;
3921
3937
  [key: string]: unknown;
3922
3938
  }
3923
3939
  /**
@@ -4003,7 +4019,7 @@ interface TaxEngineCreateDataItemsItem {
4003
4019
  /** Unit of measure the unit price is expressed in */
4004
4020
  unitOfMeasure: string | null;
4005
4021
  /** Unit price taxed, from the request or the price engine */
4006
- unitPrice: number | boolean;
4022
+ unitPrice: number | false;
4007
4023
  /** Estimated tax for this item (quantity x unit price x tax rate) */
4008
4024
  taxEstimate: number;
4009
4025
  [key: string]: unknown;
@@ -4019,8 +4035,8 @@ interface TaxEngineCreateData {
4019
4035
  taxEstimate: number;
4020
4036
  /** P21 customer ID the items were priced for */
4021
4037
  customerId: number;
4022
- /** Postal code the tax rate was looked up for */
4023
- postalCode: string | number;
4038
+ /** Postal code the tax rate was looked up for, exactly as sent (leading zeros kept) */
4039
+ postalCode: string;
4024
4040
  /** Tax rate applied, as a fraction (0.089 = 8.9%) */
4025
4041
  taxRate: number;
4026
4042
  /** Per-item tax estimates */
@@ -4755,8 +4771,11 @@ interface DistributorsListParams extends EdgeCacheParams {
4755
4771
  offset?: number;
4756
4772
  /** Order By (Default: distributors_uid|ASC) */
4757
4773
  orderBy?: string;
4758
- /** Status Code (status_cd) [(704)|705,700] */
4759
- statusCd?: number;
4774
+ /**
4775
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4776
+ * (704,705); -1 for every status. Default: 704
4777
+ */
4778
+ statusCd?: number | number[];
4760
4779
  }
4761
4780
  /** Params for GET /distributors/{distributorsUid} */
4762
4781
  type DistributorsGetParams = EdgeCacheParams;
@@ -4770,6 +4789,11 @@ interface InvProfileHdrListParams extends EdgeCacheParams {
4770
4789
  offset?: number;
4771
4790
  /** Order By (Default: inv_profile_hdr_uid|ASC) */
4772
4791
  orderBy?: string;
4792
+ /**
4793
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4794
+ * (704,705); -1 for every status. Default: every status
4795
+ */
4796
+ statusCd?: number | number[];
4773
4797
  }
4774
4798
  /** Params for GET /inv-profile-hdr/{invProfileHdrUid} */
4775
4799
  type InvProfileHdrGetParams = EdgeCacheParams;
@@ -4783,8 +4807,11 @@ interface InvProfileHdrInvProfileLineListParams extends EdgeCacheParams {
4783
4807
  orderBy?: string;
4784
4808
  /** Search keywords field */
4785
4809
  q?: string;
4786
- /** Filter by status code (700=DELETE, 704=ACTIVE, 705=INACTIVE) */
4787
- statusCd?: number;
4810
+ /**
4811
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4812
+ * (704,705); -1 for every status. Default: 704 and 705 (deleted lines excluded)
4813
+ */
4814
+ statusCd?: number | number[];
4788
4815
  }
4789
4816
  /** Params for GET /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid} */
4790
4817
  type InvProfileHdrInvProfileLineGetParams = EdgeCacheParams;
@@ -4804,8 +4831,11 @@ interface ProductsListParams extends EdgeCacheParams {
4804
4831
  prefix?: string;
4805
4832
  /** Query String */
4806
4833
  q?: string;
4807
- /** Status Code (status_cd) [(704)|(705)|(700)] */
4808
- statusCd?: number;
4834
+ /**
4835
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4836
+ * (704,705); -1 for every status. Default: 704
4837
+ */
4838
+ statusCd?: number | number[];
4809
4839
  }
4810
4840
  /** Params for GET /products/find */
4811
4841
  interface ProductsFindListParams extends EdgeCacheParams {
@@ -4817,6 +4847,11 @@ interface ProductsFindListParams extends EdgeCacheParams {
4817
4847
  offset?: number;
4818
4848
  /** Product Id Prefix */
4819
4849
  prefix?: string;
4850
+ /**
4851
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4852
+ * (704,705); -1 for every status. Default: 704
4853
+ */
4854
+ statusCd?: number | number[];
4820
4855
  }
4821
4856
  /** Params for GET /products/{productsUid} */
4822
4857
  type ProductsGetParams = EdgeCacheParams;
@@ -4830,6 +4865,11 @@ interface RestockHdrListParams extends EdgeCacheParams {
4830
4865
  offset?: number;
4831
4866
  /** Order By (Default: restock_hdr_uid|ASC) */
4832
4867
  orderBy?: string;
4868
+ /**
4869
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4870
+ * (704,705); -1 for every status. Default: every status
4871
+ */
4872
+ statusCd?: number | number[];
4833
4873
  /** Filter by Warehouse UID */
4834
4874
  warehouseUid?: number;
4835
4875
  }
@@ -4845,8 +4885,11 @@ interface SectionsListParams extends EdgeCacheParams {
4845
4885
  offset?: number;
4846
4886
  /** Order By (Default: sections_uid|ASC) */
4847
4887
  orderBy?: string;
4848
- /** Status Code (status_cd) [(704)|705|700] */
4849
- statusCd?: number;
4888
+ /**
4889
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4890
+ * (704,705); -1 for every status. Default: 704
4891
+ */
4892
+ statusCd?: number | number[];
4850
4893
  }
4851
4894
  /** Params for GET /sections/{sectionsUid} */
4852
4895
  type SectionsGetParams = EdgeCacheParams;
@@ -4862,8 +4905,11 @@ interface WarehouseListParams extends EdgeCacheParams {
4862
4905
  orderBy?: string;
4863
4906
  /** Search Query */
4864
4907
  q?: string;
4865
- /** Status Code (status_cd) [(704)|(705)|(700)] */
4866
- statusCd?: number;
4908
+ /**
4909
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4910
+ * (704,705); -1 for every status. Default: 704
4911
+ */
4912
+ statusCd?: number | number[];
4867
4913
  /** joomla.users.id; lists only the warehouses this user is assigned to */
4868
4914
  usersId?: number;
4869
4915
  }
@@ -4887,7 +4933,14 @@ interface WarehouseUsersListParams extends EdgeCacheParams {
4887
4933
  offset?: number;
4888
4934
  /** Order By (Default: warehouse_x_users_uid|ASC) */
4889
4935
  orderBy?: string;
4890
- /** CSV of status_cd to filter on [700|704|705] */
4936
+ /**
4937
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4938
+ * (704,705); -1 for every status. Default: every status
4939
+ */
4940
+ statusCd?: number | number[];
4941
+ /**
4942
+ * Deprecated: use statusCd. CSV of status codes [700|704|705], read only when statusCd is absent
4943
+ */
4891
4944
  statusCdList?: string;
4892
4945
  }
4893
4946
  /** Params for POST /warehouse/{warehouseUid}/users */
@@ -6164,7 +6217,7 @@ interface WarehouseUsageCreateDataUsageItemsItem {
6164
6217
  /** Usage line ID */
6165
6218
  usageLineUid: number;
6166
6219
  /** Warranty claim; the key is absent when none was sent */
6167
- warranty?: WarehouseUsageCreateDataUsageItemsItemWarranty;
6220
+ warranty?: WarehouseUsageCreateDataUsageItemsItemWarranty | null;
6168
6221
  [key: string]: unknown;
6169
6222
  }
6170
6223
  /**
@@ -6219,7 +6272,7 @@ interface WarehouseUsageCreateBodyUsageItemsItem {
6219
6272
  /** Item source: products or prophet21; defaults to prophet21 */
6220
6273
  invProfileLineType?: string | null;
6221
6274
  /** Warranty claim for the item */
6222
- warranty?: WarehouseUsageCreateBodyUsageItemsItemWarranty;
6275
+ warranty?: WarehouseUsageCreateBodyUsageItemsItemWarranty | null;
6223
6276
  [key: string]: unknown;
6224
6277
  }
6225
6278
  /**
@@ -6390,6 +6443,10 @@ interface VMIClientSpec {
6390
6443
  * Get distributor Details
6391
6444
  * Call: api.vmi.distributors.get(distributorsUid)
6392
6445
  *
6446
+ * Errors:
6447
+ * 400: distributorsUid is below 1.
6448
+ * 404: No distributor with this distributorsUid.
6449
+ *
6393
6450
  * GET https://vmi.augur-api.com/distributors/{distributorsUid}
6394
6451
  * Contract: https://vmi.augur-api.com/openapi.json#/paths/~1distributors~1{distributorsUid}/get
6395
6452
  *
@@ -6421,6 +6478,7 @@ interface VMIClientSpec {
6421
6478
  * Call: api.vmi.distributors.delete(distributorsUid)
6422
6479
  *
6423
6480
  * Errors:
6481
+ * 400: distributorsUid is below 1.
6424
6482
  * 404: No row exists with this ID.
6425
6483
  *
6426
6484
  * DELETE https://vmi.augur-api.com/distributors/{distributorsUid}
@@ -6440,6 +6498,7 @@ interface VMIClientSpec {
6440
6498
  * Response data: Outcome of an enable, disable, or delete request
6441
6499
  *
6442
6500
  * Errors:
6501
+ * 400: distributorsUid is below 1.
6443
6502
  * 404: No row exists with this ID.
6444
6503
  *
6445
6504
  * PUT https://vmi.augur-api.com/distributors/{distributorsUid}/enable
@@ -6462,6 +6521,7 @@ interface VMIClientSpec {
6462
6521
  *
6463
6522
  * Errors:
6464
6523
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
6524
+ * 404: No distributor with this distributorsUid.
6465
6525
  *
6466
6526
  * POST https://vmi.augur-api.com/distributors/{distributorsUid}/products
6467
6527
  * Contract:
@@ -6514,6 +6574,10 @@ interface VMIClientSpec {
6514
6574
  *
6515
6575
  * Response data: An inventory profile with the active warehouses that stock it
6516
6576
  *
6577
+ * Errors:
6578
+ * 400: invProfileHdrUid is below 1.
6579
+ * 404: No inventory profile with this invProfileHdrUid.
6580
+ *
6517
6581
  * GET https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}
6518
6582
  * Contract:
6519
6583
  * https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{invProfileHdrUid}/get
@@ -6547,6 +6611,7 @@ interface VMIClientSpec {
6547
6611
  * Call: api.vmi.invProfileHdr.delete(invProfileHdrUid)
6548
6612
  *
6549
6613
  * Errors:
6614
+ * 400: invProfileHdrUid is below 1.
6550
6615
  * 404: No row exists with this ID.
6551
6616
  *
6552
6617
  * DELETE https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}
@@ -6564,6 +6629,7 @@ interface VMIClientSpec {
6564
6629
  *
6565
6630
  * Errors:
6566
6631
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
6632
+ * 404: No inventory profile with this invProfileHdrUid.
6567
6633
  *
6568
6634
  * GET https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line
6569
6635
  * Contract:
@@ -6583,6 +6649,7 @@ interface VMIClientSpec {
6583
6649
  *
6584
6650
  * Errors:
6585
6651
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
6652
+ * 404: No inventory profile with this invProfileHdrUid.
6586
6653
  *
6587
6654
  * POST https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line
6588
6655
  * Contract:
@@ -6597,6 +6664,11 @@ interface VMIClientSpec {
6597
6664
  * Get Inventory Profile line Details
6598
6665
  * Call: api.vmi.invProfileHdr.invProfileLine.get(invProfileHdrUid, invProfileLineUid)
6599
6666
  *
6667
+ * Errors:
6668
+ * 400: invProfileHdrUid or invProfileLineUid is below 1.
6669
+ * 404: No inventory profile with this invProfileHdrUid, or no line with this
6670
+ * invProfileLineUid on that profile.
6671
+ *
6600
6672
  * GET
6601
6673
  * https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid}
6602
6674
  * Contract:
@@ -6640,6 +6712,7 @@ interface VMIClientSpec {
6640
6712
  * DELETE Inventory Profile Line
6641
6713
  *
6642
6714
  * Errors:
6715
+ * 400: invProfileHdrUid or invProfileLineUid is below 1.
6643
6716
  * 404: No row exists with this ID.
6644
6717
  *
6645
6718
  * DELETE
@@ -6665,6 +6738,7 @@ interface VMIClientSpec {
6665
6738
  *
6666
6739
  * Errors:
6667
6740
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
6741
+ * 404: No customer with this customerId.
6668
6742
  *
6669
6743
  * POST https://vmi.augur-api.com/inv-profile-hdr/{customerId}/upload
6670
6744
  * Contract:
@@ -6698,6 +6772,10 @@ interface VMIClientSpec {
6698
6772
  * Get Product Details
6699
6773
  * Call: api.vmi.products.get(productsUid)
6700
6774
  *
6775
+ * Errors:
6776
+ * 400: productsUid is below 1.
6777
+ * 404: No product with this productsUid.
6778
+ *
6701
6779
  * GET https://vmi.augur-api.com/products/{productsUid}
6702
6780
  * Contract: https://vmi.augur-api.com/openapi.json#/paths/~1products~1{productsUid}/get
6703
6781
  *
@@ -6729,6 +6807,7 @@ interface VMIClientSpec {
6729
6807
  * Call: api.vmi.products.delete(productsUid)
6730
6808
  *
6731
6809
  * Errors:
6810
+ * 400: productsUid is below 1.
6732
6811
  * 404: No row exists with this ID.
6733
6812
  *
6734
6813
  * DELETE https://vmi.augur-api.com/products/{productsUid}
@@ -6747,6 +6826,7 @@ interface VMIClientSpec {
6747
6826
  * Response data: Outcome of an enable, disable, or delete request
6748
6827
  *
6749
6828
  * Errors:
6829
+ * 400: productsUid is below 1.
6750
6830
  * 404: No row exists with this ID.
6751
6831
  *
6752
6832
  * PUT https://vmi.augur-api.com/products/{productsUid}/enable
@@ -6814,6 +6894,10 @@ interface VMIClientSpec {
6814
6894
  * Get Restock Header Details
6815
6895
  * Call: api.vmi.restockHdr.get(restockHdrUid)
6816
6896
  *
6897
+ * Errors:
6898
+ * 400: restockHdrUid is below 1.
6899
+ * 404: No restock with this restockHdrUid.
6900
+ *
6817
6901
  * GET https://vmi.augur-api.com/restock-hdr/{restockHdrUid}
6818
6902
  * Contract: https://vmi.augur-api.com/openapi.json#/paths/~1restock-hdr~1{restockHdrUid}/get
6819
6903
  *
@@ -6846,6 +6930,7 @@ interface VMIClientSpec {
6846
6930
  * Call: api.vmi.restockHdr.delete(restockHdrUid)
6847
6931
  *
6848
6932
  * Errors:
6933
+ * 400: restockHdrUid is below 1.
6849
6934
  * 404: No row exists with this ID.
6850
6935
  *
6851
6936
  * DELETE https://vmi.augur-api.com/restock-hdr/{restockHdrUid}
@@ -6892,6 +6977,10 @@ interface VMIClientSpec {
6892
6977
  * Get section Details
6893
6978
  * Call: api.vmi.sections.get(sectionsUid)
6894
6979
  *
6980
+ * Errors:
6981
+ * 400: sectionsUid is below 1.
6982
+ * 404: No section with this sectionsUid.
6983
+ *
6895
6984
  * GET https://vmi.augur-api.com/sections/{sectionsUid}
6896
6985
  * Contract: https://vmi.augur-api.com/openapi.json#/paths/~1sections~1{sectionsUid}/get
6897
6986
  *
@@ -6924,6 +7013,7 @@ interface VMIClientSpec {
6924
7013
  * Call: api.vmi.sections.delete(sectionsUid)
6925
7014
  *
6926
7015
  * Errors:
7016
+ * 400: sectionsUid is below 1.
6927
7017
  * 404: No row exists with this ID.
6928
7018
  *
6929
7019
  * DELETE https://vmi.augur-api.com/sections/{sectionsUid}
@@ -6942,6 +7032,7 @@ interface VMIClientSpec {
6942
7032
  * Response data: Outcome of an enable, disable, or delete request
6943
7033
  *
6944
7034
  * Errors:
7035
+ * 400: sectionsUid is below 1.
6945
7036
  * 404: No row exists with this ID.
6946
7037
  *
6947
7038
  * PUT https://vmi.augur-api.com/sections/{sectionsUid}/enable
@@ -6995,6 +7086,10 @@ interface VMIClientSpec {
6995
7086
  *
6996
7087
  * Response data: A warehouse with its active assigned users
6997
7088
  *
7089
+ * Errors:
7090
+ * 400: warehouseUid is below 1.
7091
+ * 404: No warehouse with this warehouseUid.
7092
+ *
6998
7093
  * GET https://vmi.augur-api.com/warehouse/{warehouseUid}
6999
7094
  * Contract: https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}/get
7000
7095
  *
@@ -7026,6 +7121,7 @@ interface VMIClientSpec {
7026
7121
  * Call: api.vmi.warehouse.delete(warehouseUid)
7027
7122
  *
7028
7123
  * Errors:
7124
+ * 400: warehouseUid is below 1.
7029
7125
  * 404: No row exists with this ID.
7030
7126
  *
7031
7127
  * DELETE https://vmi.augur-api.com/warehouse/{warehouseUid}
@@ -7045,6 +7141,7 @@ interface VMIClientSpec {
7045
7141
  *
7046
7142
  * Errors:
7047
7143
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
7144
+ * 404: No warehouse with this warehouseUid.
7048
7145
  *
7049
7146
  * POST https://vmi.augur-api.com/warehouse/{warehouseUid}/adjust
7050
7147
  * Contract:
@@ -7063,6 +7160,10 @@ interface VMIClientSpec {
7063
7160
  *
7064
7161
  * Response data: On-hand quantities of a warehouse's profile items, grouped by section
7065
7162
  *
7163
+ * Errors:
7164
+ * 400: warehouseUid is below 1.
7165
+ * 404: No warehouse with this warehouseUid.
7166
+ *
7066
7167
  * GET https://vmi.augur-api.com/warehouse/{warehouseUid}/availability
7067
7168
  * Contract:
7068
7169
  * https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1availability/get
@@ -7082,6 +7183,7 @@ interface VMIClientSpec {
7082
7183
  * Response data: Outcome of an enable, disable, or delete request
7083
7184
  *
7084
7185
  * Errors:
7186
+ * 400: warehouseUid is below 1.
7085
7187
  * 404: No row exists with this ID.
7086
7188
  *
7087
7189
  * PUT https://vmi.augur-api.com/warehouse/{warehouseUid}/enable
@@ -7104,6 +7206,7 @@ interface VMIClientSpec {
7104
7206
  *
7105
7207
  * Errors:
7106
7208
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
7209
+ * 404: No warehouse with this warehouseUid.
7107
7210
  *
7108
7211
  * POST https://vmi.augur-api.com/warehouse/{warehouseUid}/receive
7109
7212
  * Contract:
@@ -7123,6 +7226,10 @@ interface VMIClientSpec {
7123
7226
  * Response data: A warehouse's profile items with stock levels, for building a restock
7124
7227
  * request
7125
7228
  *
7229
+ * Errors:
7230
+ * 400: warehouseUid is below 1.
7231
+ * 404: No warehouse with this warehouseUid.
7232
+ *
7126
7233
  * GET https://vmi.augur-api.com/warehouse/{warehouseUid}/replenish
7127
7234
  * Contract:
7128
7235
  * https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1replenish/get
@@ -7143,6 +7250,7 @@ interface VMIClientSpec {
7143
7250
  *
7144
7251
  * Errors:
7145
7252
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
7253
+ * 404: No warehouse with this warehouseUid.
7146
7254
  *
7147
7255
  * POST https://vmi.augur-api.com/warehouse/{warehouseUid}/usage
7148
7256
  * Contract:
@@ -7164,6 +7272,7 @@ interface VMIClientSpec {
7164
7272
  *
7165
7273
  * Errors:
7166
7274
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
7275
+ * 404: No warehouse with this warehouseUid.
7167
7276
  *
7168
7277
  * GET https://vmi.augur-api.com/warehouse/{warehouseUid}/users
7169
7278
  * Contract:
@@ -7185,6 +7294,7 @@ interface VMIClientSpec {
7185
7294
  *
7186
7295
  * Errors:
7187
7296
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
7297
+ * 404: No warehouse with this warehouseUid.
7188
7298
  *
7189
7299
  * POST https://vmi.augur-api.com/warehouse/{warehouseUid}/users
7190
7300
  * Contract:
@@ -7244,6 +7354,7 @@ interface VMIClientSpec {
7244
7354
  * Remove User from Warehouse (sets status_cd to 700)
7245
7355
  *
7246
7356
  * Errors:
7357
+ * 400: warehouseUid or usersId is below 1.
7247
7358
  * 404: No row exists with this ID.
7248
7359
  *
7249
7360
  * DELETE https://vmi.augur-api.com/warehouse/{warehouseUid}/users/{usersId}
@@ -7767,12 +7878,15 @@ interface ItemSearchListDataItemsItem {
7767
7878
  itemDesc: string | null;
7768
7879
  /** OpenSearch relevance score */
7769
7880
  score: number | null;
7770
- /** Index source fields requested through sourceFieldsList, keyed by field name ([] when empty) */
7771
- sourceFields: Record<string, unknown> | [] | null;
7881
+ /**
7882
+ * Index source fields requested through sourceFieldsList, keyed by field name; null when the item
7883
+ * has none
7884
+ */
7885
+ sourceFields: Record<string, unknown> | null;
7772
7886
  /** Relevance score truncated to an integer */
7773
7887
  scoreInt: number;
7774
7888
  /** Brandfolder assets; the key is present only when useBrandFolderDoc=Y */
7775
- brandFolder?: ItemSearchListDataItemsItemBrandFolder;
7889
+ brandFolder?: ItemSearchListDataItemsItemBrandFolder | null;
7776
7890
  [key: string]: unknown;
7777
7891
  }
7778
7892
  /**
@@ -7792,8 +7906,8 @@ interface ItemSearchListData {
7792
7906
  took: number;
7793
7907
  /** query_string row recorded for this search text (0 when not recorded) */
7794
7908
  queryStringUid: number;
7795
- /** Redirect link configured for this search text, or false when none */
7796
- queryStringRedirectLink: string | boolean;
7909
+ /** Redirect link configured for this search text, or null when none */
7910
+ queryStringRedirectLink: string | null;
7797
7911
  [key: string]: unknown;
7798
7912
  }
7799
7913
  /**
@@ -7823,7 +7937,7 @@ interface ItemSearchFacetsListDataItemsItem {
7823
7937
  /** OpenSearch relevance score, or null when the search was sorted */
7824
7938
  score: number | null;
7825
7939
  /** Brandfolder assets; the key is present only when useBrandFolderDoc=Y */
7826
- brandFolder?: ItemSearchListDataItemsItemBrandFolder;
7940
+ brandFolder?: ItemSearchListDataItemsItemBrandFolder | null;
7827
7941
  [key: string]: unknown;
7828
7942
  }
7829
7943
  /**
@@ -10264,7 +10378,7 @@ interface BrandsFacetsListDataItemsItem {
10264
10378
  /** OpenSearch relevance score, or null when the search was sorted */
10265
10379
  score: number | null;
10266
10380
  /** Brandfolder assets; the key is present only when useBrandFolderDoc=Y */
10267
- brandFolder?: BrandsFacetsListDataItemsItemBrandFolder;
10381
+ brandFolder?: BrandsFacetsListDataItemsItemBrandFolder | null;
10268
10382
  [key: string]: unknown;
10269
10383
  }
10270
10384
  /**
@@ -10457,7 +10571,7 @@ interface CategoriesLookupGetDataChildrenOption1ItemRoomSceneOption1 {
10457
10571
  }
10458
10572
  /**
10459
10573
  * Shape of `children` (MINIMUM fields; reused wherever the same shape appears)
10460
- * Active child categories after childrenFilter, childrenLimit and childrenOffset
10574
+ * Active child categories after childrenFilter, childrenLimit and childrenOffset, in display order
10461
10575
  *
10462
10576
  * Field `children` of CategoriesLookupGetData
10463
10577
  */
@@ -10474,8 +10588,8 @@ interface CategoriesLookupGetDataChildrenOption1Item {
10474
10588
  fullPath: string | null;
10475
10589
  /** URL-safe hierarchy path */
10476
10590
  cleanPath: string | null;
10477
- /** Category image path, or false when none */
10478
- categoryImage: string | boolean;
10591
+ /** Category image path, or null when none */
10592
+ categoryImage: string | null;
10479
10593
  /** Display order under the parent */
10480
10594
  sequenceNo: number;
10481
10595
  /** Product collection */
@@ -10483,11 +10597,11 @@ interface CategoriesLookupGetDataChildrenOption1Item {
10483
10597
  /** Online items in the category */
10484
10598
  itemCount: number;
10485
10599
  /** User-defined fields (only with includeUd=Y) */
10486
- userDefined?: Record<string, string>;
10600
+ userDefined?: Record<string, string> | null;
10487
10601
  /**
10488
10602
  * Primary room-scene asset, false when none, null when the lookup failed (trinitysurfaces only)
10489
10603
  */
10490
- roomScene?: CategoriesLookupGetDataChildrenOption1ItemRoomSceneOption1 | boolean | null;
10604
+ roomScene?: CategoriesLookupGetDataChildrenOption1ItemRoomSceneOption1 | null | false;
10491
10605
  /** Brandfolder color names (trinitysurfaces only) */
10492
10606
  colorList?: string[] | null;
10493
10607
  /** Brandfolder color count (trinitysurfaces only) */
@@ -10510,10 +10624,10 @@ interface CategoriesLookupGetData {
10510
10624
  itemCategoryId: string;
10511
10625
  /** Category description */
10512
10626
  itemCategoryDesc: string;
10513
- /** Category image path, or false when none */
10514
- categoryImage: string | boolean;
10515
- /** Category text, or false when none */
10516
- categoryText: string | boolean;
10627
+ /** Category image path, or null when none */
10628
+ categoryImage: string | null;
10629
+ /** Category text, or null when none */
10630
+ categoryText: string | null;
10517
10631
  /** Parent category ID */
10518
10632
  parentItemCategoryUid: number;
10519
10633
  /** Depth of the category in the hierarchy */
@@ -10530,14 +10644,17 @@ interface CategoriesLookupGetData {
10530
10644
  maxItems: number;
10531
10645
  /** Online items in the category (OpenSearch count, after filters) */
10532
10646
  itemsByCategory: number;
10533
- /** Active child categories after childrenFilter, childrenLimit and childrenOffset */
10534
- children: CategoriesLookupGetDataChildrenOption1Item[] | Record<string, CategoriesLookupGetDataChildrenOption1Item>;
10647
+ /**
10648
+ * Active child categories after childrenFilter, childrenLimit and childrenOffset, in display
10649
+ * order
10650
+ */
10651
+ children: CategoriesLookupGetDataChildrenOption1Item[];
10535
10652
  /** Children before childrenFilter and paging */
10536
10653
  childrenTotal: number;
10537
10654
  /** Children returned */
10538
10655
  childrenCount: number;
10539
10656
  /** User-defined fields (only with includeUd=Y) */
10540
- userDefined?: Record<string, string>;
10657
+ userDefined?: Record<string, string> | null;
10541
10658
  [key: string]: unknown;
10542
10659
  }
10543
10660
  /**
@@ -10736,17 +10853,17 @@ interface CategoriesItemsListDataItemsItem {
10736
10853
  /** The item's display description in this category */
10737
10854
  displayDesc: string;
10738
10855
  /** Stock by location and per company (only with includeStock=Y) */
10739
- stock?: InvMastStockGetData;
10856
+ stock?: InvMastStockGetData | null;
10740
10857
  /** True when the 4th character of classId5 is 1 (trinitysurfaces only) */
10741
10858
  samplesApp?: boolean | null;
10742
10859
  /** True when the trim user-defined field is Y (trinitysurfaces only) */
10743
10860
  trim?: boolean | null;
10744
10861
  /** Full-sized sample item, or false (trinitysurfaces only) */
10745
- fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
10862
+ fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
10746
10863
  /** Swatch sample item, or false (trinitysurfaces only) */
10747
- swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
10864
+ swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
10748
10865
  /** Brandfolder assets (trinitysurfaces only) */
10749
- brandFolder?: BrandsFacetsListDataItemsItemBrandFolder;
10866
+ brandFolder?: BrandsFacetsListDataItemsItemBrandFolder | null;
10750
10867
  [key: string]: unknown;
10751
10868
  }
10752
10869
  /**
@@ -11225,28 +11342,28 @@ interface InvMastListItem {
11225
11342
  stock: InvMastStockGetData;
11226
11343
  /** Category display description per item category ID */
11227
11344
  categoryDisplayDescriptions: Record<string, string>;
11228
- /** Non-empty user-defined field values, keyed by field name ([] when empty) */
11229
- userDefined: Record<string, unknown> | [];
11345
+ /** Non-empty user-defined field values, keyed by field name; {} when the item has none */
11346
+ userDefined: Record<string, unknown>;
11230
11347
  /** Prophet 21 item text blocks (empty unless the site has a p21_pim config) */
11231
11348
  invMastText: InvMastListItemInvMastTextItem[];
11232
11349
  /** Descriptions in other languages */
11233
11350
  languages: InvMastListItemLanguagesItem[];
11234
11351
  /** Brandfolder assets (trinitysurfaces only) */
11235
- brandFolder?: BrandsFacetsListDataItemsItemBrandFolder;
11352
+ brandFolder?: BrandsFacetsListDataItemsItemBrandFolder | null;
11236
11353
  /** Category trees for the item's non-root categories (trinitysurfaces only) */
11237
11354
  docCatTrees?: Array<number[]> | null;
11238
11355
  /** Product collection of the item's category under root 3 (trinitysurfaces only) */
11239
11356
  productCollection?: string | null;
11240
11357
  /** Leaf category under root 3, or false (trinitysurfaces only) */
11241
- tsItemCategoryUid?: number | boolean | null;
11358
+ tsItemCategoryUid?: number | null | false;
11242
11359
  /** Leaf category under root 5, or false (trinitysurfaces only) */
11243
- ttItemCategoryUid?: number | boolean | null;
11360
+ ttItemCategoryUid?: number | null | false;
11244
11361
  /** True when the trim user-defined field is Y (trinitysurfaces only) */
11245
11362
  trim?: boolean | null;
11246
11363
  /** Full-sized sample item, or false (trinitysurfaces only) */
11247
- fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
11364
+ fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
11248
11365
  /** Swatch sample item, or false (trinitysurfaces only) */
11249
- swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
11366
+ swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
11250
11367
  /** Variant group the item belongs to */
11251
11368
  itemVariantHdrUid?: number | null;
11252
11369
  /** List price 1 (only with includePricing=Y) */
@@ -12488,11 +12605,11 @@ interface ItemWishlistHdrGetItem {
12488
12605
  /** True when the trim user-defined field is Y (trinitysurfaces only) */
12489
12606
  trim?: boolean | null;
12490
12607
  /** Full-sized sample item, or false (trinitysurfaces only) */
12491
- fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
12608
+ fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
12492
12609
  /** Swatch sample item, or false (trinitysurfaces only) */
12493
- swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
12610
+ swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
12494
12611
  /** Brandfolder assets (trinitysurfaces only) */
12495
- brandFolder?: BrandsFacetsListDataItemsItemBrandFolder;
12612
+ brandFolder?: BrandsFacetsListDataItemsItemBrandFolder | null;
12496
12613
  [key: string]: unknown;
12497
12614
  }
12498
12615
  /** Returned by: api.items.itemWishlist.hdr.get(usersId, itemWishlistHdrUid, params) */
@@ -12930,11 +13047,11 @@ interface VariantsDocListDataLinesItem {
12930
13047
  */
12931
13048
  interface VariantsDocListData {
12932
13049
  /** The variant group */
12933
- header: VariantsDocListDataHeader;
13050
+ header: VariantsDocListDataHeader | null;
12934
13051
  /** Attributes that differentiate the items, in sequence order */
12935
13052
  attributes: VariantsDocListDataAttributesItem[];
12936
13053
  /** The primary item; null when no line is primary */
12937
- primary: VariantsDocListDataPrimary;
13054
+ primary: VariantsDocListDataPrimary | null;
12938
13055
  /** Every item in the group, in sequence order */
12939
13056
  lines: VariantsDocListDataLinesItem[];
12940
13057
  /** Number of entries in lines */
@@ -16261,21 +16378,21 @@ interface InvMastAlsoBoughtListItem {
16261
16378
  /** Descriptions in other languages */
16262
16379
  languages: InvMastAlsoBoughtListItemLanguagesItem[];
16263
16380
  /** Brandfolder assets (trinitysurfaces only) */
16264
- brandFolder?: InvMastAlsoBoughtListItemBrandFolder;
16381
+ brandFolder?: InvMastAlsoBoughtListItemBrandFolder | null;
16265
16382
  /** Category trees for the item's non-root categories (trinitysurfaces only) */
16266
16383
  docCatTrees?: Array<number[]> | null;
16267
16384
  /** Product collection of the item's category under root 3 (trinitysurfaces only) */
16268
16385
  productCollection?: string | null;
16269
16386
  /** Leaf category under root 3, or false (trinitysurfaces only) */
16270
- tsItemCategoryUid?: number | boolean | null;
16387
+ tsItemCategoryUid?: number | null | false;
16271
16388
  /** Leaf category under root 5, or false (trinitysurfaces only) */
16272
- ttItemCategoryUid?: number | boolean | null;
16389
+ ttItemCategoryUid?: number | null | false;
16273
16390
  /** True when the trim user-defined field is Y (trinitysurfaces only) */
16274
16391
  trim?: boolean | null;
16275
16392
  /** Full-sized sample item, or false (trinitysurfaces only) */
16276
- fullSizedSamples?: InvMastAlsoBoughtListItemFullSizedSamples | boolean | null;
16393
+ fullSizedSamples?: InvMastAlsoBoughtListItemFullSizedSamples | null | false;
16277
16394
  /** Swatch sample item, or false (trinitysurfaces only) */
16278
- swatchSample?: InvMastAlsoBoughtListItemFullSizedSamples | boolean | null;
16395
+ swatchSample?: InvMastAlsoBoughtListItemFullSizedSamples | null | false;
16279
16396
  /** Variant group the item belongs to */
16280
16397
  itemVariantHdrUid?: number | null;
16281
16398
  /** List price 1 (only with includePricing=Y) */
@@ -17124,8 +17241,8 @@ declare class LegacyClient extends BaseServiceClient {
17124
17241
 
17125
17242
  /**
17126
17243
  * Generated types for the agr-site service.
17127
- * Central site configuration hub managing settings, notifications, training data, and cross-service
17128
- * integrations per client
17244
+ * Central site configuration hub managing settings, notifications, and cross-service integrations
17245
+ * per client
17129
17246
  *
17130
17247
  * Public specs (the source of truth for every shape below):
17131
17248
  * https://agr-site.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
@@ -17229,54 +17346,6 @@ interface SettingsListParams extends EdgeCacheParams {
17229
17346
  }
17230
17347
  /** Params for GET /settings/{settingsUid} */
17231
17348
  type SettingsGetParams = EdgeCacheParams;
17232
- /** Params for GET /training */
17233
- interface TrainingListParams extends EdgeCacheParams {
17234
- /** Limit number of results (Default: 10) */
17235
- limit?: number;
17236
- /** Starting offset results (Default: 0) */
17237
- offset?: number;
17238
- /** Order By (Default: training_set_uid|ASC) */
17239
- orderBy?: string;
17240
- /**
17241
- * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
17242
- * (704,705); -1 for every status. Default: every status
17243
- */
17244
- statusCd?: number | number[];
17245
- }
17246
- /** Params for GET /training/{trainingSetUid} */
17247
- type TrainingGetParams = EdgeCacheParams;
17248
- /** Params for GET /training/{trainingSetUid}/conversations */
17249
- interface TrainingConversationsListParams extends EdgeCacheParams {
17250
- /** Limit number of results (Default: 10) */
17251
- limit?: number;
17252
- /** Starting offset results (Default: 0) */
17253
- offset?: number;
17254
- /** Order By (Default: training_conv_uid|ASC) */
17255
- orderBy?: string;
17256
- /**
17257
- * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
17258
- * (704,705); -1 for every status. Default: every status
17259
- */
17260
- statusCd?: number | number[];
17261
- }
17262
- /** Params for GET /training/{trainingSetUid}/conversations/{trainingConvUid} */
17263
- type TrainingConversationsGetParams = EdgeCacheParams;
17264
- /** Params for GET /training/{trainingSetUid}/conversations/{trainingConvUid}/messages */
17265
- interface TrainingConversationsMessagesListParams extends EdgeCacheParams {
17266
- /** Limit number of results (Default: 10) */
17267
- limit?: number;
17268
- /** Starting offset results (Default: 0) */
17269
- offset?: number;
17270
- /** Order By (Default: training_msg_uid|ASC) */
17271
- orderBy?: string;
17272
- /**
17273
- * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
17274
- * (704,705); -1 for every status. Default: every status
17275
- */
17276
- statusCd?: number | number[];
17277
- }
17278
- /** Params for GET /training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid} */
17279
- type TrainingConversationsMessagesGetParams = EdgeCacheParams;
17280
17349
  /** Params for GET /users/{userId}/addresses */
17281
17350
  interface UsersAddressesListParams extends EdgeCacheParams {
17282
17351
  /** Filter by email_address */
@@ -17410,7 +17479,7 @@ interface ContextGetDataOption1$1 {
17410
17479
  *
17411
17480
  * Nested in ContextGetData
17412
17481
  */
17413
- interface ContextGetDataOption2$1 {
17482
+ interface ContextGetDataOption2 {
17414
17483
  /** Site described */
17415
17484
  siteId: string;
17416
17485
  /** Site domain; null when the site is not provisioned */
@@ -17431,7 +17500,7 @@ interface ContextGetDataOption2$1 {
17431
17500
  *
17432
17501
  * Returned by: api.agrSite.context.get(siteId)
17433
17502
  */
17434
- type ContextGetData$1 = ContextGetDataOption1$1 | ContextGetDataOption2$1;
17503
+ type ContextGetData$1 = ContextGetDataOption1$1 | ContextGetDataOption2;
17435
17504
  /**
17436
17505
  * Write a file to a site web folder
17437
17506
  * Response data for POST /datafiles — MINIMUM fields, extras pass through
@@ -17892,414 +17961,6 @@ interface SettingsUpdateBody {
17892
17961
  * Returned by: api.agrSite.settings.delete(settingsUid)
17893
17962
  */
17894
17963
  type SettingsDeleteData = SettingsListItem;
17895
- /**
17896
- * List Training Sets
17897
- * Response data for GET /training — MINIMUM fields, extras pass through
17898
- *
17899
- * Returned by: api.agrSite.training.list(params) (array items)
17900
- * Returned by: api.agrSite.training.create(data)
17901
- * Returned by: api.agrSite.training.get(trainingSetUid)
17902
- * Returned by: api.agrSite.training.update(trainingSetUid, data)
17903
- * Returned by: api.agrSite.training.delete(trainingSetUid)
17904
- */
17905
- interface TrainingListItem {
17906
- /** Primary key */
17907
- trainingSetUid: number;
17908
- /** Dataset name (max 100 chars) */
17909
- name: string;
17910
- /** Dataset description (max 65536 chars) */
17911
- description: string | null;
17912
- /** Format type (harmony, chatml, alpaca) (max 20 chars) */
17913
- formatType: string | null;
17914
- /** System role content (max 65536 chars) */
17915
- systemPrompt: string | null;
17916
- /** Developer role content (Harmony only) (max 65536 chars) */
17917
- developerPrompt: string | null;
17918
- /** Target model for fine-tuning (max 100 chars) */
17919
- modelTarget: string | null;
17920
- /** Training split percentage */
17921
- trainSplitPct: number;
17922
- /** Count of conversations */
17923
- totalConversations: number;
17924
- /** Total tokens in dataset */
17925
- totalTokens: number;
17926
- /** Record status */
17927
- statusCd: number;
17928
- /** Processing status */
17929
- processCd: number;
17930
- /** Update tracking */
17931
- updateCd: number;
17932
- /** Created timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
17933
- dateCreated: string;
17934
- /** Modified timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
17935
- dateLastModified: string;
17936
- [key: string]: unknown;
17937
- }
17938
- /** Returned by: api.agrSite.training.list(params) */
17939
- type TrainingListData = TrainingListItem[];
17940
- /**
17941
- * Create Training Set
17942
- * Response data for POST /training — MINIMUM fields, extras pass through
17943
- *
17944
- * Returned by: api.agrSite.training.create(data)
17945
- */
17946
- type TrainingCreateData = TrainingListItem;
17947
- /**
17948
- * Create Training Set
17949
- * Request body for POST /training — MINIMUM fields, extras pass through
17950
- *
17951
- * Request body of: api.agrSite.training.create(data)
17952
- */
17953
- interface TrainingCreateBody {
17954
- /** Training set name; nothing is stored when missing */
17955
- name: string | null;
17956
- /** Training data format */
17957
- formatType?: string | null;
17958
- /** Description */
17959
- description?: string | null;
17960
- /** System prompt for every conversation */
17961
- systemPrompt?: string | null;
17962
- /** Developer prompt for every conversation */
17963
- developerPrompt?: string | null;
17964
- /** Model the set is built for */
17965
- modelTarget?: string | null;
17966
- /** Percent of conversations used for training (Default: 80) */
17967
- trainSplitPct?: number | null;
17968
- [key: string]: unknown;
17969
- }
17970
- /**
17971
- * Get Training Set Details
17972
- * Response data for GET /training/{trainingSetUid} — MINIMUM fields, extras pass through
17973
- *
17974
- * Returned by: api.agrSite.training.get(trainingSetUid)
17975
- */
17976
- type TrainingGetData = TrainingListItem;
17977
- /**
17978
- * Update Training Set
17979
- * Response data for PUT /training/{trainingSetUid} — MINIMUM fields, extras pass through
17980
- *
17981
- * Returned by: api.agrSite.training.update(trainingSetUid, data)
17982
- */
17983
- type TrainingUpdateData = TrainingListItem;
17984
- /**
17985
- * Update Training Set
17986
- * Request body for PUT /training/{trainingSetUid} — MINIMUM fields, extras pass through
17987
- *
17988
- * Request body of: api.agrSite.training.update(trainingSetUid, data)
17989
- */
17990
- interface TrainingUpdateBody {
17991
- /** Training set name */
17992
- name?: string | null;
17993
- /** Training data format */
17994
- formatType?: string | null;
17995
- /** Description */
17996
- description?: string | null;
17997
- /** System prompt for every conversation */
17998
- systemPrompt?: string | null;
17999
- /** Developer prompt for every conversation */
18000
- developerPrompt?: string | null;
18001
- /** Model the set is built for */
18002
- modelTarget?: string | null;
18003
- /** Percent of conversations used for training */
18004
- trainSplitPct?: number | null;
18005
- /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
18006
- statusCd?: number | null;
18007
- [key: string]: unknown;
18008
- }
18009
- /**
18010
- * DELETE Training Set
18011
- * Response data for DELETE /training/{trainingSetUid} — MINIMUM fields, extras pass through
18012
- *
18013
- * Returned by: api.agrSite.training.delete(trainingSetUid)
18014
- */
18015
- type TrainingDeleteData = TrainingListItem;
18016
- /**
18017
- * List Training Conversations
18018
- * Response data for GET /training/{trainingSetUid}/conversations — MINIMUM fields, extras pass
18019
- * through
18020
- *
18021
- * Returned by: api.agrSite.training.conversations.list(trainingSetUid, params) (array items)
18022
- * Returned by: api.agrSite.training.conversations.create(trainingSetUid, data)
18023
- * Returned by: api.agrSite.training.conversations.get(trainingSetUid, trainingConvUid)
18024
- * Returned by: api.agrSite.training.conversations.update(trainingSetUid, trainingConvUid, data)
18025
- * Returned by: api.agrSite.training.conversations.delete(trainingSetUid, trainingConvUid)
18026
- */
18027
- interface TrainingConversationsListItem {
18028
- /** Primary key */
18029
- trainingConvUid: number;
18030
- /** FK to training_set */
18031
- trainingSetUid: number;
18032
- /** Source type (synthetic, datatype, curated, import) (max 20 chars) */
18033
- sourceType: string;
18034
- /** AI model that generated Q&A (oss-20b, claude-opus, etc.) (max 100 chars) */
18035
- generatorModel: string | null;
18036
- /** Source MS (nullable for synthetic) (max 100 chars) */
18037
- serviceName: string | null;
18038
- /** Source DT (nullable for synthetic) (max 100 chars) */
18039
- dataTypeName: string | null;
18040
- /** FK to source record (nullable, many convs per source) */
18041
- dataTypeUid: number | null;
18042
- /** Topic category (pricing, shipping, etc.) (max 50 chars) */
18043
- category: string | null;
18044
- /** 0.00-1.00 quality rating */
18045
- qualityScore: number | null;
18046
- /** Split type (train, val, test) (max 10 chars) */
18047
- splitType: string;
18048
- /** Tokens in conversation */
18049
- totalTokens: number;
18050
- /** Record status */
18051
- statusCd: number;
18052
- /** Processing status */
18053
- processCd: number;
18054
- /** Update tracking */
18055
- updateCd: number;
18056
- /** Created timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
18057
- dateCreated: string;
18058
- /** Modified timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
18059
- dateLastModified: string;
18060
- [key: string]: unknown;
18061
- }
18062
- /** Returned by: api.agrSite.training.conversations.list(trainingSetUid, params) */
18063
- type TrainingConversationsListData = TrainingConversationsListItem[];
18064
- /**
18065
- * Create Training Conversation
18066
- * Response data for POST /training/{trainingSetUid}/conversations — MINIMUM fields, extras pass
18067
- * through
18068
- *
18069
- * Returned by: api.agrSite.training.conversations.create(trainingSetUid, data)
18070
- */
18071
- type TrainingConversationsCreateData = TrainingConversationsListItem;
18072
- /**
18073
- * Create Training Conversation
18074
- * Request body for POST /training/{trainingSetUid}/conversations — MINIMUM fields, extras pass
18075
- * through
18076
- *
18077
- * Request body of: api.agrSite.training.conversations.create(trainingSetUid, data)
18078
- */
18079
- interface TrainingConversationsCreateBody {
18080
- /** Where the conversation came from (Default: synthetic) */
18081
- sourceType?: string | null;
18082
- /** Model that generated the conversation */
18083
- generatorModel?: string | null;
18084
- /** Service the conversation is about */
18085
- serviceName?: string | null;
18086
- /** Datatype the conversation is about */
18087
- dataTypeName?: string | null;
18088
- /** ID of the record the conversation is about */
18089
- dataTypeUid?: number | null;
18090
- /** Category */
18091
- category?: string | null;
18092
- /** Quality score */
18093
- qualityScore?: number | null;
18094
- /** train or validation (Default: train) */
18095
- splitType?: string | null;
18096
- /** Token count (Default: 0) */
18097
- totalTokens?: number | null;
18098
- [key: string]: unknown;
18099
- }
18100
- /**
18101
- * Get Training Conversation Details
18102
- * Response data for GET /training/{trainingSetUid}/conversations/{trainingConvUid} — MINIMUM
18103
- * fields, extras pass through
18104
- *
18105
- * Returned by: api.agrSite.training.conversations.get(trainingSetUid, trainingConvUid)
18106
- */
18107
- type TrainingConversationsGetData = TrainingConversationsListItem;
18108
- /**
18109
- * Update Training Conversation
18110
- * Response data for PUT /training/{trainingSetUid}/conversations/{trainingConvUid} — MINIMUM
18111
- * fields, extras pass through
18112
- *
18113
- * Returned by: api.agrSite.training.conversations.update(trainingSetUid, trainingConvUid, data)
18114
- */
18115
- type TrainingConversationsUpdateData = TrainingConversationsListItem;
18116
- /**
18117
- * Update Training Conversation
18118
- * Request body for PUT /training/{trainingSetUid}/conversations/{trainingConvUid} — MINIMUM fields,
18119
- * extras pass through
18120
- *
18121
- * Request body of: api.agrSite.training.conversations.update(trainingSetUid, trainingConvUid, data)
18122
- */
18123
- interface TrainingConversationsUpdateBody {
18124
- /** Where the conversation came from */
18125
- sourceType?: string | null;
18126
- /** Model that generated the conversation */
18127
- generatorModel?: string | null;
18128
- /** Category */
18129
- category?: string | null;
18130
- /** Quality score */
18131
- qualityScore?: number | null;
18132
- /** train or validation */
18133
- splitType?: string | null;
18134
- /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
18135
- statusCd?: number | null;
18136
- [key: string]: unknown;
18137
- }
18138
- /**
18139
- * DELETE Training Conversation
18140
- * Response data for DELETE /training/{trainingSetUid}/conversations/{trainingConvUid} — MINIMUM
18141
- * fields, extras pass through
18142
- *
18143
- * Returned by: api.agrSite.training.conversations.delete(trainingSetUid, trainingConvUid)
18144
- */
18145
- type TrainingConversationsDeleteData = TrainingConversationsListItem;
18146
- /**
18147
- * List Training Messages
18148
- * Response data for GET /training/{trainingSetUid}/conversations/{trainingConvUid}/messages —
18149
- * MINIMUM fields, extras pass through
18150
- *
18151
- * Returned by:
18152
- * api.agrSite.training.conversations.messages.list(trainingSetUid, trainingConvUid, params) (array
18153
- * items)
18154
- * Returned by:
18155
- * api.agrSite.training.conversations.messages.create(trainingSetUid, trainingConvUid, data)
18156
- * Returned by:
18157
- * api.agrSite.training.conversations.messages.get(trainingSetUid, trainingConvUid, trainingMsgUid)
18158
- * Returned by:
18159
- * api.agrSite.training.conversations.messages.update(trainingSetUid, trainingConvUid, trainingMsgUid, data)
18160
- * Returned by:
18161
- * api.agrSite.training.conversations.messages.delete(trainingSetUid, trainingConvUid, trainingMsgUid)
18162
- */
18163
- interface TrainingConversationsMessagesListItem {
18164
- /** Primary key */
18165
- trainingMsgUid: number;
18166
- /** FK to training_conv */
18167
- trainingConvUid: number;
18168
- /** Message order (1, 2, 3...) */
18169
- sequenceNo: number;
18170
- /** Message role (system, developer, user, assistant, tool) (max 20 chars) */
18171
- role: string;
18172
- /** Harmony channel (analysis, commentary, final) (max 20 chars) */
18173
- channel: string | null;
18174
- /** User question / general content (max 65536 chars) */
18175
- content: string | null;
18176
- /** Reasoning (assistant thinking) (max 65536 chars) */
18177
- analysis: string | null;
18178
- /** Tool preamble (Harmony) (max 65536 chars) */
18179
- commentary: string | null;
18180
- /** Answer (assistant response) (max 65536 chars) */
18181
- final: string | null;
18182
- /** Training weight (0=skip, 1=train) */
18183
- weight: number;
18184
- /** Tokens in message */
18185
- tokens: number;
18186
- /** Record status */
18187
- statusCd: number;
18188
- /** Processing status */
18189
- processCd: number;
18190
- /** Update tracking */
18191
- updateCd: number;
18192
- /** Created timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
18193
- dateCreated: string;
18194
- /** Modified timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
18195
- dateLastModified: string;
18196
- [key: string]: unknown;
18197
- }
18198
- /**
18199
- * Returned by:
18200
- * api.agrSite.training.conversations.messages.list(trainingSetUid, trainingConvUid, params)
18201
- */
18202
- type TrainingConversationsMessagesListData = TrainingConversationsMessagesListItem[];
18203
- /**
18204
- * Create Training Message
18205
- * Response data for POST /training/{trainingSetUid}/conversations/{trainingConvUid}/messages —
18206
- * MINIMUM fields, extras pass through
18207
- *
18208
- * Returned by:
18209
- * api.agrSite.training.conversations.messages.create(trainingSetUid, trainingConvUid, data)
18210
- */
18211
- type TrainingConversationsMessagesCreateData = TrainingConversationsMessagesListItem;
18212
- /**
18213
- * Create Training Message
18214
- * Request body for POST /training/{trainingSetUid}/conversations/{trainingConvUid}/messages —
18215
- * MINIMUM fields, extras pass through
18216
- *
18217
- * Request body of:
18218
- * api.agrSite.training.conversations.messages.create(trainingSetUid, trainingConvUid, data)
18219
- */
18220
- interface TrainingConversationsMessagesCreateBody {
18221
- /** Position in the conversation (Default: 0) */
18222
- sequenceNo?: number | null;
18223
- /** Speaker role (Default: user) */
18224
- role?: string | null;
18225
- /** Message channel */
18226
- channel?: string | null;
18227
- /** Message content */
18228
- content?: string | null;
18229
- /** Analysis text */
18230
- analysis?: string | null;
18231
- /** Commentary text */
18232
- commentary?: string | null;
18233
- /** Final answer text */
18234
- final?: string | null;
18235
- /** Training weight (Default: 1) */
18236
- weight?: number | null;
18237
- /** Token count (Default: 0) */
18238
- tokens?: number | null;
18239
- [key: string]: unknown;
18240
- }
18241
- /**
18242
- * Get Training Message Details
18243
- * Response data for GET
18244
- * /training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid} — MINIMUM
18245
- * fields, extras pass through
18246
- *
18247
- * Returned by:
18248
- * api.agrSite.training.conversations.messages.get(trainingSetUid, trainingConvUid, trainingMsgUid)
18249
- */
18250
- type TrainingConversationsMessagesGetData = TrainingConversationsMessagesListItem;
18251
- /**
18252
- * Update Training Message
18253
- * Response data for PUT
18254
- * /training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid} — MINIMUM
18255
- * fields, extras pass through
18256
- *
18257
- * Returned by:
18258
- * api.agrSite.training.conversations.messages.update(trainingSetUid, trainingConvUid, trainingMsgUid, data)
18259
- */
18260
- type TrainingConversationsMessagesUpdateData = TrainingConversationsMessagesListItem;
18261
- /**
18262
- * Update Training Message
18263
- * Request body for PUT
18264
- * /training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid} — MINIMUM
18265
- * fields, extras pass through
18266
- *
18267
- * Request body of:
18268
- * api.agrSite.training.conversations.messages.update(trainingSetUid, trainingConvUid, trainingMsgUid, data)
18269
- */
18270
- interface TrainingConversationsMessagesUpdateBody {
18271
- /** Position in the conversation */
18272
- sequenceNo?: number | null;
18273
- /** Speaker role */
18274
- role?: string | null;
18275
- /** Message channel */
18276
- channel?: string | null;
18277
- /** Message content */
18278
- content?: string | null;
18279
- /** Analysis text */
18280
- analysis?: string | null;
18281
- /** Commentary text */
18282
- commentary?: string | null;
18283
- /** Final answer text */
18284
- final?: string | null;
18285
- /** Training weight */
18286
- weight?: number | null;
18287
- /** Token count */
18288
- tokens?: number | null;
18289
- /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
18290
- statusCd?: number | null;
18291
- [key: string]: unknown;
18292
- }
18293
- /**
18294
- * DELETE Training Message
18295
- * Response data for DELETE
18296
- * /training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid} — MINIMUM
18297
- * fields, extras pass through
18298
- *
18299
- * Returned by:
18300
- * api.agrSite.training.conversations.messages.delete(trainingSetUid, trainingConvUid, trainingMsgUid)
18301
- */
18302
- type TrainingConversationsMessagesDeleteData = TrainingConversationsMessagesListItem;
18303
17964
  /**
18304
17965
  * List user addresses
18305
17966
  * Response data for GET /users/{userId}/addresses — MINIMUM fields, extras pass through
@@ -18912,292 +18573,6 @@ interface AgrSiteClientSpec {
18912
18573
  */
18913
18574
  delete: (settingsUid: number) => Promise<BaseResponse$1<SettingsDeleteData>>;
18914
18575
  };
18915
- training: {
18916
- /**
18917
- * List Training Sets
18918
- * Call: api.agrSite.training.list(params)
18919
- *
18920
- * Errors:
18921
- * 400: orderBy is not column|ASC or column|DESC on a training_set column.
18922
- *
18923
- * GET https://agr-site.augur-api.com/training
18924
- * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1training/get
18925
- *
18926
- * @param params TrainingListParams (query string)
18927
- * @returns BaseResponse whose `data` is TrainingListData
18928
- */
18929
- list: (params?: TrainingListParams) => Promise<BaseResponse$1<TrainingListData>>;
18930
- /**
18931
- * Create Training Set
18932
- * Call: api.agrSite.training.create(data)
18933
- *
18934
- * Request body: Create a training set
18935
- *
18936
- * POST https://agr-site.augur-api.com/training
18937
- * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1training/post
18938
- *
18939
- * @param data TrainingCreateBody (request body)
18940
- * @returns BaseResponse whose `data` is TrainingCreateData
18941
- */
18942
- create: (data: TrainingCreateBody) => Promise<BaseResponse$1<TrainingCreateData>>;
18943
- /**
18944
- * Get Training Set Details
18945
- * Call: api.agrSite.training.get(trainingSetUid)
18946
- *
18947
- * Errors:
18948
- * 404: No training set with this ID.
18949
- *
18950
- * GET https://agr-site.augur-api.com/training/{trainingSetUid}
18951
- * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}/get
18952
- *
18953
- * @param trainingSetUid Training set the conversations belong to
18954
- * @param params TrainingGetParams (query string)
18955
- * @returns BaseResponse whose `data` is TrainingGetData
18956
- */
18957
- get: (trainingSetUid: number, params?: TrainingGetParams) => Promise<BaseResponse$1<TrainingGetData>>;
18958
- /**
18959
- * Update Training Set
18960
- * Call: api.agrSite.training.update(trainingSetUid, data)
18961
- *
18962
- * Request body: Partial update of a training set; an absent field keeps its current value
18963
- *
18964
- * Errors:
18965
- * 400: trainingSetUid is 0 or negative.
18966
- * 404: No training set with this ID.
18967
- *
18968
- * PUT https://agr-site.augur-api.com/training/{trainingSetUid}
18969
- * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}/put
18970
- *
18971
- * @param trainingSetUid Training set the conversations belong to
18972
- * @param data TrainingUpdateBody (request body)
18973
- * @returns BaseResponse whose `data` is TrainingUpdateData
18974
- */
18975
- update: (trainingSetUid: number, data: TrainingUpdateBody) => Promise<BaseResponse$1<TrainingUpdateData>>;
18976
- /**
18977
- * DELETE Training Set
18978
- * Call: api.agrSite.training.delete(trainingSetUid)
18979
- *
18980
- * Errors:
18981
- * 400: trainingSetUid is 0 or negative.
18982
- * 404: No training set with this ID.
18983
- *
18984
- * DELETE https://agr-site.augur-api.com/training/{trainingSetUid}
18985
- * Contract:
18986
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}/delete
18987
- *
18988
- * @param trainingSetUid Training set the conversations belong to
18989
- * @returns BaseResponse whose `data` is TrainingDeleteData
18990
- */
18991
- delete: (trainingSetUid: number) => Promise<BaseResponse$1<TrainingDeleteData>>;
18992
- conversations: {
18993
- /**
18994
- * List Training Conversations
18995
- * Call: api.agrSite.training.conversations.list(trainingSetUid, params)
18996
- *
18997
- * Errors:
18998
- * 400: orderBy is not column|ASC or column|DESC on a training_conv column.
18999
- * 404: No training set with this trainingSetUid.
19000
- *
19001
- * GET https://agr-site.augur-api.com/training/{trainingSetUid}/conversations
19002
- * Contract:
19003
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}~1conversations/get
19004
- *
19005
- * @param trainingSetUid Training set the conversations belong to
19006
- * @param params TrainingConversationsListParams (query string)
19007
- * @returns BaseResponse whose `data` is TrainingConversationsListData
19008
- */
19009
- list: (trainingSetUid: number, params?: TrainingConversationsListParams) => Promise<BaseResponse$1<TrainingConversationsListData>>;
19010
- /**
19011
- * Create Training Conversation
19012
- * Call: api.agrSite.training.conversations.create(trainingSetUid, data)
19013
- *
19014
- * Request body: Add a conversation to the training set in the path
19015
- *
19016
- * Errors:
19017
- * 400: trainingSetUid is 0 or negative.
19018
- * 404: No training set with this trainingSetUid.
19019
- *
19020
- * POST https://agr-site.augur-api.com/training/{trainingSetUid}/conversations
19021
- * Contract:
19022
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}~1conversations/post
19023
- *
19024
- * @param trainingSetUid Training set the conversations belong to
19025
- * @param data TrainingConversationsCreateBody (request body)
19026
- * @returns BaseResponse whose `data` is TrainingConversationsCreateData
19027
- */
19028
- create: (trainingSetUid: number, data: TrainingConversationsCreateBody) => Promise<BaseResponse$1<TrainingConversationsCreateData>>;
19029
- /**
19030
- * Get Training Conversation Details
19031
- * Call: api.agrSite.training.conversations.get(trainingSetUid, trainingConvUid)
19032
- *
19033
- * Errors:
19034
- * 400: trainingSetUid or trainingConvUid is 0 or negative.
19035
- * 404: No training conversation with this ID.
19036
- *
19037
- * GET
19038
- * https://agr-site.augur-api.com/training/{trainingSetUid}/conversations/{trainingConvUid}
19039
- * Contract:
19040
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}~1conversations~1{trainingConvUid}/get
19041
- *
19042
- * @param trainingSetUid Training set the conversations belong to
19043
- * @param trainingConvUid Training conversation ID
19044
- * @param params TrainingConversationsGetParams (query string)
19045
- * @returns BaseResponse whose `data` is TrainingConversationsGetData
19046
- */
19047
- get: (trainingSetUid: number, trainingConvUid: number, params?: TrainingConversationsGetParams) => Promise<BaseResponse$1<TrainingConversationsGetData>>;
19048
- /**
19049
- * Update Training Conversation
19050
- * Call: api.agrSite.training.conversations.update(trainingSetUid, trainingConvUid, data)
19051
- *
19052
- * Request body: Partial update of a training conversation; an absent field keeps its current
19053
- * value
19054
- *
19055
- * Errors:
19056
- * 400: trainingSetUid or trainingConvUid is 0 or negative.
19057
- * 404: No training conversation with this ID.
19058
- *
19059
- * PUT
19060
- * https://agr-site.augur-api.com/training/{trainingSetUid}/conversations/{trainingConvUid}
19061
- * Contract:
19062
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}~1conversations~1{trainingConvUid}/put
19063
- *
19064
- * @param trainingSetUid Training set the conversations belong to
19065
- * @param trainingConvUid Training conversation ID
19066
- * @param data TrainingConversationsUpdateBody (request body)
19067
- * @returns BaseResponse whose `data` is TrainingConversationsUpdateData
19068
- */
19069
- update: (trainingSetUid: number, trainingConvUid: number, data: TrainingConversationsUpdateBody) => Promise<BaseResponse$1<TrainingConversationsUpdateData>>;
19070
- /**
19071
- * DELETE Training Conversation
19072
- * Call: api.agrSite.training.conversations.delete(trainingSetUid, trainingConvUid)
19073
- *
19074
- * Errors:
19075
- * 400: trainingSetUid or trainingConvUid is 0 or negative.
19076
- * 404: No training conversation with this ID.
19077
- *
19078
- * DELETE
19079
- * https://agr-site.augur-api.com/training/{trainingSetUid}/conversations/{trainingConvUid}
19080
- * Contract:
19081
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}~1conversations~1{trainingConvUid}/delete
19082
- *
19083
- * @param trainingSetUid Training set the conversations belong to
19084
- * @param trainingConvUid Training conversation ID
19085
- * @returns BaseResponse whose `data` is TrainingConversationsDeleteData
19086
- */
19087
- delete: (trainingSetUid: number, trainingConvUid: number) => Promise<BaseResponse$1<TrainingConversationsDeleteData>>;
19088
- messages: {
19089
- /**
19090
- * List Training Messages
19091
- * Call:
19092
- * api.agrSite.training.conversations.messages.list(trainingSetUid, trainingConvUid, params)
19093
- *
19094
- * Errors:
19095
- * 400: orderBy is not column|ASC or column|DESC on a training_msg column.
19096
- * 404: No training set with this trainingSetUid, or no conversation with this
19097
- * trainingConvUid in that set.
19098
- *
19099
- * GET
19100
- * https://agr-site.augur-api.com/training/{trainingSetUid}/conversations/{trainingConvUid}/messages
19101
- * Contract:
19102
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}~1conversations~1{trainingConvUid}~1messages/get
19103
- *
19104
- * @param trainingSetUid Training set the conversations belong to
19105
- * @param trainingConvUid Training conversation ID
19106
- * @param params TrainingConversationsMessagesListParams (query string)
19107
- * @returns BaseResponse whose `data` is TrainingConversationsMessagesListData
19108
- */
19109
- list: (trainingSetUid: number, trainingConvUid: number, params?: TrainingConversationsMessagesListParams) => Promise<BaseResponse$1<TrainingConversationsMessagesListData>>;
19110
- /**
19111
- * Create Training Message
19112
- * Call:
19113
- * api.agrSite.training.conversations.messages.create(trainingSetUid, trainingConvUid, data)
19114
- *
19115
- * Request body: Add a message to the training conversation in the path
19116
- *
19117
- * Errors:
19118
- * 400: trainingSetUid or trainingConvUid is 0 or negative.
19119
- * 404: No training set with this trainingSetUid, or no conversation with this
19120
- * trainingConvUid in that set.
19121
- *
19122
- * POST
19123
- * https://agr-site.augur-api.com/training/{trainingSetUid}/conversations/{trainingConvUid}/messages
19124
- * Contract:
19125
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}~1conversations~1{trainingConvUid}~1messages/post
19126
- *
19127
- * @param trainingSetUid Training set the conversations belong to
19128
- * @param trainingConvUid Training conversation ID
19129
- * @param data TrainingConversationsMessagesCreateBody (request body)
19130
- * @returns BaseResponse whose `data` is TrainingConversationsMessagesCreateData
19131
- */
19132
- create: (trainingSetUid: number, trainingConvUid: number, data: TrainingConversationsMessagesCreateBody) => Promise<BaseResponse$1<TrainingConversationsMessagesCreateData>>;
19133
- /**
19134
- * Get Training Message Details
19135
- * Call:
19136
- * api.agrSite.training.conversations.messages.get(trainingSetUid, trainingConvUid, trainingMsgUid)
19137
- *
19138
- * Errors:
19139
- * 400: trainingSetUid, trainingConvUid or trainingMsgUid is 0 or negative.
19140
- * 404: No training message with this ID.
19141
- *
19142
- * GET
19143
- * https://agr-site.augur-api.com/training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid}
19144
- * Contract:
19145
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}~1conversations~1{trainingConvUid}~1messages~1{trainingMsgUid}/get
19146
- *
19147
- * @param trainingSetUid Training set the conversations belong to
19148
- * @param trainingConvUid Training conversation ID
19149
- * @param trainingMsgUid Training message ID
19150
- * @param params TrainingConversationsMessagesGetParams (query string)
19151
- * @returns BaseResponse whose `data` is TrainingConversationsMessagesGetData
19152
- */
19153
- get: (trainingSetUid: number, trainingConvUid: number, trainingMsgUid: number, params?: TrainingConversationsMessagesGetParams) => Promise<BaseResponse$1<TrainingConversationsMessagesGetData>>;
19154
- /**
19155
- * Update Training Message
19156
- * Call:
19157
- * api.agrSite.training.conversations.messages.update(trainingSetUid, trainingConvUid, trainingMsgUid, data)
19158
- *
19159
- * Request body: Partial update of a training message; an absent field keeps its current
19160
- * value
19161
- *
19162
- * Errors:
19163
- * 400: trainingSetUid, trainingConvUid or trainingMsgUid is 0 or negative.
19164
- * 404: No training message with this ID.
19165
- *
19166
- * PUT
19167
- * https://agr-site.augur-api.com/training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid}
19168
- * Contract:
19169
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}~1conversations~1{trainingConvUid}~1messages~1{trainingMsgUid}/put
19170
- *
19171
- * @param trainingSetUid Training set the conversations belong to
19172
- * @param trainingConvUid Training conversation ID
19173
- * @param trainingMsgUid Training message ID
19174
- * @param data TrainingConversationsMessagesUpdateBody (request body)
19175
- * @returns BaseResponse whose `data` is TrainingConversationsMessagesUpdateData
19176
- */
19177
- update: (trainingSetUid: number, trainingConvUid: number, trainingMsgUid: number, data: TrainingConversationsMessagesUpdateBody) => Promise<BaseResponse$1<TrainingConversationsMessagesUpdateData>>;
19178
- /**
19179
- * DELETE Training Message
19180
- * Call:
19181
- * api.agrSite.training.conversations.messages.delete(trainingSetUid, trainingConvUid, trainingMsgUid)
19182
- *
19183
- * Errors:
19184
- * 400: trainingSetUid, trainingConvUid or trainingMsgUid is 0 or negative.
19185
- * 404: No training message with this ID.
19186
- *
19187
- * DELETE
19188
- * https://agr-site.augur-api.com/training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid}
19189
- * Contract:
19190
- * https://agr-site.augur-api.com/openapi.json#/paths/~1training~1{trainingSetUid}~1conversations~1{trainingConvUid}~1messages~1{trainingMsgUid}/delete
19191
- *
19192
- * @param trainingSetUid Training set the conversations belong to
19193
- * @param trainingConvUid Training conversation ID
19194
- * @param trainingMsgUid Training message ID
19195
- * @returns BaseResponse whose `data` is TrainingConversationsMessagesDeleteData
19196
- */
19197
- delete: (trainingSetUid: number, trainingConvUid: number, trainingMsgUid: number) => Promise<BaseResponse$1<TrainingConversationsMessagesDeleteData>>;
19198
- };
19199
- };
19200
- };
19201
18576
  users: {
19202
18577
  addresses: {
19203
18578
  /**
@@ -19308,6 +18683,7 @@ type types$h_ConfigsListItem = ConfigsListItem;
19308
18683
  type types$h_ConfigsListParams = ConfigsListParams;
19309
18684
  type types$h_ConfigsUpdateBody = ConfigsUpdateBody;
19310
18685
  type types$h_ConfigsUpdateData = ConfigsUpdateData;
18686
+ type types$h_ContextGetDataOption2 = ContextGetDataOption2;
19311
18687
  type types$h_DatafilesCreateBody = DatafilesCreateBody;
19312
18688
  type types$h_DatafilesCreateData = DatafilesCreateData;
19313
18689
  type types$h_FyxerTranscriptCreateBody = FyxerTranscriptCreateBody;
@@ -19351,36 +18727,6 @@ type types$h_SettingsListItem = SettingsListItem;
19351
18727
  type types$h_SettingsListParams = SettingsListParams;
19352
18728
  type types$h_SettingsUpdateBody = SettingsUpdateBody;
19353
18729
  type types$h_SettingsUpdateData = SettingsUpdateData;
19354
- type types$h_TrainingConversationsCreateBody = TrainingConversationsCreateBody;
19355
- type types$h_TrainingConversationsCreateData = TrainingConversationsCreateData;
19356
- type types$h_TrainingConversationsDeleteData = TrainingConversationsDeleteData;
19357
- type types$h_TrainingConversationsGetData = TrainingConversationsGetData;
19358
- type types$h_TrainingConversationsGetParams = TrainingConversationsGetParams;
19359
- type types$h_TrainingConversationsListData = TrainingConversationsListData;
19360
- type types$h_TrainingConversationsListItem = TrainingConversationsListItem;
19361
- type types$h_TrainingConversationsListParams = TrainingConversationsListParams;
19362
- type types$h_TrainingConversationsMessagesCreateBody = TrainingConversationsMessagesCreateBody;
19363
- type types$h_TrainingConversationsMessagesCreateData = TrainingConversationsMessagesCreateData;
19364
- type types$h_TrainingConversationsMessagesDeleteData = TrainingConversationsMessagesDeleteData;
19365
- type types$h_TrainingConversationsMessagesGetData = TrainingConversationsMessagesGetData;
19366
- type types$h_TrainingConversationsMessagesGetParams = TrainingConversationsMessagesGetParams;
19367
- type types$h_TrainingConversationsMessagesListData = TrainingConversationsMessagesListData;
19368
- type types$h_TrainingConversationsMessagesListItem = TrainingConversationsMessagesListItem;
19369
- type types$h_TrainingConversationsMessagesListParams = TrainingConversationsMessagesListParams;
19370
- type types$h_TrainingConversationsMessagesUpdateBody = TrainingConversationsMessagesUpdateBody;
19371
- type types$h_TrainingConversationsMessagesUpdateData = TrainingConversationsMessagesUpdateData;
19372
- type types$h_TrainingConversationsUpdateBody = TrainingConversationsUpdateBody;
19373
- type types$h_TrainingConversationsUpdateData = TrainingConversationsUpdateData;
19374
- type types$h_TrainingCreateBody = TrainingCreateBody;
19375
- type types$h_TrainingCreateData = TrainingCreateData;
19376
- type types$h_TrainingDeleteData = TrainingDeleteData;
19377
- type types$h_TrainingGetData = TrainingGetData;
19378
- type types$h_TrainingGetParams = TrainingGetParams;
19379
- type types$h_TrainingListData = TrainingListData;
19380
- type types$h_TrainingListItem = TrainingListItem;
19381
- type types$h_TrainingListParams = TrainingListParams;
19382
- type types$h_TrainingUpdateBody = TrainingUpdateBody;
19383
- type types$h_TrainingUpdateData = TrainingUpdateData;
19384
18730
  type types$h_UsersAddressesCreateBody = UsersAddressesCreateBody;
19385
18731
  type types$h_UsersAddressesCreateData = UsersAddressesCreateData;
19386
18732
  type types$h_UsersAddressesDeleteData = UsersAddressesDeleteData;
@@ -19392,13 +18738,13 @@ type types$h_UsersAddressesListParams = UsersAddressesListParams;
19392
18738
  type types$h_UsersAddressesUpdateBody = UsersAddressesUpdateBody;
19393
18739
  type types$h_UsersAddressesUpdateData = UsersAddressesUpdateData;
19394
18740
  declare namespace types$h {
19395
- export type { types$h_AgrSiteClientSpec as AgrSiteClientSpec, types$h_ConfigsGetData as ConfigsGetData, types$h_ConfigsGetDataConfigsItem as ConfigsGetDataConfigsItem, types$h_ConfigsGetParams as ConfigsGetParams, types$h_ConfigsListData as ConfigsListData, types$h_ConfigsListItem as ConfigsListItem, types$h_ConfigsListParams as ConfigsListParams, types$h_ConfigsUpdateBody as ConfigsUpdateBody, types$h_ConfigsUpdateData as ConfigsUpdateData, ContextGetData$1 as ContextGetData, ContextGetDataOption1$1 as ContextGetDataOption1, ContextGetDataOption1ServicesItem$1 as ContextGetDataOption1ServicesItem, ContextGetDataOption2$1 as ContextGetDataOption2, ContextGetParams$1 as ContextGetParams, types$h_DatafilesCreateBody as DatafilesCreateBody, types$h_DatafilesCreateData as DatafilesCreateData, types$h_FyxerTranscriptCreateBody as FyxerTranscriptCreateBody, types$h_FyxerTranscriptCreateData as FyxerTranscriptCreateData, types$h_FyxerTranscriptDeleteData as FyxerTranscriptDeleteData, types$h_FyxerTranscriptGetData as FyxerTranscriptGetData, types$h_FyxerTranscriptGetParams as FyxerTranscriptGetParams, types$h_FyxerTranscriptListData as FyxerTranscriptListData, types$h_FyxerTranscriptListItem as FyxerTranscriptListItem, types$h_FyxerTranscriptListParams as FyxerTranscriptListParams, types$h_FyxerTranscriptUpdateBody as FyxerTranscriptUpdateBody, types$h_FyxerTranscriptUpdateData as FyxerTranscriptUpdateData, types$h_GeoCodesPostalCodesGetData as GeoCodesPostalCodesGetData, types$h_GeoCodesPostalCodesGetParams as GeoCodesPostalCodesGetParams, types$h_GeoCodesPostalCodesListData as GeoCodesPostalCodesListData, types$h_GeoCodesPostalCodesListItem as GeoCodesPostalCodesListItem, types$h_GeoCodesPostalCodesListParams as GeoCodesPostalCodesListParams, types$h_MetaFilesRobotsListData as MetaFilesRobotsListData, types$h_MetaFilesRobotsListParams as MetaFilesRobotsListParams, types$h_NotificationsCreateBody as NotificationsCreateBody, types$h_NotificationsCreateData as NotificationsCreateData, types$h_OpenSearchEmbeddingListData as OpenSearchEmbeddingListData, types$h_OpenSearchEmbeddingListParams as OpenSearchEmbeddingListParams, types$h_PostalCodesXShiptosCreateBody as PostalCodesXShiptosCreateBody, types$h_PostalCodesXShiptosCreateData as PostalCodesXShiptosCreateData, types$h_PostalCodesXShiptosDeleteData as PostalCodesXShiptosDeleteData, types$h_PostalCodesXShiptosGetData as PostalCodesXShiptosGetData, types$h_PostalCodesXShiptosGetParams as PostalCodesXShiptosGetParams, types$h_PostalCodesXShiptosListData as PostalCodesXShiptosListData, types$h_PostalCodesXShiptosListItem as PostalCodesXShiptosListItem, types$h_PostalCodesXShiptosListParams as PostalCodesXShiptosListParams, types$h_PostalCodesXShiptosUpdateBody as PostalCodesXShiptosUpdateBody, types$h_PostalCodesXShiptosUpdateData as PostalCodesXShiptosUpdateData, types$h_SettingsCreateBody as SettingsCreateBody, types$h_SettingsCreateData as SettingsCreateData, types$h_SettingsDeleteData as SettingsDeleteData, types$h_SettingsGetData as SettingsGetData, types$h_SettingsGetParams as SettingsGetParams, types$h_SettingsListData as SettingsListData, types$h_SettingsListItem as SettingsListItem, types$h_SettingsListParams as SettingsListParams, types$h_SettingsUpdateBody as SettingsUpdateBody, types$h_SettingsUpdateData as SettingsUpdateData, types$h_TrainingConversationsCreateBody as TrainingConversationsCreateBody, types$h_TrainingConversationsCreateData as TrainingConversationsCreateData, types$h_TrainingConversationsDeleteData as TrainingConversationsDeleteData, types$h_TrainingConversationsGetData as TrainingConversationsGetData, types$h_TrainingConversationsGetParams as TrainingConversationsGetParams, types$h_TrainingConversationsListData as TrainingConversationsListData, types$h_TrainingConversationsListItem as TrainingConversationsListItem, types$h_TrainingConversationsListParams as TrainingConversationsListParams, types$h_TrainingConversationsMessagesCreateBody as TrainingConversationsMessagesCreateBody, types$h_TrainingConversationsMessagesCreateData as TrainingConversationsMessagesCreateData, types$h_TrainingConversationsMessagesDeleteData as TrainingConversationsMessagesDeleteData, types$h_TrainingConversationsMessagesGetData as TrainingConversationsMessagesGetData, types$h_TrainingConversationsMessagesGetParams as TrainingConversationsMessagesGetParams, types$h_TrainingConversationsMessagesListData as TrainingConversationsMessagesListData, types$h_TrainingConversationsMessagesListItem as TrainingConversationsMessagesListItem, types$h_TrainingConversationsMessagesListParams as TrainingConversationsMessagesListParams, types$h_TrainingConversationsMessagesUpdateBody as TrainingConversationsMessagesUpdateBody, types$h_TrainingConversationsMessagesUpdateData as TrainingConversationsMessagesUpdateData, types$h_TrainingConversationsUpdateBody as TrainingConversationsUpdateBody, types$h_TrainingConversationsUpdateData as TrainingConversationsUpdateData, types$h_TrainingCreateBody as TrainingCreateBody, types$h_TrainingCreateData as TrainingCreateData, types$h_TrainingDeleteData as TrainingDeleteData, types$h_TrainingGetData as TrainingGetData, types$h_TrainingGetParams as TrainingGetParams, types$h_TrainingListData as TrainingListData, types$h_TrainingListItem as TrainingListItem, types$h_TrainingListParams as TrainingListParams, types$h_TrainingUpdateBody as TrainingUpdateBody, types$h_TrainingUpdateData as TrainingUpdateData, types$h_UsersAddressesCreateBody as UsersAddressesCreateBody, types$h_UsersAddressesCreateData as UsersAddressesCreateData, types$h_UsersAddressesDeleteData as UsersAddressesDeleteData, types$h_UsersAddressesGetData as UsersAddressesGetData, types$h_UsersAddressesGetParams as UsersAddressesGetParams, types$h_UsersAddressesListData as UsersAddressesListData, types$h_UsersAddressesListItem as UsersAddressesListItem, types$h_UsersAddressesListParams as UsersAddressesListParams, types$h_UsersAddressesUpdateBody as UsersAddressesUpdateBody, types$h_UsersAddressesUpdateData as UsersAddressesUpdateData };
18741
+ export type { types$h_AgrSiteClientSpec as AgrSiteClientSpec, types$h_ConfigsGetData as ConfigsGetData, types$h_ConfigsGetDataConfigsItem as ConfigsGetDataConfigsItem, types$h_ConfigsGetParams as ConfigsGetParams, types$h_ConfigsListData as ConfigsListData, types$h_ConfigsListItem as ConfigsListItem, types$h_ConfigsListParams as ConfigsListParams, types$h_ConfigsUpdateBody as ConfigsUpdateBody, types$h_ConfigsUpdateData as ConfigsUpdateData, ContextGetData$1 as ContextGetData, ContextGetDataOption1$1 as ContextGetDataOption1, ContextGetDataOption1ServicesItem$1 as ContextGetDataOption1ServicesItem, types$h_ContextGetDataOption2 as ContextGetDataOption2, ContextGetParams$1 as ContextGetParams, types$h_DatafilesCreateBody as DatafilesCreateBody, types$h_DatafilesCreateData as DatafilesCreateData, types$h_FyxerTranscriptCreateBody as FyxerTranscriptCreateBody, types$h_FyxerTranscriptCreateData as FyxerTranscriptCreateData, types$h_FyxerTranscriptDeleteData as FyxerTranscriptDeleteData, types$h_FyxerTranscriptGetData as FyxerTranscriptGetData, types$h_FyxerTranscriptGetParams as FyxerTranscriptGetParams, types$h_FyxerTranscriptListData as FyxerTranscriptListData, types$h_FyxerTranscriptListItem as FyxerTranscriptListItem, types$h_FyxerTranscriptListParams as FyxerTranscriptListParams, types$h_FyxerTranscriptUpdateBody as FyxerTranscriptUpdateBody, types$h_FyxerTranscriptUpdateData as FyxerTranscriptUpdateData, types$h_GeoCodesPostalCodesGetData as GeoCodesPostalCodesGetData, types$h_GeoCodesPostalCodesGetParams as GeoCodesPostalCodesGetParams, types$h_GeoCodesPostalCodesListData as GeoCodesPostalCodesListData, types$h_GeoCodesPostalCodesListItem as GeoCodesPostalCodesListItem, types$h_GeoCodesPostalCodesListParams as GeoCodesPostalCodesListParams, types$h_MetaFilesRobotsListData as MetaFilesRobotsListData, types$h_MetaFilesRobotsListParams as MetaFilesRobotsListParams, types$h_NotificationsCreateBody as NotificationsCreateBody, types$h_NotificationsCreateData as NotificationsCreateData, types$h_OpenSearchEmbeddingListData as OpenSearchEmbeddingListData, types$h_OpenSearchEmbeddingListParams as OpenSearchEmbeddingListParams, types$h_PostalCodesXShiptosCreateBody as PostalCodesXShiptosCreateBody, types$h_PostalCodesXShiptosCreateData as PostalCodesXShiptosCreateData, types$h_PostalCodesXShiptosDeleteData as PostalCodesXShiptosDeleteData, types$h_PostalCodesXShiptosGetData as PostalCodesXShiptosGetData, types$h_PostalCodesXShiptosGetParams as PostalCodesXShiptosGetParams, types$h_PostalCodesXShiptosListData as PostalCodesXShiptosListData, types$h_PostalCodesXShiptosListItem as PostalCodesXShiptosListItem, types$h_PostalCodesXShiptosListParams as PostalCodesXShiptosListParams, types$h_PostalCodesXShiptosUpdateBody as PostalCodesXShiptosUpdateBody, types$h_PostalCodesXShiptosUpdateData as PostalCodesXShiptosUpdateData, types$h_SettingsCreateBody as SettingsCreateBody, types$h_SettingsCreateData as SettingsCreateData, types$h_SettingsDeleteData as SettingsDeleteData, types$h_SettingsGetData as SettingsGetData, types$h_SettingsGetParams as SettingsGetParams, types$h_SettingsListData as SettingsListData, types$h_SettingsListItem as SettingsListItem, types$h_SettingsListParams as SettingsListParams, types$h_SettingsUpdateBody as SettingsUpdateBody, types$h_SettingsUpdateData as SettingsUpdateData, types$h_UsersAddressesCreateBody as UsersAddressesCreateBody, types$h_UsersAddressesCreateData as UsersAddressesCreateData, types$h_UsersAddressesDeleteData as UsersAddressesDeleteData, types$h_UsersAddressesGetData as UsersAddressesGetData, types$h_UsersAddressesGetParams as UsersAddressesGetParams, types$h_UsersAddressesListData as UsersAddressesListData, types$h_UsersAddressesListItem as UsersAddressesListItem, types$h_UsersAddressesListParams as UsersAddressesListParams, types$h_UsersAddressesUpdateBody as UsersAddressesUpdateBody, types$h_UsersAddressesUpdateData as UsersAddressesUpdateData };
19396
18742
  }
19397
18743
 
19398
18744
  /**
19399
18745
  * Generated client for the agr-site service.
19400
- * Central site configuration hub managing settings, notifications, training data, and cross-service
19401
- * integrations per client
18746
+ * Central site configuration hub managing settings, notifications, and cross-service integrations
18747
+ * per client
19402
18748
  *
19403
18749
  * Public specs (the source of truth for every shape below):
19404
18750
  * https://agr-site.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
@@ -19456,43 +18802,6 @@ declare namespace types$h {
19456
18802
  * PUT /settings/{settingsUid} → api.agrSite.settings.update(settingsUid, data) →
19457
18803
  * SettingsUpdateData
19458
18804
  * DELETE /settings/{settingsUid} → api.agrSite.settings.delete(settingsUid) → SettingsDeleteData
19459
- * GET /training → api.agrSite.training.list(params) → TrainingListData
19460
- * POST /training → api.agrSite.training.create(data) → TrainingCreateData
19461
- * GET /training/{trainingSetUid} → api.agrSite.training.get(trainingSetUid) → TrainingGetData
19462
- * PUT /training/{trainingSetUid} → api.agrSite.training.update(trainingSetUid, data) →
19463
- * TrainingUpdateData
19464
- * DELETE /training/{trainingSetUid} → api.agrSite.training.delete(trainingSetUid) →
19465
- * TrainingDeleteData
19466
- * GET /training/{trainingSetUid}/conversations →
19467
- * api.agrSite.training.conversations.list(trainingSetUid, params) →
19468
- * TrainingConversationsListData
19469
- * POST /training/{trainingSetUid}/conversations →
19470
- * api.agrSite.training.conversations.create(trainingSetUid, data) →
19471
- * TrainingConversationsCreateData
19472
- * GET /training/{trainingSetUid}/conversations/{trainingConvUid} →
19473
- * api.agrSite.training.conversations.get(trainingSetUid, trainingConvUid) →
19474
- * TrainingConversationsGetData
19475
- * PUT /training/{trainingSetUid}/conversations/{trainingConvUid} →
19476
- * api.agrSite.training.conversations.update(trainingSetUid, trainingConvUid, data) →
19477
- * TrainingConversationsUpdateData
19478
- * DELETE /training/{trainingSetUid}/conversations/{trainingConvUid} →
19479
- * api.agrSite.training.conversations.delete(trainingSetUid, trainingConvUid) →
19480
- * TrainingConversationsDeleteData
19481
- * GET /training/{trainingSetUid}/conversations/{trainingConvUid}/messages →
19482
- * api.agrSite.training.conversations.messages.list(trainingSetUid, trainingConvUid, params) →
19483
- * TrainingConversationsMessagesListData
19484
- * POST /training/{trainingSetUid}/conversations/{trainingConvUid}/messages →
19485
- * api.agrSite.training.conversations.messages.create(trainingSetUid, trainingConvUid, data) →
19486
- * TrainingConversationsMessagesCreateData
19487
- * GET /training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid} →
19488
- * api.agrSite.training.conversations.messages.get(trainingSetUid, trainingConvUid, trainingMsgUid)
19489
- * → TrainingConversationsMessagesGetData
19490
- * PUT /training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid} →
19491
- * api.agrSite.training.conversations.messages.update(trainingSetUid, trainingConvUid, trainingMsgUid, data)
19492
- * → TrainingConversationsMessagesUpdateData
19493
- * DELETE /training/{trainingSetUid}/conversations/{trainingConvUid}/messages/{trainingMsgUid} →
19494
- * api.agrSite.training.conversations.messages.delete(trainingSetUid, trainingConvUid, trainingMsgUid)
19495
- * → TrainingConversationsMessagesDeleteData
19496
18805
  * GET /users/{userId}/addresses → api.agrSite.users.addresses.list(userId, params) →
19497
18806
  * UsersAddressesListData
19498
18807
  * POST /users/{userId}/addresses → api.agrSite.users.addresses.create(userId, data) →
@@ -19516,7 +18825,6 @@ declare class AgrSiteClient extends BaseServiceClient {
19516
18825
  readonly openSearch: AgrSiteClientSpec['openSearch'];
19517
18826
  readonly postalCodesXShiptos: AgrSiteClientSpec['postalCodesXShiptos'];
19518
18827
  readonly settings: AgrSiteClientSpec['settings'];
19519
- readonly training: AgrSiteClientSpec['training'];
19520
18828
  readonly users: AgrSiteClientSpec['users'];
19521
18829
  readonly configsData: DataOnly<AgrSiteClientSpec['configs']>;
19522
18830
  readonly contextData: DataOnly<AgrSiteClientSpec['context']>;
@@ -19528,7 +18836,6 @@ declare class AgrSiteClient extends BaseServiceClient {
19528
18836
  readonly openSearchData: DataOnly<AgrSiteClientSpec['openSearch']>;
19529
18837
  readonly postalCodesXShiptosData: DataOnly<AgrSiteClientSpec['postalCodesXShiptos']>;
19530
18838
  readonly settingsData: DataOnly<AgrSiteClientSpec['settings']>;
19531
- readonly trainingData: DataOnly<AgrSiteClientSpec['training']>;
19532
18839
  readonly usersData: DataOnly<AgrSiteClientSpec['users']>;
19533
18840
  constructor(http: HTTPClient, baseUrl?: string);
19534
18841
  protected getServiceDescription(): string;
@@ -21143,7 +20450,7 @@ interface CustomerShipToListItem {
21143
20450
  /** Shipping route description */
21144
20451
  routeDescription: string | null;
21145
20452
  /** The ship-to's address; null when no address row matches */
21146
- address: CustomerShipToListItemAddress;
20453
+ address: CustomerShipToListItemAddress | null;
21147
20454
  [key: string]: unknown;
21148
20455
  }
21149
20456
  /** Returned by: api.customers.customer.shipTo.list(customerId, params) */
@@ -24736,9 +24043,9 @@ interface ElementPaymentCreateBodyAddressBilling {
24736
24043
  */
24737
24044
  interface ElementPaymentCreateBodyAddress {
24738
24045
  /** Billing address; address1 and postalCode feed the AVS check */
24739
- billing?: ElementPaymentCreateBodyAddressBilling;
24046
+ billing?: ElementPaymentCreateBodyAddressBilling | null;
24740
24047
  /** Shipping address; state and postalCode pick the site's Element processor */
24741
- shipping?: ElementPaymentCreateBodyAddressBilling;
24048
+ shipping?: ElementPaymentCreateBodyAddressBilling | null;
24742
24049
  [key: string]: unknown;
24743
24050
  }
24744
24051
  /**
@@ -24749,9 +24056,9 @@ interface ElementPaymentCreateBodyAddress {
24749
24056
  */
24750
24057
  interface ElementPaymentCreateBody {
24751
24058
  /** Card to tokenize */
24752
- card?: ElementPaymentCreateBodyCard;
24059
+ card?: ElementPaymentCreateBodyCard | null;
24753
24060
  /** Billing and shipping addresses; shipping picks the processor, billing feeds AVS */
24754
- address?: ElementPaymentCreateBodyAddress;
24061
+ address?: ElementPaymentCreateBodyAddress | null;
24755
24062
  [key: string]: unknown;
24756
24063
  }
24757
24064
  /**
@@ -24849,7 +24156,7 @@ interface PaypalAuthorizationCaptureCreateDataOption1 {
24849
24156
  /** Reason the capture is in its status ([] when empty) */
24850
24157
  statusDetails?: Record<string, unknown> | [] | null;
24851
24158
  /** Captured amount */
24852
- amount?: PaypalAuthorizationCaptureCreateDataOption1Amount;
24159
+ amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
24853
24160
  /** Invoice identifier */
24854
24161
  invoiceId?: string | null;
24855
24162
  /** Merchant custom ID sent with the order */
@@ -24969,7 +24276,7 @@ interface PaypalAuthorizationVoidCreateDataOption1 {
24969
24276
  /** Reason the authorization is in its status ([] when empty) */
24970
24277
  statusDetails?: Record<string, unknown> | [] | null;
24971
24278
  /** Authorized amount */
24972
- amount?: PaypalAuthorizationCaptureCreateDataOption1Amount;
24279
+ amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
24973
24280
  /** Invoice identifier sent with the order */
24974
24281
  invoiceId?: string | null;
24975
24282
  /** Merchant custom ID sent with the order */
@@ -25030,7 +24337,7 @@ interface PaypalCaptureRefundCreateDataOption1 {
25030
24337
  /** Reason the refund is in its status ([] when empty) */
25031
24338
  statusDetails?: Record<string, unknown> | [] | null;
25032
24339
  /** Refunded amount */
25033
- amount?: PaypalAuthorizationCaptureCreateDataOption1Amount;
24340
+ amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
25034
24341
  /** Invoice identifier */
25035
24342
  invoiceId?: string | null;
25036
24343
  /** Merchant custom ID */
@@ -25102,7 +24409,7 @@ interface PaypalOrderCreateDataOption1PurchaseUnitsItem {
25102
24409
  /** Purchase unit reference ID */
25103
24410
  referenceId?: string | null;
25104
24411
  /** Purchase unit amount */
25105
- amount?: PaypalAuthorizationCaptureCreateDataOption1Amount;
24412
+ amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
25106
24413
  /** Merchant receiving the payment ([] when empty) */
25107
24414
  payee?: Record<string, unknown> | [] | null;
25108
24415
  /** Platform fees and disbursement instructions ([] when empty) */
@@ -25120,7 +24427,7 @@ interface PaypalOrderCreateDataOption1PurchaseUnitsItem {
25120
24427
  /** Card and level 2/3 data ([] when empty) */
25121
24428
  supplementaryData?: Record<string, unknown> | [] | null;
25122
24429
  /** Authorizations, captures and refunds made against the unit */
25123
- payments?: PaypalOrderCreateDataOption1PurchaseUnitsItemPayments;
24430
+ payments?: PaypalOrderCreateDataOption1PurchaseUnitsItemPayments | null;
25124
24431
  [key: string]: unknown;
25125
24432
  }
25126
24433
  /**
@@ -25165,7 +24472,7 @@ interface PaypalOrderCreateDataOption1PayerAddress {
25165
24472
  */
25166
24473
  interface PaypalOrderCreateDataOption1Payer {
25167
24474
  /** Payer name */
25168
- name?: PaypalOrderCreateDataOption1PayerName;
24475
+ name?: PaypalOrderCreateDataOption1PayerName | null;
25169
24476
  /** Payer email address */
25170
24477
  emailAddress?: string | null;
25171
24478
  /** PayPal payer ID (the PayerID PayPal appends to the return URL) */
@@ -25177,7 +24484,7 @@ interface PaypalOrderCreateDataOption1Payer {
25177
24484
  /** Payer tax ID ([] when empty) */
25178
24485
  taxInfo?: Record<string, unknown> | [] | null;
25179
24486
  /** Payer address */
25180
- address?: PaypalOrderCreateDataOption1PayerAddress;
24487
+ address?: PaypalOrderCreateDataOption1PayerAddress | null;
25181
24488
  [key: string]: unknown;
25182
24489
  }
25183
24490
  /**
@@ -25202,7 +24509,7 @@ interface PaypalOrderCreateDataOption1 {
25202
24509
  /** Purchase units, with the payments made against each */
25203
24510
  purchaseUnits?: PaypalOrderCreateDataOption1PurchaseUnitsItem[] | null;
25204
24511
  /** Buyer who approved the order */
25205
- payer?: PaypalOrderCreateDataOption1Payer;
24512
+ payer?: PaypalOrderCreateDataOption1Payer | null;
25206
24513
  /** When the order was created (ISO 8601) */
25207
24514
  createTime?: string | null;
25208
24515
  /** When the order was last updated (ISO 8601) */
@@ -25379,11 +24686,11 @@ interface PaytraceAuthorizationCreateBody {
25379
24686
  /** Dollar amount to authorize */
25380
24687
  amount: number | null;
25381
24688
  /** Card to authorize */
25382
- creditCard: PaytraceAuthorizationCreateBodyCreditCard;
24689
+ creditCard: PaytraceAuthorizationCreateBodyCreditCard | null;
25383
24690
  /** Card security code (3-4 digits) */
25384
24691
  csc?: string | null;
25385
24692
  /** Billing address sent with the authorization */
25386
- billingAddress?: PaytraceAuthorizationCreateBodyBillingAddress;
24693
+ billingAddress?: PaytraceAuthorizationCreateBodyBillingAddress | null;
25387
24694
  /** Invoice identifier */
25388
24695
  invoiceId?: string | null;
25389
24696
  /** true (or the string "true" or "1") uses the PayTrace sandbox; default live */
@@ -26148,9 +25455,10 @@ interface ContextGetDataOption1ServicesItem {
26148
25455
  [key: string]: unknown;
26149
25456
  }
26150
25457
  /**
26151
- * Shape of data nested in ContextGetData (MINIMUM fields; reused wherever the same shape appears)
25458
+ * Get a site configuration context
25459
+ * Response data for GET /context/{siteId} — MINIMUM fields, extras pass through
26152
25460
  *
26153
- * Nested in ContextGetData
25461
+ * Returned by: api.agrInfo.context.get(siteId)
26154
25462
  */
26155
25463
  interface ContextGetDataOption1 {
26156
25464
  /** Site described */
@@ -26167,33 +25475,13 @@ interface ContextGetDataOption1 {
26167
25475
  inactiveServices: string[];
26168
25476
  [key: string]: unknown;
26169
25477
  }
26170
- /**
26171
- * Shape of data nested in ContextGetData (MINIMUM fields; reused wherever the same shape appears)
26172
- *
26173
- * Nested in ContextGetData
26174
- */
26175
- interface ContextGetDataOption2 {
26176
- /** Site described */
26177
- siteId: string;
26178
- /** Site domain; null when the site is not provisioned */
26179
- domain: string | null;
26180
- /** Site row in sites_table (dev port = 3000 + uid); 0 when the site is unknown */
26181
- uid: number;
26182
- /** Services the site is configured for */
26183
- services: string[];
26184
- /** Number of configured services */
26185
- serviceCount: number;
26186
- /** Services the site is not configured for */
26187
- inactiveServices: string[];
26188
- [key: string]: unknown;
26189
- }
26190
25478
  /**
26191
25479
  * Get a site configuration context
26192
25480
  * Response data for GET /context/{siteId} — MINIMUM fields, extras pass through
26193
25481
  *
26194
25482
  * Returned by: api.agrInfo.context.get(siteId)
26195
25483
  */
26196
- type ContextGetData = ContextGetDataOption1 | ContextGetDataOption2;
25484
+ type ContextGetData = ContextGetDataOption1;
26197
25485
  /**
26198
25486
  * Generate Response from joomla
26199
25487
  * Response data for POST /joomla/generate — MINIMUM fields, extras pass through
@@ -26394,6 +25682,96 @@ interface RubricsUpdateBody {
26394
25682
  * Returned by: api.agrInfo.rubrics.delete(rubricsUid)
26395
25683
  */
26396
25684
  type RubricsDeleteData = RubricsListItem;
25685
+ /**
25686
+ * Shape of `user` (MINIMUM fields; reused wherever the same shape appears)
25687
+ * The token's user; null for a site token or a refused caller
25688
+ *
25689
+ * Field `user` of SitesP21ApiCreateData
25690
+ * Field `user` of SitesValidateCreateData
25691
+ */
25692
+ interface SitesValidateCreateDataUser {
25693
+ /** User ID (a Joomla user, or an agr_int user for agr-int-user and client tokens) */
25694
+ userId: number;
25695
+ /** Username */
25696
+ username: string;
25697
+ /** Email address; empty for a client credential */
25698
+ email: string;
25699
+ /** Display name; empty for a client credential */
25700
+ name: string;
25701
+ /** Roles granted to the user ("Super User" for a Joomla super user) */
25702
+ roles: string[];
25703
+ [key: string]: unknown;
25704
+ }
25705
+ /**
25706
+ * Shape of `p21` (MINIMUM fields; reused wherever the same shape appears)
25707
+ * The site's P21 API credentials; null when the caller is refused or the site has no P21 API
25708
+ * configured
25709
+ *
25710
+ * Field `p21` of SitesP21ApiCreateData
25711
+ */
25712
+ interface SitesP21ApiCreateDataP21 {
25713
+ /**
25714
+ * P21 API base URL (https://{host}:{port}); token endpoint is POST
25715
+ * {baseUrl}/api/security/token/v2
25716
+ */
25717
+ baseUrl: string;
25718
+ /** P21 API user name, sent to the token endpoint with the password */
25719
+ username: string;
25720
+ /** P21 API password */
25721
+ password: string;
25722
+ /** P21 consumer key for the token endpoint; null while sites use user credentials */
25723
+ clientSecret: string | null;
25724
+ /** True when the site allows write-back through the P21 API; false until write-back exists */
25725
+ writable: boolean;
25726
+ [key: string]: unknown;
25727
+ }
25728
+ /**
25729
+ * P21 API credentials
25730
+ * Response data for POST /sites/p21-api — MINIMUM fields, extras pass through
25731
+ *
25732
+ * Returned by: api.agrInfo.sites.p21Api.create(data)
25733
+ */
25734
+ interface SitesP21ApiCreateData {
25735
+ /** True when the caller is accepted for the site (validated exactly as POST /sites/validate) */
25736
+ valid: boolean;
25737
+ /** Site the caller was validated against */
25738
+ siteId: string;
25739
+ /** Why the caller was refused, or why p21 is null; empty otherwise */
25740
+ error: string;
25741
+ /** site, user, agr-int-user or client; null when the token did not validate */
25742
+ tokenType: string | null;
25743
+ /** True for a Joomla super user token */
25744
+ isAdmin: boolean;
25745
+ /** The token's user; null for a site token or a refused caller */
25746
+ user: SitesValidateCreateDataUser | null;
25747
+ /**
25748
+ * The site's P21 API credentials; null when the caller is refused or the site has no P21 API
25749
+ * configured
25750
+ */
25751
+ p21: SitesP21ApiCreateDataP21 | null;
25752
+ [key: string]: unknown;
25753
+ }
25754
+ /**
25755
+ * P21 API credentials
25756
+ * Request body for POST /sites/p21-api — MINIMUM fields, extras pass through
25757
+ *
25758
+ * Request body of: api.agrInfo.sites.p21Api.create(data)
25759
+ * Request body of: api.agrInfo.sites.validate.create(data)
25760
+ */
25761
+ interface SitesValidateCreateBody {
25762
+ /** Site the token was issued for */
25763
+ siteId: string;
25764
+ /** JWT, or an agr_int client credential (agrc_...) */
25765
+ token: string;
25766
+ [key: string]: unknown;
25767
+ }
25768
+ /**
25769
+ * P21 API credentials
25770
+ * Request body for POST /sites/p21-api — MINIMUM fields, extras pass through
25771
+ *
25772
+ * Request body of: api.agrInfo.sites.p21Api.create(data)
25773
+ */
25774
+ type SitesP21ApiCreateBody = SitesValidateCreateBody;
26397
25775
  /**
26398
25776
  * Staff token for a target site
26399
25777
  * Response data for POST /sites/staff-token — MINIMUM fields, extras pass through
@@ -26420,25 +25798,6 @@ interface SitesStaffTokenCreateBody {
26420
25798
  siteId: string;
26421
25799
  [key: string]: unknown;
26422
25800
  }
26423
- /**
26424
- * Shape of `user` (MINIMUM fields; reused wherever the same shape appears)
26425
- * The token's user; null for a site token or a failed validation
26426
- *
26427
- * Field `user` of SitesValidateCreateData
26428
- */
26429
- interface SitesValidateCreateDataUser {
26430
- /** User ID (a Joomla user, or an agr_int user for agr-int-user and client tokens) */
26431
- userId: number;
26432
- /** Username */
26433
- username: string;
26434
- /** Email address; empty for a client credential */
26435
- email: string;
26436
- /** Display name; empty for a client credential */
26437
- name: string;
26438
- /** Roles granted to the user ("Super User" for a Joomla super user) */
26439
- roles: string[];
26440
- [key: string]: unknown;
26441
- }
26442
25801
  /**
26443
25802
  * Shape of `connection` (MINIMUM fields; reused wherever the same shape appears)
26444
25803
  * The site's P21 database connection
@@ -26476,24 +25835,11 @@ interface SitesValidateCreateData {
26476
25835
  /** True for a Joomla super user token */
26477
25836
  isAdmin: boolean;
26478
25837
  /** The token's user; null for a site token or a failed validation */
26479
- user: SitesValidateCreateDataUser;
25838
+ user: SitesValidateCreateDataUser | null;
26480
25839
  /** The site's P21 database connection */
26481
25840
  connection: SitesValidateCreateDataConnection;
26482
25841
  [key: string]: unknown;
26483
25842
  }
26484
- /**
26485
- * Validate credentials
26486
- * Request body for POST /sites/validate — MINIMUM fields, extras pass through
26487
- *
26488
- * Request body of: api.agrInfo.sites.validate.create(data)
26489
- */
26490
- interface SitesValidateCreateBody {
26491
- /** Site the token was issued for */
26492
- siteId: string;
26493
- /** JWT, or an agr_int client credential (agrc_...) */
26494
- token: string;
26495
- [key: string]: unknown;
26496
- }
26497
25843
  /**
26498
25844
  * List Workflows
26499
25845
  * Response data for GET /workflows — MINIMUM fields, extras pass through
@@ -26621,6 +25967,7 @@ interface AgrInfoClientSpec {
26621
25967
  *
26622
25968
  * Errors:
26623
25969
  * 400: The body is missing or not a JSON object.
25970
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26624
25971
  *
26625
25972
  * POST https://agr-info.augur-api.com/akasha/generate
26626
25973
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1akasha~1generate/post
@@ -26638,8 +25985,14 @@ interface AgrInfoClientSpec {
26638
25985
  *
26639
25986
  * get the context for a site
26640
25987
  *
25988
+ * Response data: A site's configuration as the admin site (augur_info) sees it: every service
25989
+ * with its full config
25990
+ *
26641
25991
  * Auth: bearer token; spec scopes: none listed (most endpoints list `public`)
26642
25992
  *
25993
+ * Errors:
25994
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
25995
+ *
26643
25996
  * GET https://agr-info.augur-api.com/context/{siteId}
26644
25997
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1context~1{siteId}/get
26645
25998
  *
@@ -26660,6 +26013,7 @@ interface AgrInfoClientSpec {
26660
26013
  *
26661
26014
  * Errors:
26662
26015
  * 400: The body is missing or not a JSON object.
26016
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26663
26017
  *
26664
26018
  * POST https://agr-info.augur-api.com/joomla/generate
26665
26019
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1joomla~1generate/post
@@ -26677,6 +26031,7 @@ interface AgrInfoClientSpec {
26677
26031
  *
26678
26032
  * Errors:
26679
26033
  * 400: orderBy is not column|ASC or column|DESC on a microservices column.
26034
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26680
26035
  *
26681
26036
  * GET https://agr-info.augur-api.com/microservices
26682
26037
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1microservices/get
@@ -26693,6 +26048,7 @@ interface AgrInfoClientSpec {
26693
26048
  *
26694
26049
  * Errors:
26695
26050
  * 400: The body is missing or not a JSON object. Or name is missing.
26051
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26696
26052
  *
26697
26053
  * POST https://agr-info.augur-api.com/microservices
26698
26054
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1microservices/post
@@ -26706,6 +26062,7 @@ interface AgrInfoClientSpec {
26706
26062
  * Call: api.agrInfo.microservices.get(microservicesUid)
26707
26063
  *
26708
26064
  * Errors:
26065
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26709
26066
  * 404: No microservice with this ID.
26710
26067
  *
26711
26068
  * GET https://agr-info.augur-api.com/microservices/{microservicesUid}
@@ -26726,6 +26083,7 @@ interface AgrInfoClientSpec {
26726
26083
  *
26727
26084
  * Errors:
26728
26085
  * 400: The body is missing or not a JSON object.
26086
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26729
26087
  * 404: No microservice with this ID.
26730
26088
  *
26731
26089
  * PUT https://agr-info.augur-api.com/microservices/{microservicesUid}
@@ -26742,6 +26100,7 @@ interface AgrInfoClientSpec {
26742
26100
  * Call: api.agrInfo.microservices.delete(microservicesUid)
26743
26101
  *
26744
26102
  * Errors:
26103
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26745
26104
  * 404: No microservice with this ID.
26746
26105
  *
26747
26106
  * DELETE https://agr-info.augur-api.com/microservices/{microservicesUid}
@@ -26760,6 +26119,7 @@ interface AgrInfoClientSpec {
26760
26119
  *
26761
26120
  * Errors:
26762
26121
  * 400: orderBy is not column|ASC or column|DESC on a rubrics column.
26122
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26763
26123
  *
26764
26124
  * GET https://agr-info.augur-api.com/rubrics
26765
26125
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1rubrics/get
@@ -26777,6 +26137,7 @@ interface AgrInfoClientSpec {
26777
26137
  *
26778
26138
  * Errors:
26779
26139
  * 400: The body is missing or not a JSON object. Or title, id or content is missing.
26140
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26780
26141
  *
26781
26142
  * POST https://agr-info.augur-api.com/rubrics
26782
26143
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1rubrics/post
@@ -26790,6 +26151,7 @@ interface AgrInfoClientSpec {
26790
26151
  * Call: api.agrInfo.rubrics.get(rubricsUid)
26791
26152
  *
26792
26153
  * Errors:
26154
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26793
26155
  * 404: No rubric with this ID.
26794
26156
  *
26795
26157
  * GET https://agr-info.augur-api.com/rubrics/{rubricsUid}
@@ -26808,6 +26170,7 @@ interface AgrInfoClientSpec {
26808
26170
  *
26809
26171
  * Errors:
26810
26172
  * 400: The body is missing or not a JSON object.
26173
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26811
26174
  * 404: No rubric with this ID.
26812
26175
  *
26813
26176
  * PUT https://agr-info.augur-api.com/rubrics/{rubricsUid}
@@ -26823,6 +26186,7 @@ interface AgrInfoClientSpec {
26823
26186
  * Call: api.agrInfo.rubrics.delete(rubricsUid)
26824
26187
  *
26825
26188
  * Errors:
26189
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26826
26190
  * 404: No rubric with this ID.
26827
26191
  *
26828
26192
  * DELETE https://agr-info.augur-api.com/rubrics/{rubricsUid}
@@ -26834,6 +26198,32 @@ interface AgrInfoClientSpec {
26834
26198
  delete: (rubricsUid: number) => Promise<BaseResponse$1<RubricsDeleteData>>;
26835
26199
  };
26836
26200
  sites: {
26201
+ p21Api: {
26202
+ /**
26203
+ * P21 API credentials
26204
+ * Call: api.agrInfo.sites.p21Api.create(data)
26205
+ *
26206
+ * Validate a caller for a site exactly as POST /sites/validate does, and return the site's
26207
+ * Prophet 21 API (middleware) credentials instead of the SQL connection. An accepted caller
26208
+ * is valid even when the site has no P21 API configured (p21 null). Sent with Cache-Control:
26209
+ * private, no-store
26210
+ *
26211
+ * Request body: Validate a site's token or client credential
26212
+ * Response data: Result of validating a caller for a site, with the site's Prophet 21 API
26213
+ * (middleware) credentials; never the SQL connection
26214
+ *
26215
+ * Errors:
26216
+ * 400: The body is missing or not a JSON object. Or siteId or token is missing.
26217
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26218
+ *
26219
+ * POST https://agr-info.augur-api.com/sites/p21-api
26220
+ * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1sites~1p21-api/post
26221
+ *
26222
+ * @param data SitesP21ApiCreateBody (request body)
26223
+ * @returns BaseResponse whose `data` is SitesP21ApiCreateData
26224
+ */
26225
+ create: (data: SitesP21ApiCreateBody) => Promise<BaseResponse$1<SitesP21ApiCreateData>>;
26226
+ };
26837
26227
  staffToken: {
26838
26228
  /**
26839
26229
  * Staff token for a target site
@@ -26852,6 +26242,8 @@ interface AgrInfoClientSpec {
26852
26242
  * or the target site has no unblocked Super User with the same username and email
26853
26243
  * (case-insensitive).
26854
26244
  * 404: The target siteId is not a known site.
26245
+ * 503: A site database or service did not respond while checking the caller, the target
26246
+ * site or its mirror account, or while issuing the token. Retryable.
26855
26247
  *
26856
26248
  * POST https://agr-info.augur-api.com/sites/staff-token
26857
26249
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1sites~1staff-token/post
@@ -26874,6 +26266,7 @@ interface AgrInfoClientSpec {
26874
26266
  *
26875
26267
  * Errors:
26876
26268
  * 400: The body is missing or not a JSON object. Or siteId or token is missing.
26269
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26877
26270
  *
26878
26271
  * POST https://agr-info.augur-api.com/sites/validate
26879
26272
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1sites~1validate/post
@@ -26891,6 +26284,7 @@ interface AgrInfoClientSpec {
26891
26284
  *
26892
26285
  * Errors:
26893
26286
  * 400: orderBy is not column|ASC or column|DESC on a workflows column.
26287
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26894
26288
  *
26895
26289
  * GET https://agr-info.augur-api.com/workflows
26896
26290
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1workflows/get
@@ -26907,6 +26301,7 @@ interface AgrInfoClientSpec {
26907
26301
  *
26908
26302
  * Errors:
26909
26303
  * 400: The body is missing or not a JSON object. Or title or workflow is missing.
26304
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26910
26305
  *
26911
26306
  * POST https://agr-info.augur-api.com/workflows
26912
26307
  * Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1workflows/post
@@ -26920,6 +26315,7 @@ interface AgrInfoClientSpec {
26920
26315
  * Call: api.agrInfo.workflows.get(workflowsUid)
26921
26316
  *
26922
26317
  * Errors:
26318
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26923
26319
  * 404: No workflow with this ID.
26924
26320
  *
26925
26321
  * GET https://agr-info.augur-api.com/workflows/{workflowsUid}
@@ -26938,6 +26334,7 @@ interface AgrInfoClientSpec {
26938
26334
  *
26939
26335
  * Errors:
26940
26336
  * 400: The body is missing or not a JSON object.
26337
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26941
26338
  * 404: No workflow with this ID.
26942
26339
  *
26943
26340
  * PUT https://agr-info.augur-api.com/workflows/{workflowsUid}
@@ -26953,6 +26350,7 @@ interface AgrInfoClientSpec {
26953
26350
  * Call: api.agrInfo.workflows.delete(workflowsUid)
26954
26351
  *
26955
26352
  * Errors:
26353
+ * 403: x-site-id is not augur_info: agr_info serves only the augur_info site.
26956
26354
  * 404: No workflow with this ID.
26957
26355
  *
26958
26356
  * DELETE https://agr-info.augur-api.com/workflows/{workflowsUid}
@@ -26972,7 +26370,6 @@ type types$c_AkashaGenerateCreateData = AkashaGenerateCreateData;
26972
26370
  type types$c_ContextGetData = ContextGetData;
26973
26371
  type types$c_ContextGetDataOption1 = ContextGetDataOption1;
26974
26372
  type types$c_ContextGetDataOption1ServicesItem = ContextGetDataOption1ServicesItem;
26975
- type types$c_ContextGetDataOption2 = ContextGetDataOption2;
26976
26373
  type types$c_ContextGetParams = ContextGetParams;
26977
26374
  type types$c_JoomlaGenerateCreateBody = JoomlaGenerateCreateBody;
26978
26375
  type types$c_JoomlaGenerateCreateData = JoomlaGenerateCreateData;
@@ -26996,6 +26393,9 @@ type types$c_RubricsListItem = RubricsListItem;
26996
26393
  type types$c_RubricsListParams = RubricsListParams;
26997
26394
  type types$c_RubricsUpdateBody = RubricsUpdateBody;
26998
26395
  type types$c_RubricsUpdateData = RubricsUpdateData;
26396
+ type types$c_SitesP21ApiCreateBody = SitesP21ApiCreateBody;
26397
+ type types$c_SitesP21ApiCreateData = SitesP21ApiCreateData;
26398
+ type types$c_SitesP21ApiCreateDataP21 = SitesP21ApiCreateDataP21;
26999
26399
  type types$c_SitesStaffTokenCreateBody = SitesStaffTokenCreateBody;
27000
26400
  type types$c_SitesStaffTokenCreateData = SitesStaffTokenCreateData;
27001
26401
  type types$c_SitesValidateCreateBody = SitesValidateCreateBody;
@@ -27013,7 +26413,7 @@ type types$c_WorkflowsListParams = WorkflowsListParams;
27013
26413
  type types$c_WorkflowsUpdateBody = WorkflowsUpdateBody;
27014
26414
  type types$c_WorkflowsUpdateData = WorkflowsUpdateData;
27015
26415
  declare namespace types$c {
27016
- 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_ContextGetDataOption2 as ContextGetDataOption2, 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_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 };
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 };
27017
26417
  }
27018
26418
 
27019
26419
  /**
@@ -27053,6 +26453,7 @@ declare namespace types$c {
27053
26453
  * GET /rubrics/{rubricsUid} → api.agrInfo.rubrics.get(rubricsUid) → RubricsGetData
27054
26454
  * PUT /rubrics/{rubricsUid} → api.agrInfo.rubrics.update(rubricsUid, data) → RubricsUpdateData
27055
26455
  * DELETE /rubrics/{rubricsUid} → api.agrInfo.rubrics.delete(rubricsUid) → RubricsDeleteData
26456
+ * POST /sites/p21-api → api.agrInfo.sites.p21Api.create(data) → SitesP21ApiCreateData
27056
26457
  * POST /sites/staff-token → api.agrInfo.sites.staffToken.create(data) → SitesStaffTokenCreateData
27057
26458
  * POST /sites/validate → api.agrInfo.sites.validate.create(data) → SitesValidateCreateData
27058
26459
  * GET /workflows → api.agrInfo.workflows.list(params) → WorkflowsListData
@@ -27085,7 +26486,8 @@ declare class AgrInfoClient extends BaseServiceClient {
27085
26486
 
27086
26487
  /**
27087
26488
  * Generated types for the agr-int service.
27088
- * agr_int
26489
+ * Access control for Augur API users and clients: users, roles, bundles, resources, per-user table
26490
+ * access grants, and client credentials
27089
26491
  *
27090
26492
  * Public specs (the source of truth for every shape below):
27091
26493
  * https://agr-int.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
@@ -27533,25 +26935,25 @@ type ClientsListData = ClientsListItem[];
27533
26935
  */
27534
26936
  interface ClientsCreateData {
27535
26937
  /** Client credential unique ID; 0 when issuing failed */
27536
- clientsUid?: number;
26938
+ clientsUid: number;
27537
26939
  /** Public client identifier (agrc_ prefix) */
27538
- clientId?: string;
26940
+ clientId: string;
27539
26941
  /** agr_int user the credential acts as */
27540
- usersUid?: number;
26942
+ usersUid: number;
27541
26943
  /** Site secret key version the client_id was issued under */
27542
- keyVersion?: number;
26944
+ keyVersion: number;
27543
26945
  /** Admin-facing label, e.g. the connector name */
27544
- clientName?: string;
26946
+ clientName: string;
27545
26947
  /** Admin-facing notes */
27546
- description?: string | null;
26948
+ description: string | null;
27547
26949
  /** ID of the admin who issued the credential; null when issued from the CLI */
27548
- issuedById?: number | null;
26950
+ issuedById: number | null;
27549
26951
  /** Username of the admin who issued the credential */
27550
- issuedByUsername?: string | null;
26952
+ issuedByUsername: string | null;
27551
26953
  /** Status code: 704 = Active */
27552
- statusCd?: number;
26954
+ statusCd: number;
27553
26955
  /** Full bearer string agrc_<clientId>.<secret><crc32> */
27554
- credential?: string;
26956
+ credential: string;
27555
26957
  [key: string]: unknown;
27556
26958
  }
27557
26959
  /**
@@ -27580,25 +26982,25 @@ interface ClientsCreateBody {
27580
26982
  */
27581
26983
  interface ClientsValidateCreateData {
27582
26984
  /** True only when the credential decrypts, matches, and its client and user are ACTIVE */
27583
- valid?: boolean;
26985
+ valid: boolean;
27584
26986
  /** Site decrypted from the client_id; consumers MUST scope the connection to it */
27585
- siteId?: string;
26987
+ siteId: string;
27586
26988
  /** Always "client" for a valid credential */
27587
- tokenUse?: string;
26989
+ tokenUse: string;
27588
26990
  /** Client credential unique ID */
27589
- clientUid?: number;
26991
+ clientUid: number;
27590
26992
  /** Public client identifier (agrc_ prefix) */
27591
- clientId?: string;
26993
+ clientId: string;
27592
26994
  /** agr_int user the credential acts as */
27593
- usersUid?: number;
26995
+ usersUid: number;
27594
26996
  /** Username of that user */
27595
- username?: string;
26997
+ username: string;
27596
26998
  /** Active role ids the owning user holds */
27597
- roles?: string[];
26999
+ roles: string[];
27598
27000
  /** Active bundle ids granted through those roles */
27599
- bundles?: string[];
27001
+ bundles: string[];
27600
27002
  /** P21 table set (resources.resource_path) the credential may query */
27601
- resources?: string[];
27003
+ resources: string[];
27602
27004
  [key: string]: unknown;
27603
27005
  }
27604
27006
  /**
@@ -27626,41 +27028,41 @@ interface ClientsValidateCreateBody {
27626
27028
  */
27627
27029
  interface ClientsGetData {
27628
27030
  /** Client credential unique ID */
27629
- clientsUid?: number;
27031
+ clientsUid: number;
27630
27032
  /** Public client identifier (agrc_ prefix) */
27631
- clientId?: string;
27033
+ clientId: string;
27632
27034
  /** Re-derived 43-char client secret; '' when the credential is not revealable */
27633
- clientSecret?: string;
27035
+ clientSecret: string;
27634
27036
  /** agr_int user the credential acts as */
27635
- usersUid?: number;
27037
+ usersUid: number;
27636
27038
  /** Site secret key version the client_id was issued under */
27637
- keyVersion?: number;
27039
+ keyVersion: number;
27638
27040
  /** Admin-facing label, e.g. the connector name */
27639
- clientName?: string;
27041
+ clientName: string;
27640
27042
  /** Admin-facing notes */
27641
- description?: string | null;
27043
+ description: string | null;
27642
27044
  /** ID of the admin who issued the credential; null when issued from the CLI */
27643
- issuedById?: number | null;
27045
+ issuedById: number | null;
27644
27046
  /** Username of the admin who issued the credential */
27645
- issuedByUsername?: string | null;
27047
+ issuedByUsername: string | null;
27646
27048
  /** ID of the admin who retired the credential; null while active */
27647
- retiredById?: number | null;
27049
+ retiredById: number | null;
27648
27050
  /** Username of the admin who retired the credential */
27649
- retiredByUsername?: string | null;
27051
+ retiredByUsername: string | null;
27650
27052
  /** When the credential last authenticated (Y-m-d H:i:s); null if never used */
27651
- dateLastUsed?: string | null;
27053
+ dateLastUsed: string | null;
27652
27054
  /** When the credential was issued (Y-m-d H:i:s) */
27653
- dateCreated?: string;
27055
+ dateCreated: string;
27654
27056
  /** When the credential was last modified (Y-m-d H:i:s) */
27655
- dateLastModified?: string;
27057
+ dateLastModified: string;
27656
27058
  /** Update code (1185 = Import Complete) */
27657
- updateCd?: number;
27059
+ updateCd: number;
27658
27060
  /** Status code: 704 = Active, 705 = Inactive, 700 = Retired */
27659
- statusCd?: number;
27061
+ statusCd: number;
27660
27062
  /** Process code */
27661
- processCd?: number;
27063
+ processCd: number;
27662
27064
  /** Full bearer string agrc_<clientId>.<secret><crc32>; '' when not revealable */
27663
- credential?: string;
27065
+ credential: string;
27664
27066
  [key: string]: unknown;
27665
27067
  }
27666
27068
  /**
@@ -28015,7 +27417,7 @@ interface UsersRotateCreateData {
28015
27417
  /** Username; '' on failure */
28016
27418
  username: string;
28017
27419
  /** Signed access JWT (scope agr-int-user) to present as a bearer; '' on failure */
28018
- token?: string;
27420
+ token: string;
28019
27421
  [key: string]: unknown;
28020
27422
  }
28021
27423
  /**
@@ -28040,23 +27442,23 @@ interface UsersRotateCreateBody {
28040
27442
  */
28041
27443
  interface UsersValidateCreateData {
28042
27444
  /** True only when the token verifies, has scope agr-int-user, and its user is ACTIVE */
28043
- valid?: boolean;
27445
+ valid: boolean;
28044
27446
  /** Token scope; consumers MUST authorize on this, not on userId */
28045
- scope?: string;
27447
+ scope: string;
28046
27448
  /** agr_int user unique ID (users_uid) */
28047
- userId?: number;
27449
+ userId: number;
28048
27450
  /** Username, refreshed from the user row */
28049
- username?: string;
27451
+ username: string;
28050
27452
  /** Email address, refreshed from the user row */
28051
- email?: string;
27453
+ email: string;
28052
27454
  /** Display name, refreshed from the user row */
28053
- name?: string;
27455
+ name: string;
28054
27456
  /** Active role ids the user holds */
28055
- roles?: string[];
27457
+ roles: string[];
28056
27458
  /** Active bundle ids granted through those roles */
28057
- bundles?: string[];
27459
+ bundles: string[];
28058
27460
  /** P21 table set (resources.resource_path) the user may query */
28059
- resources?: string[];
27461
+ resources: string[];
28060
27462
  [key: string]: unknown;
28061
27463
  }
28062
27464
  /**
@@ -29145,7 +28547,8 @@ declare namespace types$b {
29145
28547
 
29146
28548
  /**
29147
28549
  * Generated client for the agr-int service.
29148
- * agr_int
28550
+ * Access control for Augur API users and clients: users, roles, bundles, resources, per-user table
28551
+ * access grants, and client credentials
29149
28552
  *
29150
28553
  * Public specs (the source of truth for every shape below):
29151
28554
  * https://agr-int.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
@@ -29338,7 +28741,7 @@ interface RatesCreateBodyItemsItem {
29338
28741
  */
29339
28742
  interface RatesCreateBody$1 {
29340
28743
  /** Ship-to address */
29341
- address: RatesCreateBodyAddress;
28744
+ address: RatesCreateBodyAddress | null;
29342
28745
  /** Order lines to tax */
29343
28746
  items: RatesCreateBodyItemsItem[];
29344
28747
  [key: string]: unknown;
@@ -31562,7 +30965,7 @@ interface LocationListItem {
31562
30965
  /** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
31563
30966
  updateCd: number;
31564
30967
  /** The location's address; the key is absent unless includeAddress=Y */
31565
- address?: AddressListItem;
30968
+ address?: AddressListItem | null;
31566
30969
  [key: string]: unknown;
31567
30970
  }
31568
30971
  /** Returned by: api.p21Core.location.list(params) */
@@ -32675,7 +32078,7 @@ interface ScheduledImportMasterMetadataCreateBody {
32675
32078
  * FTP/SFTP connection; all five fields are required for ftp and sftp; pending_import does not
32676
32079
  * read them
32677
32080
  */
32678
- properties?: ScheduledImportMasterMetadataSftpCreateBody;
32081
+ properties?: ScheduledImportMasterMetadataSftpCreateBody | null;
32679
32082
  [key: string]: unknown;
32680
32083
  }
32681
32084
  /**
@@ -32754,7 +32157,7 @@ interface ScheduledImportMetadataUpdateBody {
32754
32157
  /** New delivery method: pending_import, ftp or sftp; any casing */
32755
32158
  deliveryMethod?: string | null;
32756
32159
  /** New FTP/SFTP connection; replaces the stored properties as a whole */
32757
- properties?: ScheduledImportMasterMetadataSftpCreateBody;
32160
+ properties?: ScheduledImportMasterMetadataSftpCreateBody | null;
32758
32161
  [key: string]: unknown;
32759
32162
  }
32760
32163
  /**
@@ -33469,85 +32872,85 @@ interface UsLookupGetParams extends EdgeCacheParams {
33469
32872
  */
33470
32873
  interface UsLookupGetData {
33471
32874
  /** Recipient or firm name on the matched address */
33472
- addressee?: string | null;
32875
+ addressee: string | null;
33473
32876
  /** Y when the match defaulted to the building rather than a unit */
33474
- buildingDefaultIndicator?: string | null;
32877
+ buildingDefaultIndicator: string | null;
33475
32878
  /** USPS carrier route code */
33476
- carrierRoute?: string | null;
32879
+ carrierRoute: string | null;
33477
32880
  /** USPS preferred city name */
33478
- cityName?: string | null;
32881
+ cityName: string | null;
33479
32882
  /** Congressional district number */
33480
- congressionalDistrict?: string | null;
32883
+ congressionalDistrict: string | null;
33481
32884
  /** USPS default city name for the ZIP code */
33482
- defaultCityName?: string | null;
32885
+ defaultCityName: string | null;
33483
32886
  /** Standardized first delivery line */
33484
- deliveryLine1?: string | null;
32887
+ deliveryLine1: string | null;
33485
32888
  /** Standardized second delivery line */
33486
- deliveryLine2?: string | null;
32889
+ deliveryLine2: string | null;
33487
32890
  /** Two-digit USPS delivery point */
33488
- deliveryPoint?: string | null;
32891
+ deliveryPoint: string | null;
33489
32892
  /** Full USPS delivery point barcode */
33490
- deliveryPointBarcode?: string | null;
32893
+ deliveryPointBarcode: string | null;
33491
32894
  /** Delivery point check digit */
33492
- deliveryPointCheckDigit?: string | null;
32895
+ deliveryPointCheckDigit: string | null;
33493
32896
  /** eLOT sequence number */
33494
- elotSequence?: string | null;
32897
+ elotSequence: string | null;
33495
32898
  /** eLOT sort: A (ascending) or D (descending) */
33496
- elotSort?: string | null;
32899
+ elotSort: string | null;
33497
32900
  /** Extra secondary designator, e.g. Ste */
33498
- extraSecondaryDesignator?: string | null;
32901
+ extraSecondaryDesignator: string | null;
33499
32902
  /** Extra secondary number */
33500
- extraSecondaryNumber?: string | null;
32903
+ extraSecondaryNumber: string | null;
33501
32904
  /** Caller-supplied input ID echoed back */
33502
- inputId?: string | null;
32905
+ inputId: string | null;
33503
32906
  /** True when the address is on the USPS Early Warning System list */
33504
- isEwsMatch?: boolean | null;
32907
+ isEwsMatch: boolean | null;
33505
32908
  /** Standardized city, state and ZIP line */
33506
- lastLine?: string | null;
32909
+ lastLine: string | null;
33507
32910
  /** Latitude of the matched address */
33508
- latitude?: number | null;
32911
+ latitude: number | null;
33509
32912
  /** Longitude of the matched address */
33510
- longitude?: number | null;
32913
+ longitude: number | null;
33511
32914
  /** True when the address observes daylight saving time */
33512
- obeyDst?: boolean | null;
32915
+ obeyDst: boolean | null;
33513
32916
  /** ZIP+4 add-on code */
33514
- plus4Code?: string | null;
32917
+ plus4Code: string | null;
33515
32918
  /** Private mailbox designator */
33516
- pmbDesignator?: string | null;
32919
+ pmbDesignator: string | null;
33517
32920
  /** Private mailbox number */
33518
- pmbNumber?: string | null;
32921
+ pmbNumber: string | null;
33519
32922
  /** Geocode precision, e.g. Zip9 */
33520
- precision?: string | null;
32923
+ precision: string | null;
33521
32924
  /** House or building number */
33522
- primaryNumber?: string | null;
32925
+ primaryNumber: string | null;
33523
32926
  /** Residential Delivery Indicator: Residential or Commercial */
33524
- rdi?: string | null;
32927
+ rdi: string | null;
33525
32928
  /** USPS record type, e.g. S (street) or H (highrise) */
33526
- recordType?: string | null;
32929
+ recordType: string | null;
33527
32930
  /** Secondary unit designator, e.g. Apt */
33528
- secondaryDesignator?: string | null;
32931
+ secondaryDesignator: string | null;
33529
32932
  /** Secondary unit number */
33530
- secondaryNumber?: string | null;
32933
+ secondaryNumber: string | null;
33531
32934
  /** Two-letter state abbreviation */
33532
- stateAbbreviation?: string | null;
32935
+ stateAbbreviation: string | null;
33533
32936
  /** Street name */
33534
- streetName?: string | null;
32937
+ streetName: string | null;
33535
32938
  /** Street post-direction, e.g. N */
33536
- streetPostDirection?: string | null;
32939
+ streetPostDirection: string | null;
33537
32940
  /** Street pre-direction, e.g. N */
33538
- streetPreDirection?: string | null;
32941
+ streetPreDirection: string | null;
33539
32942
  /** Street suffix, e.g. St */
33540
- streetSuffix?: string | null;
32943
+ streetSuffix: string | null;
33541
32944
  /** Time zone name, e.g. Eastern */
33542
- timeZone?: string | null;
32945
+ timeZone: string | null;
33543
32946
  /** Puerto Rico urbanization name */
33544
- urbanization?: string | null;
32947
+ urbanization: string | null;
33545
32948
  /** Hours offset from UTC */
33546
- utcOffset?: number | null;
32949
+ utcOffset: number | null;
33547
32950
  /** Five-digit ZIP code */
33548
- zipCode?: string | null;
32951
+ zipCode: string | null;
33549
32952
  /** ZIP code type, e.g. Standard or POBox */
33550
- zipType?: string | null;
32953
+ zipType: string | null;
33551
32954
  [key: string]: unknown;
33552
32955
  }
33553
32956
  interface SmartyStreetsClientSpec {
@@ -33560,6 +32963,9 @@ interface SmartyStreetsClientSpec {
33560
32963
  * Response data: Best US street match for the queried address; fields Smarty does not return
33561
32964
  * are null
33562
32965
  *
32966
+ * Errors:
32967
+ * 404: No US address matched the lookup.
32968
+ *
33563
32969
  * GET https://smarty-streets.augur-api.com/us/lookup
33564
32970
  * Contract: https://smarty-streets.augur-api.com/openapi.json#/paths/~1us~1lookup/get
33565
32971
  *
@@ -35918,4 +35324,4 @@ declare class AugurAPI {
35918
35324
  private calculateMultiWordMatches;
35919
35325
  }
35920
35326
 
35921
- export { types$e as $, AugurAPI as A, type BaseResponse$1 as B, type CallArgs as C, type DiscoveryEndpoint as D, type EndpointEntry as E, type Envelope as F, GregorovichClient as G, types$8 as H, type HealthCheckData as I, HealthCheckDataSchema as J, ItemsClient as K, types$j as L, JoomlaClient as M, types$o as N, LegacyClient as O, types$i as P, LogisticsClient as Q, types$7 as R, OpenSearchClient as S, types$k as T, OrdersClient as U, types$f as V, P21ApisClient as W, types$6 as X, P21CoreClient as Y, types$5 as Z, P21PimClient as _, AgrInfoClient as a, P21SismClient as a0, types$4 as a1, PaginationParamsSchema as a2, PaymentsClient as a3, types$d as a4, type PingData as a5, PricingClient as a6, types$m as a7, type RequestConfig as a8, type ServiceMap as a9, ShippingClient as aa, types$3 as ab, SmartyStreetsClient as ac, types$2 as ad, UPSClient as ae, types$1 as af, VMIClient as ag, types$l as ah, type WhoamiData as ai, WhoamiDataSchema as aj, AgrIntClient as b, types$b as c, AgrSiteClient as d, types$h as e, AgrWorkClient as f, type AugurAPIConfig as g, type AugurContext as h, type AugurRequestConfig as i, type AugurRequestError as j, type AugurResponse as k, AvalaraClient as l, types$a as m, BaseResponseSchema as n, Basecamp2Client as o, types as p, BrandFolderClient as q, types$9 as r, type CallResult as s, types$c as t, CommerceClient as u, types$n as v, ContextCreationError as w, CustomersClient as x, types$g as y, type EndpointSearchResult as z };
35327
+ export { P21PimClient as $, AugurAPI as A, type BaseResponse$1 as B, type CallArgs as C, type DiscoveryEndpoint as D, type EndpointEntry as E, type Envelope as F, GregorovichClient as G, types$8 as H, type HealthCheckData as I, HealthCheckDataSchema as J, ItemsClient as K, types$j as L, JoomlaClient as M, types$o as N, type Known as O, LegacyClient as P, types$i as Q, LogisticsClient as R, types$7 as S, OpenSearchClient as T, types$k as U, OrdersClient as V, types$f as W, P21ApisClient as X, types$6 as Y, P21CoreClient as Z, types$5 as _, AgrInfoClient as a, types$e as a0, P21SismClient as a1, types$4 as a2, PaginationParamsSchema as a3, PaymentsClient as a4, types$d as a5, type PingData as a6, PricingClient as a7, types$m as a8, type RequestConfig as a9, type ServiceMap as aa, ShippingClient as ab, types$3 as ac, SmartyStreetsClient as ad, types$2 as ae, UPSClient as af, types$1 as ag, VMIClient as ah, types$l as ai, type WhoamiData as aj, WhoamiDataSchema as ak, AgrIntClient as b, types$b as c, AgrSiteClient as d, types$h as e, AgrWorkClient as f, type AugurAPIConfig as g, type AugurContext as h, type AugurRequestConfig as i, type AugurRequestError as j, type AugurResponse as k, AvalaraClient as l, types$a as m, BaseResponseSchema as n, Basecamp2Client as o, types as p, BrandFolderClient as q, types$9 as r, type CallResult as s, types$c as t, CommerceClient as u, types$n as v, ContextCreationError as w, CustomersClient as x, types$g as y, type EndpointSearchResult as z };