@simpleapps-com/augur-api 2026.10.28 → 2026.10.30
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-DtPkSDMz.d.mts → client-DRpPuvl5.d.mts} +422 -26
- package/dist/{client-DtPkSDMz.d.ts → client-DRpPuvl5.d.ts} +422 -26
- package/dist/index.d.mts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +267 -15
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +267 -15
- 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
|
@@ -658,6 +658,11 @@ interface TagsListParams extends EdgeCacheParams {
|
|
|
658
658
|
}
|
|
659
659
|
/** Params for GET /usergroups */
|
|
660
660
|
interface UsergroupsListParams extends EdgeCacheParams {
|
|
661
|
+
/**
|
|
662
|
+
* Shape of each group [Y|N] (default N = the title string; Y = an object with id, title and
|
|
663
|
+
* parentId)
|
|
664
|
+
*/
|
|
665
|
+
fullDocument?: string;
|
|
661
666
|
/** Select order of the groups Default: title|ASC */
|
|
662
667
|
orderBy?: string;
|
|
663
668
|
/** CSV List of parent ids (default:blank) */
|
|
@@ -1056,13 +1061,28 @@ interface TagsListItem {
|
|
|
1056
1061
|
}
|
|
1057
1062
|
/** Returned by: api.joomla.tags.list(params) */
|
|
1058
1063
|
type TagsListData = TagsListItem[];
|
|
1064
|
+
/**
|
|
1065
|
+
* Shape of data nested in UsergroupsListData (MINIMUM fields; reused wherever the same shape
|
|
1066
|
+
* appears)
|
|
1067
|
+
*
|
|
1068
|
+
* Nested in UsergroupsListData
|
|
1069
|
+
*/
|
|
1070
|
+
interface UsergroupsListDataOption2Item {
|
|
1071
|
+
/** User group ID, the id the user group write routes take */
|
|
1072
|
+
id: number;
|
|
1073
|
+
/** User group title */
|
|
1074
|
+
title: string;
|
|
1075
|
+
/** ID of the parent user group (0 for the root group) */
|
|
1076
|
+
parentId: number;
|
|
1077
|
+
[key: string]: unknown;
|
|
1078
|
+
}
|
|
1059
1079
|
/**
|
|
1060
1080
|
* Get User Groups
|
|
1061
1081
|
* Response data for GET /usergroups — MINIMUM fields, extras pass through
|
|
1062
1082
|
*
|
|
1063
1083
|
* Returned by: api.joomla.usergroups.list(params)
|
|
1064
1084
|
*/
|
|
1065
|
-
type UsergroupsListData = string[];
|
|
1085
|
+
type UsergroupsListData = string[] | UsergroupsListDataOption2Item[];
|
|
1066
1086
|
/**
|
|
1067
1087
|
* Shape of `groups` (MINIMUM fields; reused wherever the same shape appears)
|
|
1068
1088
|
* User groups the user belongs to
|
|
@@ -1608,6 +1628,7 @@ interface JoomlaClientSpec {
|
|
|
1608
1628
|
* Response data: A Joomla article's core fields, without images or custom fields
|
|
1609
1629
|
*
|
|
1610
1630
|
* Errors:
|
|
1631
|
+
* 400: id is 0 and alias or catid is missing.
|
|
1611
1632
|
* 404: No article with this ID (or, for ID 0, with this alias and catid).
|
|
1612
1633
|
*
|
|
1613
1634
|
* GET https://joomla.augur-api.com/content/{id}
|
|
@@ -1627,6 +1648,7 @@ interface JoomlaClientSpec {
|
|
|
1627
1648
|
* (ContentHelper::generateDocument)
|
|
1628
1649
|
*
|
|
1629
1650
|
* Errors:
|
|
1651
|
+
* 400: id is 0 and alias or catid is missing.
|
|
1630
1652
|
* 404: No article with this ID (or, for ID 0, with this alias and catid).
|
|
1631
1653
|
*
|
|
1632
1654
|
* GET https://joomla.augur-api.com/content/{id}/doc
|
|
@@ -1665,6 +1687,7 @@ interface JoomlaClientSpec {
|
|
|
1665
1687
|
* (MenuHelper::generateDocument)
|
|
1666
1688
|
*
|
|
1667
1689
|
* Errors:
|
|
1690
|
+
* 400: id is 0 and alias is missing.
|
|
1668
1691
|
* 404: No menu item with this ID (or, for ID 0, with this alias).
|
|
1669
1692
|
*
|
|
1670
1693
|
* GET https://joomla.augur-api.com/menu/{id}/doc
|
|
@@ -2009,6 +2032,7 @@ type types$r_TagsListData = TagsListData;
|
|
|
2009
2032
|
type types$r_TagsListItem = TagsListItem;
|
|
2010
2033
|
type types$r_TagsListParams = TagsListParams;
|
|
2011
2034
|
type types$r_UsergroupsListData = UsergroupsListData;
|
|
2035
|
+
type types$r_UsergroupsListDataOption2Item = UsergroupsListDataOption2Item;
|
|
2012
2036
|
type types$r_UsergroupsListParams = UsergroupsListParams;
|
|
2013
2037
|
type types$r_UsersDocListData = UsersDocListData;
|
|
2014
2038
|
type types$r_UsersDocListParams = UsersDocListParams;
|
|
@@ -2031,7 +2055,7 @@ type types$r_UsersTrinityListParams = UsersTrinityListParams;
|
|
|
2031
2055
|
type types$r_UsersVerifyPasswordCreateBody = UsersVerifyPasswordCreateBody;
|
|
2032
2056
|
type types$r_UsersVerifyPasswordCreateData = UsersVerifyPasswordCreateData;
|
|
2033
2057
|
declare namespace types$r {
|
|
2034
|
-
export type { types$r_ActionLogsGetData as ActionLogsGetData, types$r_ActionLogsGetParams as ActionLogsGetParams, types$r_ActionLogsListData as ActionLogsListData, types$r_ActionLogsListItem as ActionLogsListItem, types$r_ActionLogsListParams as ActionLogsListParams, CategoriesGetData$2 as CategoriesGetData, CategoriesGetParams$2 as CategoriesGetParams, CategoriesListData$1 as CategoriesListData, CategoriesListItem$1 as CategoriesListItem, CategoriesListParams$1 as CategoriesListParams, types$r_ContentDocListData as ContentDocListData, types$r_ContentDocListParams as ContentDocListParams, types$r_ContentGetData as ContentGetData, types$r_ContentGetParams as ContentGetParams, types$r_ContentListData as ContentListData, types$r_ContentListItem as ContentListItem, types$r_ContentListItemFieldsItem as ContentListItemFieldsItem, types$r_ContentListParams as ContentListParams, types$r_JoomlaClientSpec as JoomlaClientSpec, types$r_MenuDocListData as MenuDocListData, types$r_MenuDocListParams as MenuDocListParams, types$r_MenuListData as MenuListData, types$r_MenuListItem as MenuListItem, types$r_MenuListParams as MenuListParams, types$r_ModulesGetData as ModulesGetData, types$r_ModulesGetParams as ModulesGetParams, types$r_ModulesListData as ModulesListData, types$r_ModulesListItem as ModulesListItem, types$r_ModulesListParams as ModulesListParams, types$r_TagsListData as TagsListData, types$r_TagsListItem as TagsListItem, types$r_TagsListParams as TagsListParams, types$r_UsergroupsListData as UsergroupsListData, types$r_UsergroupsListParams as UsergroupsListParams, UsersCreateBody$1 as UsersCreateBody, UsersCreateData$1 as UsersCreateData, UsersDeleteData$1 as UsersDeleteData, types$r_UsersDocListData as UsersDocListData, types$r_UsersDocListParams as UsersDocListParams, UsersGetData$2 as UsersGetData, UsersGetParams$2 as UsersGetParams, types$r_UsersGroupsCreateBody as UsersGroupsCreateBody, types$r_UsersGroupsCreateData as UsersGroupsCreateData, types$r_UsersGroupsDeleteData as UsersGroupsDeleteData, types$r_UsersGroupsGetData as UsersGroupsGetData, types$r_UsersGroupsGetParams as UsersGroupsGetParams, types$r_UsersGroupsListData as UsersGroupsListData, types$r_UsersGroupsListItem as UsersGroupsListItem, types$r_UsersGroupsListParams as UsersGroupsListParams, UsersListData$2 as UsersListData, UsersListItem$2 as UsersListItem, types$r_UsersListItemGroupsItem as UsersListItemGroupsItem, types$r_UsersListItemShipToItem as UsersListItemShipToItem, types$r_UsersListItemShipToItemAddress as UsersListItemShipToItemAddress, UsersListParams$2 as UsersListParams, types$r_UsersTrinityListData as UsersTrinityListData, types$r_UsersTrinityListDataP21Role as UsersTrinityListDataP21Role, types$r_UsersTrinityListDataP21RoleAddress as UsersTrinityListDataP21RoleAddress, types$r_UsersTrinityListDataProfile as UsersTrinityListDataProfile, types$r_UsersTrinityListParams as UsersTrinityListParams, UsersUpdateBody$1 as UsersUpdateBody, UsersUpdateData$1 as UsersUpdateData, types$r_UsersVerifyPasswordCreateBody as UsersVerifyPasswordCreateBody, types$r_UsersVerifyPasswordCreateData as UsersVerifyPasswordCreateData };
|
|
2058
|
+
export type { types$r_ActionLogsGetData as ActionLogsGetData, types$r_ActionLogsGetParams as ActionLogsGetParams, types$r_ActionLogsListData as ActionLogsListData, types$r_ActionLogsListItem as ActionLogsListItem, types$r_ActionLogsListParams as ActionLogsListParams, CategoriesGetData$2 as CategoriesGetData, CategoriesGetParams$2 as CategoriesGetParams, CategoriesListData$1 as CategoriesListData, CategoriesListItem$1 as CategoriesListItem, CategoriesListParams$1 as CategoriesListParams, types$r_ContentDocListData as ContentDocListData, types$r_ContentDocListParams as ContentDocListParams, types$r_ContentGetData as ContentGetData, types$r_ContentGetParams as ContentGetParams, types$r_ContentListData as ContentListData, types$r_ContentListItem as ContentListItem, types$r_ContentListItemFieldsItem as ContentListItemFieldsItem, types$r_ContentListParams as ContentListParams, types$r_JoomlaClientSpec as JoomlaClientSpec, types$r_MenuDocListData as MenuDocListData, types$r_MenuDocListParams as MenuDocListParams, types$r_MenuListData as MenuListData, types$r_MenuListItem as MenuListItem, types$r_MenuListParams as MenuListParams, types$r_ModulesGetData as ModulesGetData, types$r_ModulesGetParams as ModulesGetParams, types$r_ModulesListData as ModulesListData, types$r_ModulesListItem as ModulesListItem, types$r_ModulesListParams as ModulesListParams, types$r_TagsListData as TagsListData, types$r_TagsListItem as TagsListItem, types$r_TagsListParams as TagsListParams, types$r_UsergroupsListData as UsergroupsListData, types$r_UsergroupsListDataOption2Item as UsergroupsListDataOption2Item, types$r_UsergroupsListParams as UsergroupsListParams, UsersCreateBody$1 as UsersCreateBody, UsersCreateData$1 as UsersCreateData, UsersDeleteData$1 as UsersDeleteData, types$r_UsersDocListData as UsersDocListData, types$r_UsersDocListParams as UsersDocListParams, UsersGetData$2 as UsersGetData, UsersGetParams$2 as UsersGetParams, types$r_UsersGroupsCreateBody as UsersGroupsCreateBody, types$r_UsersGroupsCreateData as UsersGroupsCreateData, types$r_UsersGroupsDeleteData as UsersGroupsDeleteData, types$r_UsersGroupsGetData as UsersGroupsGetData, types$r_UsersGroupsGetParams as UsersGroupsGetParams, types$r_UsersGroupsListData as UsersGroupsListData, types$r_UsersGroupsListItem as UsersGroupsListItem, types$r_UsersGroupsListParams as UsersGroupsListParams, UsersListData$2 as UsersListData, UsersListItem$2 as UsersListItem, types$r_UsersListItemGroupsItem as UsersListItemGroupsItem, types$r_UsersListItemShipToItem as UsersListItemShipToItem, types$r_UsersListItemShipToItemAddress as UsersListItemShipToItemAddress, UsersListParams$2 as UsersListParams, types$r_UsersTrinityListData as UsersTrinityListData, types$r_UsersTrinityListDataP21Role as UsersTrinityListDataP21Role, types$r_UsersTrinityListDataP21RoleAddress as UsersTrinityListDataP21RoleAddress, types$r_UsersTrinityListDataProfile as UsersTrinityListDataProfile, types$r_UsersTrinityListParams as UsersTrinityListParams, UsersUpdateBody$1 as UsersUpdateBody, UsersUpdateData$1 as UsersUpdateData, types$r_UsersVerifyPasswordCreateBody as UsersVerifyPasswordCreateBody, types$r_UsersVerifyPasswordCreateData as UsersVerifyPasswordCreateData };
|
|
2035
2059
|
}
|
|
2036
2060
|
|
|
2037
2061
|
/**
|
|
@@ -2146,7 +2170,10 @@ interface CartHdrLookupGetParams extends EdgeCacheParams {
|
|
|
2146
2170
|
contactId: number;
|
|
2147
2171
|
/** Prophet 21 customer the cart belongs to */
|
|
2148
2172
|
customerId: number;
|
|
2149
|
-
/**
|
|
2173
|
+
/**
|
|
2174
|
+
* The user's cart number; 0 or absent picks cart 1 for a logged-in user; ignored for an anonymous
|
|
2175
|
+
* cart (userId 0), which gets an allocated number
|
|
2176
|
+
*/
|
|
2150
2177
|
userCartNo?: number;
|
|
2151
2178
|
/** Storefront user the cart belongs to; 0 for an anonymous cart keyed on cartToken */
|
|
2152
2179
|
userId: number;
|
|
@@ -24996,8 +25023,36 @@ interface GeoCodesPostalCodesListParams extends EdgeCacheParams {
|
|
|
24996
25023
|
}
|
|
24997
25024
|
/** Params for GET /geo-codes-postal-codes/{geoCodesPostalCodesUid} */
|
|
24998
25025
|
type GeoCodesPostalCodesGetParams = EdgeCacheParams;
|
|
25026
|
+
/** Params for GET /linked-sites */
|
|
25027
|
+
type LinkedSitesListParams = EdgeCacheParams;
|
|
24999
25028
|
/** Params for GET /meta-files/robots */
|
|
25000
25029
|
type MetaFilesRobotsListParams = EdgeCacheParams;
|
|
25030
|
+
/** Params for GET /notifications */
|
|
25031
|
+
interface NotificationsListParams extends EdgeCacheParams {
|
|
25032
|
+
/** Datatype the notification is about (checkout, import, ...) */
|
|
25033
|
+
dataTypeName?: string;
|
|
25034
|
+
/** ID of the record the notification is about (checkout uid, import uid, ...) */
|
|
25035
|
+
dataTypeUid?: number;
|
|
25036
|
+
/** Limit number of results (Default: 10) */
|
|
25037
|
+
limit?: number;
|
|
25038
|
+
/** Starting offset results (Default: 0) */
|
|
25039
|
+
offset?: number;
|
|
25040
|
+
/** Order By, one field|ASC or field|DESC (Default: notifications_uid|ASC) */
|
|
25041
|
+
orderBy?: string;
|
|
25042
|
+
/** Send state: 704 = queued, 2556 = sending, 1185 = sent, 700 = removed */
|
|
25043
|
+
processCd?: number;
|
|
25044
|
+
/** Service the notification is about (commerce, p21_sism, ...) */
|
|
25045
|
+
serviceName?: string;
|
|
25046
|
+
/**
|
|
25047
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
25048
|
+
* (704,705); -1 for every status. Default: 704
|
|
25049
|
+
*/
|
|
25050
|
+
statusCd?: number | number[];
|
|
25051
|
+
/** Notification type (created, imported_joomla, ...) */
|
|
25052
|
+
type?: string;
|
|
25053
|
+
}
|
|
25054
|
+
/** Params for GET /notifications/{notificationsUid} */
|
|
25055
|
+
type NotificationsGetParams = EdgeCacheParams;
|
|
25001
25056
|
/** Params for GET /open-search/embedding */
|
|
25002
25057
|
interface OpenSearchEmbeddingListParams extends EdgeCacheParams {
|
|
25003
25058
|
/** search query */
|
|
@@ -25386,6 +25441,51 @@ type GeoCodesPostalCodesListData = GeoCodesPostalCodesListItem[];
|
|
|
25386
25441
|
* Returned by: api.agrSite.geoCodesPostalCodes.get(geoCodesPostalCodesUid)
|
|
25387
25442
|
*/
|
|
25388
25443
|
type GeoCodesPostalCodesGetData = GeoCodesPostalCodesListItem;
|
|
25444
|
+
/**
|
|
25445
|
+
* Sites the caller can switch to
|
|
25446
|
+
* Response data for GET /linked-sites — MINIMUM fields, extras pass through
|
|
25447
|
+
*
|
|
25448
|
+
* Returned by: api.agrSite.linkedSites.list() (array items)
|
|
25449
|
+
*/
|
|
25450
|
+
interface LinkedSitesListItem {
|
|
25451
|
+
/** Linked site's siteId */
|
|
25452
|
+
siteId: string;
|
|
25453
|
+
/** Linked site's domain name; empty when the site has none on file */
|
|
25454
|
+
domain: string;
|
|
25455
|
+
/** The user's id on the linked site */
|
|
25456
|
+
userId: number;
|
|
25457
|
+
[key: string]: unknown;
|
|
25458
|
+
}
|
|
25459
|
+
/** Returned by: api.agrSite.linkedSites.list() */
|
|
25460
|
+
type LinkedSitesListData = LinkedSitesListItem[];
|
|
25461
|
+
/**
|
|
25462
|
+
* Token for a linked site
|
|
25463
|
+
* Response data for POST /linked-sites/token — MINIMUM fields, extras pass through
|
|
25464
|
+
*
|
|
25465
|
+
* Returned by: api.agrSite.linkedSites.token.create(data)
|
|
25466
|
+
*/
|
|
25467
|
+
interface LinkedSitesTokenCreateData {
|
|
25468
|
+
/** User-scope JWT bound to the linked site; short-lived (see its exp claim) */
|
|
25469
|
+
token: string;
|
|
25470
|
+
/** Linked site the token is bound to */
|
|
25471
|
+
siteId: string;
|
|
25472
|
+
/** The user's id on the linked site */
|
|
25473
|
+
userId: number;
|
|
25474
|
+
/** The user's username on the linked site */
|
|
25475
|
+
username: string;
|
|
25476
|
+
[key: string]: unknown;
|
|
25477
|
+
}
|
|
25478
|
+
/**
|
|
25479
|
+
* Token for a linked site
|
|
25480
|
+
* Request body for POST /linked-sites/token — MINIMUM fields, extras pass through
|
|
25481
|
+
*
|
|
25482
|
+
* Request body of: api.agrSite.linkedSites.token.create(data)
|
|
25483
|
+
*/
|
|
25484
|
+
interface LinkedSitesTokenCreateBody {
|
|
25485
|
+
/** Linked site to issue the token for */
|
|
25486
|
+
siteId: string;
|
|
25487
|
+
[key: string]: unknown;
|
|
25488
|
+
}
|
|
25389
25489
|
/**
|
|
25390
25490
|
* Get Robots.txt
|
|
25391
25491
|
* Response data for GET /meta-files/robots — MINIMUM fields, extras pass through
|
|
@@ -25400,10 +25500,12 @@ interface MetaFilesRobotsListData {
|
|
|
25400
25500
|
[key: string]: unknown;
|
|
25401
25501
|
}
|
|
25402
25502
|
/**
|
|
25403
|
-
*
|
|
25404
|
-
* Response data for
|
|
25503
|
+
* List Notifications
|
|
25504
|
+
* Response data for GET /notifications — MINIMUM fields, extras pass through
|
|
25405
25505
|
*
|
|
25506
|
+
* Returned by: api.agrSite.notifications.list(params) (array items)
|
|
25406
25507
|
* Returned by: api.agrSite.notifications.create(data)
|
|
25508
|
+
* Returned by: api.agrSite.notifications.get(notificationsUid)
|
|
25407
25509
|
*/
|
|
25408
25510
|
interface NotificationsCreateData {
|
|
25409
25511
|
/** Notification ID */
|
|
@@ -25428,6 +25530,15 @@ interface NotificationsCreateData {
|
|
|
25428
25530
|
processCd: number;
|
|
25429
25531
|
[key: string]: unknown;
|
|
25430
25532
|
}
|
|
25533
|
+
/**
|
|
25534
|
+
* List Notifications
|
|
25535
|
+
* Response data for GET /notifications — MINIMUM fields, extras pass through
|
|
25536
|
+
*
|
|
25537
|
+
* Returned by: api.agrSite.notifications.list(params) (array items)
|
|
25538
|
+
*/
|
|
25539
|
+
type NotificationsListItem = NotificationsCreateData;
|
|
25540
|
+
/** Returned by: api.agrSite.notifications.list(params) */
|
|
25541
|
+
type NotificationsListData = NotificationsListItem[];
|
|
25431
25542
|
/**
|
|
25432
25543
|
* Create Notification
|
|
25433
25544
|
* Request body for POST /notifications — MINIMUM fields, extras pass through
|
|
@@ -25445,6 +25556,13 @@ interface NotificationsCreateBody {
|
|
|
25445
25556
|
dataTypeUid?: number | null;
|
|
25446
25557
|
[key: string]: unknown;
|
|
25447
25558
|
}
|
|
25559
|
+
/**
|
|
25560
|
+
* Get Notification
|
|
25561
|
+
* Response data for GET /notifications/{notificationsUid} — MINIMUM fields, extras pass through
|
|
25562
|
+
*
|
|
25563
|
+
* Returned by: api.agrSite.notifications.get(notificationsUid)
|
|
25564
|
+
*/
|
|
25565
|
+
type NotificationsGetData = NotificationsCreateData;
|
|
25448
25566
|
/**
|
|
25449
25567
|
* Get Query String Embedding
|
|
25450
25568
|
* Response data for GET /open-search/embedding — MINIMUM fields, extras pass through
|
|
@@ -26045,6 +26163,51 @@ interface AgrSiteClientSpec {
|
|
|
26045
26163
|
*/
|
|
26046
26164
|
get: (geoCodesPostalCodesUid: number, params?: GeoCodesPostalCodesGetParams) => Promise<BaseResponse$1<GeoCodesPostalCodesGetData>>;
|
|
26047
26165
|
};
|
|
26166
|
+
linkedSites: {
|
|
26167
|
+
/**
|
|
26168
|
+
* Sites the caller can switch to
|
|
26169
|
+
* Call: api.agrSite.linkedSites.list()
|
|
26170
|
+
*
|
|
26171
|
+
* List the other sites the signed-in user can switch to
|
|
26172
|
+
*
|
|
26173
|
+
* Response data, each item: Another site the signed-in user can switch to
|
|
26174
|
+
*
|
|
26175
|
+
* Errors:
|
|
26176
|
+
* 403: The signed-in user cannot switch sites.
|
|
26177
|
+
* 503: A dependency did not respond. Retryable.
|
|
26178
|
+
*
|
|
26179
|
+
* GET https://agr-site.augur-api.com/linked-sites
|
|
26180
|
+
* Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1linked-sites/get
|
|
26181
|
+
*
|
|
26182
|
+
* @param params LinkedSitesListParams (query string)
|
|
26183
|
+
* @returns BaseResponse whose `data` is LinkedSitesListData
|
|
26184
|
+
*/
|
|
26185
|
+
list: (params?: LinkedSitesListParams) => Promise<BaseResponse$1<LinkedSitesListData>>;
|
|
26186
|
+
token: {
|
|
26187
|
+
/**
|
|
26188
|
+
* Token for a linked site
|
|
26189
|
+
* Call: api.agrSite.linkedSites.token.create(data)
|
|
26190
|
+
*
|
|
26191
|
+
* Exchange the signed-in user's token for a user token on another site they can switch to
|
|
26192
|
+
*
|
|
26193
|
+
* Request body: Exchange a user token on this site for a token on a linked site
|
|
26194
|
+
* Response data: A user token on another site the signed-in user can switch to
|
|
26195
|
+
*
|
|
26196
|
+
* Errors:
|
|
26197
|
+
* 400: The body is not JSON or has no siteId.
|
|
26198
|
+
* 403: The signed-in user cannot switch to the requested site. No token is issued.
|
|
26199
|
+
* 404: The target siteId is not a known site.
|
|
26200
|
+
* 503: A dependency did not respond. Retryable.
|
|
26201
|
+
*
|
|
26202
|
+
* POST https://agr-site.augur-api.com/linked-sites/token
|
|
26203
|
+
* Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1linked-sites~1token/post
|
|
26204
|
+
*
|
|
26205
|
+
* @param data LinkedSitesTokenCreateBody (request body)
|
|
26206
|
+
* @returns BaseResponse whose `data` is LinkedSitesTokenCreateData
|
|
26207
|
+
*/
|
|
26208
|
+
create: (data: LinkedSitesTokenCreateBody) => Promise<BaseResponse$1<LinkedSitesTokenCreateData>>;
|
|
26209
|
+
};
|
|
26210
|
+
};
|
|
26048
26211
|
metaFiles: {
|
|
26049
26212
|
robots: {
|
|
26050
26213
|
/**
|
|
@@ -26065,6 +26228,22 @@ interface AgrSiteClientSpec {
|
|
|
26065
26228
|
};
|
|
26066
26229
|
};
|
|
26067
26230
|
notifications: {
|
|
26231
|
+
/**
|
|
26232
|
+
* List Notifications
|
|
26233
|
+
* Call: api.agrSite.notifications.list(params)
|
|
26234
|
+
*
|
|
26235
|
+
* List notifications, filtered by the record they are about and their send state
|
|
26236
|
+
*
|
|
26237
|
+
* Errors:
|
|
26238
|
+
* 400: Invalid orderBy: not one notifications column with |ASC or |DESC.
|
|
26239
|
+
*
|
|
26240
|
+
* GET https://agr-site.augur-api.com/notifications
|
|
26241
|
+
* Contract: https://agr-site.augur-api.com/openapi.json#/paths/~1notifications/get
|
|
26242
|
+
*
|
|
26243
|
+
* @param params NotificationsListParams (query string)
|
|
26244
|
+
* @returns BaseResponse whose `data` is NotificationsListData
|
|
26245
|
+
*/
|
|
26246
|
+
list: (params?: NotificationsListParams) => Promise<BaseResponse$1<NotificationsListData>>;
|
|
26068
26247
|
/**
|
|
26069
26248
|
* Create Notification
|
|
26070
26249
|
* Call: api.agrSite.notifications.create(data)
|
|
@@ -26081,6 +26260,24 @@ interface AgrSiteClientSpec {
|
|
|
26081
26260
|
* @returns BaseResponse whose `data` is NotificationsCreateData
|
|
26082
26261
|
*/
|
|
26083
26262
|
create: (data: NotificationsCreateBody) => Promise<BaseResponse$1<NotificationsCreateData>>;
|
|
26263
|
+
/**
|
|
26264
|
+
* Get Notification
|
|
26265
|
+
* Call: api.agrSite.notifications.get(notificationsUid)
|
|
26266
|
+
*
|
|
26267
|
+
* Get one notification with its send state (process_cd) and dates
|
|
26268
|
+
*
|
|
26269
|
+
* Errors:
|
|
26270
|
+
* 404: No notification with this ID.
|
|
26271
|
+
*
|
|
26272
|
+
* GET https://agr-site.augur-api.com/notifications/{notificationsUid}
|
|
26273
|
+
* Contract:
|
|
26274
|
+
* https://agr-site.augur-api.com/openapi.json#/paths/~1notifications~1{notificationsUid}/get
|
|
26275
|
+
*
|
|
26276
|
+
* @param notificationsUid notifications.notifications_uid
|
|
26277
|
+
* @param params NotificationsGetParams (query string)
|
|
26278
|
+
* @returns BaseResponse whose `data` is NotificationsGetData
|
|
26279
|
+
*/
|
|
26280
|
+
get: (notificationsUid: number, params?: NotificationsGetParams) => Promise<BaseResponse$1<NotificationsGetData>>;
|
|
26084
26281
|
};
|
|
26085
26282
|
openSearch: {
|
|
26086
26283
|
embedding: {
|
|
@@ -26391,10 +26588,20 @@ type types$k_GeoCodesPostalCodesGetParams = GeoCodesPostalCodesGetParams;
|
|
|
26391
26588
|
type types$k_GeoCodesPostalCodesListData = GeoCodesPostalCodesListData;
|
|
26392
26589
|
type types$k_GeoCodesPostalCodesListItem = GeoCodesPostalCodesListItem;
|
|
26393
26590
|
type types$k_GeoCodesPostalCodesListParams = GeoCodesPostalCodesListParams;
|
|
26591
|
+
type types$k_LinkedSitesListData = LinkedSitesListData;
|
|
26592
|
+
type types$k_LinkedSitesListItem = LinkedSitesListItem;
|
|
26593
|
+
type types$k_LinkedSitesListParams = LinkedSitesListParams;
|
|
26594
|
+
type types$k_LinkedSitesTokenCreateBody = LinkedSitesTokenCreateBody;
|
|
26595
|
+
type types$k_LinkedSitesTokenCreateData = LinkedSitesTokenCreateData;
|
|
26394
26596
|
type types$k_MetaFilesRobotsListData = MetaFilesRobotsListData;
|
|
26395
26597
|
type types$k_MetaFilesRobotsListParams = MetaFilesRobotsListParams;
|
|
26396
26598
|
type types$k_NotificationsCreateBody = NotificationsCreateBody;
|
|
26397
26599
|
type types$k_NotificationsCreateData = NotificationsCreateData;
|
|
26600
|
+
type types$k_NotificationsGetData = NotificationsGetData;
|
|
26601
|
+
type types$k_NotificationsGetParams = NotificationsGetParams;
|
|
26602
|
+
type types$k_NotificationsListData = NotificationsListData;
|
|
26603
|
+
type types$k_NotificationsListItem = NotificationsListItem;
|
|
26604
|
+
type types$k_NotificationsListParams = NotificationsListParams;
|
|
26398
26605
|
type types$k_OpenSearchEmbeddingListData = OpenSearchEmbeddingListData;
|
|
26399
26606
|
type types$k_OpenSearchEmbeddingListParams = OpenSearchEmbeddingListParams;
|
|
26400
26607
|
type types$k_PostalCodesXShiptosCreateBody = PostalCodesXShiptosCreateBody;
|
|
@@ -26428,7 +26635,7 @@ type types$k_UsersAddressesListParams = UsersAddressesListParams;
|
|
|
26428
26635
|
type types$k_UsersAddressesUpdateBody = UsersAddressesUpdateBody;
|
|
26429
26636
|
type types$k_UsersAddressesUpdateData = UsersAddressesUpdateData;
|
|
26430
26637
|
declare namespace types$k {
|
|
26431
|
-
export type { types$k_AgrSiteClientSpec as AgrSiteClientSpec, types$k_ConfigsGetData as ConfigsGetData, types$k_ConfigsGetDataConfigsItem as ConfigsGetDataConfigsItem, types$k_ConfigsGetParams as ConfigsGetParams, types$k_ConfigsListData as ConfigsListData, types$k_ConfigsListItem as ConfigsListItem, types$k_ConfigsListParams as ConfigsListParams, types$k_ConfigsUpdateBody as ConfigsUpdateBody, types$k_ConfigsUpdateData as ConfigsUpdateData, ContextGetData$1 as ContextGetData, ContextGetDataOption1$1 as ContextGetDataOption1, ContextGetDataOption1ServicesItem$1 as ContextGetDataOption1ServicesItem, types$k_ContextGetDataOption2 as ContextGetDataOption2, ContextGetParams$1 as ContextGetParams, types$k_DatafilesCreateBody as DatafilesCreateBody, types$k_DatafilesCreateData as DatafilesCreateData, types$k_FyxerTranscriptCreateBody as FyxerTranscriptCreateBody, types$k_FyxerTranscriptCreateData as FyxerTranscriptCreateData, types$k_FyxerTranscriptDeleteData as FyxerTranscriptDeleteData, types$k_FyxerTranscriptGetData as FyxerTranscriptGetData, types$k_FyxerTranscriptGetParams as FyxerTranscriptGetParams, types$k_FyxerTranscriptListData as FyxerTranscriptListData, types$k_FyxerTranscriptListItem as FyxerTranscriptListItem, types$k_FyxerTranscriptListParams as FyxerTranscriptListParams, types$k_FyxerTranscriptUpdateBody as FyxerTranscriptUpdateBody, types$k_FyxerTranscriptUpdateData as FyxerTranscriptUpdateData, types$k_GeoCodesPostalCodesGetData as GeoCodesPostalCodesGetData, types$k_GeoCodesPostalCodesGetParams as GeoCodesPostalCodesGetParams, types$k_GeoCodesPostalCodesListData as GeoCodesPostalCodesListData, types$k_GeoCodesPostalCodesListItem as GeoCodesPostalCodesListItem, types$k_GeoCodesPostalCodesListParams as GeoCodesPostalCodesListParams, types$k_MetaFilesRobotsListData as MetaFilesRobotsListData, types$k_MetaFilesRobotsListParams as MetaFilesRobotsListParams, types$k_NotificationsCreateBody as NotificationsCreateBody, types$k_NotificationsCreateData as NotificationsCreateData, types$k_OpenSearchEmbeddingListData as OpenSearchEmbeddingListData, types$k_OpenSearchEmbeddingListParams as OpenSearchEmbeddingListParams, types$k_PostalCodesXShiptosCreateBody as PostalCodesXShiptosCreateBody, types$k_PostalCodesXShiptosCreateData as PostalCodesXShiptosCreateData, types$k_PostalCodesXShiptosDeleteData as PostalCodesXShiptosDeleteData, types$k_PostalCodesXShiptosGetData as PostalCodesXShiptosGetData, types$k_PostalCodesXShiptosGetParams as PostalCodesXShiptosGetParams, types$k_PostalCodesXShiptosListData as PostalCodesXShiptosListData, types$k_PostalCodesXShiptosListItem as PostalCodesXShiptosListItem, types$k_PostalCodesXShiptosListParams as PostalCodesXShiptosListParams, types$k_PostalCodesXShiptosUpdateBody as PostalCodesXShiptosUpdateBody, types$k_PostalCodesXShiptosUpdateData as PostalCodesXShiptosUpdateData, types$k_SettingsCreateBody as SettingsCreateBody, types$k_SettingsCreateData as SettingsCreateData, types$k_SettingsDeleteData as SettingsDeleteData, types$k_SettingsGetData as SettingsGetData, types$k_SettingsGetParams as SettingsGetParams, types$k_SettingsListData as SettingsListData, types$k_SettingsListItem as SettingsListItem, types$k_SettingsListParams as SettingsListParams, types$k_SettingsUpdateBody as SettingsUpdateBody, types$k_SettingsUpdateData as SettingsUpdateData, types$k_UsersAddressesCreateBody as UsersAddressesCreateBody, types$k_UsersAddressesCreateData as UsersAddressesCreateData, types$k_UsersAddressesDeleteData as UsersAddressesDeleteData, types$k_UsersAddressesGetData as UsersAddressesGetData, types$k_UsersAddressesGetParams as UsersAddressesGetParams, types$k_UsersAddressesListData as UsersAddressesListData, types$k_UsersAddressesListItem as UsersAddressesListItem, types$k_UsersAddressesListParams as UsersAddressesListParams, types$k_UsersAddressesUpdateBody as UsersAddressesUpdateBody, types$k_UsersAddressesUpdateData as UsersAddressesUpdateData };
|
|
26638
|
+
export type { types$k_AgrSiteClientSpec as AgrSiteClientSpec, types$k_ConfigsGetData as ConfigsGetData, types$k_ConfigsGetDataConfigsItem as ConfigsGetDataConfigsItem, types$k_ConfigsGetParams as ConfigsGetParams, types$k_ConfigsListData as ConfigsListData, types$k_ConfigsListItem as ConfigsListItem, types$k_ConfigsListParams as ConfigsListParams, types$k_ConfigsUpdateBody as ConfigsUpdateBody, types$k_ConfigsUpdateData as ConfigsUpdateData, ContextGetData$1 as ContextGetData, ContextGetDataOption1$1 as ContextGetDataOption1, ContextGetDataOption1ServicesItem$1 as ContextGetDataOption1ServicesItem, types$k_ContextGetDataOption2 as ContextGetDataOption2, ContextGetParams$1 as ContextGetParams, types$k_DatafilesCreateBody as DatafilesCreateBody, types$k_DatafilesCreateData as DatafilesCreateData, types$k_FyxerTranscriptCreateBody as FyxerTranscriptCreateBody, types$k_FyxerTranscriptCreateData as FyxerTranscriptCreateData, types$k_FyxerTranscriptDeleteData as FyxerTranscriptDeleteData, types$k_FyxerTranscriptGetData as FyxerTranscriptGetData, types$k_FyxerTranscriptGetParams as FyxerTranscriptGetParams, types$k_FyxerTranscriptListData as FyxerTranscriptListData, types$k_FyxerTranscriptListItem as FyxerTranscriptListItem, types$k_FyxerTranscriptListParams as FyxerTranscriptListParams, types$k_FyxerTranscriptUpdateBody as FyxerTranscriptUpdateBody, types$k_FyxerTranscriptUpdateData as FyxerTranscriptUpdateData, types$k_GeoCodesPostalCodesGetData as GeoCodesPostalCodesGetData, types$k_GeoCodesPostalCodesGetParams as GeoCodesPostalCodesGetParams, types$k_GeoCodesPostalCodesListData as GeoCodesPostalCodesListData, types$k_GeoCodesPostalCodesListItem as GeoCodesPostalCodesListItem, types$k_GeoCodesPostalCodesListParams as GeoCodesPostalCodesListParams, types$k_LinkedSitesListData as LinkedSitesListData, types$k_LinkedSitesListItem as LinkedSitesListItem, types$k_LinkedSitesListParams as LinkedSitesListParams, types$k_LinkedSitesTokenCreateBody as LinkedSitesTokenCreateBody, types$k_LinkedSitesTokenCreateData as LinkedSitesTokenCreateData, types$k_MetaFilesRobotsListData as MetaFilesRobotsListData, types$k_MetaFilesRobotsListParams as MetaFilesRobotsListParams, types$k_NotificationsCreateBody as NotificationsCreateBody, types$k_NotificationsCreateData as NotificationsCreateData, types$k_NotificationsGetData as NotificationsGetData, types$k_NotificationsGetParams as NotificationsGetParams, types$k_NotificationsListData as NotificationsListData, types$k_NotificationsListItem as NotificationsListItem, types$k_NotificationsListParams as NotificationsListParams, types$k_OpenSearchEmbeddingListData as OpenSearchEmbeddingListData, types$k_OpenSearchEmbeddingListParams as OpenSearchEmbeddingListParams, types$k_PostalCodesXShiptosCreateBody as PostalCodesXShiptosCreateBody, types$k_PostalCodesXShiptosCreateData as PostalCodesXShiptosCreateData, types$k_PostalCodesXShiptosDeleteData as PostalCodesXShiptosDeleteData, types$k_PostalCodesXShiptosGetData as PostalCodesXShiptosGetData, types$k_PostalCodesXShiptosGetParams as PostalCodesXShiptosGetParams, types$k_PostalCodesXShiptosListData as PostalCodesXShiptosListData, types$k_PostalCodesXShiptosListItem as PostalCodesXShiptosListItem, types$k_PostalCodesXShiptosListParams as PostalCodesXShiptosListParams, types$k_PostalCodesXShiptosUpdateBody as PostalCodesXShiptosUpdateBody, types$k_PostalCodesXShiptosUpdateData as PostalCodesXShiptosUpdateData, types$k_SettingsCreateBody as SettingsCreateBody, types$k_SettingsCreateData as SettingsCreateData, types$k_SettingsDeleteData as SettingsDeleteData, types$k_SettingsGetData as SettingsGetData, types$k_SettingsGetParams as SettingsGetParams, types$k_SettingsListData as SettingsListData, types$k_SettingsListItem as SettingsListItem, types$k_SettingsListParams as SettingsListParams, types$k_SettingsUpdateBody as SettingsUpdateBody, types$k_SettingsUpdateData as SettingsUpdateData, types$k_UsersAddressesCreateBody as UsersAddressesCreateBody, types$k_UsersAddressesCreateData as UsersAddressesCreateData, types$k_UsersAddressesDeleteData as UsersAddressesDeleteData, types$k_UsersAddressesGetData as UsersAddressesGetData, types$k_UsersAddressesGetParams as UsersAddressesGetParams, types$k_UsersAddressesListData as UsersAddressesListData, types$k_UsersAddressesListItem as UsersAddressesListItem, types$k_UsersAddressesListParams as UsersAddressesListParams, types$k_UsersAddressesUpdateBody as UsersAddressesUpdateBody, types$k_UsersAddressesUpdateData as UsersAddressesUpdateData };
|
|
26432
26639
|
}
|
|
26433
26640
|
|
|
26434
26641
|
/**
|
|
@@ -26470,8 +26677,14 @@ declare namespace types$k {
|
|
|
26470
26677
|
* GeoCodesPostalCodesListData
|
|
26471
26678
|
* GET /geo-codes-postal-codes/{geoCodesPostalCodesUid} →
|
|
26472
26679
|
* api.agrSite.geoCodesPostalCodes.get(geoCodesPostalCodesUid) → GeoCodesPostalCodesGetData
|
|
26680
|
+
* GET /linked-sites → api.agrSite.linkedSites.list() → LinkedSitesListData
|
|
26681
|
+
* POST /linked-sites/token → api.agrSite.linkedSites.token.create(data) →
|
|
26682
|
+
* LinkedSitesTokenCreateData
|
|
26473
26683
|
* GET /meta-files/robots → api.agrSite.metaFiles.robots.list() → MetaFilesRobotsListData
|
|
26684
|
+
* GET /notifications → api.agrSite.notifications.list(params) → NotificationsListData
|
|
26474
26685
|
* POST /notifications → api.agrSite.notifications.create(data) → NotificationsCreateData
|
|
26686
|
+
* GET /notifications/{notificationsUid} → api.agrSite.notifications.get(notificationsUid) →
|
|
26687
|
+
* NotificationsGetData
|
|
26475
26688
|
* GET /open-search/embedding → api.agrSite.openSearch.embedding.list(params) →
|
|
26476
26689
|
* OpenSearchEmbeddingListData
|
|
26477
26690
|
* GET /postal-codes-x-shiptos → api.agrSite.postalCodesXShiptos.list(params) →
|
|
@@ -26510,6 +26723,7 @@ declare class AgrSiteClient extends BaseServiceClient {
|
|
|
26510
26723
|
readonly datafiles: AgrSiteClientSpec['datafiles'];
|
|
26511
26724
|
readonly fyxerTranscript: AgrSiteClientSpec['fyxerTranscript'];
|
|
26512
26725
|
readonly geoCodesPostalCodes: AgrSiteClientSpec['geoCodesPostalCodes'];
|
|
26726
|
+
readonly linkedSites: AgrSiteClientSpec['linkedSites'];
|
|
26513
26727
|
readonly metaFiles: AgrSiteClientSpec['metaFiles'];
|
|
26514
26728
|
readonly notifications: AgrSiteClientSpec['notifications'];
|
|
26515
26729
|
readonly openSearch: AgrSiteClientSpec['openSearch'];
|
|
@@ -26521,6 +26735,7 @@ declare class AgrSiteClient extends BaseServiceClient {
|
|
|
26521
26735
|
readonly datafilesData: DataOnly<AgrSiteClientSpec['datafiles']>;
|
|
26522
26736
|
readonly fyxerTranscriptData: DataOnly<AgrSiteClientSpec['fyxerTranscript']>;
|
|
26523
26737
|
readonly geoCodesPostalCodesData: DataOnly<AgrSiteClientSpec['geoCodesPostalCodes']>;
|
|
26738
|
+
readonly linkedSitesData: DataOnly<AgrSiteClientSpec['linkedSites']>;
|
|
26524
26739
|
readonly metaFilesData: DataOnly<AgrSiteClientSpec['metaFiles']>;
|
|
26525
26740
|
readonly notificationsData: DataOnly<AgrSiteClientSpec['notifications']>;
|
|
26526
26741
|
readonly openSearchData: DataOnly<AgrSiteClientSpec['openSearch']>;
|
|
@@ -39335,8 +39550,7 @@ interface AgrInfoClientSpec {
|
|
|
39335
39550
|
* Staff token for a target site
|
|
39336
39551
|
* Call: api.agrInfo.sites.staffToken.create(data)
|
|
39337
39552
|
*
|
|
39338
|
-
* Exchange
|
|
39339
|
-
* with the same username and email
|
|
39553
|
+
* Exchange a staff user token for a user token on a target site
|
|
39340
39554
|
*
|
|
39341
39555
|
* Request body: Exchange an augur_info staff token for a token on a target site
|
|
39342
39556
|
* Response data: A user token on the target site, issued to an augur_info staff member as
|
|
@@ -39344,12 +39558,9 @@ interface AgrInfoClientSpec {
|
|
|
39344
39558
|
*
|
|
39345
39559
|
* Errors:
|
|
39346
39560
|
* 400: The body is not JSON or has no siteId.
|
|
39347
|
-
* 403:
|
|
39348
|
-
* or the target site has no unblocked Super User with the same username and email
|
|
39349
|
-
* (case-insensitive).
|
|
39561
|
+
* 403: The caller cannot get a token for the target site.
|
|
39350
39562
|
* 404: The target siteId is not a known site.
|
|
39351
|
-
* 503: A
|
|
39352
|
-
* site or its mirror account, or while issuing the token. Retryable.
|
|
39563
|
+
* 503: A dependency did not respond. Retryable.
|
|
39353
39564
|
*
|
|
39354
39565
|
* POST https://agr-info.augur-api.com/sites/staff-token
|
|
39355
39566
|
* Contract: https://agr-info.augur-api.com/openapi.json#/paths/~1sites~1staff-token/post
|
|
@@ -43750,6 +43961,30 @@ interface AmznListingsItemsListParams extends EdgeCacheParams {
|
|
|
43750
43961
|
}
|
|
43751
43962
|
/** Params for GET /amzn-listings-items/{amznListingsItemsUid} */
|
|
43752
43963
|
type AmznListingsItemsGetParams = EdgeCacheParams;
|
|
43964
|
+
/** Params for GET /amzn-orders */
|
|
43965
|
+
interface AmznOrdersListParams extends EdgeCacheParams {
|
|
43966
|
+
/** Filter by Amazon fulfillment status (e.g. UNSHIPPED, SHIPPED, CANCELLED) */
|
|
43967
|
+
fulfillmentStatus?: string;
|
|
43968
|
+
/** Limit number of results (Default: 10) */
|
|
43969
|
+
limit?: number;
|
|
43970
|
+
/** Starting offset (Default: 0) */
|
|
43971
|
+
offset?: number;
|
|
43972
|
+
/** Order by field and direction (Default: amzn_orders_uid|ASC) */
|
|
43973
|
+
orderBy?: string;
|
|
43974
|
+
/** Filter by Amazon order ID */
|
|
43975
|
+
orderId?: string;
|
|
43976
|
+
/** Filter by process code (704=ACTIVE, 1185=COMPLETE) */
|
|
43977
|
+
processCd?: number;
|
|
43978
|
+
/** Filter by Amazon Seller Order ID */
|
|
43979
|
+
sellerOrderId?: string;
|
|
43980
|
+
/**
|
|
43981
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
43982
|
+
* (704,705); -1 for every status. Default: 704
|
|
43983
|
+
*/
|
|
43984
|
+
statusCd?: number | number[];
|
|
43985
|
+
}
|
|
43986
|
+
/** Params for GET /amzn-orders/{amznOrdersUid} */
|
|
43987
|
+
type AmznOrdersGetParams = EdgeCacheParams;
|
|
43753
43988
|
/** Params for GET /amzn-sp/connection */
|
|
43754
43989
|
type AmznSpConnectionListParams = EdgeCacheParams;
|
|
43755
43990
|
/**
|
|
@@ -43761,33 +43996,58 @@ type AmznSpConnectionListParams = EdgeCacheParams;
|
|
|
43761
43996
|
* Returned by: api.markets.amznListingsItems.update(amznListingsItemsUid, data)
|
|
43762
43997
|
*/
|
|
43763
43998
|
interface AmznListingsItemsListItem {
|
|
43999
|
+
/** Amazon listings item ID */
|
|
43764
44000
|
amznListingsItemsUid: number;
|
|
43765
|
-
/** (max 40 chars) */
|
|
44001
|
+
/** Amazon seller SKU (max 40 chars) */
|
|
43766
44002
|
sku: string;
|
|
43767
|
-
/** (max 10 chars) */
|
|
44003
|
+
/** Amazon Standard Identification Number of the listing (max 10 chars) */
|
|
43768
44004
|
asin: string | null;
|
|
44005
|
+
/** Linked Prophet 21 item (inv_mast.inv_mast_uid); 0 until linked */
|
|
43769
44006
|
invMastUid: number;
|
|
44007
|
+
/** Prophet 21 units per Amazon unit (default 1) */
|
|
43770
44008
|
multiplier: number;
|
|
43771
|
-
/** (max 100 chars) */
|
|
44009
|
+
/** Amazon product type of the listing (max 100 chars) */
|
|
43772
44010
|
productType: string | null;
|
|
43773
|
-
/** (max 100 chars) */
|
|
44011
|
+
/** Amazon listing status (e.g. BUYABLE, DISCOVERABLE) (max 100 chars) */
|
|
43774
44012
|
listingStatus: string | null;
|
|
44013
|
+
/** Quantity Amazon reports available to fulfill */
|
|
43775
44014
|
fulfillmentQuantity: number | null;
|
|
44015
|
+
/** Offer price on Amazon for the marketplace */
|
|
43776
44016
|
price: number | null;
|
|
43777
|
-
/**
|
|
44017
|
+
/** When Amazon last updated the listing (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
43778
44018
|
lastUpdateDate: string | null;
|
|
44019
|
+
/** Raw listing JSON as Amazon returned it */
|
|
43779
44020
|
listingJson: string | null;
|
|
43780
|
-
/**
|
|
44021
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
43781
44022
|
dateCreated: string;
|
|
43782
|
-
/**
|
|
44023
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
43783
44024
|
dateLastModified: string;
|
|
44025
|
+
/** Update code (1185 = Import Complete) */
|
|
43784
44026
|
updateCd: number;
|
|
44027
|
+
/** Status code (704 = Active/linked, 705 = Inactive/unlinked, 700 = Deleted) */
|
|
43785
44028
|
statusCd: number;
|
|
44029
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
43786
44030
|
processCd: number;
|
|
43787
|
-
/**
|
|
44031
|
+
/** When the listing was created on Amazon (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
43788
44032
|
createdDate: string | null;
|
|
43789
|
-
/** (max 8 chars) */
|
|
44033
|
+
/** Prophet 21 unit of measure the listing sells in (max 8 chars) */
|
|
43790
44034
|
uom: string | null;
|
|
44035
|
+
/**
|
|
44036
|
+
* Quantity markets computed for Amazon from Prophet 21 stock (eaches, buildable assemblies,
|
|
44037
|
+
* vendor stock) divided by the multiplier
|
|
44038
|
+
*/
|
|
44039
|
+
qtyAvailable: number;
|
|
44040
|
+
/** Inventory send code (704 = send to Amazon, 1185 = sent) */
|
|
44041
|
+
invCd: number;
|
|
44042
|
+
/** Status Amazon returned for the last quantity send (ACCEPTED or INVALID) (max 20 chars) */
|
|
44043
|
+
invStatus: string | null;
|
|
44044
|
+
/**
|
|
44045
|
+
* Issues Amazon returned for the last quantity send, as code: message pairs joined by "; " (max
|
|
44046
|
+
* 1000 chars)
|
|
44047
|
+
*/
|
|
44048
|
+
invIssues: string | null;
|
|
44049
|
+
/** When the last quantity send was made (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
44050
|
+
invDate: string | null;
|
|
43791
44051
|
[key: string]: unknown;
|
|
43792
44052
|
}
|
|
43793
44053
|
/** Returned by: api.markets.amznListingsItems.list(params) */
|
|
@@ -43817,12 +44077,82 @@ type AmznListingsItemsUpdateData = AmznListingsItemsListItem;
|
|
|
43817
44077
|
*/
|
|
43818
44078
|
interface AmznListingsItemsUpdateBody {
|
|
43819
44079
|
/**
|
|
43820
|
-
* Process code [(700) delete | (704)
|
|
43821
|
-
* anything else is a 400
|
|
44080
|
+
* Process code [(700) delete | (704) process now: recompute the Amazon quantity and queue the
|
|
44081
|
+
* send | (705) inactive | (1185) complete]; absent or anything else is a 400
|
|
43822
44082
|
*/
|
|
43823
44083
|
processCd?: number | null;
|
|
43824
44084
|
[key: string]: unknown;
|
|
43825
44085
|
}
|
|
44086
|
+
/**
|
|
44087
|
+
* List Amazon orders
|
|
44088
|
+
* Response data for GET /amzn-orders — MINIMUM fields, extras pass through
|
|
44089
|
+
*
|
|
44090
|
+
* Returned by: api.markets.amznOrders.list(params) (array items)
|
|
44091
|
+
* Returned by: api.markets.amznOrders.get(amznOrdersUid)
|
|
44092
|
+
*/
|
|
44093
|
+
interface AmznOrdersListItem {
|
|
44094
|
+
/** Amazon order row ID */
|
|
44095
|
+
amznOrdersUid: number;
|
|
44096
|
+
/** Amazon order ID; the customer PO when the order is imported into Prophet 21 (max 25 chars) */
|
|
44097
|
+
orderId: string;
|
|
44098
|
+
/**
|
|
44099
|
+
* Seller Order ID on Amazon (order alias SELLER_ORDER_ID); empty until the seller sets it (max 50
|
|
44100
|
+
* chars)
|
|
44101
|
+
*/
|
|
44102
|
+
sellerOrderId: string | null;
|
|
44103
|
+
/** Matched Prophet 21 order (oe_hdr.order_no); empty until matched (max 8 chars) */
|
|
44104
|
+
orderNo: string | null;
|
|
44105
|
+
/** p21_sism import that created the Prophet 21 order; 0 until imported */
|
|
44106
|
+
importUid: number;
|
|
44107
|
+
/** Amazon marketplace the order was placed in (max 20 chars) */
|
|
44108
|
+
marketplaceId: string | null;
|
|
44109
|
+
/**
|
|
44110
|
+
* Amazon fulfillment status (PENDING, UNSHIPPED, PARTIALLY_SHIPPED, SHIPPED, CANCELLED, ...) (max
|
|
44111
|
+
* 30 chars)
|
|
44112
|
+
*/
|
|
44113
|
+
fulfillmentStatus: string | null;
|
|
44114
|
+
/** Who fulfills the order: MERCHANT or AMAZON (max 10 chars) */
|
|
44115
|
+
fulfilledBy: string | null;
|
|
44116
|
+
/** Amazon shipping service level (Standard, Expedited, ...) (max 30 chars) */
|
|
44117
|
+
fulfillmentServiceLevel: string | null;
|
|
44118
|
+
/** Latest ship-by time Amazon gives for the order (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
44119
|
+
dateShipBy: string | null;
|
|
44120
|
+
/** Order grand total Amazon reports */
|
|
44121
|
+
orderTotal: number | null;
|
|
44122
|
+
/** Currency of the order total (max 3 chars) */
|
|
44123
|
+
currencyCode: string | null;
|
|
44124
|
+
/** Number of order items */
|
|
44125
|
+
itemCount: number;
|
|
44126
|
+
/** When the customer placed the order on Amazon (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
44127
|
+
dateOrderCreated: string | null;
|
|
44128
|
+
/** When Amazon last changed the order (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
44129
|
+
dateOrderUpdated: string | null;
|
|
44130
|
+
/**
|
|
44131
|
+
* Order JSON as Amazon returned it, items included; buyer, recipient and buyer-written item text
|
|
44132
|
+
* (gift message, cancel reason, customization URL) removed
|
|
44133
|
+
*/
|
|
44134
|
+
orderJson: string | null;
|
|
44135
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
44136
|
+
dateCreated: string;
|
|
44137
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
44138
|
+
dateLastModified: string;
|
|
44139
|
+
/** Update code (1185 = Import Complete) */
|
|
44140
|
+
updateCd: number;
|
|
44141
|
+
/** Status code (704 = Active, 700 = Deleted) */
|
|
44142
|
+
statusCd: number;
|
|
44143
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
44144
|
+
processCd: number;
|
|
44145
|
+
[key: string]: unknown;
|
|
44146
|
+
}
|
|
44147
|
+
/** Returned by: api.markets.amznOrders.list(params) */
|
|
44148
|
+
type AmznOrdersListData = AmznOrdersListItem[];
|
|
44149
|
+
/**
|
|
44150
|
+
* Get an Amazon order
|
|
44151
|
+
* Response data for GET /amzn-orders/{amznOrdersUid} — MINIMUM fields, extras pass through
|
|
44152
|
+
*
|
|
44153
|
+
* Returned by: api.markets.amznOrders.get(amznOrdersUid)
|
|
44154
|
+
*/
|
|
44155
|
+
type AmznOrdersGetData = AmznOrdersListItem;
|
|
43826
44156
|
/**
|
|
43827
44157
|
* Shape of `marketplaces` (MINIMUM fields; reused wherever the same shape appears)
|
|
43828
44158
|
* Marketplaces the seller account participates in; empty when not ok
|
|
@@ -43873,6 +44203,11 @@ interface MarketsClientSpec {
|
|
|
43873
44203
|
*
|
|
43874
44204
|
* List Amazon listings items for a site
|
|
43875
44205
|
*
|
|
44206
|
+
* Errors:
|
|
44207
|
+
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an amzn_listings_items
|
|
44208
|
+
* column.
|
|
44209
|
+
* 403: This endpoint is not configured for this site (the site has no valid Amazon config).
|
|
44210
|
+
*
|
|
43876
44211
|
* GET https://markets.augur-api.com/amzn-listings-items
|
|
43877
44212
|
* Contract: https://markets.augur-api.com/openapi.json#/paths/~1amzn-listings-items/get
|
|
43878
44213
|
*
|
|
@@ -43886,6 +44221,10 @@ interface MarketsClientSpec {
|
|
|
43886
44221
|
*
|
|
43887
44222
|
* Get one Amazon listings item, the seller SKU linked to a Prophet 21 item
|
|
43888
44223
|
*
|
|
44224
|
+
* Errors:
|
|
44225
|
+
* 403: This endpoint is not configured for this site (the site has no valid Amazon config).
|
|
44226
|
+
* 404: No Amazon listings item with this ID.
|
|
44227
|
+
*
|
|
43889
44228
|
* GET https://markets.augur-api.com/amzn-listings-items/{amznListingsItemsUid}
|
|
43890
44229
|
* Contract:
|
|
43891
44230
|
* https://markets.augur-api.com/openapi.json#/paths/~1amzn-listings-items~1{amznListingsItemsUid}/get
|
|
@@ -43899,11 +44238,17 @@ interface MarketsClientSpec {
|
|
|
43899
44238
|
* Update an Amazon listings item process code
|
|
43900
44239
|
* Call: api.markets.amznListingsItems.update(amznListingsItemsUid, data)
|
|
43901
44240
|
*
|
|
43902
|
-
* Change the process code of one Amazon listings item; processCd is the only writable field
|
|
44241
|
+
* Change the process code of one Amazon listings item; processCd is the only writable field,
|
|
44242
|
+
* and 704 recomputes the Amazon quantity and queues the send
|
|
43903
44243
|
*
|
|
43904
44244
|
* Request body: Change an Amazon listings item's process code; process_cd is the only writable
|
|
43905
44245
|
* field
|
|
43906
44246
|
*
|
|
44247
|
+
* Errors:
|
|
44248
|
+
* 400: Request body is not a JSON object, or processCd is not 700, 704, 705 or 1185.
|
|
44249
|
+
* 403: This endpoint is not configured for this site (the site has no valid Amazon config).
|
|
44250
|
+
* 404: No Amazon listings item with this ID.
|
|
44251
|
+
*
|
|
43907
44252
|
* PUT https://markets.augur-api.com/amzn-listings-items/{amznListingsItemsUid}
|
|
43908
44253
|
* Contract:
|
|
43909
44254
|
* https://markets.augur-api.com/openapi.json#/paths/~1amzn-listings-items~1{amznListingsItemsUid}/put
|
|
@@ -43914,6 +44259,44 @@ interface MarketsClientSpec {
|
|
|
43914
44259
|
*/
|
|
43915
44260
|
update: (amznListingsItemsUid: number, data: AmznListingsItemsUpdateBody) => Promise<BaseResponse$1<AmznListingsItemsUpdateData>>;
|
|
43916
44261
|
};
|
|
44262
|
+
amznOrders: {
|
|
44263
|
+
/**
|
|
44264
|
+
* List Amazon orders
|
|
44265
|
+
* Call: api.markets.amznOrders.list(params)
|
|
44266
|
+
*
|
|
44267
|
+
* List Amazon orders synced for a site
|
|
44268
|
+
*
|
|
44269
|
+
* Errors:
|
|
44270
|
+
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field an amzn_orders column.
|
|
44271
|
+
* 403: This endpoint is not configured for this site (the site has no valid Amazon config).
|
|
44272
|
+
*
|
|
44273
|
+
* GET https://markets.augur-api.com/amzn-orders
|
|
44274
|
+
* Contract: https://markets.augur-api.com/openapi.json#/paths/~1amzn-orders/get
|
|
44275
|
+
*
|
|
44276
|
+
* @param params AmznOrdersListParams (query string)
|
|
44277
|
+
* @returns BaseResponse whose `data` is AmznOrdersListData
|
|
44278
|
+
*/
|
|
44279
|
+
list: (params?: AmznOrdersListParams) => Promise<BaseResponse$1<AmznOrdersListData>>;
|
|
44280
|
+
/**
|
|
44281
|
+
* Get an Amazon order
|
|
44282
|
+
* Call: api.markets.amznOrders.get(amznOrdersUid)
|
|
44283
|
+
*
|
|
44284
|
+
* Get one Amazon order synced from Amazon
|
|
44285
|
+
*
|
|
44286
|
+
* Errors:
|
|
44287
|
+
* 403: This endpoint is not configured for this site (the site has no valid Amazon config).
|
|
44288
|
+
* 404: No Amazon order with this ID.
|
|
44289
|
+
*
|
|
44290
|
+
* GET https://markets.augur-api.com/amzn-orders/{amznOrdersUid}
|
|
44291
|
+
* Contract:
|
|
44292
|
+
* https://markets.augur-api.com/openapi.json#/paths/~1amzn-orders~1{amznOrdersUid}/get
|
|
44293
|
+
*
|
|
44294
|
+
* @param amznOrdersUid amzn_orders.amzn_orders_uid
|
|
44295
|
+
* @param params AmznOrdersGetParams (query string)
|
|
44296
|
+
* @returns BaseResponse whose `data` is AmznOrdersGetData
|
|
44297
|
+
*/
|
|
44298
|
+
get: (amznOrdersUid: number, params?: AmznOrdersGetParams) => Promise<BaseResponse$1<AmznOrdersGetData>>;
|
|
44299
|
+
};
|
|
43917
44300
|
amznSp: {
|
|
43918
44301
|
connection: {
|
|
43919
44302
|
/**
|
|
@@ -43928,6 +44311,9 @@ interface MarketsClientSpec {
|
|
|
43928
44311
|
*
|
|
43929
44312
|
* Auth: bearer token; spec scopes: none listed (most endpoints list `public`)
|
|
43930
44313
|
*
|
|
44314
|
+
* Errors:
|
|
44315
|
+
* 403: This endpoint is not configured for this site (the site has no valid Amazon config).
|
|
44316
|
+
*
|
|
43931
44317
|
* GET https://markets.augur-api.com/amzn-sp/connection
|
|
43932
44318
|
* Contract: https://markets.augur-api.com/openapi.json#/paths/~1amzn-sp~1connection/get
|
|
43933
44319
|
*
|
|
@@ -43946,12 +44332,17 @@ type types$8_AmznListingsItemsListItem = AmznListingsItemsListItem;
|
|
|
43946
44332
|
type types$8_AmznListingsItemsListParams = AmznListingsItemsListParams;
|
|
43947
44333
|
type types$8_AmznListingsItemsUpdateBody = AmznListingsItemsUpdateBody;
|
|
43948
44334
|
type types$8_AmznListingsItemsUpdateData = AmznListingsItemsUpdateData;
|
|
44335
|
+
type types$8_AmznOrdersGetData = AmznOrdersGetData;
|
|
44336
|
+
type types$8_AmznOrdersGetParams = AmznOrdersGetParams;
|
|
44337
|
+
type types$8_AmznOrdersListData = AmznOrdersListData;
|
|
44338
|
+
type types$8_AmznOrdersListItem = AmznOrdersListItem;
|
|
44339
|
+
type types$8_AmznOrdersListParams = AmznOrdersListParams;
|
|
43949
44340
|
type types$8_AmznSpConnectionListData = AmznSpConnectionListData;
|
|
43950
44341
|
type types$8_AmznSpConnectionListDataMarketplacesItem = AmznSpConnectionListDataMarketplacesItem;
|
|
43951
44342
|
type types$8_AmznSpConnectionListParams = AmznSpConnectionListParams;
|
|
43952
44343
|
type types$8_MarketsClientSpec = MarketsClientSpec;
|
|
43953
44344
|
declare namespace types$8 {
|
|
43954
|
-
export type { types$8_AmznListingsItemsGetData as AmznListingsItemsGetData, types$8_AmznListingsItemsGetParams as AmznListingsItemsGetParams, types$8_AmznListingsItemsListData as AmznListingsItemsListData, types$8_AmznListingsItemsListItem as AmznListingsItemsListItem, types$8_AmznListingsItemsListParams as AmznListingsItemsListParams, types$8_AmznListingsItemsUpdateBody as AmznListingsItemsUpdateBody, types$8_AmznListingsItemsUpdateData as AmznListingsItemsUpdateData, types$8_AmznSpConnectionListData as AmznSpConnectionListData, types$8_AmznSpConnectionListDataMarketplacesItem as AmznSpConnectionListDataMarketplacesItem, types$8_AmznSpConnectionListParams as AmznSpConnectionListParams, types$8_MarketsClientSpec as MarketsClientSpec };
|
|
44345
|
+
export type { types$8_AmznListingsItemsGetData as AmznListingsItemsGetData, types$8_AmznListingsItemsGetParams as AmznListingsItemsGetParams, types$8_AmznListingsItemsListData as AmznListingsItemsListData, types$8_AmznListingsItemsListItem as AmznListingsItemsListItem, types$8_AmznListingsItemsListParams as AmznListingsItemsListParams, types$8_AmznListingsItemsUpdateBody as AmznListingsItemsUpdateBody, types$8_AmznListingsItemsUpdateData as AmznListingsItemsUpdateData, types$8_AmznOrdersGetData as AmznOrdersGetData, types$8_AmznOrdersGetParams as AmznOrdersGetParams, types$8_AmznOrdersListData as AmznOrdersListData, types$8_AmznOrdersListItem as AmznOrdersListItem, types$8_AmznOrdersListParams as AmznOrdersListParams, types$8_AmznSpConnectionListData as AmznSpConnectionListData, types$8_AmznSpConnectionListDataMarketplacesItem as AmznSpConnectionListDataMarketplacesItem, types$8_AmznSpConnectionListParams as AmznSpConnectionListParams, types$8_MarketsClientSpec as MarketsClientSpec };
|
|
43955
44346
|
}
|
|
43956
44347
|
|
|
43957
44348
|
/**
|
|
@@ -43982,13 +44373,18 @@ declare namespace types$8 {
|
|
|
43982
44373
|
* PUT /amzn-listings-items/{amznListingsItemsUid} →
|
|
43983
44374
|
* api.markets.amznListingsItems.update(amznListingsItemsUid, data) →
|
|
43984
44375
|
* AmznListingsItemsUpdateData
|
|
44376
|
+
* GET /amzn-orders → api.markets.amznOrders.list(params) → AmznOrdersListData
|
|
44377
|
+
* GET /amzn-orders/{amznOrdersUid} → api.markets.amznOrders.get(amznOrdersUid) →
|
|
44378
|
+
* AmznOrdersGetData
|
|
43985
44379
|
* GET /amzn-sp/connection → api.markets.amznSp.connection.list() → AmznSpConnectionListData
|
|
43986
44380
|
*/
|
|
43987
44381
|
|
|
43988
44382
|
declare class MarketsClient extends BaseServiceClient {
|
|
43989
44383
|
readonly amznListingsItems: MarketsClientSpec['amznListingsItems'];
|
|
44384
|
+
readonly amznOrders: MarketsClientSpec['amznOrders'];
|
|
43990
44385
|
readonly amznSp: MarketsClientSpec['amznSp'];
|
|
43991
44386
|
readonly amznListingsItemsData: DataOnly<MarketsClientSpec['amznListingsItems']>;
|
|
44387
|
+
readonly amznOrdersData: DataOnly<MarketsClientSpec['amznOrders']>;
|
|
43992
44388
|
readonly amznSpData: DataOnly<MarketsClientSpec['amznSp']>;
|
|
43993
44389
|
constructor(http: HTTPClient, baseUrl?: string);
|
|
43994
44390
|
}
|