@simpleapps-com/augur-api 2026.10.6 → 2026.10.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1165,7 +1165,7 @@ interface UsersListItemShipToItem {
1165
1165
  /** Shipping route description */
1166
1166
  routeDescription: string | null;
1167
1167
  /** The ship-to's address; null when no address row matches */
1168
- address: UsersListItemShipToItemAddress;
1168
+ address: UsersListItemShipToItemAddress | null;
1169
1169
  [key: string]: unknown;
1170
1170
  }
1171
1171
  /**
@@ -1265,7 +1265,7 @@ interface UsersVerifyPasswordCreateData {
1265
1265
  /** Username sent */
1266
1266
  username: string;
1267
1267
  /** User JWT; false when the password did not match */
1268
- token: string | boolean;
1268
+ token: string | false;
1269
1269
  /** Email address; empty when the password did not match */
1270
1270
  email: string;
1271
1271
  /** True when the user's profile has a Prophet 21 customer ID */
@@ -1521,14 +1521,14 @@ interface UsersTrinityListDataP21Role {
1521
1521
  interface UsersTrinityListData {
1522
1522
  /** Account fields and profile values */
1523
1523
  profile: UsersTrinityListDataProfile;
1524
- /** Prophet 21 contact role; the key is absent when the user has no contact ID */
1525
- p21Role: UsersTrinityListDataP21Role;
1526
1524
  /** User groups the user belongs to */
1527
1525
  groups: UsersListItemGroupsItem[];
1528
1526
  /** trinitysurfaces, trinitytile, or empty when neither matches */
1529
1527
  territory: string;
1530
1528
  /** A&D, contractor, or empty */
1531
1529
  role: string;
1530
+ /** Prophet 21 contact role; the key is absent when the user has no contact ID */
1531
+ p21Role?: UsersTrinityListDataP21Role | null;
1532
1532
  [key: string]: unknown;
1533
1533
  }
1534
1534
  interface JoomlaClientSpec {
@@ -2673,21 +2673,21 @@ interface CartHdrAlsoBoughtListItem {
2673
2673
  /** Descriptions in other languages */
2674
2674
  languages: CartHdrAlsoBoughtListItemLanguagesItem[];
2675
2675
  /** Brandfolder assets (trinitysurfaces only) */
2676
- brandFolder?: CartHdrAlsoBoughtListItemBrandFolder;
2676
+ brandFolder?: CartHdrAlsoBoughtListItemBrandFolder | null;
2677
2677
  /** Category trees for the item's non-root categories (trinitysurfaces only) */
2678
2678
  docCatTrees?: Array<number[]> | null;
2679
2679
  /** Product collection of the item's category under root 3 (trinitysurfaces only) */
2680
2680
  productCollection?: string | null;
2681
2681
  /** Leaf category under root 3, or false (trinitysurfaces only) */
2682
- tsItemCategoryUid?: number | boolean | null;
2682
+ tsItemCategoryUid?: number | null | false;
2683
2683
  /** Leaf category under root 5, or false (trinitysurfaces only) */
2684
- ttItemCategoryUid?: number | boolean | null;
2684
+ ttItemCategoryUid?: number | null | false;
2685
2685
  /** True when the trim user-defined field is Y (trinitysurfaces only) */
2686
2686
  trim?: boolean | null;
2687
2687
  /** Full-sized sample item, or false (trinitysurfaces only) */
2688
- fullSizedSamples?: CartHdrAlsoBoughtListItemFullSizedSamplesOption1 | boolean | null;
2688
+ fullSizedSamples?: CartHdrAlsoBoughtListItemFullSizedSamplesOption1 | null | false;
2689
2689
  /** Swatch sample item, or false (trinitysurfaces only) */
2690
- swatchSample?: CartHdrAlsoBoughtListItemFullSizedSamplesOption1 | boolean | null;
2690
+ swatchSample?: CartHdrAlsoBoughtListItemFullSizedSamplesOption1 | null | false;
2691
2691
  /** Variant group the item belongs to */
2692
2692
  itemVariantHdrUid?: number | null;
2693
2693
  /** List price 1 (only with includePricing=Y) */
@@ -2873,7 +2873,7 @@ interface CheckoutCreateBody {
2873
2873
  /** Alias of oeLine */
2874
2874
  lines?: Array<Record<string, unknown>> | null;
2875
2875
  /** Order-level note */
2876
- notes?: CheckoutCreateBodyNotes;
2876
+ notes?: CheckoutCreateBodyNotes | null;
2877
2877
  /** Order notepad entries, passed through to the import as sent */
2878
2878
  oeHdrNotepad?: unknown;
2879
2879
  /** Alias of oeHdrNotepad */
@@ -3416,8 +3416,11 @@ interface WebPricingListParams extends EdgeCacheParams {
3416
3416
  offset?: number;
3417
3417
  /** Order By (Default: web_pricing_uid|ASC) */
3418
3418
  orderBy?: string;
3419
- /** Status Code (status_cd) [(704)|(705)|(700)] */
3420
- statusCd?: number;
3419
+ /**
3420
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
3421
+ * (704,705); -1 for every status. Default: 704
3422
+ */
3423
+ statusCd?: number | number[];
3421
3424
  }
3422
3425
  /** Params for GET /web-pricing/{webPricingUid} */
3423
3426
  type WebPricingGetParams = EdgeCacheParams;
@@ -3429,8 +3432,11 @@ interface WebPricingCustomersListParams extends EdgeCacheParams {
3429
3432
  offset?: number;
3430
3433
  /** Order By (Default: web_pricing_x_customer_uid|ASC) */
3431
3434
  orderBy?: string;
3432
- /** Status Code (status_cd) [(704)|(705)|(700)] */
3433
- statusCd?: number;
3435
+ /**
3436
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
3437
+ * (704,705); -1 for every status. Default: 704
3438
+ */
3439
+ statusCd?: number | number[];
3434
3440
  }
3435
3441
  /** Params for GET /web-pricing/{webPricingUid}/customers/{customerId} */
3436
3442
  type WebPricingCustomersGetParams = EdgeCacheParams;
@@ -3663,7 +3669,7 @@ interface PriceEngineListDataCustomer {
3663
3669
  /** True when the customer was found */
3664
3670
  valid: boolean;
3665
3671
  /** Customer's source price code, or false when none is set */
3666
- sourcePriceCd: number | boolean;
3672
+ sourcePriceCd: number | false;
3667
3673
  /** Description of the source price code */
3668
3674
  sourcePriceDesc: string | null;
3669
3675
  /** Customer's pricing method code (211 Multiplier, 234 Libraries) */
@@ -3703,7 +3709,7 @@ interface PriceEngineListDataItem {
3703
3709
  }
3704
3710
  /**
3705
3711
  * Shape of `breaks` (MINIMUM fields; reused wherever the same shape appears)
3706
- * Quantity break tiers of the matched page
3712
+ * Quantity break tiers of the matched page, lowest quantity first
3707
3713
  *
3708
3714
  * Field `breaks` of PriceEngineListDataLibraryPriceDataOption1
3709
3715
  */
@@ -3717,7 +3723,7 @@ interface PriceEngineListDataLibraryPriceDataOption1BreaksItem {
3717
3723
  /** Last quantity this tier applies to, or null when open-ended */
3718
3724
  endQuantity: number | null;
3719
3725
  /** Unit price at this tier, or false when it could not be calculated */
3720
- unitPrice: number | boolean;
3726
+ unitPrice: number | false;
3721
3727
  [key: string]: unknown;
3722
3728
  }
3723
3729
  /**
@@ -3728,9 +3734,9 @@ interface PriceEngineListDataLibraryPriceDataOption1BreaksItem {
3728
3734
  */
3729
3735
  interface PriceEngineListDataLibraryPriceDataOption1 {
3730
3736
  /** Unit price in the requested unit of measure, or false when no page produced a price */
3731
- unitPrice: number | boolean;
3737
+ unitPrice: number | false;
3732
3738
  /** Source price the page calculation started from */
3733
- sourcePrice: number | boolean | null;
3739
+ sourcePrice: number | null | false;
3734
3740
  /** Quantity used to select the break tier */
3735
3741
  quantity: number;
3736
3742
  /** Price page UID that matched */
@@ -3793,40 +3799,40 @@ interface PriceEngineListDataLibraryPriceDataOption1 {
3793
3799
  baseUnitSize: number | null;
3794
3800
  /** Calculation value applied for the quantity (multiplier or markup percent) */
3795
3801
  multiplier: number;
3796
- /** Quantity break tiers of the matched page */
3802
+ /** Quantity break tiers of the matched page, lowest quantity first */
3797
3803
  breaks: PriceEngineListDataLibraryPriceDataOption1BreaksItem[];
3798
3804
  /** Base size the source price is divided by, set when the calculation runs */
3799
- baseSize?: number | null;
3805
+ baseSize: number | null;
3800
3806
  /** Price per base unit, set when the calculation runs */
3801
- basePrice?: number | null;
3807
+ basePrice: number | null;
3802
3808
  /** Candidate cost value on the cost path, committed as source price only after a page match */
3803
- potentialCostValue?: number | null;
3809
+ potentialCostValue: number | null;
3804
3810
  /** Cost page UID used on the cost path */
3805
- costPageUid?: number | null;
3811
+ costPageUid: number | null;
3806
3812
  /** Description of the cost page */
3807
- costPageDescription?: string | null;
3813
+ costPageDescription: string | null;
3808
3814
  /** True when a cost page matched on the cost path */
3809
- costPageMatched?: boolean | null;
3815
+ costPageMatched: boolean | null;
3810
3816
  /** Where the cost came from when a fallback was used */
3811
- costSource?: string | null;
3817
+ costSource: string | null;
3812
3818
  /** Supplier ID whose last received PO cost was used (source code 204) */
3813
- lastReceivedPoCostSupplierId?: number | null;
3819
+ lastReceivedPoCostSupplierId: number | null;
3814
3820
  /** Item's product group at the pricing location */
3815
- invLocProductGroupId?: string | null;
3821
+ invLocProductGroupId: string | null;
3816
3822
  /** Product group on the matched page */
3817
- pricePageProductGroupId?: string | null;
3823
+ pricePageProductGroupId: string | null;
3818
3824
  /** Supplier ID on the matched page */
3819
- pricePageSupplierId?: number | null;
3825
+ pricePageSupplierId: number | null;
3820
3826
  /** Discount group on the matched page */
3821
- pricePageDiscountGroupId?: string | null;
3827
+ pricePageDiscountGroupId: string | null;
3822
3828
  /** Manufacturer class on the matched page */
3823
- pricePageMfgClassId?: string | null;
3829
+ pricePageMfgClassId: string | null;
3824
3830
  /** Price family UID on the matched page */
3825
- pricePagePriceFamilyUid?: number | null;
3831
+ pricePagePriceFamilyUid: number | null;
3826
3832
  /** Item's sales discount group at the pricing location */
3827
- invLocSalesDiscountGroup?: string | null;
3833
+ invLocSalesDiscountGroup: string | null;
3828
3834
  /** Item's price family UID at the pricing location */
3829
- invLocPriceFamilyUid?: number | null;
3835
+ invLocPriceFamilyUid: number | null;
3830
3836
  [key: string]: unknown;
3831
3837
  }
3832
3838
  /**
@@ -3837,19 +3843,19 @@ interface PriceEngineListDataLibraryPriceDataOption1 {
3837
3843
  */
3838
3844
  interface PriceEngineListDataLibraryPriceDataOption2 {
3839
3845
  /** Unit price, or false when the library produced no price */
3840
- unitPrice: number | boolean;
3846
+ unitPrice: number | false;
3841
3847
  /** Pricing source label, libraryMultiplier when a price was found */
3842
- pricedFrom?: string | null;
3848
+ pricedFrom: string | null;
3843
3849
  /** Source price the multiplier was applied to */
3844
- sourcePrice?: number | null;
3850
+ sourcePrice: number | null;
3845
3851
  /** Source price code the source price came from */
3846
- sourcePriceCd?: number | null;
3852
+ sourcePriceCd: number | null;
3847
3853
  /** Library multiplier applied to the source price */
3848
- multiplier?: number | null;
3854
+ multiplier: number | null;
3849
3855
  /** Price library UID that produced the price */
3850
- priceLibraryUid?: number | null;
3856
+ priceLibraryUid: number | null;
3851
3857
  /** Unit of measure size applied to the base price */
3852
- unitOfMeasureSize?: number | null;
3858
+ unitOfMeasureSize: number | null;
3853
3859
  [key: string]: unknown;
3854
3860
  }
3855
3861
  /**
@@ -3860,7 +3866,7 @@ interface PriceEngineListDataLibraryPriceDataOption2 {
3860
3866
  */
3861
3867
  interface PriceEngineListDataDefaultCompanyPrice {
3862
3868
  /** Unit price in the requested unit of measure, or false when none was found */
3863
- unitPrice: number | boolean;
3869
+ unitPrice: number | false;
3864
3870
  /** Item's purchase pricing unit size from inv_mast */
3865
3871
  purchasePricingUnitSize: number | null;
3866
3872
  /** Company price source code (PRICE_1 to PRICE_10 or supplier list price), 0 when none */
@@ -3892,7 +3898,7 @@ interface PriceEngineListData {
3892
3898
  /** Short code of the winning stage (J, S, L, C), or false when none did */
3893
3899
  priceType: 'J' | 'S' | 'L' | 'C' | false;
3894
3900
  /** Job or contract price when job pricing matched, otherwise false */
3895
- jobPrice: number | boolean;
3901
+ jobPrice: number | false;
3896
3902
  /** Primary supplier list price, always calculated for reference */
3897
3903
  listPrice: number;
3898
3904
  /** Customer pricing setup used by the engine */
@@ -3907,17 +3913,17 @@ interface PriceEngineListData {
3907
3913
  /** Diagnostic messages collected while pricing */
3908
3914
  messages: string[];
3909
3915
  /** Job number when job pricing matched */
3910
- jobNo?: string | null;
3916
+ jobNo: string | null;
3911
3917
  /** Job price header UID when job pricing matched */
3912
- jobPriceHdrUid?: number | null;
3918
+ jobPriceHdrUid: number | null;
3913
3919
  /** Contract number when job pricing matched */
3914
- contractNo?: string | null;
3920
+ contractNo: string | null;
3915
3921
  /** Library pricing detail whenever the library stage ran, including when it found no price */
3916
- libraryPriceData?: PriceEngineListDataLibraryPriceDataOption1 | PriceEngineListDataLibraryPriceDataOption2 | null;
3922
+ libraryPriceData: PriceEngineListDataLibraryPriceDataOption1 | PriceEngineListDataLibraryPriceDataOption2 | null;
3917
3923
  /** Default company pricing detail when that stage ran */
3918
- defaultCompanyPrice?: PriceEngineListDataDefaultCompanyPrice;
3924
+ defaultCompanyPrice: PriceEngineListDataDefaultCompanyPrice | null;
3919
3925
  /** Web discount price for the customer, or false when no web pricing rule applies */
3920
- webPrice?: number | boolean;
3926
+ webPrice: number | false;
3921
3927
  [key: string]: unknown;
3922
3928
  }
3923
3929
  /**
@@ -4003,7 +4009,7 @@ interface TaxEngineCreateDataItemsItem {
4003
4009
  /** Unit of measure the unit price is expressed in */
4004
4010
  unitOfMeasure: string | null;
4005
4011
  /** Unit price taxed, from the request or the price engine */
4006
- unitPrice: number | boolean;
4012
+ unitPrice: number | false;
4007
4013
  /** Estimated tax for this item (quantity x unit price x tax rate) */
4008
4014
  taxEstimate: number;
4009
4015
  [key: string]: unknown;
@@ -4755,8 +4761,11 @@ interface DistributorsListParams extends EdgeCacheParams {
4755
4761
  offset?: number;
4756
4762
  /** Order By (Default: distributors_uid|ASC) */
4757
4763
  orderBy?: string;
4758
- /** Status Code (status_cd) [(704)|705,700] */
4759
- statusCd?: number;
4764
+ /**
4765
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4766
+ * (704,705); -1 for every status. Default: 704
4767
+ */
4768
+ statusCd?: number | number[];
4760
4769
  }
4761
4770
  /** Params for GET /distributors/{distributorsUid} */
4762
4771
  type DistributorsGetParams = EdgeCacheParams;
@@ -4770,6 +4779,11 @@ interface InvProfileHdrListParams extends EdgeCacheParams {
4770
4779
  offset?: number;
4771
4780
  /** Order By (Default: inv_profile_hdr_uid|ASC) */
4772
4781
  orderBy?: string;
4782
+ /**
4783
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4784
+ * (704,705); -1 for every status. Default: every status
4785
+ */
4786
+ statusCd?: number | number[];
4773
4787
  }
4774
4788
  /** Params for GET /inv-profile-hdr/{invProfileHdrUid} */
4775
4789
  type InvProfileHdrGetParams = EdgeCacheParams;
@@ -4783,8 +4797,11 @@ interface InvProfileHdrInvProfileLineListParams extends EdgeCacheParams {
4783
4797
  orderBy?: string;
4784
4798
  /** Search keywords field */
4785
4799
  q?: string;
4786
- /** Filter by status code (700=DELETE, 704=ACTIVE, 705=INACTIVE) */
4787
- statusCd?: number;
4800
+ /**
4801
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4802
+ * (704,705); -1 for every status. Default: 704 and 705 (deleted lines excluded)
4803
+ */
4804
+ statusCd?: number | number[];
4788
4805
  }
4789
4806
  /** Params for GET /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid} */
4790
4807
  type InvProfileHdrInvProfileLineGetParams = EdgeCacheParams;
@@ -4804,8 +4821,11 @@ interface ProductsListParams extends EdgeCacheParams {
4804
4821
  prefix?: string;
4805
4822
  /** Query String */
4806
4823
  q?: string;
4807
- /** Status Code (status_cd) [(704)|(705)|(700)] */
4808
- statusCd?: number;
4824
+ /**
4825
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4826
+ * (704,705); -1 for every status. Default: 704
4827
+ */
4828
+ statusCd?: number | number[];
4809
4829
  }
4810
4830
  /** Params for GET /products/find */
4811
4831
  interface ProductsFindListParams extends EdgeCacheParams {
@@ -4817,6 +4837,11 @@ interface ProductsFindListParams extends EdgeCacheParams {
4817
4837
  offset?: number;
4818
4838
  /** Product Id Prefix */
4819
4839
  prefix?: string;
4840
+ /**
4841
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4842
+ * (704,705); -1 for every status. Default: 704
4843
+ */
4844
+ statusCd?: number | number[];
4820
4845
  }
4821
4846
  /** Params for GET /products/{productsUid} */
4822
4847
  type ProductsGetParams = EdgeCacheParams;
@@ -4830,6 +4855,11 @@ interface RestockHdrListParams extends EdgeCacheParams {
4830
4855
  offset?: number;
4831
4856
  /** Order By (Default: restock_hdr_uid|ASC) */
4832
4857
  orderBy?: string;
4858
+ /**
4859
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4860
+ * (704,705); -1 for every status. Default: every status
4861
+ */
4862
+ statusCd?: number | number[];
4833
4863
  /** Filter by Warehouse UID */
4834
4864
  warehouseUid?: number;
4835
4865
  }
@@ -4845,8 +4875,11 @@ interface SectionsListParams extends EdgeCacheParams {
4845
4875
  offset?: number;
4846
4876
  /** Order By (Default: sections_uid|ASC) */
4847
4877
  orderBy?: string;
4848
- /** Status Code (status_cd) [(704)|705|700] */
4849
- statusCd?: number;
4878
+ /**
4879
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4880
+ * (704,705); -1 for every status. Default: 704
4881
+ */
4882
+ statusCd?: number | number[];
4850
4883
  }
4851
4884
  /** Params for GET /sections/{sectionsUid} */
4852
4885
  type SectionsGetParams = EdgeCacheParams;
@@ -4862,8 +4895,11 @@ interface WarehouseListParams extends EdgeCacheParams {
4862
4895
  orderBy?: string;
4863
4896
  /** Search Query */
4864
4897
  q?: string;
4865
- /** Status Code (status_cd) [(704)|(705)|(700)] */
4866
- statusCd?: number;
4898
+ /**
4899
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4900
+ * (704,705); -1 for every status. Default: 704
4901
+ */
4902
+ statusCd?: number | number[];
4867
4903
  /** joomla.users.id; lists only the warehouses this user is assigned to */
4868
4904
  usersId?: number;
4869
4905
  }
@@ -4887,7 +4923,14 @@ interface WarehouseUsersListParams extends EdgeCacheParams {
4887
4923
  offset?: number;
4888
4924
  /** Order By (Default: warehouse_x_users_uid|ASC) */
4889
4925
  orderBy?: string;
4890
- /** CSV of status_cd to filter on [700|704|705] */
4926
+ /**
4927
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
4928
+ * (704,705); -1 for every status. Default: every status
4929
+ */
4930
+ statusCd?: number | number[];
4931
+ /**
4932
+ * Deprecated: use statusCd. CSV of status codes [700|704|705], read only when statusCd is absent
4933
+ */
4891
4934
  statusCdList?: string;
4892
4935
  }
4893
4936
  /** Params for POST /warehouse/{warehouseUid}/users */
@@ -6164,7 +6207,7 @@ interface WarehouseUsageCreateDataUsageItemsItem {
6164
6207
  /** Usage line ID */
6165
6208
  usageLineUid: number;
6166
6209
  /** Warranty claim; the key is absent when none was sent */
6167
- warranty?: WarehouseUsageCreateDataUsageItemsItemWarranty;
6210
+ warranty?: WarehouseUsageCreateDataUsageItemsItemWarranty | null;
6168
6211
  [key: string]: unknown;
6169
6212
  }
6170
6213
  /**
@@ -6219,7 +6262,7 @@ interface WarehouseUsageCreateBodyUsageItemsItem {
6219
6262
  /** Item source: products or prophet21; defaults to prophet21 */
6220
6263
  invProfileLineType?: string | null;
6221
6264
  /** Warranty claim for the item */
6222
- warranty?: WarehouseUsageCreateBodyUsageItemsItemWarranty;
6265
+ warranty?: WarehouseUsageCreateBodyUsageItemsItemWarranty | null;
6223
6266
  [key: string]: unknown;
6224
6267
  }
6225
6268
  /**
@@ -6390,6 +6433,10 @@ interface VMIClientSpec {
6390
6433
  * Get distributor Details
6391
6434
  * Call: api.vmi.distributors.get(distributorsUid)
6392
6435
  *
6436
+ * Errors:
6437
+ * 400: distributorsUid is below 1.
6438
+ * 404: No distributor with this distributorsUid.
6439
+ *
6393
6440
  * GET https://vmi.augur-api.com/distributors/{distributorsUid}
6394
6441
  * Contract: https://vmi.augur-api.com/openapi.json#/paths/~1distributors~1{distributorsUid}/get
6395
6442
  *
@@ -6421,6 +6468,7 @@ interface VMIClientSpec {
6421
6468
  * Call: api.vmi.distributors.delete(distributorsUid)
6422
6469
  *
6423
6470
  * Errors:
6471
+ * 400: distributorsUid is below 1.
6424
6472
  * 404: No row exists with this ID.
6425
6473
  *
6426
6474
  * DELETE https://vmi.augur-api.com/distributors/{distributorsUid}
@@ -6440,6 +6488,7 @@ interface VMIClientSpec {
6440
6488
  * Response data: Outcome of an enable, disable, or delete request
6441
6489
  *
6442
6490
  * Errors:
6491
+ * 400: distributorsUid is below 1.
6443
6492
  * 404: No row exists with this ID.
6444
6493
  *
6445
6494
  * PUT https://vmi.augur-api.com/distributors/{distributorsUid}/enable
@@ -6462,6 +6511,7 @@ interface VMIClientSpec {
6462
6511
  *
6463
6512
  * Errors:
6464
6513
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
6514
+ * 404: No distributor with this distributorsUid.
6465
6515
  *
6466
6516
  * POST https://vmi.augur-api.com/distributors/{distributorsUid}/products
6467
6517
  * Contract:
@@ -6514,6 +6564,10 @@ interface VMIClientSpec {
6514
6564
  *
6515
6565
  * Response data: An inventory profile with the active warehouses that stock it
6516
6566
  *
6567
+ * Errors:
6568
+ * 400: invProfileHdrUid is below 1.
6569
+ * 404: No inventory profile with this invProfileHdrUid.
6570
+ *
6517
6571
  * GET https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}
6518
6572
  * Contract:
6519
6573
  * https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{invProfileHdrUid}/get
@@ -6547,6 +6601,7 @@ interface VMIClientSpec {
6547
6601
  * Call: api.vmi.invProfileHdr.delete(invProfileHdrUid)
6548
6602
  *
6549
6603
  * Errors:
6604
+ * 400: invProfileHdrUid is below 1.
6550
6605
  * 404: No row exists with this ID.
6551
6606
  *
6552
6607
  * DELETE https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}
@@ -6564,6 +6619,7 @@ interface VMIClientSpec {
6564
6619
  *
6565
6620
  * Errors:
6566
6621
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
6622
+ * 404: No inventory profile with this invProfileHdrUid.
6567
6623
  *
6568
6624
  * GET https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line
6569
6625
  * Contract:
@@ -6583,6 +6639,7 @@ interface VMIClientSpec {
6583
6639
  *
6584
6640
  * Errors:
6585
6641
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
6642
+ * 404: No inventory profile with this invProfileHdrUid.
6586
6643
  *
6587
6644
  * POST https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line
6588
6645
  * Contract:
@@ -6597,6 +6654,11 @@ interface VMIClientSpec {
6597
6654
  * Get Inventory Profile line Details
6598
6655
  * Call: api.vmi.invProfileHdr.invProfileLine.get(invProfileHdrUid, invProfileLineUid)
6599
6656
  *
6657
+ * Errors:
6658
+ * 400: invProfileHdrUid or invProfileLineUid is below 1.
6659
+ * 404: No inventory profile with this invProfileHdrUid, or no line with this
6660
+ * invProfileLineUid on that profile.
6661
+ *
6600
6662
  * GET
6601
6663
  * https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid}
6602
6664
  * Contract:
@@ -6640,6 +6702,7 @@ interface VMIClientSpec {
6640
6702
  * DELETE Inventory Profile Line
6641
6703
  *
6642
6704
  * Errors:
6705
+ * 400: invProfileHdrUid or invProfileLineUid is below 1.
6643
6706
  * 404: No row exists with this ID.
6644
6707
  *
6645
6708
  * DELETE
@@ -6665,6 +6728,7 @@ interface VMIClientSpec {
6665
6728
  *
6666
6729
  * Errors:
6667
6730
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
6731
+ * 404: No customer with this customerId.
6668
6732
  *
6669
6733
  * POST https://vmi.augur-api.com/inv-profile-hdr/{customerId}/upload
6670
6734
  * Contract:
@@ -6698,6 +6762,10 @@ interface VMIClientSpec {
6698
6762
  * Get Product Details
6699
6763
  * Call: api.vmi.products.get(productsUid)
6700
6764
  *
6765
+ * Errors:
6766
+ * 400: productsUid is below 1.
6767
+ * 404: No product with this productsUid.
6768
+ *
6701
6769
  * GET https://vmi.augur-api.com/products/{productsUid}
6702
6770
  * Contract: https://vmi.augur-api.com/openapi.json#/paths/~1products~1{productsUid}/get
6703
6771
  *
@@ -6729,6 +6797,7 @@ interface VMIClientSpec {
6729
6797
  * Call: api.vmi.products.delete(productsUid)
6730
6798
  *
6731
6799
  * Errors:
6800
+ * 400: productsUid is below 1.
6732
6801
  * 404: No row exists with this ID.
6733
6802
  *
6734
6803
  * DELETE https://vmi.augur-api.com/products/{productsUid}
@@ -6747,6 +6816,7 @@ interface VMIClientSpec {
6747
6816
  * Response data: Outcome of an enable, disable, or delete request
6748
6817
  *
6749
6818
  * Errors:
6819
+ * 400: productsUid is below 1.
6750
6820
  * 404: No row exists with this ID.
6751
6821
  *
6752
6822
  * PUT https://vmi.augur-api.com/products/{productsUid}/enable
@@ -6814,6 +6884,10 @@ interface VMIClientSpec {
6814
6884
  * Get Restock Header Details
6815
6885
  * Call: api.vmi.restockHdr.get(restockHdrUid)
6816
6886
  *
6887
+ * Errors:
6888
+ * 400: restockHdrUid is below 1.
6889
+ * 404: No restock with this restockHdrUid.
6890
+ *
6817
6891
  * GET https://vmi.augur-api.com/restock-hdr/{restockHdrUid}
6818
6892
  * Contract: https://vmi.augur-api.com/openapi.json#/paths/~1restock-hdr~1{restockHdrUid}/get
6819
6893
  *
@@ -6846,6 +6920,7 @@ interface VMIClientSpec {
6846
6920
  * Call: api.vmi.restockHdr.delete(restockHdrUid)
6847
6921
  *
6848
6922
  * Errors:
6923
+ * 400: restockHdrUid is below 1.
6849
6924
  * 404: No row exists with this ID.
6850
6925
  *
6851
6926
  * DELETE https://vmi.augur-api.com/restock-hdr/{restockHdrUid}
@@ -6892,6 +6967,10 @@ interface VMIClientSpec {
6892
6967
  * Get section Details
6893
6968
  * Call: api.vmi.sections.get(sectionsUid)
6894
6969
  *
6970
+ * Errors:
6971
+ * 400: sectionsUid is below 1.
6972
+ * 404: No section with this sectionsUid.
6973
+ *
6895
6974
  * GET https://vmi.augur-api.com/sections/{sectionsUid}
6896
6975
  * Contract: https://vmi.augur-api.com/openapi.json#/paths/~1sections~1{sectionsUid}/get
6897
6976
  *
@@ -6924,6 +7003,7 @@ interface VMIClientSpec {
6924
7003
  * Call: api.vmi.sections.delete(sectionsUid)
6925
7004
  *
6926
7005
  * Errors:
7006
+ * 400: sectionsUid is below 1.
6927
7007
  * 404: No row exists with this ID.
6928
7008
  *
6929
7009
  * DELETE https://vmi.augur-api.com/sections/{sectionsUid}
@@ -6942,6 +7022,7 @@ interface VMIClientSpec {
6942
7022
  * Response data: Outcome of an enable, disable, or delete request
6943
7023
  *
6944
7024
  * Errors:
7025
+ * 400: sectionsUid is below 1.
6945
7026
  * 404: No row exists with this ID.
6946
7027
  *
6947
7028
  * PUT https://vmi.augur-api.com/sections/{sectionsUid}/enable
@@ -6995,6 +7076,10 @@ interface VMIClientSpec {
6995
7076
  *
6996
7077
  * Response data: A warehouse with its active assigned users
6997
7078
  *
7079
+ * Errors:
7080
+ * 400: warehouseUid is below 1.
7081
+ * 404: No warehouse with this warehouseUid.
7082
+ *
6998
7083
  * GET https://vmi.augur-api.com/warehouse/{warehouseUid}
6999
7084
  * Contract: https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}/get
7000
7085
  *
@@ -7026,6 +7111,7 @@ interface VMIClientSpec {
7026
7111
  * Call: api.vmi.warehouse.delete(warehouseUid)
7027
7112
  *
7028
7113
  * Errors:
7114
+ * 400: warehouseUid is below 1.
7029
7115
  * 404: No row exists with this ID.
7030
7116
  *
7031
7117
  * DELETE https://vmi.augur-api.com/warehouse/{warehouseUid}
@@ -7045,6 +7131,7 @@ interface VMIClientSpec {
7045
7131
  *
7046
7132
  * Errors:
7047
7133
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
7134
+ * 404: No warehouse with this warehouseUid.
7048
7135
  *
7049
7136
  * POST https://vmi.augur-api.com/warehouse/{warehouseUid}/adjust
7050
7137
  * Contract:
@@ -7063,6 +7150,10 @@ interface VMIClientSpec {
7063
7150
  *
7064
7151
  * Response data: On-hand quantities of a warehouse's profile items, grouped by section
7065
7152
  *
7153
+ * Errors:
7154
+ * 400: warehouseUid is below 1.
7155
+ * 404: No warehouse with this warehouseUid.
7156
+ *
7066
7157
  * GET https://vmi.augur-api.com/warehouse/{warehouseUid}/availability
7067
7158
  * Contract:
7068
7159
  * https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1availability/get
@@ -7082,6 +7173,7 @@ interface VMIClientSpec {
7082
7173
  * Response data: Outcome of an enable, disable, or delete request
7083
7174
  *
7084
7175
  * Errors:
7176
+ * 400: warehouseUid is below 1.
7085
7177
  * 404: No row exists with this ID.
7086
7178
  *
7087
7179
  * PUT https://vmi.augur-api.com/warehouse/{warehouseUid}/enable
@@ -7104,6 +7196,7 @@ interface VMIClientSpec {
7104
7196
  *
7105
7197
  * Errors:
7106
7198
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
7199
+ * 404: No warehouse with this warehouseUid.
7107
7200
  *
7108
7201
  * POST https://vmi.augur-api.com/warehouse/{warehouseUid}/receive
7109
7202
  * Contract:
@@ -7123,6 +7216,10 @@ interface VMIClientSpec {
7123
7216
  * Response data: A warehouse's profile items with stock levels, for building a restock
7124
7217
  * request
7125
7218
  *
7219
+ * Errors:
7220
+ * 400: warehouseUid is below 1.
7221
+ * 404: No warehouse with this warehouseUid.
7222
+ *
7126
7223
  * GET https://vmi.augur-api.com/warehouse/{warehouseUid}/replenish
7127
7224
  * Contract:
7128
7225
  * https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1replenish/get
@@ -7143,6 +7240,7 @@ interface VMIClientSpec {
7143
7240
  *
7144
7241
  * Errors:
7145
7242
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
7243
+ * 404: No warehouse with this warehouseUid.
7146
7244
  *
7147
7245
  * POST https://vmi.augur-api.com/warehouse/{warehouseUid}/usage
7148
7246
  * Contract:
@@ -7164,6 +7262,7 @@ interface VMIClientSpec {
7164
7262
  *
7165
7263
  * Errors:
7166
7264
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
7265
+ * 404: No warehouse with this warehouseUid.
7167
7266
  *
7168
7267
  * GET https://vmi.augur-api.com/warehouse/{warehouseUid}/users
7169
7268
  * Contract:
@@ -7185,6 +7284,7 @@ interface VMIClientSpec {
7185
7284
  *
7186
7285
  * Errors:
7187
7286
  * 400: Bad request: the body is missing or a parameter is invalid; message says which.
7287
+ * 404: No warehouse with this warehouseUid.
7188
7288
  *
7189
7289
  * POST https://vmi.augur-api.com/warehouse/{warehouseUid}/users
7190
7290
  * Contract:
@@ -7244,6 +7344,7 @@ interface VMIClientSpec {
7244
7344
  * Remove User from Warehouse (sets status_cd to 700)
7245
7345
  *
7246
7346
  * Errors:
7347
+ * 400: warehouseUid or usersId is below 1.
7247
7348
  * 404: No row exists with this ID.
7248
7349
  *
7249
7350
  * DELETE https://vmi.augur-api.com/warehouse/{warehouseUid}/users/{usersId}
@@ -7772,7 +7873,7 @@ interface ItemSearchListDataItemsItem {
7772
7873
  /** Relevance score truncated to an integer */
7773
7874
  scoreInt: number;
7774
7875
  /** Brandfolder assets; the key is present only when useBrandFolderDoc=Y */
7775
- brandFolder?: ItemSearchListDataItemsItemBrandFolder;
7876
+ brandFolder?: ItemSearchListDataItemsItemBrandFolder | null;
7776
7877
  [key: string]: unknown;
7777
7878
  }
7778
7879
  /**
@@ -7793,7 +7894,7 @@ interface ItemSearchListData {
7793
7894
  /** query_string row recorded for this search text (0 when not recorded) */
7794
7895
  queryStringUid: number;
7795
7896
  /** Redirect link configured for this search text, or false when none */
7796
- queryStringRedirectLink: string | boolean;
7897
+ queryStringRedirectLink: string | false;
7797
7898
  [key: string]: unknown;
7798
7899
  }
7799
7900
  /**
@@ -7823,7 +7924,7 @@ interface ItemSearchFacetsListDataItemsItem {
7823
7924
  /** OpenSearch relevance score, or null when the search was sorted */
7824
7925
  score: number | null;
7825
7926
  /** Brandfolder assets; the key is present only when useBrandFolderDoc=Y */
7826
- brandFolder?: ItemSearchListDataItemsItemBrandFolder;
7927
+ brandFolder?: ItemSearchListDataItemsItemBrandFolder | null;
7827
7928
  [key: string]: unknown;
7828
7929
  }
7829
7930
  /**
@@ -10264,7 +10365,7 @@ interface BrandsFacetsListDataItemsItem {
10264
10365
  /** OpenSearch relevance score, or null when the search was sorted */
10265
10366
  score: number | null;
10266
10367
  /** Brandfolder assets; the key is present only when useBrandFolderDoc=Y */
10267
- brandFolder?: BrandsFacetsListDataItemsItemBrandFolder;
10368
+ brandFolder?: BrandsFacetsListDataItemsItemBrandFolder | null;
10268
10369
  [key: string]: unknown;
10269
10370
  }
10270
10371
  /**
@@ -10475,7 +10576,7 @@ interface CategoriesLookupGetDataChildrenOption1Item {
10475
10576
  /** URL-safe hierarchy path */
10476
10577
  cleanPath: string | null;
10477
10578
  /** Category image path, or false when none */
10478
- categoryImage: string | boolean;
10579
+ categoryImage: string | false;
10479
10580
  /** Display order under the parent */
10480
10581
  sequenceNo: number;
10481
10582
  /** Product collection */
@@ -10483,11 +10584,11 @@ interface CategoriesLookupGetDataChildrenOption1Item {
10483
10584
  /** Online items in the category */
10484
10585
  itemCount: number;
10485
10586
  /** User-defined fields (only with includeUd=Y) */
10486
- userDefined?: Record<string, string>;
10587
+ userDefined?: Record<string, string> | null;
10487
10588
  /**
10488
10589
  * Primary room-scene asset, false when none, null when the lookup failed (trinitysurfaces only)
10489
10590
  */
10490
- roomScene?: CategoriesLookupGetDataChildrenOption1ItemRoomSceneOption1 | boolean | null;
10591
+ roomScene?: CategoriesLookupGetDataChildrenOption1ItemRoomSceneOption1 | null | false;
10491
10592
  /** Brandfolder color names (trinitysurfaces only) */
10492
10593
  colorList?: string[] | null;
10493
10594
  /** Brandfolder color count (trinitysurfaces only) */
@@ -10511,9 +10612,9 @@ interface CategoriesLookupGetData {
10511
10612
  /** Category description */
10512
10613
  itemCategoryDesc: string;
10513
10614
  /** Category image path, or false when none */
10514
- categoryImage: string | boolean;
10615
+ categoryImage: string | false;
10515
10616
  /** Category text, or false when none */
10516
- categoryText: string | boolean;
10617
+ categoryText: string | false;
10517
10618
  /** Parent category ID */
10518
10619
  parentItemCategoryUid: number;
10519
10620
  /** Depth of the category in the hierarchy */
@@ -10537,7 +10638,7 @@ interface CategoriesLookupGetData {
10537
10638
  /** Children returned */
10538
10639
  childrenCount: number;
10539
10640
  /** User-defined fields (only with includeUd=Y) */
10540
- userDefined?: Record<string, string>;
10641
+ userDefined?: Record<string, string> | null;
10541
10642
  [key: string]: unknown;
10542
10643
  }
10543
10644
  /**
@@ -10736,17 +10837,17 @@ interface CategoriesItemsListDataItemsItem {
10736
10837
  /** The item's display description in this category */
10737
10838
  displayDesc: string;
10738
10839
  /** Stock by location and per company (only with includeStock=Y) */
10739
- stock?: InvMastStockGetData;
10840
+ stock?: InvMastStockGetData | null;
10740
10841
  /** True when the 4th character of classId5 is 1 (trinitysurfaces only) */
10741
10842
  samplesApp?: boolean | null;
10742
10843
  /** True when the trim user-defined field is Y (trinitysurfaces only) */
10743
10844
  trim?: boolean | null;
10744
10845
  /** Full-sized sample item, or false (trinitysurfaces only) */
10745
- fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
10846
+ fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
10746
10847
  /** Swatch sample item, or false (trinitysurfaces only) */
10747
- swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
10848
+ swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
10748
10849
  /** Brandfolder assets (trinitysurfaces only) */
10749
- brandFolder?: BrandsFacetsListDataItemsItemBrandFolder;
10850
+ brandFolder?: BrandsFacetsListDataItemsItemBrandFolder | null;
10750
10851
  [key: string]: unknown;
10751
10852
  }
10752
10853
  /**
@@ -11232,21 +11333,21 @@ interface InvMastListItem {
11232
11333
  /** Descriptions in other languages */
11233
11334
  languages: InvMastListItemLanguagesItem[];
11234
11335
  /** Brandfolder assets (trinitysurfaces only) */
11235
- brandFolder?: BrandsFacetsListDataItemsItemBrandFolder;
11336
+ brandFolder?: BrandsFacetsListDataItemsItemBrandFolder | null;
11236
11337
  /** Category trees for the item's non-root categories (trinitysurfaces only) */
11237
11338
  docCatTrees?: Array<number[]> | null;
11238
11339
  /** Product collection of the item's category under root 3 (trinitysurfaces only) */
11239
11340
  productCollection?: string | null;
11240
11341
  /** Leaf category under root 3, or false (trinitysurfaces only) */
11241
- tsItemCategoryUid?: number | boolean | null;
11342
+ tsItemCategoryUid?: number | null | false;
11242
11343
  /** Leaf category under root 5, or false (trinitysurfaces only) */
11243
- ttItemCategoryUid?: number | boolean | null;
11344
+ ttItemCategoryUid?: number | null | false;
11244
11345
  /** True when the trim user-defined field is Y (trinitysurfaces only) */
11245
11346
  trim?: boolean | null;
11246
11347
  /** Full-sized sample item, or false (trinitysurfaces only) */
11247
- fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
11348
+ fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
11248
11349
  /** Swatch sample item, or false (trinitysurfaces only) */
11249
- swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
11350
+ swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
11250
11351
  /** Variant group the item belongs to */
11251
11352
  itemVariantHdrUid?: number | null;
11252
11353
  /** List price 1 (only with includePricing=Y) */
@@ -12488,11 +12589,11 @@ interface ItemWishlistHdrGetItem {
12488
12589
  /** True when the trim user-defined field is Y (trinitysurfaces only) */
12489
12590
  trim?: boolean | null;
12490
12591
  /** Full-sized sample item, or false (trinitysurfaces only) */
12491
- fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
12592
+ fullSizedSamples?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
12492
12593
  /** Swatch sample item, or false (trinitysurfaces only) */
12493
- swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | boolean | null;
12594
+ swatchSample?: CategoriesItemsListDataItemsItemFullSizedSamplesOption1 | null | false;
12494
12595
  /** Brandfolder assets (trinitysurfaces only) */
12495
- brandFolder?: BrandsFacetsListDataItemsItemBrandFolder;
12596
+ brandFolder?: BrandsFacetsListDataItemsItemBrandFolder | null;
12496
12597
  [key: string]: unknown;
12497
12598
  }
12498
12599
  /** Returned by: api.items.itemWishlist.hdr.get(usersId, itemWishlistHdrUid, params) */
@@ -12930,11 +13031,11 @@ interface VariantsDocListDataLinesItem {
12930
13031
  */
12931
13032
  interface VariantsDocListData {
12932
13033
  /** The variant group */
12933
- header: VariantsDocListDataHeader;
13034
+ header: VariantsDocListDataHeader | null;
12934
13035
  /** Attributes that differentiate the items, in sequence order */
12935
13036
  attributes: VariantsDocListDataAttributesItem[];
12936
13037
  /** The primary item; null when no line is primary */
12937
- primary: VariantsDocListDataPrimary;
13038
+ primary: VariantsDocListDataPrimary | null;
12938
13039
  /** Every item in the group, in sequence order */
12939
13040
  lines: VariantsDocListDataLinesItem[];
12940
13041
  /** Number of entries in lines */
@@ -16261,21 +16362,21 @@ interface InvMastAlsoBoughtListItem {
16261
16362
  /** Descriptions in other languages */
16262
16363
  languages: InvMastAlsoBoughtListItemLanguagesItem[];
16263
16364
  /** Brandfolder assets (trinitysurfaces only) */
16264
- brandFolder?: InvMastAlsoBoughtListItemBrandFolder;
16365
+ brandFolder?: InvMastAlsoBoughtListItemBrandFolder | null;
16265
16366
  /** Category trees for the item's non-root categories (trinitysurfaces only) */
16266
16367
  docCatTrees?: Array<number[]> | null;
16267
16368
  /** Product collection of the item's category under root 3 (trinitysurfaces only) */
16268
16369
  productCollection?: string | null;
16269
16370
  /** Leaf category under root 3, or false (trinitysurfaces only) */
16270
- tsItemCategoryUid?: number | boolean | null;
16371
+ tsItemCategoryUid?: number | null | false;
16271
16372
  /** Leaf category under root 5, or false (trinitysurfaces only) */
16272
- ttItemCategoryUid?: number | boolean | null;
16373
+ ttItemCategoryUid?: number | null | false;
16273
16374
  /** True when the trim user-defined field is Y (trinitysurfaces only) */
16274
16375
  trim?: boolean | null;
16275
16376
  /** Full-sized sample item, or false (trinitysurfaces only) */
16276
- fullSizedSamples?: InvMastAlsoBoughtListItemFullSizedSamples | boolean | null;
16377
+ fullSizedSamples?: InvMastAlsoBoughtListItemFullSizedSamples | null | false;
16277
16378
  /** Swatch sample item, or false (trinitysurfaces only) */
16278
- swatchSample?: InvMastAlsoBoughtListItemFullSizedSamples | boolean | null;
16379
+ swatchSample?: InvMastAlsoBoughtListItemFullSizedSamples | null | false;
16279
16380
  /** Variant group the item belongs to */
16280
16381
  itemVariantHdrUid?: number | null;
16281
16382
  /** List price 1 (only with includePricing=Y) */
@@ -17124,8 +17225,8 @@ declare class LegacyClient extends BaseServiceClient {
17124
17225
 
17125
17226
  /**
17126
17227
  * Generated types for the agr-site service.
17127
- * Central site configuration hub managing settings, notifications, training data, and cross-service
17128
- * integrations per client
17228
+ * Central site configuration hub managing settings, notifications, and cross-service integrations
17229
+ * per client
17129
17230
  *
17130
17231
  * Public specs (the source of truth for every shape below):
17131
17232
  * https://agr-site.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
@@ -17229,54 +17330,6 @@ interface SettingsListParams extends EdgeCacheParams {
17229
17330
  }
17230
17331
  /** Params for GET /settings/{settingsUid} */
17231
17332
  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
17333
  /** Params for GET /users/{userId}/addresses */
17281
17334
  interface UsersAddressesListParams extends EdgeCacheParams {
17282
17335
  /** Filter by email_address */
@@ -17893,558 +17946,150 @@ interface SettingsUpdateBody {
17893
17946
  */
17894
17947
  type SettingsDeleteData = SettingsListItem;
17895
17948
  /**
17896
- * List Training Sets
17897
- * Response data for GET /training — MINIMUM fields, extras pass through
17949
+ * List user addresses
17950
+ * Response data for GET /users/{userId}/addresses — MINIMUM fields, extras pass through
17898
17951
  *
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)
17952
+ * Returned by: api.agrSite.users.addresses.list(userId, params) (array items)
17953
+ * Returned by: api.agrSite.users.addresses.create(userId, data)
17954
+ * Returned by: api.agrSite.users.addresses.get(userId, userAddressUid)
17955
+ * Returned by: api.agrSite.users.addresses.update(userId, userAddressUid, data)
17956
+ * Returned by: api.agrSite.users.addresses.delete(userId, userAddressUid)
17904
17957
  */
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) */
17958
+ interface UsersAddressesListItem {
17959
+ /** User address ID */
17960
+ userAddressUid: number;
17961
+ /** Joomla user the address belongs to */
17962
+ userId: number;
17963
+ /** Address line 1 (max 50 chars) */
17964
+ address1: string | null;
17965
+ /** Address line 2 (max 50 chars) */
17966
+ address2: string | null;
17967
+ /** Address line 3 (max 50 chars) */
17968
+ address3: string | null;
17969
+ /** City (max 50 chars) */
17970
+ city: string | null;
17971
+ /** State or province (max 50 chars) */
17972
+ state: string | null;
17973
+ /** Postal code (max 10 chars) */
17974
+ postalCode: string | null;
17975
+ /** Country (max 50 chars) */
17976
+ country: string | null;
17977
+ /** Email address (max 255 chars) */
17978
+ emailAddress: string | null;
17979
+ /** Name on the address (max 255 chars) */
17980
+ name: string | null;
17981
+ /** Main phone number (max 20 chars) */
17982
+ phoneNumberMain: string | null;
17983
+ /** Mobile phone number (max 20 chars) */
17984
+ phoneNumberMobile: string | null;
17985
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
17933
17986
  dateCreated: string;
17934
- /** Modified timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
17987
+ /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
17935
17988
  dateLastModified: string;
17989
+ /** Update code (1185 = Import Complete) */
17990
+ updateCd: number;
17991
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
17992
+ statusCd: number;
17993
+ /** Process code (704 = Active, 1185 = Import Complete) */
17994
+ processCd: number;
17936
17995
  [key: string]: unknown;
17937
17996
  }
17938
- /** Returned by: api.agrSite.training.list(params) */
17939
- type TrainingListData = TrainingListItem[];
17997
+ /** Returned by: api.agrSite.users.addresses.list(userId, params) */
17998
+ type UsersAddressesListData = UsersAddressesListItem[];
17940
17999
  /**
17941
- * Create Training Set
17942
- * Response data for POST /training — MINIMUM fields, extras pass through
18000
+ * Create a new user_address row
18001
+ * Response data for POST /users/{userId}/addresses — MINIMUM fields, extras pass through
17943
18002
  *
17944
- * Returned by: api.agrSite.training.create(data)
18003
+ * Returned by: api.agrSite.users.addresses.create(userId, data)
17945
18004
  */
17946
- type TrainingCreateData = TrainingListItem;
18005
+ type UsersAddressesCreateData = UsersAddressesListItem;
17947
18006
  /**
17948
- * Create Training Set
17949
- * Request body for POST /training — MINIMUM fields, extras pass through
18007
+ * Create a new user_address row
18008
+ * Request body for POST /users/{userId}/addresses — MINIMUM fields, extras pass through
17950
18009
  *
17951
- * Request body of: api.agrSite.training.create(data)
18010
+ * Request body of: api.agrSite.users.addresses.create(userId, data)
17952
18011
  */
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;
18012
+ interface UsersAddressesCreateBody {
18013
+ /** Address line 1 */
18014
+ address1?: string | null;
18015
+ /** Address line 2 */
18016
+ address2?: string | null;
18017
+ /** Address line 3 */
18018
+ address3?: string | null;
18019
+ /** City */
18020
+ city?: string | null;
18021
+ /** State or province */
18022
+ state?: string | null;
18023
+ /** Postal code */
18024
+ postalCode?: string | null;
18025
+ /** Country */
18026
+ country?: string | null;
18027
+ /** Email address */
18028
+ emailAddress?: string | null;
18029
+ /** Name on the address */
18030
+ name?: string | null;
18031
+ /** Main phone number */
18032
+ phoneNumberMain?: string | null;
18033
+ /** Mobile phone number */
18034
+ phoneNumberMobile?: string | null;
18035
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) (Default: 704) */
18036
+ statusCd?: number | null;
18037
+ /** Process code (704 = Active, 1185 = Import Complete) (Default: 704) */
18038
+ processCd?: number | null;
18039
+ /** Update code (1185 = Import Complete) (Default: 1185) */
18040
+ updateCd?: number | null;
17968
18041
  [key: string]: unknown;
17969
18042
  }
17970
18043
  /**
17971
- * Get Training Set Details
17972
- * Response data for GET /training/{trainingSetUid} — MINIMUM fields, extras pass through
18044
+ * Get a user_address
18045
+ * Response data for GET /users/{userId}/addresses/{userAddressUid} — MINIMUM fields, extras pass
18046
+ * through
17973
18047
  *
17974
- * Returned by: api.agrSite.training.get(trainingSetUid)
18048
+ * Returned by: api.agrSite.users.addresses.get(userId, userAddressUid)
17975
18049
  */
17976
- type TrainingGetData = TrainingListItem;
18050
+ type UsersAddressesGetData = UsersAddressesListItem;
17977
18051
  /**
17978
- * Update Training Set
17979
- * Response data for PUT /training/{trainingSetUid} — MINIMUM fields, extras pass through
18052
+ * Update a user_address row
18053
+ * Response data for PUT /users/{userId}/addresses/{userAddressUid} — MINIMUM fields, extras pass
18054
+ * through
17980
18055
  *
17981
- * Returned by: api.agrSite.training.update(trainingSetUid, data)
18056
+ * Returned by: api.agrSite.users.addresses.update(userId, userAddressUid, data)
17982
18057
  */
17983
- type TrainingUpdateData = TrainingListItem;
18058
+ type UsersAddressesUpdateData = UsersAddressesListItem;
17984
18059
  /**
17985
- * Update Training Set
17986
- * Request body for PUT /training/{trainingSetUid} — MINIMUM fields, extras pass through
18060
+ * Update a user_address row
18061
+ * Request body for PUT /users/{userId}/addresses/{userAddressUid} — MINIMUM fields, extras pass
18062
+ * through
17987
18063
  *
17988
- * Request body of: api.agrSite.training.update(trainingSetUid, data)
18064
+ * Request body of: api.agrSite.users.addresses.update(userId, userAddressUid, data)
17989
18065
  */
17990
- interface TrainingUpdateBody {
17991
- /** Training set name */
18066
+ interface UsersAddressesUpdateBody {
18067
+ /** Address line 1 */
18068
+ address1?: string | null;
18069
+ /** Address line 2 */
18070
+ address2?: string | null;
18071
+ /** Address line 3 */
18072
+ address3?: string | null;
18073
+ /** City */
18074
+ city?: string | null;
18075
+ /** State or province */
18076
+ state?: string | null;
18077
+ /** Postal code */
18078
+ postalCode?: string | null;
18079
+ /** Country */
18080
+ country?: string | null;
18081
+ /** Email address */
18082
+ emailAddress?: string | null;
18083
+ /** Name on the address */
17992
18084
  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;
18085
+ /** Main phone number */
18086
+ phoneNumberMain?: string | null;
18087
+ /** Mobile phone number */
18088
+ phoneNumberMobile?: string | null;
18005
18089
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
18006
18090
  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
- /**
18304
- * List user addresses
18305
- * Response data for GET /users/{userId}/addresses — MINIMUM fields, extras pass through
18306
- *
18307
- * Returned by: api.agrSite.users.addresses.list(userId, params) (array items)
18308
- * Returned by: api.agrSite.users.addresses.create(userId, data)
18309
- * Returned by: api.agrSite.users.addresses.get(userId, userAddressUid)
18310
- * Returned by: api.agrSite.users.addresses.update(userId, userAddressUid, data)
18311
- * Returned by: api.agrSite.users.addresses.delete(userId, userAddressUid)
18312
- */
18313
- interface UsersAddressesListItem {
18314
- /** User address ID */
18315
- userAddressUid: number;
18316
- /** Joomla user the address belongs to */
18317
- userId: number;
18318
- /** Address line 1 (max 50 chars) */
18319
- address1: string | null;
18320
- /** Address line 2 (max 50 chars) */
18321
- address2: string | null;
18322
- /** Address line 3 (max 50 chars) */
18323
- address3: string | null;
18324
- /** City (max 50 chars) */
18325
- city: string | null;
18326
- /** State or province (max 50 chars) */
18327
- state: string | null;
18328
- /** Postal code (max 10 chars) */
18329
- postalCode: string | null;
18330
- /** Country (max 50 chars) */
18331
- country: string | null;
18332
- /** Email address (max 255 chars) */
18333
- emailAddress: string | null;
18334
- /** Name on the address (max 255 chars) */
18335
- name: string | null;
18336
- /** Main phone number (max 20 chars) */
18337
- phoneNumberMain: string | null;
18338
- /** Mobile phone number (max 20 chars) */
18339
- phoneNumberMobile: string | null;
18340
- /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
18341
- dateCreated: string;
18342
- /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
18343
- dateLastModified: string;
18344
- /** Update code (1185 = Import Complete) */
18345
- updateCd: number;
18346
- /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
18347
- statusCd: number;
18348
- /** Process code (704 = Active, 1185 = Import Complete) */
18349
- processCd: number;
18350
- [key: string]: unknown;
18351
- }
18352
- /** Returned by: api.agrSite.users.addresses.list(userId, params) */
18353
- type UsersAddressesListData = UsersAddressesListItem[];
18354
- /**
18355
- * Create a new user_address row
18356
- * Response data for POST /users/{userId}/addresses — MINIMUM fields, extras pass through
18357
- *
18358
- * Returned by: api.agrSite.users.addresses.create(userId, data)
18359
- */
18360
- type UsersAddressesCreateData = UsersAddressesListItem;
18361
- /**
18362
- * Create a new user_address row
18363
- * Request body for POST /users/{userId}/addresses — MINIMUM fields, extras pass through
18364
- *
18365
- * Request body of: api.agrSite.users.addresses.create(userId, data)
18366
- */
18367
- interface UsersAddressesCreateBody {
18368
- /** Address line 1 */
18369
- address1?: string | null;
18370
- /** Address line 2 */
18371
- address2?: string | null;
18372
- /** Address line 3 */
18373
- address3?: string | null;
18374
- /** City */
18375
- city?: string | null;
18376
- /** State or province */
18377
- state?: string | null;
18378
- /** Postal code */
18379
- postalCode?: string | null;
18380
- /** Country */
18381
- country?: string | null;
18382
- /** Email address */
18383
- emailAddress?: string | null;
18384
- /** Name on the address */
18385
- name?: string | null;
18386
- /** Main phone number */
18387
- phoneNumberMain?: string | null;
18388
- /** Mobile phone number */
18389
- phoneNumberMobile?: string | null;
18390
- /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) (Default: 704) */
18391
- statusCd?: number | null;
18392
- /** Process code (704 = Active, 1185 = Import Complete) (Default: 704) */
18393
- processCd?: number | null;
18394
- /** Update code (1185 = Import Complete) (Default: 1185) */
18395
- updateCd?: number | null;
18396
- [key: string]: unknown;
18397
- }
18398
- /**
18399
- * Get a user_address
18400
- * Response data for GET /users/{userId}/addresses/{userAddressUid} — MINIMUM fields, extras pass
18401
- * through
18402
- *
18403
- * Returned by: api.agrSite.users.addresses.get(userId, userAddressUid)
18404
- */
18405
- type UsersAddressesGetData = UsersAddressesListItem;
18406
- /**
18407
- * Update a user_address row
18408
- * Response data for PUT /users/{userId}/addresses/{userAddressUid} — MINIMUM fields, extras pass
18409
- * through
18410
- *
18411
- * Returned by: api.agrSite.users.addresses.update(userId, userAddressUid, data)
18412
- */
18413
- type UsersAddressesUpdateData = UsersAddressesListItem;
18414
- /**
18415
- * Update a user_address row
18416
- * Request body for PUT /users/{userId}/addresses/{userAddressUid} — MINIMUM fields, extras pass
18417
- * through
18418
- *
18419
- * Request body of: api.agrSite.users.addresses.update(userId, userAddressUid, data)
18420
- */
18421
- interface UsersAddressesUpdateBody {
18422
- /** Address line 1 */
18423
- address1?: string | null;
18424
- /** Address line 2 */
18425
- address2?: string | null;
18426
- /** Address line 3 */
18427
- address3?: string | null;
18428
- /** City */
18429
- city?: string | null;
18430
- /** State or province */
18431
- state?: string | null;
18432
- /** Postal code */
18433
- postalCode?: string | null;
18434
- /** Country */
18435
- country?: string | null;
18436
- /** Email address */
18437
- emailAddress?: string | null;
18438
- /** Name on the address */
18439
- name?: string | null;
18440
- /** Main phone number */
18441
- phoneNumberMain?: string | null;
18442
- /** Mobile phone number */
18443
- phoneNumberMobile?: string | null;
18444
- /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
18445
- statusCd?: number | null;
18446
- /** Process code (704 = Active, 1185 = Import Complete) */
18447
- processCd?: number | null;
18091
+ /** Process code (704 = Active, 1185 = Import Complete) */
18092
+ processCd?: number | null;
18448
18093
  [key: string]: unknown;
18449
18094
  }
18450
18095
  /**
@@ -18824,379 +18469,93 @@ interface AgrSiteClientSpec {
18824
18469
  * 404: No postal code ship-to link with this ID.
18825
18470
  *
18826
18471
  * DELETE https://agr-site.augur-api.com/postal-codes-x-shiptos/{postalCodesXShiptosUid}
18827
- * Contract:
18828
- * https://agr-site.augur-api.com/openapi.json#/paths/~1postal-codes-x-shiptos~1{postalCodesXShiptosUid}/delete
18829
- *
18830
- * @param postalCodesXShiptosUid Postal code to ship-to link ID
18831
- * @returns BaseResponse whose `data` is PostalCodesXShiptosDeleteData
18832
- */
18833
- delete: (postalCodesXShiptosUid: number) => Promise<BaseResponse$1<PostalCodesXShiptosDeleteData>>;
18834
- };
18835
- settings: {
18836
- /**
18837
- * List Settings
18838
- * Call: api.agrSite.settings.list(params)
18839
- *
18840
- * Errors:
18841
- * 400: orderBy is not column|ASC or column|DESC on a settings column.
18842
- *
18843
- * GET https://agr-site.augur-api.com/settings
18844
- * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings/get
18845
- *
18846
- * @param params SettingsListParams (query string)
18847
- * @returns BaseResponse whose `data` is SettingsListData
18848
- */
18849
- list: (params?: SettingsListParams) => Promise<BaseResponse$1<SettingsListData>>;
18850
- /**
18851
- * Create Settings
18852
- * Call: api.agrSite.settings.create(data)
18853
- *
18854
- * Request body: Create a setting, or return the existing one with the same service and name
18855
- *
18856
- * Errors:
18857
- * 400: The body is missing or not a JSON object.
18858
- *
18859
- * POST https://agr-site.augur-api.com/settings
18860
- * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings/post
18861
- *
18862
- * @param data SettingsCreateBody (request body)
18863
- * @returns BaseResponse whose `data` is SettingsCreateData
18864
- */
18865
- create: (data: SettingsCreateBody) => Promise<BaseResponse$1<SettingsCreateData>>;
18866
- /**
18867
- * Get Settings Details
18868
- * Call: api.agrSite.settings.get(settingsUid)
18869
- *
18870
- * Errors:
18871
- * 404: No setting with this ID.
18872
- *
18873
- * GET https://agr-site.augur-api.com/settings/{settingsUid}
18874
- * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings~1{settingsUid}/get
18875
- *
18876
- * @param settingsUid Setting ID
18877
- * @param params SettingsGetParams (query string)
18878
- * @returns BaseResponse whose `data` is SettingsGetData
18879
- */
18880
- get: (settingsUid: number, params?: SettingsGetParams) => Promise<BaseResponse$1<SettingsGetData>>;
18881
- /**
18882
- * Update Settings
18883
- * Call: api.agrSite.settings.update(settingsUid, data)
18884
- *
18885
- * Request body: Partial update of a setting; an absent field keeps its current value
18886
- *
18887
- * Errors:
18888
- * 400: The body is missing or not a JSON object.
18889
- * 404: No setting with this ID.
18890
- *
18891
- * PUT https://agr-site.augur-api.com/settings/{settingsUid}
18892
- * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings~1{settingsUid}/put
18893
- *
18894
- * @param settingsUid Setting ID
18895
- * @param data SettingsUpdateBody (request body)
18896
- * @returns BaseResponse whose `data` is SettingsUpdateData
18897
- */
18898
- update: (settingsUid: number, data: SettingsUpdateBody) => Promise<BaseResponse$1<SettingsUpdateData>>;
18899
- /**
18900
- * DELETE Settings
18901
- * Call: api.agrSite.settings.delete(settingsUid)
18902
- *
18903
- * Errors:
18904
- * 400: settingsUid is 0 or negative.
18905
- * 404: No setting with this ID.
18906
- *
18907
- * DELETE https://agr-site.augur-api.com/settings/{settingsUid}
18908
- * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings~1{settingsUid}/delete
18909
- *
18910
- * @param settingsUid Setting ID
18911
- * @returns BaseResponse whose `data` is SettingsDeleteData
18912
- */
18913
- delete: (settingsUid: number) => Promise<BaseResponse$1<SettingsDeleteData>>;
18914
- };
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
- };
18472
+ * Contract:
18473
+ * https://agr-site.augur-api.com/openapi.json#/paths/~1postal-codes-x-shiptos~1{postalCodesXShiptosUid}/delete
18474
+ *
18475
+ * @param postalCodesXShiptosUid Postal code to ship-to link ID
18476
+ * @returns BaseResponse whose `data` is PostalCodesXShiptosDeleteData
18477
+ */
18478
+ delete: (postalCodesXShiptosUid: number) => Promise<BaseResponse$1<PostalCodesXShiptosDeleteData>>;
18479
+ };
18480
+ settings: {
18481
+ /**
18482
+ * List Settings
18483
+ * Call: api.agrSite.settings.list(params)
18484
+ *
18485
+ * Errors:
18486
+ * 400: orderBy is not column|ASC or column|DESC on a settings column.
18487
+ *
18488
+ * GET https://agr-site.augur-api.com/settings
18489
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings/get
18490
+ *
18491
+ * @param params SettingsListParams (query string)
18492
+ * @returns BaseResponse whose `data` is SettingsListData
18493
+ */
18494
+ list: (params?: SettingsListParams) => Promise<BaseResponse$1<SettingsListData>>;
18495
+ /**
18496
+ * Create Settings
18497
+ * Call: api.agrSite.settings.create(data)
18498
+ *
18499
+ * Request body: Create a setting, or return the existing one with the same service and name
18500
+ *
18501
+ * Errors:
18502
+ * 400: The body is missing or not a JSON object.
18503
+ *
18504
+ * POST https://agr-site.augur-api.com/settings
18505
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings/post
18506
+ *
18507
+ * @param data SettingsCreateBody (request body)
18508
+ * @returns BaseResponse whose `data` is SettingsCreateData
18509
+ */
18510
+ create: (data: SettingsCreateBody) => Promise<BaseResponse$1<SettingsCreateData>>;
18511
+ /**
18512
+ * Get Settings Details
18513
+ * Call: api.agrSite.settings.get(settingsUid)
18514
+ *
18515
+ * Errors:
18516
+ * 404: No setting with this ID.
18517
+ *
18518
+ * GET https://agr-site.augur-api.com/settings/{settingsUid}
18519
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings~1{settingsUid}/get
18520
+ *
18521
+ * @param settingsUid Setting ID
18522
+ * @param params SettingsGetParams (query string)
18523
+ * @returns BaseResponse whose `data` is SettingsGetData
18524
+ */
18525
+ get: (settingsUid: number, params?: SettingsGetParams) => Promise<BaseResponse$1<SettingsGetData>>;
18526
+ /**
18527
+ * Update Settings
18528
+ * Call: api.agrSite.settings.update(settingsUid, data)
18529
+ *
18530
+ * Request body: Partial update of a setting; an absent field keeps its current value
18531
+ *
18532
+ * Errors:
18533
+ * 400: The body is missing or not a JSON object.
18534
+ * 404: No setting with this ID.
18535
+ *
18536
+ * PUT https://agr-site.augur-api.com/settings/{settingsUid}
18537
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings~1{settingsUid}/put
18538
+ *
18539
+ * @param settingsUid Setting ID
18540
+ * @param data SettingsUpdateBody (request body)
18541
+ * @returns BaseResponse whose `data` is SettingsUpdateData
18542
+ */
18543
+ update: (settingsUid: number, data: SettingsUpdateBody) => Promise<BaseResponse$1<SettingsUpdateData>>;
18544
+ /**
18545
+ * DELETE Settings
18546
+ * Call: api.agrSite.settings.delete(settingsUid)
18547
+ *
18548
+ * Errors:
18549
+ * 400: settingsUid is 0 or negative.
18550
+ * 404: No setting with this ID.
18551
+ *
18552
+ * DELETE https://agr-site.augur-api.com/settings/{settingsUid}
18553
+ * Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1settings~1{settingsUid}/delete
18554
+ *
18555
+ * @param settingsUid Setting ID
18556
+ * @returns BaseResponse whose `data` is SettingsDeleteData
18557
+ */
18558
+ delete: (settingsUid: number) => Promise<BaseResponse$1<SettingsDeleteData>>;
19200
18559
  };
19201
18560
  users: {
19202
18561
  addresses: {
@@ -19351,36 +18710,6 @@ type types$h_SettingsListItem = SettingsListItem;
19351
18710
  type types$h_SettingsListParams = SettingsListParams;
19352
18711
  type types$h_SettingsUpdateBody = SettingsUpdateBody;
19353
18712
  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
18713
  type types$h_UsersAddressesCreateBody = UsersAddressesCreateBody;
19385
18714
  type types$h_UsersAddressesCreateData = UsersAddressesCreateData;
19386
18715
  type types$h_UsersAddressesDeleteData = UsersAddressesDeleteData;
@@ -19392,13 +18721,13 @@ type types$h_UsersAddressesListParams = UsersAddressesListParams;
19392
18721
  type types$h_UsersAddressesUpdateBody = UsersAddressesUpdateBody;
19393
18722
  type types$h_UsersAddressesUpdateData = UsersAddressesUpdateData;
19394
18723
  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 };
18724
+ 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_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
18725
  }
19397
18726
 
19398
18727
  /**
19399
18728
  * Generated client for the agr-site service.
19400
- * Central site configuration hub managing settings, notifications, training data, and cross-service
19401
- * integrations per client
18729
+ * Central site configuration hub managing settings, notifications, and cross-service integrations
18730
+ * per client
19402
18731
  *
19403
18732
  * Public specs (the source of truth for every shape below):
19404
18733
  * https://agr-site.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
@@ -19456,43 +18785,6 @@ declare namespace types$h {
19456
18785
  * PUT /settings/{settingsUid} → api.agrSite.settings.update(settingsUid, data) →
19457
18786
  * SettingsUpdateData
19458
18787
  * 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
18788
  * GET /users/{userId}/addresses → api.agrSite.users.addresses.list(userId, params) →
19497
18789
  * UsersAddressesListData
19498
18790
  * POST /users/{userId}/addresses → api.agrSite.users.addresses.create(userId, data) →
@@ -19516,7 +18808,6 @@ declare class AgrSiteClient extends BaseServiceClient {
19516
18808
  readonly openSearch: AgrSiteClientSpec['openSearch'];
19517
18809
  readonly postalCodesXShiptos: AgrSiteClientSpec['postalCodesXShiptos'];
19518
18810
  readonly settings: AgrSiteClientSpec['settings'];
19519
- readonly training: AgrSiteClientSpec['training'];
19520
18811
  readonly users: AgrSiteClientSpec['users'];
19521
18812
  readonly configsData: DataOnly<AgrSiteClientSpec['configs']>;
19522
18813
  readonly contextData: DataOnly<AgrSiteClientSpec['context']>;
@@ -19528,7 +18819,6 @@ declare class AgrSiteClient extends BaseServiceClient {
19528
18819
  readonly openSearchData: DataOnly<AgrSiteClientSpec['openSearch']>;
19529
18820
  readonly postalCodesXShiptosData: DataOnly<AgrSiteClientSpec['postalCodesXShiptos']>;
19530
18821
  readonly settingsData: DataOnly<AgrSiteClientSpec['settings']>;
19531
- readonly trainingData: DataOnly<AgrSiteClientSpec['training']>;
19532
18822
  readonly usersData: DataOnly<AgrSiteClientSpec['users']>;
19533
18823
  constructor(http: HTTPClient, baseUrl?: string);
19534
18824
  protected getServiceDescription(): string;
@@ -21143,7 +20433,7 @@ interface CustomerShipToListItem {
21143
20433
  /** Shipping route description */
21144
20434
  routeDescription: string | null;
21145
20435
  /** The ship-to's address; null when no address row matches */
21146
- address: CustomerShipToListItemAddress;
20436
+ address: CustomerShipToListItemAddress | null;
21147
20437
  [key: string]: unknown;
21148
20438
  }
21149
20439
  /** Returned by: api.customers.customer.shipTo.list(customerId, params) */
@@ -24736,9 +24026,9 @@ interface ElementPaymentCreateBodyAddressBilling {
24736
24026
  */
24737
24027
  interface ElementPaymentCreateBodyAddress {
24738
24028
  /** Billing address; address1 and postalCode feed the AVS check */
24739
- billing?: ElementPaymentCreateBodyAddressBilling;
24029
+ billing?: ElementPaymentCreateBodyAddressBilling | null;
24740
24030
  /** Shipping address; state and postalCode pick the site's Element processor */
24741
- shipping?: ElementPaymentCreateBodyAddressBilling;
24031
+ shipping?: ElementPaymentCreateBodyAddressBilling | null;
24742
24032
  [key: string]: unknown;
24743
24033
  }
24744
24034
  /**
@@ -24749,9 +24039,9 @@ interface ElementPaymentCreateBodyAddress {
24749
24039
  */
24750
24040
  interface ElementPaymentCreateBody {
24751
24041
  /** Card to tokenize */
24752
- card?: ElementPaymentCreateBodyCard;
24042
+ card?: ElementPaymentCreateBodyCard | null;
24753
24043
  /** Billing and shipping addresses; shipping picks the processor, billing feeds AVS */
24754
- address?: ElementPaymentCreateBodyAddress;
24044
+ address?: ElementPaymentCreateBodyAddress | null;
24755
24045
  [key: string]: unknown;
24756
24046
  }
24757
24047
  /**
@@ -24849,7 +24139,7 @@ interface PaypalAuthorizationCaptureCreateDataOption1 {
24849
24139
  /** Reason the capture is in its status ([] when empty) */
24850
24140
  statusDetails?: Record<string, unknown> | [] | null;
24851
24141
  /** Captured amount */
24852
- amount?: PaypalAuthorizationCaptureCreateDataOption1Amount;
24142
+ amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
24853
24143
  /** Invoice identifier */
24854
24144
  invoiceId?: string | null;
24855
24145
  /** Merchant custom ID sent with the order */
@@ -24969,7 +24259,7 @@ interface PaypalAuthorizationVoidCreateDataOption1 {
24969
24259
  /** Reason the authorization is in its status ([] when empty) */
24970
24260
  statusDetails?: Record<string, unknown> | [] | null;
24971
24261
  /** Authorized amount */
24972
- amount?: PaypalAuthorizationCaptureCreateDataOption1Amount;
24262
+ amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
24973
24263
  /** Invoice identifier sent with the order */
24974
24264
  invoiceId?: string | null;
24975
24265
  /** Merchant custom ID sent with the order */
@@ -25030,7 +24320,7 @@ interface PaypalCaptureRefundCreateDataOption1 {
25030
24320
  /** Reason the refund is in its status ([] when empty) */
25031
24321
  statusDetails?: Record<string, unknown> | [] | null;
25032
24322
  /** Refunded amount */
25033
- amount?: PaypalAuthorizationCaptureCreateDataOption1Amount;
24323
+ amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
25034
24324
  /** Invoice identifier */
25035
24325
  invoiceId?: string | null;
25036
24326
  /** Merchant custom ID */
@@ -25102,7 +24392,7 @@ interface PaypalOrderCreateDataOption1PurchaseUnitsItem {
25102
24392
  /** Purchase unit reference ID */
25103
24393
  referenceId?: string | null;
25104
24394
  /** Purchase unit amount */
25105
- amount?: PaypalAuthorizationCaptureCreateDataOption1Amount;
24395
+ amount?: PaypalAuthorizationCaptureCreateDataOption1Amount | null;
25106
24396
  /** Merchant receiving the payment ([] when empty) */
25107
24397
  payee?: Record<string, unknown> | [] | null;
25108
24398
  /** Platform fees and disbursement instructions ([] when empty) */
@@ -25120,7 +24410,7 @@ interface PaypalOrderCreateDataOption1PurchaseUnitsItem {
25120
24410
  /** Card and level 2/3 data ([] when empty) */
25121
24411
  supplementaryData?: Record<string, unknown> | [] | null;
25122
24412
  /** Authorizations, captures and refunds made against the unit */
25123
- payments?: PaypalOrderCreateDataOption1PurchaseUnitsItemPayments;
24413
+ payments?: PaypalOrderCreateDataOption1PurchaseUnitsItemPayments | null;
25124
24414
  [key: string]: unknown;
25125
24415
  }
25126
24416
  /**
@@ -25165,7 +24455,7 @@ interface PaypalOrderCreateDataOption1PayerAddress {
25165
24455
  */
25166
24456
  interface PaypalOrderCreateDataOption1Payer {
25167
24457
  /** Payer name */
25168
- name?: PaypalOrderCreateDataOption1PayerName;
24458
+ name?: PaypalOrderCreateDataOption1PayerName | null;
25169
24459
  /** Payer email address */
25170
24460
  emailAddress?: string | null;
25171
24461
  /** PayPal payer ID (the PayerID PayPal appends to the return URL) */
@@ -25177,7 +24467,7 @@ interface PaypalOrderCreateDataOption1Payer {
25177
24467
  /** Payer tax ID ([] when empty) */
25178
24468
  taxInfo?: Record<string, unknown> | [] | null;
25179
24469
  /** Payer address */
25180
- address?: PaypalOrderCreateDataOption1PayerAddress;
24470
+ address?: PaypalOrderCreateDataOption1PayerAddress | null;
25181
24471
  [key: string]: unknown;
25182
24472
  }
25183
24473
  /**
@@ -25202,7 +24492,7 @@ interface PaypalOrderCreateDataOption1 {
25202
24492
  /** Purchase units, with the payments made against each */
25203
24493
  purchaseUnits?: PaypalOrderCreateDataOption1PurchaseUnitsItem[] | null;
25204
24494
  /** Buyer who approved the order */
25205
- payer?: PaypalOrderCreateDataOption1Payer;
24495
+ payer?: PaypalOrderCreateDataOption1Payer | null;
25206
24496
  /** When the order was created (ISO 8601) */
25207
24497
  createTime?: string | null;
25208
24498
  /** When the order was last updated (ISO 8601) */
@@ -25379,11 +24669,11 @@ interface PaytraceAuthorizationCreateBody {
25379
24669
  /** Dollar amount to authorize */
25380
24670
  amount: number | null;
25381
24671
  /** Card to authorize */
25382
- creditCard: PaytraceAuthorizationCreateBodyCreditCard;
24672
+ creditCard: PaytraceAuthorizationCreateBodyCreditCard | null;
25383
24673
  /** Card security code (3-4 digits) */
25384
24674
  csc?: string | null;
25385
24675
  /** Billing address sent with the authorization */
25386
- billingAddress?: PaytraceAuthorizationCreateBodyBillingAddress;
24676
+ billingAddress?: PaytraceAuthorizationCreateBodyBillingAddress | null;
25387
24677
  /** Invoice identifier */
25388
24678
  invoiceId?: string | null;
25389
24679
  /** true (or the string "true" or "1") uses the PayTrace sandbox; default live */
@@ -26476,7 +25766,7 @@ interface SitesValidateCreateData {
26476
25766
  /** True for a Joomla super user token */
26477
25767
  isAdmin: boolean;
26478
25768
  /** The token's user; null for a site token or a failed validation */
26479
- user: SitesValidateCreateDataUser;
25769
+ user: SitesValidateCreateDataUser | null;
26480
25770
  /** The site's P21 database connection */
26481
25771
  connection: SitesValidateCreateDataConnection;
26482
25772
  [key: string]: unknown;
@@ -27085,7 +26375,8 @@ declare class AgrInfoClient extends BaseServiceClient {
27085
26375
 
27086
26376
  /**
27087
26377
  * Generated types for the agr-int service.
27088
- * agr_int
26378
+ * Access control for Augur API users and clients: users, roles, bundles, resources, per-user table
26379
+ * access grants, and client credentials
27089
26380
  *
27090
26381
  * Public specs (the source of truth for every shape below):
27091
26382
  * https://agr-int.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
@@ -27533,25 +26824,25 @@ type ClientsListData = ClientsListItem[];
27533
26824
  */
27534
26825
  interface ClientsCreateData {
27535
26826
  /** Client credential unique ID; 0 when issuing failed */
27536
- clientsUid?: number;
26827
+ clientsUid: number;
27537
26828
  /** Public client identifier (agrc_ prefix) */
27538
- clientId?: string;
26829
+ clientId: string;
27539
26830
  /** agr_int user the credential acts as */
27540
- usersUid?: number;
26831
+ usersUid: number;
27541
26832
  /** Site secret key version the client_id was issued under */
27542
- keyVersion?: number;
26833
+ keyVersion: number;
27543
26834
  /** Admin-facing label, e.g. the connector name */
27544
- clientName?: string;
26835
+ clientName: string;
27545
26836
  /** Admin-facing notes */
27546
- description?: string | null;
26837
+ description: string | null;
27547
26838
  /** ID of the admin who issued the credential; null when issued from the CLI */
27548
- issuedById?: number | null;
26839
+ issuedById: number | null;
27549
26840
  /** Username of the admin who issued the credential */
27550
- issuedByUsername?: string | null;
26841
+ issuedByUsername: string | null;
27551
26842
  /** Status code: 704 = Active */
27552
- statusCd?: number;
26843
+ statusCd: number;
27553
26844
  /** Full bearer string agrc_<clientId>.<secret><crc32> */
27554
- credential?: string;
26845
+ credential: string;
27555
26846
  [key: string]: unknown;
27556
26847
  }
27557
26848
  /**
@@ -27580,25 +26871,25 @@ interface ClientsCreateBody {
27580
26871
  */
27581
26872
  interface ClientsValidateCreateData {
27582
26873
  /** True only when the credential decrypts, matches, and its client and user are ACTIVE */
27583
- valid?: boolean;
26874
+ valid: boolean;
27584
26875
  /** Site decrypted from the client_id; consumers MUST scope the connection to it */
27585
- siteId?: string;
26876
+ siteId: string;
27586
26877
  /** Always "client" for a valid credential */
27587
- tokenUse?: string;
26878
+ tokenUse: string;
27588
26879
  /** Client credential unique ID */
27589
- clientUid?: number;
26880
+ clientUid: number;
27590
26881
  /** Public client identifier (agrc_ prefix) */
27591
- clientId?: string;
26882
+ clientId: string;
27592
26883
  /** agr_int user the credential acts as */
27593
- usersUid?: number;
26884
+ usersUid: number;
27594
26885
  /** Username of that user */
27595
- username?: string;
26886
+ username: string;
27596
26887
  /** Active role ids the owning user holds */
27597
- roles?: string[];
26888
+ roles: string[];
27598
26889
  /** Active bundle ids granted through those roles */
27599
- bundles?: string[];
26890
+ bundles: string[];
27600
26891
  /** P21 table set (resources.resource_path) the credential may query */
27601
- resources?: string[];
26892
+ resources: string[];
27602
26893
  [key: string]: unknown;
27603
26894
  }
27604
26895
  /**
@@ -27626,41 +26917,41 @@ interface ClientsValidateCreateBody {
27626
26917
  */
27627
26918
  interface ClientsGetData {
27628
26919
  /** Client credential unique ID */
27629
- clientsUid?: number;
26920
+ clientsUid: number;
27630
26921
  /** Public client identifier (agrc_ prefix) */
27631
- clientId?: string;
26922
+ clientId: string;
27632
26923
  /** Re-derived 43-char client secret; '' when the credential is not revealable */
27633
- clientSecret?: string;
26924
+ clientSecret: string;
27634
26925
  /** agr_int user the credential acts as */
27635
- usersUid?: number;
26926
+ usersUid: number;
27636
26927
  /** Site secret key version the client_id was issued under */
27637
- keyVersion?: number;
26928
+ keyVersion: number;
27638
26929
  /** Admin-facing label, e.g. the connector name */
27639
- clientName?: string;
26930
+ clientName: string;
27640
26931
  /** Admin-facing notes */
27641
- description?: string | null;
26932
+ description: string | null;
27642
26933
  /** ID of the admin who issued the credential; null when issued from the CLI */
27643
- issuedById?: number | null;
26934
+ issuedById: number | null;
27644
26935
  /** Username of the admin who issued the credential */
27645
- issuedByUsername?: string | null;
26936
+ issuedByUsername: string | null;
27646
26937
  /** ID of the admin who retired the credential; null while active */
27647
- retiredById?: number | null;
26938
+ retiredById: number | null;
27648
26939
  /** Username of the admin who retired the credential */
27649
- retiredByUsername?: string | null;
26940
+ retiredByUsername: string | null;
27650
26941
  /** When the credential last authenticated (Y-m-d H:i:s); null if never used */
27651
- dateLastUsed?: string | null;
26942
+ dateLastUsed: string | null;
27652
26943
  /** When the credential was issued (Y-m-d H:i:s) */
27653
- dateCreated?: string;
26944
+ dateCreated: string;
27654
26945
  /** When the credential was last modified (Y-m-d H:i:s) */
27655
- dateLastModified?: string;
26946
+ dateLastModified: string;
27656
26947
  /** Update code (1185 = Import Complete) */
27657
- updateCd?: number;
26948
+ updateCd: number;
27658
26949
  /** Status code: 704 = Active, 705 = Inactive, 700 = Retired */
27659
- statusCd?: number;
26950
+ statusCd: number;
27660
26951
  /** Process code */
27661
- processCd?: number;
26952
+ processCd: number;
27662
26953
  /** Full bearer string agrc_<clientId>.<secret><crc32>; '' when not revealable */
27663
- credential?: string;
26954
+ credential: string;
27664
26955
  [key: string]: unknown;
27665
26956
  }
27666
26957
  /**
@@ -28015,7 +27306,7 @@ interface UsersRotateCreateData {
28015
27306
  /** Username; '' on failure */
28016
27307
  username: string;
28017
27308
  /** Signed access JWT (scope agr-int-user) to present as a bearer; '' on failure */
28018
- token?: string;
27309
+ token: string;
28019
27310
  [key: string]: unknown;
28020
27311
  }
28021
27312
  /**
@@ -28040,23 +27331,23 @@ interface UsersRotateCreateBody {
28040
27331
  */
28041
27332
  interface UsersValidateCreateData {
28042
27333
  /** True only when the token verifies, has scope agr-int-user, and its user is ACTIVE */
28043
- valid?: boolean;
27334
+ valid: boolean;
28044
27335
  /** Token scope; consumers MUST authorize on this, not on userId */
28045
- scope?: string;
27336
+ scope: string;
28046
27337
  /** agr_int user unique ID (users_uid) */
28047
- userId?: number;
27338
+ userId: number;
28048
27339
  /** Username, refreshed from the user row */
28049
- username?: string;
27340
+ username: string;
28050
27341
  /** Email address, refreshed from the user row */
28051
- email?: string;
27342
+ email: string;
28052
27343
  /** Display name, refreshed from the user row */
28053
- name?: string;
27344
+ name: string;
28054
27345
  /** Active role ids the user holds */
28055
- roles?: string[];
27346
+ roles: string[];
28056
27347
  /** Active bundle ids granted through those roles */
28057
- bundles?: string[];
27348
+ bundles: string[];
28058
27349
  /** P21 table set (resources.resource_path) the user may query */
28059
- resources?: string[];
27350
+ resources: string[];
28060
27351
  [key: string]: unknown;
28061
27352
  }
28062
27353
  /**
@@ -29145,7 +28436,8 @@ declare namespace types$b {
29145
28436
 
29146
28437
  /**
29147
28438
  * Generated client for the agr-int service.
29148
- * agr_int
28439
+ * Access control for Augur API users and clients: users, roles, bundles, resources, per-user table
28440
+ * access grants, and client credentials
29149
28441
  *
29150
28442
  * Public specs (the source of truth for every shape below):
29151
28443
  * https://agr-int.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
@@ -29338,7 +28630,7 @@ interface RatesCreateBodyItemsItem {
29338
28630
  */
29339
28631
  interface RatesCreateBody$1 {
29340
28632
  /** Ship-to address */
29341
- address: RatesCreateBodyAddress;
28633
+ address: RatesCreateBodyAddress | null;
29342
28634
  /** Order lines to tax */
29343
28635
  items: RatesCreateBodyItemsItem[];
29344
28636
  [key: string]: unknown;
@@ -31562,7 +30854,7 @@ interface LocationListItem {
31562
30854
  /** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
31563
30855
  updateCd: number;
31564
30856
  /** The location's address; the key is absent unless includeAddress=Y */
31565
- address?: AddressListItem;
30857
+ address?: AddressListItem | null;
31566
30858
  [key: string]: unknown;
31567
30859
  }
31568
30860
  /** Returned by: api.p21Core.location.list(params) */
@@ -32077,6 +31369,26 @@ interface ScheduledImportMasterListParams extends EdgeCacheParams {
32077
31369
  }
32078
31370
  /** Params for GET /scheduled-import-master/{scheduledImportMasterUid} */
32079
31371
  type ScheduledImportMasterGetParams = EdgeCacheParams;
31372
+ /** Params for GET /scheduled-import-metadata */
31373
+ interface ScheduledImportMetadataListParams extends EdgeCacheParams {
31374
+ /** Filter by delivery method: pending_import, ftp, sftp */
31375
+ deliveryMethod?: string;
31376
+ /** limit number of results (Default: 10) */
31377
+ limit?: number;
31378
+ /** offset (Default: 0) */
31379
+ offset?: number;
31380
+ /** Order By field (Default: scheduled_import_metadata_uid|ASC) */
31381
+ orderBy?: string;
31382
+ /** Filter by scheduled import master */
31383
+ scheduledImportMasterUid?: number;
31384
+ /**
31385
+ * Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
31386
+ * (704,705); -1 for every status. Default: 704
31387
+ */
31388
+ statusCd?: number | number[];
31389
+ }
31390
+ /** Params for GET /scheduled-import-metadata/{scheduledImportMetadataUid} */
31391
+ type ScheduledImportMetadataGetParams = EdgeCacheParams;
32080
31392
  /**
32081
31393
  * get a list of imports
32082
31394
  * Response data for GET /import — MINIMUM fields, extras pass through
@@ -32599,6 +31911,65 @@ type ScheduledImportMasterListData = ScheduledImportMasterListItem[];
32599
31911
  * Returned by: api.p21Sism.scheduledImportMaster.get(scheduledImportMasterUid)
32600
31912
  */
32601
31913
  type ScheduledImportMasterGetData = ScheduledImportMasterListItem;
31914
+ /**
31915
+ * Set the delivery method of a scheduled import master
31916
+ * Response data for POST /scheduled-import-master/{scheduledImportMasterUid}/metadata — MINIMUM
31917
+ * fields, extras pass through
31918
+ *
31919
+ * Returned by: api.p21Sism.scheduledImportMaster.metadata.create(scheduledImportMasterUid, data)
31920
+ * Returned by: api.p21Sism.scheduledImportMetadata.list(params) (array items)
31921
+ * Returned by: api.p21Sism.scheduledImportMetadata.get(scheduledImportMetadataUid)
31922
+ * Returned by: api.p21Sism.scheduledImportMetadata.update(scheduledImportMetadataUid, data)
31923
+ * Returned by: api.p21Sism.scheduledImportMetadata.delete(scheduledImportMetadataUid)
31924
+ */
31925
+ interface ScheduledImportMasterMetadataCreateData {
31926
+ /** Scheduled import metadata ID */
31927
+ scheduledImportMetadataUid: number;
31928
+ /** Scheduled import master this delivery method is for; one record per master */
31929
+ scheduledImportMasterUid: number;
31930
+ /**
31931
+ * How import:deliver reaches P21: pending_import (on-premise P21), ftp or sftp (hosted P21) (max
31932
+ * 40 chars)
31933
+ */
31934
+ deliveryMethod: string;
31935
+ /**
31936
+ * FTP/SFTP connection as a JSON string (host, port, username, password, path); pending_import
31937
+ * does not read it (max 16777215 chars)
31938
+ */
31939
+ properties: string | null;
31940
+ /** Date the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
31941
+ dateCreated: string;
31942
+ /** Date the record was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
31943
+ dateLastModified: string;
31944
+ /** Update code (1185 = Import Complete) */
31945
+ updateCd: number;
31946
+ /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
31947
+ statusCd: number;
31948
+ /** Process code (704 = Active, 1185 = Import Complete) */
31949
+ processCd: number;
31950
+ [key: string]: unknown;
31951
+ }
31952
+ /**
31953
+ * Set the delivery method of a scheduled import master
31954
+ * Request body for POST /scheduled-import-master/{scheduledImportMasterUid}/metadata — MINIMUM
31955
+ * fields, extras pass through
31956
+ *
31957
+ * Request body of:
31958
+ * api.p21Sism.scheduledImportMaster.metadata.create(scheduledImportMasterUid, data)
31959
+ */
31960
+ interface ScheduledImportMasterMetadataCreateBody {
31961
+ /**
31962
+ * How import:deliver reaches P21: pending_import (on-premise P21), ftp or sftp (hosted P21); any
31963
+ * casing
31964
+ */
31965
+ deliveryMethod: string;
31966
+ /**
31967
+ * FTP/SFTP connection; all five fields are required for ftp and sftp; pending_import does not
31968
+ * read them
31969
+ */
31970
+ properties?: ScheduledImportMasterMetadataSftpCreateBody | null;
31971
+ [key: string]: unknown;
31972
+ }
32602
31973
  /**
32603
31974
  * Create SFTP metadata for a scheduled import master
32604
31975
  * Response data for POST /scheduled-import-master/{scheduledImportMasterUid}/metadata/sftp —
@@ -32621,22 +31992,71 @@ interface ScheduledImportMasterMetadataSftpCreateData {
32621
31992
  * Request body for POST /scheduled-import-master/{scheduledImportMasterUid}/metadata/sftp — MINIMUM
32622
31993
  * fields, extras pass through
32623
31994
  *
31995
+ * Field `properties` of ScheduledImportMasterMetadataCreateBody
32624
31996
  * Request body of:
32625
31997
  * api.p21Sism.scheduledImportMaster.metadata.sftp.create(scheduledImportMasterUid, data)
31998
+ * Field `properties` of ScheduledImportMetadataUpdateBody
32626
31999
  */
32627
32000
  interface ScheduledImportMasterMetadataSftpCreateBody {
32628
- /** SFTP server host name */
32001
+ /** FTP/SFTP server host name */
32629
32002
  host?: string | null;
32630
- /** SFTP server port */
32003
+ /** FTP/SFTP server port */
32631
32004
  port?: string | null;
32632
- /** SFTP login user name */
32005
+ /** FTP/SFTP login user name */
32633
32006
  username?: string | null;
32634
- /** SFTP login password */
32007
+ /** FTP/SFTP login password */
32635
32008
  password?: string | null;
32636
32009
  /** Remote directory the import files are written to */
32637
32010
  path?: string | null;
32638
32011
  [key: string]: unknown;
32639
32012
  }
32013
+ /**
32014
+ * List scheduled import metadata
32015
+ * Response data for GET /scheduled-import-metadata — MINIMUM fields, extras pass through
32016
+ *
32017
+ * Returned by: api.p21Sism.scheduledImportMetadata.list(params) (array items)
32018
+ */
32019
+ type ScheduledImportMetadataListItem = ScheduledImportMasterMetadataCreateData;
32020
+ /** Returned by: api.p21Sism.scheduledImportMetadata.list(params) */
32021
+ type ScheduledImportMetadataListData = ScheduledImportMetadataListItem[];
32022
+ /**
32023
+ * Get one scheduled import metadata record
32024
+ * Response data for GET /scheduled-import-metadata/{scheduledImportMetadataUid} — MINIMUM fields,
32025
+ * extras pass through
32026
+ *
32027
+ * Returned by: api.p21Sism.scheduledImportMetadata.get(scheduledImportMetadataUid)
32028
+ */
32029
+ type ScheduledImportMetadataGetData = ScheduledImportMasterMetadataCreateData;
32030
+ /**
32031
+ * Change a scheduled import metadata record
32032
+ * Response data for PUT /scheduled-import-metadata/{scheduledImportMetadataUid} — MINIMUM fields,
32033
+ * extras pass through
32034
+ *
32035
+ * Returned by: api.p21Sism.scheduledImportMetadata.update(scheduledImportMetadataUid, data)
32036
+ */
32037
+ type ScheduledImportMetadataUpdateData = ScheduledImportMasterMetadataCreateData;
32038
+ /**
32039
+ * Change a scheduled import metadata record
32040
+ * Request body for PUT /scheduled-import-metadata/{scheduledImportMetadataUid} — MINIMUM fields,
32041
+ * extras pass through
32042
+ *
32043
+ * Request body of: api.p21Sism.scheduledImportMetadata.update(scheduledImportMetadataUid, data)
32044
+ */
32045
+ interface ScheduledImportMetadataUpdateBody {
32046
+ /** New delivery method: pending_import, ftp or sftp; any casing */
32047
+ deliveryMethod?: string | null;
32048
+ /** New FTP/SFTP connection; replaces the stored properties as a whole */
32049
+ properties?: ScheduledImportMasterMetadataSftpCreateBody | null;
32050
+ [key: string]: unknown;
32051
+ }
32052
+ /**
32053
+ * Soft delete a scheduled import metadata record
32054
+ * Response data for DELETE /scheduled-import-metadata/{scheduledImportMetadataUid} — MINIMUM
32055
+ * fields, extras pass through
32056
+ *
32057
+ * Returned by: api.p21Sism.scheduledImportMetadata.delete(scheduledImportMetadataUid)
32058
+ */
32059
+ type ScheduledImportMetadataDeleteData = ScheduledImportMasterMetadataCreateData;
32640
32060
  interface P21SismClientSpec {
32641
32061
  import: {
32642
32062
  /**
@@ -32885,18 +32305,46 @@ interface P21SismClientSpec {
32885
32305
  */
32886
32306
  get: (scheduledImportMasterUid: string, params?: ScheduledImportMasterGetParams) => Promise<BaseResponse$1<ScheduledImportMasterGetData>>;
32887
32307
  metadata: {
32308
+ /**
32309
+ * Set the delivery method of a scheduled import master
32310
+ * Call: api.p21Sism.scheduledImportMaster.metadata.create(scheduledImportMasterUid, data)
32311
+ *
32312
+ * Set the delivery method (pending_import, ftp, sftp) of a scheduled import master; replaces
32313
+ * its existing record and revives a soft-deleted one
32314
+ *
32315
+ * Request body: Create (or replace) the delivery-method record of a scheduled import master;
32316
+ * a master has at most one
32317
+ *
32318
+ * Success status: 201 (not 200)
32319
+ *
32320
+ * Errors:
32321
+ * 400: Body is not a JSON object, or deliveryMethod is missing.
32322
+ * 404: No scheduled import master with this ID.
32323
+ * 422: Unknown deliveryMethod, or ftp/sftp without all five connection properties.
32324
+ *
32325
+ * POST
32326
+ * https://p21-sism.augur-api.com/scheduled-import-master/{scheduledImportMasterUid}/metadata
32327
+ * Contract:
32328
+ * https://p21-sism.augur-api.com/openapi.json#/paths/~1scheduled-import-master~1{scheduledImportMasterUid}~1metadata/post
32329
+ *
32330
+ * @param scheduledImportMasterUid Scheduled import master the delivery method is for
32331
+ * @param data ScheduledImportMasterMetadataCreateBody (request body)
32332
+ * @returns BaseResponse whose `data` is ScheduledImportMasterMetadataCreateData
32333
+ */
32334
+ create: (scheduledImportMasterUid: string, data: ScheduledImportMasterMetadataCreateBody) => Promise<BaseResponse$1<ScheduledImportMasterMetadataCreateData>>;
32888
32335
  sftp: {
32889
32336
  /**
32890
32337
  * Create SFTP metadata for a scheduled import master
32891
32338
  * Call:
32892
32339
  * api.p21Sism.scheduledImportMaster.metadata.sftp.create(scheduledImportMasterUid, data)
32893
32340
  *
32894
- * Request body: SFTP connection properties for a scheduled import master; the whole body is
32895
- * stored as-is as the metadata properties
32341
+ * Request body: FTP or SFTP connection properties for a scheduled import master, stored as
32342
+ * the metadata properties
32896
32343
  * Response data: The SFTP delivery metadata saved for a scheduled import master
32897
32344
  *
32898
32345
  * Errors:
32899
32346
  * 400: The body is missing or not a JSON object.
32347
+ * 404: No scheduled import master with this ID.
32900
32348
  *
32901
32349
  * POST
32902
32350
  * https://p21-sism.augur-api.com/scheduled-import-master/{scheduledImportMasterUid}/metadata/sftp
@@ -32911,6 +32359,84 @@ interface P21SismClientSpec {
32911
32359
  };
32912
32360
  };
32913
32361
  };
32362
+ scheduledImportMetadata: {
32363
+ /**
32364
+ * List scheduled import metadata
32365
+ * Call: api.p21Sism.scheduledImportMetadata.list(params)
32366
+ *
32367
+ * List scheduled import metadata: the delivery method import:deliver uses for each scheduled
32368
+ * import master
32369
+ *
32370
+ * Errors:
32371
+ * 400: orderBy is not one scheduled_import_metadata column with |ASC or |DESC.
32372
+ *
32373
+ * GET https://p21-sism.augur-api.com/scheduled-import-metadata
32374
+ * Contract: https://p21-sism.augur-api.com/openapi.json#/paths/~1scheduled-import-metadata/get
32375
+ *
32376
+ * @param params ScheduledImportMetadataListParams (query string)
32377
+ * @returns BaseResponse whose `data` is ScheduledImportMetadataListData
32378
+ */
32379
+ list: (params?: ScheduledImportMetadataListParams) => Promise<BaseResponse$1<ScheduledImportMetadataListData>>;
32380
+ /**
32381
+ * Get one scheduled import metadata record
32382
+ * Call: api.p21Sism.scheduledImportMetadata.get(scheduledImportMetadataUid)
32383
+ *
32384
+ * Get one scheduled import metadata record, including its properties
32385
+ *
32386
+ * Errors:
32387
+ * 404: No scheduled import metadata with this ID.
32388
+ *
32389
+ * GET https://p21-sism.augur-api.com/scheduled-import-metadata/{scheduledImportMetadataUid}
32390
+ * Contract:
32391
+ * https://p21-sism.augur-api.com/openapi.json#/paths/~1scheduled-import-metadata~1{scheduledImportMetadataUid}/get
32392
+ *
32393
+ * @param scheduledImportMetadataUid Scheduled import metadata record to return
32394
+ * @param params ScheduledImportMetadataGetParams (query string)
32395
+ * @returns BaseResponse whose `data` is ScheduledImportMetadataGetData
32396
+ */
32397
+ get: (scheduledImportMetadataUid: string, params?: ScheduledImportMetadataGetParams) => Promise<BaseResponse$1<ScheduledImportMetadataGetData>>;
32398
+ /**
32399
+ * Change a scheduled import metadata record
32400
+ * Call: api.p21Sism.scheduledImportMetadata.update(scheduledImportMetadataUid, data)
32401
+ *
32402
+ * Change the delivery method or connection properties of a scheduled import metadata record
32403
+ *
32404
+ * Request body: Change the delivery method or connection properties of a scheduled import
32405
+ * metadata record; absent fields stay as they are
32406
+ *
32407
+ * Errors:
32408
+ * 400: Body carries neither deliveryMethod nor properties.
32409
+ * 404: No scheduled import metadata with this ID.
32410
+ * 422: Unknown deliveryMethod, or the record after the change is ftp/sftp without all five
32411
+ * connection properties.
32412
+ *
32413
+ * PUT https://p21-sism.augur-api.com/scheduled-import-metadata/{scheduledImportMetadataUid}
32414
+ * Contract:
32415
+ * https://p21-sism.augur-api.com/openapi.json#/paths/~1scheduled-import-metadata~1{scheduledImportMetadataUid}/put
32416
+ *
32417
+ * @param scheduledImportMetadataUid Scheduled import metadata record to change
32418
+ * @param data ScheduledImportMetadataUpdateBody (request body)
32419
+ * @returns BaseResponse whose `data` is ScheduledImportMetadataUpdateData
32420
+ */
32421
+ update: (scheduledImportMetadataUid: string, data: ScheduledImportMetadataUpdateBody) => Promise<BaseResponse$1<ScheduledImportMetadataUpdateData>>;
32422
+ /**
32423
+ * Soft delete a scheduled import metadata record
32424
+ * Call: api.p21Sism.scheduledImportMetadata.delete(scheduledImportMetadataUid)
32425
+ *
32426
+ * Soft delete a scheduled import metadata record (statusCd 700)
32427
+ *
32428
+ * Errors:
32429
+ * 404: No scheduled import metadata with this ID.
32430
+ *
32431
+ * DELETE https://p21-sism.augur-api.com/scheduled-import-metadata/{scheduledImportMetadataUid}
32432
+ * Contract:
32433
+ * https://p21-sism.augur-api.com/openapi.json#/paths/~1scheduled-import-metadata~1{scheduledImportMetadataUid}/delete
32434
+ *
32435
+ * @param scheduledImportMetadataUid Scheduled import metadata record to soft delete
32436
+ * @returns BaseResponse whose `data` is ScheduledImportMetadataDeleteData
32437
+ */
32438
+ delete: (scheduledImportMetadataUid: string) => Promise<BaseResponse$1<ScheduledImportMetadataDeleteData>>;
32439
+ };
32914
32440
  }
32915
32441
 
32916
32442
  type types$4_ImportDailySummaryListData = ImportDailySummaryListData;
@@ -32947,10 +32473,20 @@ type types$4_ScheduledImportMasterGetParams = ScheduledImportMasterGetParams;
32947
32473
  type types$4_ScheduledImportMasterListData = ScheduledImportMasterListData;
32948
32474
  type types$4_ScheduledImportMasterListItem = ScheduledImportMasterListItem;
32949
32475
  type types$4_ScheduledImportMasterListParams = ScheduledImportMasterListParams;
32476
+ type types$4_ScheduledImportMasterMetadataCreateBody = ScheduledImportMasterMetadataCreateBody;
32477
+ type types$4_ScheduledImportMasterMetadataCreateData = ScheduledImportMasterMetadataCreateData;
32950
32478
  type types$4_ScheduledImportMasterMetadataSftpCreateBody = ScheduledImportMasterMetadataSftpCreateBody;
32951
32479
  type types$4_ScheduledImportMasterMetadataSftpCreateData = ScheduledImportMasterMetadataSftpCreateData;
32480
+ type types$4_ScheduledImportMetadataDeleteData = ScheduledImportMetadataDeleteData;
32481
+ type types$4_ScheduledImportMetadataGetData = ScheduledImportMetadataGetData;
32482
+ type types$4_ScheduledImportMetadataGetParams = ScheduledImportMetadataGetParams;
32483
+ type types$4_ScheduledImportMetadataListData = ScheduledImportMetadataListData;
32484
+ type types$4_ScheduledImportMetadataListItem = ScheduledImportMetadataListItem;
32485
+ type types$4_ScheduledImportMetadataListParams = ScheduledImportMetadataListParams;
32486
+ type types$4_ScheduledImportMetadataUpdateBody = ScheduledImportMetadataUpdateBody;
32487
+ type types$4_ScheduledImportMetadataUpdateData = ScheduledImportMetadataUpdateData;
32952
32488
  declare namespace types$4 {
32953
- export type { types$4_ImportDailySummaryListData as ImportDailySummaryListData, types$4_ImportDailySummaryListItem as ImportDailySummaryListItem, types$4_ImportDailySummaryListParams as ImportDailySummaryListParams, types$4_ImportDeleteData as ImportDeleteData, types$4_ImportGetData as ImportGetData, types$4_ImportGetParams as ImportGetParams, types$4_ImportImpOeHdrListData as ImportImpOeHdrListData, types$4_ImportImpOeHdrListParams as ImportImpOeHdrListParams, types$4_ImportImpOeHdrSalesrepListData as ImportImpOeHdrSalesrepListData, types$4_ImportImpOeHdrSalesrepListParams as ImportImpOeHdrSalesrepListParams, types$4_ImportImpOeHdrSalesrepUpdateBody as ImportImpOeHdrSalesrepUpdateBody, types$4_ImportImpOeHdrSalesrepUpdateData as ImportImpOeHdrSalesrepUpdateData, types$4_ImportImpOeHdrUpdateBody as ImportImpOeHdrUpdateBody, types$4_ImportImpOeHdrUpdateData as ImportImpOeHdrUpdateData, types$4_ImportImpOeHdrWebListData as ImportImpOeHdrWebListData, types$4_ImportImpOeHdrWebListParams as ImportImpOeHdrWebListParams, types$4_ImportListData as ImportListData, types$4_ImportListItem as ImportListItem, types$4_ImportListParams as ImportListParams, types$4_ImportRecentListData as ImportRecentListData, types$4_ImportRecentListItem as ImportRecentListItem, types$4_ImportRecentListItemDateCreated as ImportRecentListItemDateCreated, types$4_ImportRecentListParams as ImportRecentListParams, types$4_ImportStuckListData as ImportStuckListData, types$4_ImportStuckListItem as ImportStuckListItem, types$4_ImportStuckListParams as ImportStuckListParams, types$4_ImportUpdateBody as ImportUpdateBody, types$4_ImportUpdateData as ImportUpdateData, types$4_P21SismClientSpec as P21SismClientSpec, types$4_ScheduledImportMasterGetData as ScheduledImportMasterGetData, types$4_ScheduledImportMasterGetParams as ScheduledImportMasterGetParams, types$4_ScheduledImportMasterListData as ScheduledImportMasterListData, types$4_ScheduledImportMasterListItem as ScheduledImportMasterListItem, types$4_ScheduledImportMasterListParams as ScheduledImportMasterListParams, types$4_ScheduledImportMasterMetadataSftpCreateBody as ScheduledImportMasterMetadataSftpCreateBody, types$4_ScheduledImportMasterMetadataSftpCreateData as ScheduledImportMasterMetadataSftpCreateData };
32489
+ export type { types$4_ImportDailySummaryListData as ImportDailySummaryListData, types$4_ImportDailySummaryListItem as ImportDailySummaryListItem, types$4_ImportDailySummaryListParams as ImportDailySummaryListParams, types$4_ImportDeleteData as ImportDeleteData, types$4_ImportGetData as ImportGetData, types$4_ImportGetParams as ImportGetParams, types$4_ImportImpOeHdrListData as ImportImpOeHdrListData, types$4_ImportImpOeHdrListParams as ImportImpOeHdrListParams, types$4_ImportImpOeHdrSalesrepListData as ImportImpOeHdrSalesrepListData, types$4_ImportImpOeHdrSalesrepListParams as ImportImpOeHdrSalesrepListParams, types$4_ImportImpOeHdrSalesrepUpdateBody as ImportImpOeHdrSalesrepUpdateBody, types$4_ImportImpOeHdrSalesrepUpdateData as ImportImpOeHdrSalesrepUpdateData, types$4_ImportImpOeHdrUpdateBody as ImportImpOeHdrUpdateBody, types$4_ImportImpOeHdrUpdateData as ImportImpOeHdrUpdateData, types$4_ImportImpOeHdrWebListData as ImportImpOeHdrWebListData, types$4_ImportImpOeHdrWebListParams as ImportImpOeHdrWebListParams, types$4_ImportListData as ImportListData, types$4_ImportListItem as ImportListItem, types$4_ImportListParams as ImportListParams, types$4_ImportRecentListData as ImportRecentListData, types$4_ImportRecentListItem as ImportRecentListItem, types$4_ImportRecentListItemDateCreated as ImportRecentListItemDateCreated, types$4_ImportRecentListParams as ImportRecentListParams, types$4_ImportStuckListData as ImportStuckListData, types$4_ImportStuckListItem as ImportStuckListItem, types$4_ImportStuckListParams as ImportStuckListParams, types$4_ImportUpdateBody as ImportUpdateBody, types$4_ImportUpdateData as ImportUpdateData, types$4_P21SismClientSpec as P21SismClientSpec, types$4_ScheduledImportMasterGetData as ScheduledImportMasterGetData, types$4_ScheduledImportMasterGetParams as ScheduledImportMasterGetParams, types$4_ScheduledImportMasterListData as ScheduledImportMasterListData, types$4_ScheduledImportMasterListItem as ScheduledImportMasterListItem, types$4_ScheduledImportMasterListParams as ScheduledImportMasterListParams, types$4_ScheduledImportMasterMetadataCreateBody as ScheduledImportMasterMetadataCreateBody, types$4_ScheduledImportMasterMetadataCreateData as ScheduledImportMasterMetadataCreateData, types$4_ScheduledImportMasterMetadataSftpCreateBody as ScheduledImportMasterMetadataSftpCreateBody, types$4_ScheduledImportMasterMetadataSftpCreateData as ScheduledImportMasterMetadataSftpCreateData, types$4_ScheduledImportMetadataDeleteData as ScheduledImportMetadataDeleteData, types$4_ScheduledImportMetadataGetData as ScheduledImportMetadataGetData, types$4_ScheduledImportMetadataGetParams as ScheduledImportMetadataGetParams, types$4_ScheduledImportMetadataListData as ScheduledImportMetadataListData, types$4_ScheduledImportMetadataListItem as ScheduledImportMetadataListItem, types$4_ScheduledImportMetadataListParams as ScheduledImportMetadataListParams, types$4_ScheduledImportMetadataUpdateBody as ScheduledImportMetadataUpdateBody, types$4_ScheduledImportMetadataUpdateData as ScheduledImportMetadataUpdateData };
32954
32490
  }
32955
32491
 
32956
32492
  /**
@@ -32999,16 +32535,32 @@ declare namespace types$4 {
32999
32535
  * GET /scheduled-import-master/{scheduledImportMasterUid} →
33000
32536
  * api.p21Sism.scheduledImportMaster.get(scheduledImportMasterUid) →
33001
32537
  * ScheduledImportMasterGetData
32538
+ * POST /scheduled-import-master/{scheduledImportMasterUid}/metadata →
32539
+ * api.p21Sism.scheduledImportMaster.metadata.create(scheduledImportMasterUid, data) →
32540
+ * ScheduledImportMasterMetadataCreateData
33002
32541
  * POST /scheduled-import-master/{scheduledImportMasterUid}/metadata/sftp →
33003
32542
  * api.p21Sism.scheduledImportMaster.metadata.sftp.create(scheduledImportMasterUid, data) →
33004
32543
  * ScheduledImportMasterMetadataSftpCreateData
32544
+ * GET /scheduled-import-metadata → api.p21Sism.scheduledImportMetadata.list(params) →
32545
+ * ScheduledImportMetadataListData
32546
+ * GET /scheduled-import-metadata/{scheduledImportMetadataUid} →
32547
+ * api.p21Sism.scheduledImportMetadata.get(scheduledImportMetadataUid) →
32548
+ * ScheduledImportMetadataGetData
32549
+ * PUT /scheduled-import-metadata/{scheduledImportMetadataUid} →
32550
+ * api.p21Sism.scheduledImportMetadata.update(scheduledImportMetadataUid, data) →
32551
+ * ScheduledImportMetadataUpdateData
32552
+ * DELETE /scheduled-import-metadata/{scheduledImportMetadataUid} →
32553
+ * api.p21Sism.scheduledImportMetadata.delete(scheduledImportMetadataUid) →
32554
+ * ScheduledImportMetadataDeleteData
33005
32555
  */
33006
32556
 
33007
32557
  declare class P21SismClient extends BaseServiceClient {
33008
32558
  readonly import: P21SismClientSpec['import'];
33009
32559
  readonly scheduledImportMaster: P21SismClientSpec['scheduledImportMaster'];
32560
+ readonly scheduledImportMetadata: P21SismClientSpec['scheduledImportMetadata'];
33010
32561
  readonly importData: DataOnly<P21SismClientSpec['import']>;
33011
32562
  readonly scheduledImportMasterData: DataOnly<P21SismClientSpec['scheduledImportMaster']>;
32563
+ readonly scheduledImportMetadataData: DataOnly<P21SismClientSpec['scheduledImportMetadata']>;
33012
32564
  constructor(http: HTTPClient, baseUrl?: string);
33013
32565
  protected getServiceDescription(): string;
33014
32566
  }
@@ -33209,85 +32761,85 @@ interface UsLookupGetParams extends EdgeCacheParams {
33209
32761
  */
33210
32762
  interface UsLookupGetData {
33211
32763
  /** Recipient or firm name on the matched address */
33212
- addressee?: string | null;
32764
+ addressee: string | null;
33213
32765
  /** Y when the match defaulted to the building rather than a unit */
33214
- buildingDefaultIndicator?: string | null;
32766
+ buildingDefaultIndicator: string | null;
33215
32767
  /** USPS carrier route code */
33216
- carrierRoute?: string | null;
32768
+ carrierRoute: string | null;
33217
32769
  /** USPS preferred city name */
33218
- cityName?: string | null;
32770
+ cityName: string | null;
33219
32771
  /** Congressional district number */
33220
- congressionalDistrict?: string | null;
32772
+ congressionalDistrict: string | null;
33221
32773
  /** USPS default city name for the ZIP code */
33222
- defaultCityName?: string | null;
32774
+ defaultCityName: string | null;
33223
32775
  /** Standardized first delivery line */
33224
- deliveryLine1?: string | null;
32776
+ deliveryLine1: string | null;
33225
32777
  /** Standardized second delivery line */
33226
- deliveryLine2?: string | null;
32778
+ deliveryLine2: string | null;
33227
32779
  /** Two-digit USPS delivery point */
33228
- deliveryPoint?: string | null;
32780
+ deliveryPoint: string | null;
33229
32781
  /** Full USPS delivery point barcode */
33230
- deliveryPointBarcode?: string | null;
32782
+ deliveryPointBarcode: string | null;
33231
32783
  /** Delivery point check digit */
33232
- deliveryPointCheckDigit?: string | null;
32784
+ deliveryPointCheckDigit: string | null;
33233
32785
  /** eLOT sequence number */
33234
- elotSequence?: string | null;
32786
+ elotSequence: string | null;
33235
32787
  /** eLOT sort: A (ascending) or D (descending) */
33236
- elotSort?: string | null;
32788
+ elotSort: string | null;
33237
32789
  /** Extra secondary designator, e.g. Ste */
33238
- extraSecondaryDesignator?: string | null;
32790
+ extraSecondaryDesignator: string | null;
33239
32791
  /** Extra secondary number */
33240
- extraSecondaryNumber?: string | null;
32792
+ extraSecondaryNumber: string | null;
33241
32793
  /** Caller-supplied input ID echoed back */
33242
- inputId?: string | null;
32794
+ inputId: string | null;
33243
32795
  /** True when the address is on the USPS Early Warning System list */
33244
- isEwsMatch?: boolean | null;
32796
+ isEwsMatch: boolean | null;
33245
32797
  /** Standardized city, state and ZIP line */
33246
- lastLine?: string | null;
32798
+ lastLine: string | null;
33247
32799
  /** Latitude of the matched address */
33248
- latitude?: number | null;
32800
+ latitude: number | null;
33249
32801
  /** Longitude of the matched address */
33250
- longitude?: number | null;
32802
+ longitude: number | null;
33251
32803
  /** True when the address observes daylight saving time */
33252
- obeyDst?: boolean | null;
32804
+ obeyDst: boolean | null;
33253
32805
  /** ZIP+4 add-on code */
33254
- plus4Code?: string | null;
32806
+ plus4Code: string | null;
33255
32807
  /** Private mailbox designator */
33256
- pmbDesignator?: string | null;
32808
+ pmbDesignator: string | null;
33257
32809
  /** Private mailbox number */
33258
- pmbNumber?: string | null;
32810
+ pmbNumber: string | null;
33259
32811
  /** Geocode precision, e.g. Zip9 */
33260
- precision?: string | null;
32812
+ precision: string | null;
33261
32813
  /** House or building number */
33262
- primaryNumber?: string | null;
32814
+ primaryNumber: string | null;
33263
32815
  /** Residential Delivery Indicator: Residential or Commercial */
33264
- rdi?: string | null;
32816
+ rdi: string | null;
33265
32817
  /** USPS record type, e.g. S (street) or H (highrise) */
33266
- recordType?: string | null;
32818
+ recordType: string | null;
33267
32819
  /** Secondary unit designator, e.g. Apt */
33268
- secondaryDesignator?: string | null;
32820
+ secondaryDesignator: string | null;
33269
32821
  /** Secondary unit number */
33270
- secondaryNumber?: string | null;
32822
+ secondaryNumber: string | null;
33271
32823
  /** Two-letter state abbreviation */
33272
- stateAbbreviation?: string | null;
32824
+ stateAbbreviation: string | null;
33273
32825
  /** Street name */
33274
- streetName?: string | null;
32826
+ streetName: string | null;
33275
32827
  /** Street post-direction, e.g. N */
33276
- streetPostDirection?: string | null;
32828
+ streetPostDirection: string | null;
33277
32829
  /** Street pre-direction, e.g. N */
33278
- streetPreDirection?: string | null;
32830
+ streetPreDirection: string | null;
33279
32831
  /** Street suffix, e.g. St */
33280
- streetSuffix?: string | null;
32832
+ streetSuffix: string | null;
33281
32833
  /** Time zone name, e.g. Eastern */
33282
- timeZone?: string | null;
32834
+ timeZone: string | null;
33283
32835
  /** Puerto Rico urbanization name */
33284
- urbanization?: string | null;
32836
+ urbanization: string | null;
33285
32837
  /** Hours offset from UTC */
33286
- utcOffset?: number | null;
32838
+ utcOffset: number | null;
33287
32839
  /** Five-digit ZIP code */
33288
- zipCode?: string | null;
32840
+ zipCode: string | null;
33289
32841
  /** ZIP code type, e.g. Standard or POBox */
33290
- zipType?: string | null;
32842
+ zipType: string | null;
33291
32843
  [key: string]: unknown;
33292
32844
  }
33293
32845
  interface SmartyStreetsClientSpec {
@@ -33300,6 +32852,9 @@ interface SmartyStreetsClientSpec {
33300
32852
  * Response data: Best US street match for the queried address; fields Smarty does not return
33301
32853
  * are null
33302
32854
  *
32855
+ * Errors:
32856
+ * 404: No US address matched the lookup.
32857
+ *
33303
32858
  * GET https://smarty-streets.augur-api.com/us/lookup
33304
32859
  * Contract: https://smarty-streets.augur-api.com/openapi.json#/paths/~1us~1lookup/get
33305
32860
  *