@simpleapps-com/augur-api 2026.10.22 → 2026.10.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{client-lbFVi2ZG.d.mts → client-YEqPdap2.d.mts} +189 -0
- package/dist/{client-lbFVi2ZG.d.ts → client-YEqPdap2.d.ts} +189 -0
- package/dist/index.d.mts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/dist/testing.d.mts +1 -1
- package/dist/testing.d.ts +1 -1
- package/package.json +1 -1
|
@@ -2990,6 +2990,9 @@ interface CommerceClientSpec {
|
|
|
2990
2990
|
*
|
|
2991
2991
|
* Response data, each item: The full item doc (InvMastHelper::generateDoc)
|
|
2992
2992
|
*
|
|
2993
|
+
* Errors:
|
|
2994
|
+
* 404: No cart_hdr row with this cartHdrUid.
|
|
2995
|
+
*
|
|
2993
2996
|
* GET https://commerce.augur-api.com/cart-hdr/{cartHdrUid}/also-bought
|
|
2994
2997
|
* Contract:
|
|
2995
2998
|
* https://commerce.augur-api.com/openapi.json#/paths/~1cart-hdr~1{cartHdrUid}~1also-bought/get
|
|
@@ -3036,6 +3039,9 @@ interface CommerceClientSpec {
|
|
|
3036
3039
|
*
|
|
3037
3040
|
* Response data, each item: One cart line with its item's id and assembly flag
|
|
3038
3041
|
*
|
|
3042
|
+
* Errors:
|
|
3043
|
+
* 404: No cart_hdr row with this cartHdrUid.
|
|
3044
|
+
*
|
|
3039
3045
|
* GET https://commerce.augur-api.com/cart-line/{cartHdrUid}
|
|
3040
3046
|
* Contract: https://commerce.augur-api.com/openapi.json#/paths/~1cart-line~1{cartHdrUid}/get
|
|
3041
3047
|
*
|
|
@@ -3068,6 +3074,7 @@ interface CommerceClientSpec {
|
|
|
3068
3074
|
* Errors:
|
|
3069
3075
|
* 400: Cart header uid is required. Or Cart line data is required. Or Every cart line
|
|
3070
3076
|
* requires invMastUid, quantity and unitOfMeasure.
|
|
3077
|
+
* 404: No cart_hdr row with this cartHdrUid.
|
|
3071
3078
|
*
|
|
3072
3079
|
* POST https://commerce.augur-api.com/cart-line/{cartHdrUid}/add
|
|
3073
3080
|
* Contract:
|
|
@@ -3111,6 +3118,7 @@ interface CommerceClientSpec {
|
|
|
3111
3118
|
* Errors:
|
|
3112
3119
|
* 400: Cart header uid is required. Or Cart line data is required. Or Every cart line
|
|
3113
3120
|
* requires invMastUid, quantity and unitOfMeasure.
|
|
3121
|
+
* 404: No cart_hdr row with this cartHdrUid.
|
|
3114
3122
|
*
|
|
3115
3123
|
* POST https://commerce.augur-api.com/cart-line/{cartHdrUid}/update
|
|
3116
3124
|
* Contract:
|
|
@@ -6337,6 +6345,7 @@ interface PricingClientSpec {
|
|
|
6337
6345
|
*
|
|
6338
6346
|
* Errors:
|
|
6339
6347
|
* 400: Invalid orderBy: not one job price line column with ASC or DESC; message says which.
|
|
6348
|
+
* 404: No job_price_hdr row with this jobPriceHdrUid.
|
|
6340
6349
|
*
|
|
6341
6350
|
* GET https://pricing.augur-api.com/job-price-hdr/{jobPriceHdrUid}/lines
|
|
6342
6351
|
* Contract:
|
|
@@ -11654,6 +11663,9 @@ interface OpenSearchClientSpec {
|
|
|
11654
11663
|
* Get Query String Redirect Details
|
|
11655
11664
|
* Call: api.openSearch.queryStringRedirect.get(queryStringRedirectUid)
|
|
11656
11665
|
*
|
|
11666
|
+
* Errors:
|
|
11667
|
+
* 404: No query_string_redirect row with this queryStringRedirectUid.
|
|
11668
|
+
*
|
|
11657
11669
|
* GET https://open-search.augur-api.com/query-string-redirect/{queryStringRedirectUid}
|
|
11658
11670
|
* Contract:
|
|
11659
11671
|
* https://open-search.augur-api.com/openapi.json#/paths/~1query-string-redirect~1{queryStringRedirectUid}/get
|
|
@@ -19075,6 +19087,7 @@ interface ItemsClientSpec {
|
|
|
19075
19087
|
* Errors:
|
|
19076
19088
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an
|
|
19077
19089
|
* attribute_x_attribute_group column.
|
|
19090
|
+
* 404: No attribute group with this attributeGroupUid.
|
|
19078
19091
|
*
|
|
19079
19092
|
* GET https://items.augur-api.com/attribute-groups/{attributeGroupUid}/attributes
|
|
19080
19093
|
* Contract:
|
|
@@ -19095,6 +19108,7 @@ interface ItemsClientSpec {
|
|
|
19095
19108
|
*
|
|
19096
19109
|
* Errors:
|
|
19097
19110
|
* 400: The body is missing or not a JSON object.
|
|
19111
|
+
* 404: No attribute group with this attributeGroupUid.
|
|
19098
19112
|
*
|
|
19099
19113
|
* POST https://items.augur-api.com/attribute-groups/{attributeGroupUid}/attributes
|
|
19100
19114
|
* Contract:
|
|
@@ -19216,6 +19230,9 @@ interface ItemsClientSpec {
|
|
|
19216
19230
|
*
|
|
19217
19231
|
* Response data: Typed response for one attribute, as returned by `GET /api/attributes` and
|
|
19218
19232
|
*
|
|
19233
|
+
* Errors:
|
|
19234
|
+
* 404: No attribute with this attributeUid.
|
|
19235
|
+
*
|
|
19219
19236
|
* GET https://items.augur-api.com/attributes/{attributeUid}
|
|
19220
19237
|
* Contract: https://items.augur-api.com/openapi.json#/paths/~1attributes~1{attributeUid}/get
|
|
19221
19238
|
*
|
|
@@ -19269,6 +19286,7 @@ interface ItemsClientSpec {
|
|
|
19269
19286
|
* item_id and the item_attribute_value columns; or invalid orderBy: MUST be one
|
|
19270
19287
|
* field|ASC or field|DESC; sortable fields are item_id and the item_attribute_value
|
|
19271
19288
|
* columns.
|
|
19289
|
+
* 404: No attribute with this attributeUid.
|
|
19272
19290
|
*
|
|
19273
19291
|
* GET https://items.augur-api.com/attributes/{attributeUid}/items
|
|
19274
19292
|
* Contract:
|
|
@@ -19311,6 +19329,7 @@ interface ItemsClientSpec {
|
|
|
19311
19329
|
* Errors:
|
|
19312
19330
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an attribute_value
|
|
19313
19331
|
* column.
|
|
19332
|
+
* 404: No attribute with this attributeUid.
|
|
19314
19333
|
*
|
|
19315
19334
|
* GET https://items.augur-api.com/attributes/{attributeUid}/values
|
|
19316
19335
|
* Contract:
|
|
@@ -19329,6 +19348,7 @@ interface ItemsClientSpec {
|
|
|
19329
19348
|
*
|
|
19330
19349
|
* Errors:
|
|
19331
19350
|
* 400: The body is missing or not a JSON object.
|
|
19351
|
+
* 404: No attribute with this attributeUid.
|
|
19332
19352
|
*
|
|
19333
19353
|
* POST https://items.augur-api.com/attributes/{attributeUid}/values
|
|
19334
19354
|
* Contract:
|
|
@@ -19343,6 +19363,9 @@ interface ItemsClientSpec {
|
|
|
19343
19363
|
* Get AttributeValue Details
|
|
19344
19364
|
* Call: api.items.attributes.values.get(attributeUid, attributeValueUid)
|
|
19345
19365
|
*
|
|
19366
|
+
* Errors:
|
|
19367
|
+
* 404: No attribute value with this attributeValueUid on this attribute.
|
|
19368
|
+
*
|
|
19346
19369
|
* GET https://items.augur-api.com/attributes/{attributeUid}/values/{attributeValueUid}
|
|
19347
19370
|
* Contract:
|
|
19348
19371
|
* https://items.augur-api.com/openapi.json#/paths/~1attributes~1{attributeUid}~1values~1{attributeValueUid}/get
|
|
@@ -19465,6 +19488,10 @@ interface ItemsClientSpec {
|
|
|
19465
19488
|
* Get Brands Details
|
|
19466
19489
|
* Call: api.items.brands.get(brandsUid, params)
|
|
19467
19490
|
*
|
|
19491
|
+
* Errors:
|
|
19492
|
+
* 400: brandsUid is 0 and no brandsId was sent.
|
|
19493
|
+
* 404: No brand with this brandsUid, or no brand matching brandsId when brandsUid is 0.
|
|
19494
|
+
*
|
|
19468
19495
|
* GET https://items.augur-api.com/brands/{brandsUid}
|
|
19469
19496
|
* Contract: https://items.augur-api.com/openapi.json#/paths/~1brands~1{brandsUid}/get
|
|
19470
19497
|
*
|
|
@@ -19512,6 +19539,9 @@ interface ItemsClientSpec {
|
|
|
19512
19539
|
*
|
|
19513
19540
|
* Response data: The filterable attributes of a category, brand or contract
|
|
19514
19541
|
*
|
|
19542
|
+
* Errors:
|
|
19543
|
+
* 404: No brand with this brandsUid.
|
|
19544
|
+
*
|
|
19515
19545
|
* GET https://items.augur-api.com/brands/{brandsUid}/attributes
|
|
19516
19546
|
* Contract:
|
|
19517
19547
|
* https://items.augur-api.com/openapi.json#/paths/~1brands~1{brandsUid}~1attributes/get
|
|
@@ -19595,6 +19625,9 @@ interface ItemsClientSpec {
|
|
|
19595
19625
|
*
|
|
19596
19626
|
* Request body: Assign an item to a brand (the brand comes from the path)
|
|
19597
19627
|
*
|
|
19628
|
+
* Errors:
|
|
19629
|
+
* 404: No brand with this brandsUid.
|
|
19630
|
+
*
|
|
19598
19631
|
* POST https://items.augur-api.com/brands/{brandsUid}/items
|
|
19599
19632
|
* Contract: https://items.augur-api.com/openapi.json#/paths/~1brands~1{brandsUid}~1items/post
|
|
19600
19633
|
*
|
|
@@ -19609,6 +19642,9 @@ interface ItemsClientSpec {
|
|
|
19609
19642
|
*
|
|
19610
19643
|
* Get a brand-to-item assignment by UID
|
|
19611
19644
|
*
|
|
19645
|
+
* Errors:
|
|
19646
|
+
* 404: No brand item assignment with this brandsXItemsUid on this brand.
|
|
19647
|
+
*
|
|
19612
19648
|
* GET https://items.augur-api.com/brands/{brandsUid}/items/{brandsXItemsUid}
|
|
19613
19649
|
* Contract:
|
|
19614
19650
|
* https://items.augur-api.com/openapi.json#/paths/~1brands~1{brandsUid}~1items~1{brandsXItemsUid}/get
|
|
@@ -19684,6 +19720,9 @@ interface ItemsClientSpec {
|
|
|
19684
19720
|
*
|
|
19685
19721
|
* Response data: The filterable attributes of a category, brand or contract
|
|
19686
19722
|
*
|
|
19723
|
+
* Errors:
|
|
19724
|
+
* 404: No item category with this itemCategoryUid.
|
|
19725
|
+
*
|
|
19687
19726
|
* GET https://items.augur-api.com/categories/{itemCategoryUid}/attributes
|
|
19688
19727
|
* Contract:
|
|
19689
19728
|
* https://items.augur-api.com/openapi.json#/paths/~1categories~1{itemCategoryUid}~1attributes/get
|
|
@@ -19705,6 +19744,7 @@ interface ItemsClientSpec {
|
|
|
19705
19744
|
* Errors:
|
|
19706
19745
|
* 400: Invalid sort '...': MUST be field|asc or field|desc, comma-separated, each field a
|
|
19707
19746
|
* keyword or numeric field of the items index.
|
|
19747
|
+
* 404: No item category with this itemCategoryUid.
|
|
19708
19748
|
*
|
|
19709
19749
|
* GET https://items.augur-api.com/categories/{itemCategoryUid}/facets
|
|
19710
19750
|
* Contract:
|
|
@@ -19724,6 +19764,9 @@ interface ItemsClientSpec {
|
|
|
19724
19764
|
* Response data: A category's images: folder images on every site, plus product collection
|
|
19725
19765
|
* and Brandfolder assets on trinitysurfaces
|
|
19726
19766
|
*
|
|
19767
|
+
* Errors:
|
|
19768
|
+
* 404: No item category with this itemCategoryUid.
|
|
19769
|
+
*
|
|
19727
19770
|
* GET https://items.augur-api.com/categories/{itemCategoryUid}/images
|
|
19728
19771
|
* Contract:
|
|
19729
19772
|
* https://items.augur-api.com/openapi.json#/paths/~1categories~1{itemCategoryUid}~1images/get
|
|
@@ -19745,6 +19788,7 @@ interface ItemsClientSpec {
|
|
|
19745
19788
|
* Errors:
|
|
19746
19789
|
* 400: Invalid sortBy '...': MUST be one field|ASC or field|DESC, the field a keyword or
|
|
19747
19790
|
* numeric field of the items index.
|
|
19791
|
+
* 404: No item category with this itemCategoryUid.
|
|
19748
19792
|
*
|
|
19749
19793
|
* GET https://items.augur-api.com/categories/{itemCategoryUid}/items
|
|
19750
19794
|
* Contract:
|
|
@@ -20025,6 +20069,7 @@ interface ItemsClientSpec {
|
|
|
20025
20069
|
* Errors:
|
|
20026
20070
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an alternate_code
|
|
20027
20071
|
* column.
|
|
20072
|
+
* 404: No item with this invMastUid.
|
|
20028
20073
|
*
|
|
20029
20074
|
* GET https://items.augur-api.com/inv-mast/{invMastUid}/alternate-code
|
|
20030
20075
|
* Contract:
|
|
@@ -20047,6 +20092,7 @@ interface ItemsClientSpec {
|
|
|
20047
20092
|
* Errors:
|
|
20048
20093
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an
|
|
20049
20094
|
* item_attribute_value column.
|
|
20095
|
+
* 404: No item with this invMastUid.
|
|
20050
20096
|
*
|
|
20051
20097
|
* GET https://items.augur-api.com/inv-mast/{invMastUid}/attributes
|
|
20052
20098
|
* Contract:
|
|
@@ -20069,6 +20115,7 @@ interface ItemsClientSpec {
|
|
|
20069
20115
|
* Errors:
|
|
20070
20116
|
* 400: The body is missing or not a JSON object. Or Invalid invMastUid. Or attributeName is
|
|
20071
20117
|
* required and must be a string. Or attributeValue is required and must be a string.
|
|
20118
|
+
* 404: No item with this invMastUid.
|
|
20072
20119
|
*
|
|
20073
20120
|
* POST https://items.augur-api.com/inv-mast/{invMastUid}/attributes
|
|
20074
20121
|
* Contract:
|
|
@@ -20114,6 +20161,7 @@ interface ItemsClientSpec {
|
|
|
20114
20161
|
* Errors:
|
|
20115
20162
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an
|
|
20116
20163
|
* item_attribute_value column.
|
|
20164
|
+
* 404: No item with this invMastUid, or no attribute with this attributeUid.
|
|
20117
20165
|
*
|
|
20118
20166
|
* GET https://items.augur-api.com/inv-mast/{invMastUid}/attributes/{attributeUid}/values
|
|
20119
20167
|
* Contract:
|
|
@@ -20136,6 +20184,7 @@ interface ItemsClientSpec {
|
|
|
20136
20184
|
* Errors:
|
|
20137
20185
|
* 400: The body is missing or not a JSON object. Or attributeValue is required and must
|
|
20138
20186
|
* be a string. Or Invalid invMastUid. Or Invalid attributeUid.
|
|
20187
|
+
* 404: No item with this invMastUid, or no attribute with this attributeUid.
|
|
20139
20188
|
*
|
|
20140
20189
|
* POST https://items.augur-api.com/inv-mast/{invMastUid}/attributes/{attributeUid}/values
|
|
20141
20190
|
* Contract:
|
|
@@ -20230,6 +20279,7 @@ interface ItemsClientSpec {
|
|
|
20230
20279
|
* Errors:
|
|
20231
20280
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an inv_mast_faq
|
|
20232
20281
|
* column.
|
|
20282
|
+
* 404: No item with this invMastUid.
|
|
20233
20283
|
*
|
|
20234
20284
|
* GET https://items.augur-api.com/inv-mast/{invMastUid}/faq
|
|
20235
20285
|
* Contract: https://items.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1faq/get
|
|
@@ -20243,6 +20293,9 @@ interface ItemsClientSpec {
|
|
|
20243
20293
|
* Get Item FAQ Details
|
|
20244
20294
|
* Call: api.items.invMast.faq.get(invMastUid, invMastFaqUid)
|
|
20245
20295
|
*
|
|
20296
|
+
* Errors:
|
|
20297
|
+
* 404: No item FAQ with this invMastFaqUid on this item.
|
|
20298
|
+
*
|
|
20246
20299
|
* GET https://items.augur-api.com/inv-mast/{invMastUid}/faq/{invMastFaqUid}
|
|
20247
20300
|
* Contract:
|
|
20248
20301
|
* https://items.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1faq~1{invMastFaqUid}/get
|
|
@@ -20302,6 +20355,7 @@ interface ItemsClientSpec {
|
|
|
20302
20355
|
* Errors:
|
|
20303
20356
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an inv_accessory
|
|
20304
20357
|
* column.
|
|
20358
|
+
* 404: No item with this invMastUid.
|
|
20305
20359
|
*
|
|
20306
20360
|
* GET https://items.augur-api.com/inv-mast/{invMastUid}/inv-accessory
|
|
20307
20361
|
* Contract:
|
|
@@ -20323,6 +20377,7 @@ interface ItemsClientSpec {
|
|
|
20323
20377
|
*
|
|
20324
20378
|
* Errors:
|
|
20325
20379
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an inv_sub column.
|
|
20380
|
+
* 404: No item with this invMastUid.
|
|
20326
20381
|
*
|
|
20327
20382
|
* GET https://items.augur-api.com/inv-mast/{invMastUid}/inv-sub
|
|
20328
20383
|
* Contract:
|
|
@@ -20345,6 +20400,7 @@ interface ItemsClientSpec {
|
|
|
20345
20400
|
*
|
|
20346
20401
|
* Errors:
|
|
20347
20402
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an inv_bin column.
|
|
20403
|
+
* 404: No item with this invMastUid.
|
|
20348
20404
|
*
|
|
20349
20405
|
* GET https://items.augur-api.com/inv-mast/{invMastUid}/locations/{locationId}/bins
|
|
20350
20406
|
* Contract:
|
|
@@ -20449,6 +20505,9 @@ interface ItemsClientSpec {
|
|
|
20449
20505
|
* Response data: An item's stock by location plus the available total per company
|
|
20450
20506
|
* (InvLocHelper::getStockDetails)
|
|
20451
20507
|
*
|
|
20508
|
+
* Errors:
|
|
20509
|
+
* 404: No item with this invMastUid.
|
|
20510
|
+
*
|
|
20452
20511
|
* GET https://items.augur-api.com/inv-mast/{invMastUid}/stock
|
|
20453
20512
|
* Contract:
|
|
20454
20513
|
* https://items.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1stock/get
|
|
@@ -20556,6 +20615,9 @@ interface ItemsClientSpec {
|
|
|
20556
20615
|
* List document links for an item
|
|
20557
20616
|
* Call: api.items.invMastLinks.get(invMastUid, params)
|
|
20558
20617
|
*
|
|
20618
|
+
* Errors:
|
|
20619
|
+
* 404: No item with this invMastUid.
|
|
20620
|
+
*
|
|
20559
20621
|
* GET https://items.augur-api.com/inv-mast-links/{invMastUid}
|
|
20560
20622
|
* Contract: https://items.augur-api.com/openapi.json#/paths/~1inv-mast-links~1{invMastUid}/get
|
|
20561
20623
|
*
|
|
@@ -20645,6 +20707,9 @@ interface ItemsClientSpec {
|
|
|
20645
20707
|
* List sub parts for an item
|
|
20646
20708
|
* Call: api.items.invMastSubParts.get(invMastUid, params)
|
|
20647
20709
|
*
|
|
20710
|
+
* Errors:
|
|
20711
|
+
* 404: No item with this invMastUid.
|
|
20712
|
+
*
|
|
20648
20713
|
* GET https://items.augur-api.com/inv-mast-sub-parts/{invMastUid}
|
|
20649
20714
|
* Contract:
|
|
20650
20715
|
* https://items.augur-api.com/openapi.json#/paths/~1inv-mast-sub-parts~1{invMastUid}/get
|
|
@@ -21423,6 +21488,9 @@ interface ItemsClientSpec {
|
|
|
21423
21488
|
* Get Item UOM Details
|
|
21424
21489
|
* Call: api.items.itemUom.get(itemUomUid)
|
|
21425
21490
|
*
|
|
21491
|
+
* Errors:
|
|
21492
|
+
* 404: No item UOM with this itemUomUid.
|
|
21493
|
+
*
|
|
21426
21494
|
* GET https://items.augur-api.com/item-uom/{itemUomUid}
|
|
21427
21495
|
* Contract: https://items.augur-api.com/openapi.json#/paths/~1item-uom~1{itemUomUid}/get
|
|
21428
21496
|
*
|
|
@@ -21517,6 +21585,7 @@ interface ItemsClientSpec {
|
|
|
21517
21585
|
* Errors:
|
|
21518
21586
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an
|
|
21519
21587
|
* item_wishlist_line column.
|
|
21588
|
+
* 404: No wishlist with this itemWishlistHdrUid.
|
|
21520
21589
|
*
|
|
21521
21590
|
* GET https://items.augur-api.com/item-wishlist/{usersId}/hdr/{itemWishlistHdrUid}
|
|
21522
21591
|
* Contract:
|
|
@@ -21539,6 +21608,7 @@ interface ItemsClientSpec {
|
|
|
21539
21608
|
*
|
|
21540
21609
|
* Errors:
|
|
21541
21610
|
* 400: Invalid JSON.
|
|
21611
|
+
* 404: No wishlist with this itemWishlistHdrUid.
|
|
21542
21612
|
*
|
|
21543
21613
|
* POST https://items.augur-api.com/item-wishlist/{usersId}/hdr/{itemWishlistHdrUid}
|
|
21544
21614
|
* Contract:
|
|
@@ -21558,6 +21628,9 @@ interface ItemsClientSpec {
|
|
|
21558
21628
|
*
|
|
21559
21629
|
* Get one item of a wishlist; an empty object when the line does not belong to the wishlist
|
|
21560
21630
|
*
|
|
21631
|
+
* Errors:
|
|
21632
|
+
* 404: No wishlist line with this itemWishlistLineUid on this wishlist.
|
|
21633
|
+
*
|
|
21561
21634
|
* GET
|
|
21562
21635
|
* https://items.augur-api.com/item-wishlist/{usersId}/hdr/{itemWishlistHdrUid}/line/{itemWishlistLineUid}
|
|
21563
21636
|
* Contract:
|
|
@@ -21946,6 +22019,7 @@ interface ItemsClientSpec {
|
|
|
21946
22019
|
* Errors:
|
|
21947
22020
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an
|
|
21948
22021
|
* item_variant_hdr_x_attribute column.
|
|
22022
|
+
* 404: No variant group with this itemVariantHdrUid.
|
|
21949
22023
|
*
|
|
21950
22024
|
* GET https://items.augur-api.com/variants/{itemVariantHdrUid}/attributes
|
|
21951
22025
|
* Contract:
|
|
@@ -21966,6 +22040,7 @@ interface ItemsClientSpec {
|
|
|
21966
22040
|
*
|
|
21967
22041
|
* Errors:
|
|
21968
22042
|
* 400: The body is missing or not a JSON object.
|
|
22043
|
+
* 404: No variant group with this itemVariantHdrUid.
|
|
21969
22044
|
*
|
|
21970
22045
|
* POST https://items.augur-api.com/variants/{itemVariantHdrUid}/attributes
|
|
21971
22046
|
* Contract:
|
|
@@ -22068,6 +22143,7 @@ interface ItemsClientSpec {
|
|
|
22068
22143
|
* Errors:
|
|
22069
22144
|
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an item_variant_line
|
|
22070
22145
|
* column.
|
|
22146
|
+
* 404: No variant group with this itemVariantHdrUid.
|
|
22071
22147
|
*
|
|
22072
22148
|
* GET https://items.augur-api.com/variants/{itemVariantHdrUid}/lines
|
|
22073
22149
|
* Contract:
|
|
@@ -22088,6 +22164,7 @@ interface ItemsClientSpec {
|
|
|
22088
22164
|
*
|
|
22089
22165
|
* Errors:
|
|
22090
22166
|
* 400: The body is missing or not a JSON object.
|
|
22167
|
+
* 404: No variant group with this itemVariantHdrUid.
|
|
22091
22168
|
*
|
|
22092
22169
|
* POST https://items.augur-api.com/variants/{itemVariantHdrUid}/lines
|
|
22093
22170
|
* Contract:
|
|
@@ -22102,6 +22179,9 @@ interface ItemsClientSpec {
|
|
|
22102
22179
|
* Get Item Variant Line Details
|
|
22103
22180
|
* Call: api.items.variants.lines.get(itemVariantHdrUid, itemVariantLineUid)
|
|
22104
22181
|
*
|
|
22182
|
+
* Errors:
|
|
22183
|
+
* 404: No variant line with this itemVariantLineUid on this variant group.
|
|
22184
|
+
*
|
|
22105
22185
|
* GET https://items.augur-api.com/variants/{itemVariantHdrUid}/lines/{itemVariantLineUid}
|
|
22106
22186
|
* Contract:
|
|
22107
22187
|
* https://items.augur-api.com/openapi.json#/paths/~1variants~1{itemVariantHdrUid}~1lines~1{itemVariantLineUid}/get
|
|
@@ -22158,6 +22238,9 @@ interface ItemsClientSpec {
|
|
|
22158
22238
|
* Response data, each item: One item similar to a variant group and not already in it, ranked
|
|
22159
22239
|
* by vector similarity
|
|
22160
22240
|
*
|
|
22241
|
+
* Errors:
|
|
22242
|
+
* 404: No variant group with this itemVariantHdrUid.
|
|
22243
|
+
*
|
|
22161
22244
|
* GET https://items.augur-api.com/variants/{itemVariantHdrUid}/similar
|
|
22162
22245
|
* Contract:
|
|
22163
22246
|
* https://items.augur-api.com/openapi.json#/paths/~1variants~1{itemVariantHdrUid}~1similar/get
|
|
@@ -24184,6 +24267,9 @@ interface LegacyClientSpec {
|
|
|
24184
24267
|
*
|
|
24185
24268
|
* Response data, each item: The full item doc (InvMastHelper::generateDoc)
|
|
24186
24269
|
*
|
|
24270
|
+
* Errors:
|
|
24271
|
+
* 404: No inv_mast row with this invMastUid.
|
|
24272
|
+
*
|
|
24187
24273
|
* GET https://legacy.augur-api.com/inv-mast/{invMastUid}/also-bought
|
|
24188
24274
|
* Contract:
|
|
24189
24275
|
* https://legacy.augur-api.com/openapi.json#/paths/~1inv-mast~1{invMastUid}~1also-bought/get
|
|
@@ -24296,6 +24382,7 @@ interface LegacyClientSpec {
|
|
|
24296
24382
|
*
|
|
24297
24383
|
* Errors:
|
|
24298
24384
|
* 400: orderBy is not column|ASC or column|DESC on an inv_mast_web_desc column.
|
|
24385
|
+
* 404: No inv_mast row with this invMastUid.
|
|
24299
24386
|
*
|
|
24300
24387
|
* GET https://legacy.augur-api.com/inv-mast/{invMastUid}/web-desc
|
|
24301
24388
|
* Contract:
|
|
@@ -24315,6 +24402,7 @@ interface LegacyClientSpec {
|
|
|
24315
24402
|
*
|
|
24316
24403
|
* Errors:
|
|
24317
24404
|
* 400: The body is missing or not a JSON object.
|
|
24405
|
+
* 404: No inv_mast row with this invMastUid.
|
|
24318
24406
|
*
|
|
24319
24407
|
* POST https://legacy.augur-api.com/inv-mast/{invMastUid}/web-desc
|
|
24320
24408
|
* Contract:
|
|
@@ -24437,6 +24525,7 @@ interface LegacyClientSpec {
|
|
|
24437
24525
|
* Call: api.legacy.legacy.state.get(stateUid, params)
|
|
24438
24526
|
*
|
|
24439
24527
|
* Errors:
|
|
24528
|
+
* 400: stateUid is 0 and no twoLetterCode was sent.
|
|
24440
24529
|
* 404: No state with this ID (or, for ID 0, with this twoLetterCode).
|
|
24441
24530
|
*
|
|
24442
24531
|
* GET https://legacy.augur-api.com/legacy/state/{stateUid}
|
|
@@ -29075,6 +29164,7 @@ interface CustomersClientSpec {
|
|
|
29075
29164
|
*
|
|
29076
29165
|
* Errors:
|
|
29077
29166
|
* 400: orderBy is not column|ASC or column|DESC on a customer column.
|
|
29167
|
+
* 404: No contact with this id.
|
|
29078
29168
|
*
|
|
29079
29169
|
* GET https://customers.augur-api.com/contacts/{id}/customers
|
|
29080
29170
|
* Contract:
|
|
@@ -29227,6 +29317,9 @@ interface CustomersClientSpec {
|
|
|
29227
29317
|
*
|
|
29228
29318
|
* Response data, each item: One shipping address in a customer's address lookup
|
|
29229
29319
|
*
|
|
29320
|
+
* Errors:
|
|
29321
|
+
* 404: No customer with this customerId.
|
|
29322
|
+
*
|
|
29230
29323
|
* GET https://customers.augur-api.com/customer/{customerId}/address
|
|
29231
29324
|
* Contract:
|
|
29232
29325
|
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1address/get
|
|
@@ -29244,6 +29337,7 @@ interface CustomersClientSpec {
|
|
|
29244
29337
|
*
|
|
29245
29338
|
* Errors:
|
|
29246
29339
|
* 400: orderBy is not column|ASC or column|DESC on a customer_address column.
|
|
29340
|
+
* 404: No customer with this customerId.
|
|
29247
29341
|
*
|
|
29248
29342
|
* GET https://customers.augur-api.com/customer/{customerId}/addresses
|
|
29249
29343
|
* Contract:
|
|
@@ -29260,6 +29354,9 @@ interface CustomersClientSpec {
|
|
|
29260
29354
|
*
|
|
29261
29355
|
* Request body: Create a customer address; every field is optional
|
|
29262
29356
|
*
|
|
29357
|
+
* Errors:
|
|
29358
|
+
* 404: No customer with this customerId.
|
|
29359
|
+
*
|
|
29263
29360
|
* POST https://customers.augur-api.com/customer/{customerId}/addresses
|
|
29264
29361
|
* Contract:
|
|
29265
29362
|
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1addresses/post
|
|
@@ -29336,6 +29433,7 @@ interface CustomersClientSpec {
|
|
|
29336
29433
|
* Errors:
|
|
29337
29434
|
* 400: asOf is not a YYYY-MM-DD date, or orderBy is not column|ASC or column|DESC on an
|
|
29338
29435
|
* invoice_hdr column.
|
|
29436
|
+
* 404: No customer with this customerId.
|
|
29339
29437
|
*
|
|
29340
29438
|
* GET https://customers.augur-api.com/customer/{customerId}/aging
|
|
29341
29439
|
* Contract:
|
|
@@ -29356,6 +29454,7 @@ interface CustomersClientSpec {
|
|
|
29356
29454
|
*
|
|
29357
29455
|
* Errors:
|
|
29358
29456
|
* 400: orderBy is not column|ASC or column|DESC on a contacts column.
|
|
29457
|
+
* 404: No customer with this customerId.
|
|
29359
29458
|
*
|
|
29360
29459
|
* GET https://customers.augur-api.com/customer/{customerId}/contacts
|
|
29361
29460
|
* Contract:
|
|
@@ -29372,6 +29471,9 @@ interface CustomersClientSpec {
|
|
|
29372
29471
|
*
|
|
29373
29472
|
* Request body: A new Prophet 21 contact, passed to the P21 Entity API as sent
|
|
29374
29473
|
*
|
|
29474
|
+
* Errors:
|
|
29475
|
+
* 404: No customer with this customerId.
|
|
29476
|
+
*
|
|
29375
29477
|
* POST https://customers.augur-api.com/customer/{customerId}/contacts
|
|
29376
29478
|
* Contract:
|
|
29377
29479
|
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1contacts/post
|
|
@@ -29416,6 +29518,7 @@ interface CustomersClientSpec {
|
|
|
29416
29518
|
*
|
|
29417
29519
|
* Errors:
|
|
29418
29520
|
* 400: orderBy is not column|ASC or column|DESC on an invoice_hdr column.
|
|
29521
|
+
* 404: No customer with this customerId.
|
|
29419
29522
|
*
|
|
29420
29523
|
* GET https://customers.augur-api.com/customer/{customerId}/invoices
|
|
29421
29524
|
* Contract:
|
|
@@ -29515,6 +29618,7 @@ interface CustomersClientSpec {
|
|
|
29515
29618
|
*
|
|
29516
29619
|
* Errors:
|
|
29517
29620
|
* 400: orderBy is not column|ASC or column|DESC on an items_x_customer column.
|
|
29621
|
+
* 404: No customer with this customerId.
|
|
29518
29622
|
*
|
|
29519
29623
|
* GET https://customers.augur-api.com/customer/{customerId}/purchased-items
|
|
29520
29624
|
* Contract:
|
|
@@ -29536,6 +29640,7 @@ interface CustomersClientSpec {
|
|
|
29536
29640
|
*
|
|
29537
29641
|
* Errors:
|
|
29538
29642
|
* 400: orderBy is not column|ASC or column|DESC on an oe_hdr column.
|
|
29643
|
+
* 404: No customer with this customerId.
|
|
29539
29644
|
*
|
|
29540
29645
|
* GET https://customers.augur-api.com/customer/{customerId}/quotes
|
|
29541
29646
|
* Contract:
|
|
@@ -29599,6 +29704,7 @@ interface CustomersClientSpec {
|
|
|
29599
29704
|
*
|
|
29600
29705
|
* Errors:
|
|
29601
29706
|
* 400: orderBy is not column|ASC or column|DESC on an oe_hdr column.
|
|
29707
|
+
* 404: No customer with this customerId.
|
|
29602
29708
|
*
|
|
29603
29709
|
* GET https://customers.augur-api.com/customer/{customerId}/rmas
|
|
29604
29710
|
* Contract:
|
|
@@ -29643,6 +29749,7 @@ interface CustomersClientSpec {
|
|
|
29643
29749
|
* 400: invoicedFrom or invoicedTo is not a YYYY-MM-DD date, invoicedFrom is later than
|
|
29644
29750
|
* invoicedTo, totalBy is not week, month or year, or orderBy is not item_id or
|
|
29645
29751
|
* item_desc with |ASC or |DESC.
|
|
29752
|
+
* 404: No customer with this customerId.
|
|
29646
29753
|
*
|
|
29647
29754
|
* GET https://customers.augur-api.com/customer/{customerId}/sales-usage
|
|
29648
29755
|
* Contract:
|
|
@@ -29661,6 +29768,9 @@ interface CustomersClientSpec {
|
|
|
29661
29768
|
*
|
|
29662
29769
|
* Request body: A new Prophet 21 ship-to, passed to the P21 Entity API as sent
|
|
29663
29770
|
*
|
|
29771
|
+
* Errors:
|
|
29772
|
+
* 404: No customer with this customerId.
|
|
29773
|
+
*
|
|
29664
29774
|
* POST https://customers.augur-api.com/customer/{customerId}/ship-to
|
|
29665
29775
|
* Contract:
|
|
29666
29776
|
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1ship-to/post
|
|
@@ -29679,6 +29789,7 @@ interface CustomersClientSpec {
|
|
|
29679
29789
|
*
|
|
29680
29790
|
* Errors:
|
|
29681
29791
|
* 400: orderBy is not column|ASC or column|DESC on a ship_to column.
|
|
29792
|
+
* 404: No customer with this customerId.
|
|
29682
29793
|
*
|
|
29683
29794
|
* GET https://customers.augur-api.com/customer/{customerId}/ship-to
|
|
29684
29795
|
* Contract:
|
|
@@ -29720,6 +29831,7 @@ interface CustomersClientSpec {
|
|
|
29720
29831
|
*
|
|
29721
29832
|
* Errors:
|
|
29722
29833
|
* 400: orderBy is not column|ASC or column|DESC on an address column.
|
|
29834
|
+
* 404: No customer with this customerId.
|
|
29723
29835
|
*
|
|
29724
29836
|
* GET https://customers.augur-api.com/customer/{customerId}/ship-to/lookup
|
|
29725
29837
|
* Contract:
|
|
@@ -29739,6 +29851,7 @@ interface CustomersClientSpec {
|
|
|
29739
29851
|
*
|
|
29740
29852
|
* Errors:
|
|
29741
29853
|
* 400: orderBy is not column|ASC or column|DESC on a customer_tags column.
|
|
29854
|
+
* 404: No customer with this customerId.
|
|
29742
29855
|
*
|
|
29743
29856
|
* GET https://customers.augur-api.com/customer/{customerId}/tags
|
|
29744
29857
|
* Contract:
|
|
@@ -29757,6 +29870,7 @@ interface CustomersClientSpec {
|
|
|
29757
29870
|
*
|
|
29758
29871
|
* Errors:
|
|
29759
29872
|
* 400: The tag is missing or blank.
|
|
29873
|
+
* 404: No customer with this customerId.
|
|
29760
29874
|
*
|
|
29761
29875
|
* POST https://customers.augur-api.com/customer/{customerId}/tags
|
|
29762
29876
|
* Contract:
|
|
@@ -40397,6 +40511,7 @@ interface AgrIntClientSpec {
|
|
|
40397
40511
|
*
|
|
40398
40512
|
* Errors:
|
|
40399
40513
|
* 403: The bearer token does not belong to an admin user.
|
|
40514
|
+
* 404: No bundles row with this bundlesUid.
|
|
40400
40515
|
*
|
|
40401
40516
|
* GET https://agr-int.augur-api.com/bundles/{bundlesUid}
|
|
40402
40517
|
* Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1bundles~1{bundlesUid}/get
|
|
@@ -40455,6 +40570,7 @@ interface AgrIntClientSpec {
|
|
|
40455
40570
|
* Errors:
|
|
40456
40571
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
40457
40572
|
* 403: The bearer token does not belong to an admin user.
|
|
40573
|
+
* 404: No bundles row with this bundlesUid.
|
|
40458
40574
|
*
|
|
40459
40575
|
* GET https://agr-int.augur-api.com/bundles/{bundlesUid}/resources
|
|
40460
40576
|
* Contract:
|
|
@@ -40478,6 +40594,7 @@ interface AgrIntClientSpec {
|
|
|
40478
40594
|
* Errors:
|
|
40479
40595
|
* 400: A required body field is missing or has the wrong type.
|
|
40480
40596
|
* 403: The bearer token does not belong to an admin user.
|
|
40597
|
+
* 404: No bundles row with this bundlesUid.
|
|
40481
40598
|
*
|
|
40482
40599
|
* POST https://agr-int.augur-api.com/bundles/{bundlesUid}/resources
|
|
40483
40600
|
* Contract:
|
|
@@ -40706,6 +40823,7 @@ interface AgrIntClientSpec {
|
|
|
40706
40823
|
*
|
|
40707
40824
|
* Errors:
|
|
40708
40825
|
* 403: The bearer token does not belong to an admin user.
|
|
40826
|
+
* 404: No resources row with this resourcesUid.
|
|
40709
40827
|
*
|
|
40710
40828
|
* GET https://agr-int.augur-api.com/resources/{resourcesUid}
|
|
40711
40829
|
* Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1resources~1{resourcesUid}/get
|
|
@@ -40761,6 +40879,7 @@ interface AgrIntClientSpec {
|
|
|
40761
40879
|
*
|
|
40762
40880
|
* Errors:
|
|
40763
40881
|
* 403: The bearer token does not belong to an admin user.
|
|
40882
|
+
* 404: No roles row with this rolesUid.
|
|
40764
40883
|
*
|
|
40765
40884
|
* GET https://agr-int.augur-api.com/roles/{rolesUid}
|
|
40766
40885
|
* Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1roles~1{rolesUid}/get
|
|
@@ -40819,6 +40938,7 @@ interface AgrIntClientSpec {
|
|
|
40819
40938
|
* Errors:
|
|
40820
40939
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
40821
40940
|
* 403: The bearer token does not belong to an admin user.
|
|
40941
|
+
* 404: No roles row with this rolesUid.
|
|
40822
40942
|
*
|
|
40823
40943
|
* GET https://agr-int.augur-api.com/roles/{rolesUid}/bundles
|
|
40824
40944
|
* Contract:
|
|
@@ -40842,6 +40962,7 @@ interface AgrIntClientSpec {
|
|
|
40842
40962
|
* Errors:
|
|
40843
40963
|
* 400: A required body field is missing or has the wrong type.
|
|
40844
40964
|
* 403: The bearer token does not belong to an admin user.
|
|
40965
|
+
* 404: No roles row with this rolesUid.
|
|
40845
40966
|
*
|
|
40846
40967
|
* POST https://agr-int.augur-api.com/roles/{rolesUid}/bundles
|
|
40847
40968
|
* Contract:
|
|
@@ -40962,6 +41083,7 @@ interface AgrIntClientSpec {
|
|
|
40962
41083
|
*
|
|
40963
41084
|
* Errors:
|
|
40964
41085
|
* 403: The bearer token does not belong to an admin user.
|
|
41086
|
+
* 404: No users row with this usersUid.
|
|
40965
41087
|
*
|
|
40966
41088
|
* GET https://agr-int.augur-api.com/users/{usersUid}
|
|
40967
41089
|
* Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}/get
|
|
@@ -41018,6 +41140,7 @@ interface AgrIntClientSpec {
|
|
|
41018
41140
|
* Errors:
|
|
41019
41141
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
41020
41142
|
* 403: The bearer token does not belong to an admin user.
|
|
41143
|
+
* 404: No users row with this usersUid.
|
|
41021
41144
|
*
|
|
41022
41145
|
* GET https://agr-int.augur-api.com/users/{usersUid}/roles
|
|
41023
41146
|
* Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}~1roles/get
|
|
@@ -41039,6 +41162,7 @@ interface AgrIntClientSpec {
|
|
|
41039
41162
|
* Errors:
|
|
41040
41163
|
* 400: A required body field is missing or has the wrong type.
|
|
41041
41164
|
* 403: The bearer token does not belong to an admin user.
|
|
41165
|
+
* 404: No users row with this usersUid.
|
|
41042
41166
|
*
|
|
41043
41167
|
* POST https://agr-int.augur-api.com/users/{usersUid}/roles
|
|
41044
41168
|
* Contract: https://agr-int.augur-api.com/openapi.json#/paths/~1users~1{usersUid}~1roles/post
|
|
@@ -43427,6 +43551,7 @@ interface P21ApisClientSpec {
|
|
|
43427
43551
|
*
|
|
43428
43552
|
* Errors:
|
|
43429
43553
|
* 400: The path companyUid is 0 and no companyId query parameter was given.
|
|
43554
|
+
* 404: No company row with this companyUid (checked when companyId is not passed).
|
|
43430
43555
|
*
|
|
43431
43556
|
* GET https://p21-apis.augur-api.com/trans-company/{companyUid}
|
|
43432
43557
|
* Contract:
|
|
@@ -43461,6 +43586,7 @@ interface P21ApisClientSpec {
|
|
|
43461
43586
|
*
|
|
43462
43587
|
* Errors:
|
|
43463
43588
|
* 400: The path usersUid is 0 and no userId query parameter was given.
|
|
43589
|
+
* 404: No users row with this usersUid (checked when userId is not passed).
|
|
43464
43590
|
*
|
|
43465
43591
|
* GET https://p21-apis.augur-api.com/trans-user/{usersUid}
|
|
43466
43592
|
* Contract: https://p21-apis.augur-api.com/openapi.json#/paths/~1trans-user~1{usersUid}/get
|
|
@@ -43492,6 +43618,8 @@ interface P21ApisClientSpec {
|
|
|
43492
43618
|
*
|
|
43493
43619
|
* Errors:
|
|
43494
43620
|
* 400: The path webDisplayTypeUid is 0 and no webDisplayTypeId query parameter was given.
|
|
43621
|
+
* 404: No web_display_type row with this webDisplayTypeUid (checked when webDisplayTypeId is
|
|
43622
|
+
* not passed).
|
|
43495
43623
|
*
|
|
43496
43624
|
* GET https://p21-apis.augur-api.com/trans-web-display-type/{webDisplayTypeUid}
|
|
43497
43625
|
* Contract:
|
|
@@ -45495,6 +45623,9 @@ interface P21CoreClientSpec {
|
|
|
45495
45623
|
* Response data: A Prophet 21 address with its mailing and physical lines and Augur's status,
|
|
45496
45624
|
* enabled and default flags
|
|
45497
45625
|
*
|
|
45626
|
+
* Errors:
|
|
45627
|
+
* 404: No address row with this id.
|
|
45628
|
+
*
|
|
45498
45629
|
* GET https://p21-core.augur-api.com/address/{id}
|
|
45499
45630
|
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1address~1{id}/get
|
|
45500
45631
|
*
|
|
@@ -45513,6 +45644,7 @@ interface P21CoreClientSpec {
|
|
|
45513
45644
|
*
|
|
45514
45645
|
* Errors:
|
|
45515
45646
|
* 400: orderBy is not column|ASC or column|DESC on an address column.
|
|
45647
|
+
* 404: No address row with this id.
|
|
45516
45648
|
*
|
|
45517
45649
|
* GET https://p21-core.augur-api.com/address/{id}/corp-address
|
|
45518
45650
|
* Contract:
|
|
@@ -45532,6 +45664,9 @@ interface P21CoreClientSpec {
|
|
|
45532
45664
|
* Response data: A Prophet 21 address with its mailing and physical lines and Augur's status,
|
|
45533
45665
|
* enabled and default flags
|
|
45534
45666
|
*
|
|
45667
|
+
* Errors:
|
|
45668
|
+
* 404: No address row with this id.
|
|
45669
|
+
*
|
|
45535
45670
|
* GET https://p21-core.augur-api.com/address/{id}/default
|
|
45536
45671
|
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1address~1{id}~1default/get
|
|
45537
45672
|
*
|
|
@@ -45549,6 +45684,9 @@ interface P21CoreClientSpec {
|
|
|
45549
45684
|
* Response data: A Prophet 21 address with its mailing and physical lines and Augur's status,
|
|
45550
45685
|
* enabled and default flags
|
|
45551
45686
|
*
|
|
45687
|
+
* Errors:
|
|
45688
|
+
* 404: No address row with this id.
|
|
45689
|
+
*
|
|
45552
45690
|
* GET https://p21-core.augur-api.com/address/{id}/enable
|
|
45553
45691
|
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1address~1{id}~1enable/get
|
|
45554
45692
|
*
|
|
@@ -45615,6 +45753,9 @@ interface P21CoreClientSpec {
|
|
|
45615
45753
|
* Get Cash Drawer Details
|
|
45616
45754
|
* Call: api.p21Core.cashDrawer.get(cashDrawerUid)
|
|
45617
45755
|
*
|
|
45756
|
+
* Errors:
|
|
45757
|
+
* 404: No cash_drawer row with this cashDrawerUid.
|
|
45758
|
+
*
|
|
45618
45759
|
* GET https://p21-core.augur-api.com/cash-drawer/{cashDrawerUid}
|
|
45619
45760
|
* Contract:
|
|
45620
45761
|
* https://p21-core.augur-api.com/openapi.json#/paths/~1cash-drawer~1{cashDrawerUid}/get
|
|
@@ -45719,6 +45860,9 @@ interface P21CoreClientSpec {
|
|
|
45719
45860
|
* Get P21 Code Details
|
|
45720
45861
|
* Call: api.p21Core.codeP21.get(codeUid)
|
|
45721
45862
|
*
|
|
45863
|
+
* Errors:
|
|
45864
|
+
* 404: No code_p21 row with this codeUid.
|
|
45865
|
+
*
|
|
45722
45866
|
* GET https://p21-core.augur-api.com/code-p21/{codeUid}
|
|
45723
45867
|
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1code-p21~1{codeUid}/get
|
|
45724
45868
|
*
|
|
@@ -45857,6 +46001,7 @@ interface P21CoreClientSpec {
|
|
|
45857
46001
|
* Get a freight code by UID, or by code when the UID is zero
|
|
45858
46002
|
*
|
|
45859
46003
|
* Errors:
|
|
46004
|
+
* 400: freightCodeUid is 0 and no freightCodeId was sent.
|
|
45860
46005
|
* 404: No freight code with this ID.
|
|
45861
46006
|
*
|
|
45862
46007
|
* GET https://p21-core.augur-api.com/freight-code/{freightCodeUid}
|
|
@@ -45928,6 +46073,9 @@ interface P21CoreClientSpec {
|
|
|
45928
46073
|
*
|
|
45929
46074
|
* Response data: A Prophet 21 location, with its address when the caller asks for it
|
|
45930
46075
|
*
|
|
46076
|
+
* Errors:
|
|
46077
|
+
* 404: No location row with this locationId.
|
|
46078
|
+
*
|
|
45931
46079
|
* GET https://p21-core.augur-api.com/location/{locationId}
|
|
45932
46080
|
* Contract: https://p21-core.augur-api.com/openapi.json#/paths/~1location~1{locationId}/get
|
|
45933
46081
|
*
|
|
@@ -56203,6 +56351,9 @@ interface Basecamp2ClientSpec {
|
|
|
56203
56351
|
* Get Comment by ID
|
|
56204
56352
|
* Call: api.basecamp2.comments.get(id)
|
|
56205
56353
|
*
|
|
56354
|
+
* Errors:
|
|
56355
|
+
* 404: No comment with this id.
|
|
56356
|
+
*
|
|
56206
56357
|
* GET https://basecamp2.augur-api.com/comments/{id}
|
|
56207
56358
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1comments~1{id}/get
|
|
56208
56359
|
*
|
|
@@ -56263,6 +56414,9 @@ interface Basecamp2ClientSpec {
|
|
|
56263
56414
|
* Get Person by ID
|
|
56264
56415
|
* Call: api.basecamp2.people.get(id)
|
|
56265
56416
|
*
|
|
56417
|
+
* Errors:
|
|
56418
|
+
* 404: No person with this id.
|
|
56419
|
+
*
|
|
56266
56420
|
* GET https://basecamp2.augur-api.com/people/{id}
|
|
56267
56421
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1people~1{id}/get
|
|
56268
56422
|
*
|
|
@@ -56278,6 +56432,7 @@ interface Basecamp2ClientSpec {
|
|
|
56278
56432
|
*
|
|
56279
56433
|
* Errors:
|
|
56280
56434
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56435
|
+
* 404: No person with this id.
|
|
56281
56436
|
*
|
|
56282
56437
|
* GET https://basecamp2.augur-api.com/people/{id}/metrics
|
|
56283
56438
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1people~1{id}~1metrics/get
|
|
@@ -56296,6 +56451,7 @@ interface Basecamp2ClientSpec {
|
|
|
56296
56451
|
*
|
|
56297
56452
|
* Errors:
|
|
56298
56453
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56454
|
+
* 404: No person with this personId, or no project with this projectId.
|
|
56299
56455
|
*
|
|
56300
56456
|
* GET https://basecamp2.augur-api.com/people/{personId}/projects/{projectId}/todos
|
|
56301
56457
|
* Contract:
|
|
@@ -56316,6 +56472,7 @@ interface Basecamp2ClientSpec {
|
|
|
56316
56472
|
*
|
|
56317
56473
|
* Errors:
|
|
56318
56474
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56475
|
+
* 404: No person with this id.
|
|
56319
56476
|
*
|
|
56320
56477
|
* GET https://basecamp2.augur-api.com/people/{id}/todos
|
|
56321
56478
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1people~1{id}~1todos/get
|
|
@@ -56346,6 +56503,9 @@ interface Basecamp2ClientSpec {
|
|
|
56346
56503
|
* Get Project by ID
|
|
56347
56504
|
* Call: api.basecamp2.projects.get(id)
|
|
56348
56505
|
*
|
|
56506
|
+
* Errors:
|
|
56507
|
+
* 404: No project with this id.
|
|
56508
|
+
*
|
|
56349
56509
|
* GET https://basecamp2.augur-api.com/projects/{id}
|
|
56350
56510
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1projects~1{id}/get
|
|
56351
56511
|
*
|
|
@@ -56361,6 +56521,7 @@ interface Basecamp2ClientSpec {
|
|
|
56361
56521
|
*
|
|
56362
56522
|
* Errors:
|
|
56363
56523
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56524
|
+
* 404: No project with this id.
|
|
56364
56525
|
*
|
|
56365
56526
|
* GET https://basecamp2.augur-api.com/projects/{id}/metrics
|
|
56366
56527
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1projects~1{id}~1metrics/get
|
|
@@ -56378,6 +56539,7 @@ interface Basecamp2ClientSpec {
|
|
|
56378
56539
|
*
|
|
56379
56540
|
* Errors:
|
|
56380
56541
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56542
|
+
* 404: No project with this id.
|
|
56381
56543
|
*
|
|
56382
56544
|
* GET https://basecamp2.augur-api.com/projects/{id}/todolists
|
|
56383
56545
|
* Contract:
|
|
@@ -56395,6 +56557,7 @@ interface Basecamp2ClientSpec {
|
|
|
56395
56557
|
*
|
|
56396
56558
|
* Errors:
|
|
56397
56559
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56560
|
+
* 404: No project with this projectId, or no todolist with this todolistId.
|
|
56398
56561
|
*
|
|
56399
56562
|
* GET https://basecamp2.augur-api.com/projects/{projectId}/todolists/{todolistId}/todos
|
|
56400
56563
|
* Contract:
|
|
@@ -56415,6 +56578,7 @@ interface Basecamp2ClientSpec {
|
|
|
56415
56578
|
*
|
|
56416
56579
|
* Errors:
|
|
56417
56580
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56581
|
+
* 404: No project with this id.
|
|
56418
56582
|
*
|
|
56419
56583
|
* GET https://basecamp2.augur-api.com/projects/{id}/todos
|
|
56420
56584
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1projects~1{id}~1todos/get
|
|
@@ -56445,6 +56609,9 @@ interface Basecamp2ClientSpec {
|
|
|
56445
56609
|
* Get Todolist Details
|
|
56446
56610
|
* Call: api.basecamp2.todolists.get(id)
|
|
56447
56611
|
*
|
|
56612
|
+
* Errors:
|
|
56613
|
+
* 404: No todolist with this id.
|
|
56614
|
+
*
|
|
56448
56615
|
* GET https://basecamp2.augur-api.com/todolists/{id}
|
|
56449
56616
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todolists~1{id}/get
|
|
56450
56617
|
*
|
|
@@ -56473,6 +56640,9 @@ interface Basecamp2ClientSpec {
|
|
|
56473
56640
|
* Get Todo Details
|
|
56474
56641
|
* Call: api.basecamp2.todos.get(id)
|
|
56475
56642
|
*
|
|
56643
|
+
* Errors:
|
|
56644
|
+
* 404: No todo with this id.
|
|
56645
|
+
*
|
|
56476
56646
|
* GET https://basecamp2.augur-api.com/todos/{id}
|
|
56477
56647
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}/get
|
|
56478
56648
|
*
|
|
@@ -56488,6 +56658,7 @@ interface Basecamp2ClientSpec {
|
|
|
56488
56658
|
*
|
|
56489
56659
|
* Errors:
|
|
56490
56660
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56661
|
+
* 404: No todo with this id.
|
|
56491
56662
|
*
|
|
56492
56663
|
* GET https://basecamp2.augur-api.com/todos/{id}/comments
|
|
56493
56664
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1comments/get
|
|
@@ -56505,6 +56676,7 @@ interface Basecamp2ClientSpec {
|
|
|
56505
56676
|
*
|
|
56506
56677
|
* Errors:
|
|
56507
56678
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56679
|
+
* 404: No todo with this id.
|
|
56508
56680
|
*
|
|
56509
56681
|
* GET https://basecamp2.augur-api.com/todos/{id}/events
|
|
56510
56682
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1events/get
|
|
@@ -56537,6 +56709,9 @@ interface Basecamp2ClientSpec {
|
|
|
56537
56709
|
* Get Todo Metrics Detail
|
|
56538
56710
|
* Call: api.basecamp2.todos.metrics.list(id)
|
|
56539
56711
|
*
|
|
56712
|
+
* Errors:
|
|
56713
|
+
* 404: No todo metrics with this id.
|
|
56714
|
+
*
|
|
56540
56715
|
* GET https://basecamp2.augur-api.com/todos/{id}/metrics
|
|
56541
56716
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1metrics/get
|
|
56542
56717
|
*
|
|
@@ -56553,6 +56728,7 @@ interface Basecamp2ClientSpec {
|
|
|
56553
56728
|
*
|
|
56554
56729
|
* Errors:
|
|
56555
56730
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56731
|
+
* 404: No todo with this id.
|
|
56556
56732
|
*
|
|
56557
56733
|
* GET https://basecamp2.augur-api.com/todos/{id}/sessions
|
|
56558
56734
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1sessions/get
|
|
@@ -56569,6 +56745,9 @@ interface Basecamp2ClientSpec {
|
|
|
56569
56745
|
* Request body: New work session on a todos record, which comes from the path; every body
|
|
56570
56746
|
* field is optional
|
|
56571
56747
|
*
|
|
56748
|
+
* Errors:
|
|
56749
|
+
* 404: No todo with this id.
|
|
56750
|
+
*
|
|
56572
56751
|
* POST https://basecamp2.augur-api.com/todos/{id}/sessions
|
|
56573
56752
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1sessions/post
|
|
56574
56753
|
*
|
|
@@ -56581,6 +56760,9 @@ interface Basecamp2ClientSpec {
|
|
|
56581
56760
|
* Get Session Details
|
|
56582
56761
|
* Call: api.basecamp2.todos.sessions.get(id, sessionId)
|
|
56583
56762
|
*
|
|
56763
|
+
* Errors:
|
|
56764
|
+
* 404: No todo with this id, or no session with this sessionId on that todo.
|
|
56765
|
+
*
|
|
56584
56766
|
* GET https://basecamp2.augur-api.com/todos/{id}/sessions/{sessionId}
|
|
56585
56767
|
* Contract:
|
|
56586
56768
|
* https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1sessions~1{sessionId}/get
|
|
@@ -56600,6 +56782,7 @@ interface Basecamp2ClientSpec {
|
|
|
56600
56782
|
*
|
|
56601
56783
|
* Errors:
|
|
56602
56784
|
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
56785
|
+
* 404: No todo with this id, or no session with this sessionId on that todo.
|
|
56603
56786
|
*
|
|
56604
56787
|
* PUT https://basecamp2.augur-api.com/todos/{id}/sessions/{sessionId}
|
|
56605
56788
|
* Contract:
|
|
@@ -56615,6 +56798,9 @@ interface Basecamp2ClientSpec {
|
|
|
56615
56798
|
* Delete Session
|
|
56616
56799
|
* Call: api.basecamp2.todos.sessions.delete(id, sessionId)
|
|
56617
56800
|
*
|
|
56801
|
+
* Errors:
|
|
56802
|
+
* 404: No todo with this id, or no session with this sessionId on that todo.
|
|
56803
|
+
*
|
|
56618
56804
|
* DELETE https://basecamp2.augur-api.com/todos/{id}/sessions/{sessionId}
|
|
56619
56805
|
* Contract:
|
|
56620
56806
|
* https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1sessions~1{sessionId}/delete
|
|
@@ -56645,6 +56831,9 @@ interface Basecamp2ClientSpec {
|
|
|
56645
56831
|
* Get Todo Summary Details
|
|
56646
56832
|
* Call: api.basecamp2.todosSummary.get(id)
|
|
56647
56833
|
*
|
|
56834
|
+
* Errors:
|
|
56835
|
+
* 404: No todo summary with this id.
|
|
56836
|
+
*
|
|
56648
56837
|
* GET https://basecamp2.augur-api.com/todos-summary/{id}
|
|
56649
56838
|
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos-summary~1{id}/get
|
|
56650
56839
|
*
|