@simpleapps-com/augur-api 2026.9.6 → 2026.9.7
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/README.md +29 -0
- package/SKILL.md +15 -0
- package/dist/{client-BdaR6MZK.d.mts → client-BbTOVex4.d.mts} +232 -21
- package/dist/{client-BdaR6MZK.d.ts → client-BbTOVex4.d.ts} +232 -21
- package/dist/index.d.mts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +384 -146
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +384 -146
- package/dist/index.mjs.map +1 -1
- package/dist/testing.d.mts +1 -1
- package/dist/testing.d.ts +1 -1
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -139,6 +139,35 @@ try {
|
|
|
139
139
|
}
|
|
140
140
|
```
|
|
141
141
|
|
|
142
|
+
The status decides the class: 400 → `ValidationError`, 401 → `AuthenticationError`, 404 → `NotFoundError`, 429 → `RateLimitError`, anything else → `AugurError`. `error.endpoint` is the path template (`/inv-mast/{invMastUid}`), and messages never contain parameter values.
|
|
143
|
+
|
|
144
|
+
## Endpoint Registry and `call()`
|
|
145
|
+
|
|
146
|
+
`AugurAPI.endpoints()` lists every endpoint (id, method, path template, params). `call()` invokes one by id or alias id, with no typed method:
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
const result = await api.call('items.invMast.doc.get', {
|
|
150
|
+
pathParams: { invMastUid: 12345 },
|
|
151
|
+
query: { edgeCache: 1 },
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
result.httpStatus; // 200
|
|
155
|
+
result.envelope?.data; // set when the body is the standard 8-key envelope
|
|
156
|
+
result.body; // parsed JSON, or the raw text when the body isn't JSON
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
- Arguments are checked before any request: path params must match exactly, query keys must be declared, and a body is allowed only on POST/PUT. Violations throw `InvalidArgumentError`.
|
|
160
|
+
- A 2xx always resolves; there is no schema validation. Use the typed methods when you want validated, typed responses.
|
|
161
|
+
- Non-2xx responses throw the same errors as the typed methods.
|
|
162
|
+
|
|
163
|
+
## Path Values
|
|
164
|
+
|
|
165
|
+
Path values are sent unencoded, because the API does not decode path segments (`/bins/D%2FS` looks up the literal `D%2FS`). A string path value MUST use only letters, digits and `- . _ ~ ! $ & ' ( ) * + , ; = : @`. Anything else, such as `/`, `?`, `#`, `%`, spaces or non-ASCII, throws `InvalidArgumentError` before any request. Pass the raw value, never a pre-encoded one. Use the query parameter instead where there is one:
|
|
166
|
+
|
|
167
|
+
```typescript
|
|
168
|
+
await api.call('items.locations.bins.list', { pathParams: { locationId: 100 }, query: { bin: 'D/S' } });
|
|
169
|
+
```
|
|
170
|
+
|
|
142
171
|
## For AI Agents
|
|
143
172
|
|
|
144
173
|
See [SKILL.md](./SKILL.md) for guidance on using this package with AI assistance.
|
package/SKILL.md
CHANGED
|
@@ -214,6 +214,21 @@ for (const faq of faqs) {
|
|
|
214
214
|
}
|
|
215
215
|
```
|
|
216
216
|
|
|
217
|
+
## Calling by Endpoint Id (`call()`)
|
|
218
|
+
|
|
219
|
+
For generic callers (tools, agents, scripts) that should not hard-code a typed method:
|
|
220
|
+
|
|
221
|
+
```typescript
|
|
222
|
+
AugurAPI.endpoints(); // every endpoint: id, method, path template, pathParams, queryParams, hasBody
|
|
223
|
+
const result = await api.call('items.invMast.doc.get', { pathParams: { invMastUid: 12345 } });
|
|
224
|
+
result.envelope?.data; // null envelope means the body isn't the 8-key envelope; see result.body
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
- Ids are `camelCase(service).chain.action`, the same as the typed call path.
|
|
228
|
+
- Arguments are checked before any request (`InvalidArgumentError`). A 2xx never fails validation.
|
|
229
|
+
- Errors: 400 → `ValidationError`, 401 → `AuthenticationError`, 404 → `NotFoundError`, 429 → `RateLimitError`, anything else → `AugurError`. `error.endpoint` is the path template.
|
|
230
|
+
- Path values are sent unencoded: a string path value with `/ ? # %`, spaces or non-ASCII is rejected. Use the query param instead (e.g. `bins.list` with `query: { bin: 'D/S' }`).
|
|
231
|
+
|
|
217
232
|
## Key Differences from Python Client
|
|
218
233
|
|
|
219
234
|
| Aspect | TypeScript | Python |
|
|
@@ -39,6 +39,8 @@ interface RequestConfig {
|
|
|
39
39
|
signal?: AbortSignal;
|
|
40
40
|
headers?: Record<string, string>;
|
|
41
41
|
responseType?: 'json' | 'text' | 'blob' | 'arraybuffer';
|
|
42
|
+
/** Path template reported as `endpoint` in errors, e.g. `/inv-mast/{invMastUid}` */
|
|
43
|
+
endpoint?: string;
|
|
42
44
|
}
|
|
43
45
|
/**
|
|
44
46
|
* Interface for context object containing authentication and site information
|
|
@@ -65,6 +67,49 @@ declare class ContextCreationError extends Error {
|
|
|
65
67
|
constructor(message: string, field?: string | undefined);
|
|
66
68
|
}
|
|
67
69
|
|
|
70
|
+
/**
|
|
71
|
+
* `call()`: reach any registry endpoint by id, with no per-endpoint code.
|
|
72
|
+
*
|
|
73
|
+
* Arguments are checked against the registry entry before any I/O. The
|
|
74
|
+
* response is returned as-is: no schema validation, no JSON assumption, and a
|
|
75
|
+
* 2xx never fails. The contract is wiki/Endpoint-Registry.md.
|
|
76
|
+
*/
|
|
77
|
+
|
|
78
|
+
/** What `call()` sends. Keys are sent as given; there is no case renaming. */
|
|
79
|
+
interface CallArgs {
|
|
80
|
+
/** Exactly the entry's `pathParams` */
|
|
81
|
+
pathParams?: Record<string, string | number>;
|
|
82
|
+
/** A subset of the entry's `queryParams`, plus `edgeCache` where the entry allows it */
|
|
83
|
+
query?: Record<string, unknown>;
|
|
84
|
+
/** Only for entries with `hasBody` */
|
|
85
|
+
body?: unknown;
|
|
86
|
+
}
|
|
87
|
+
/** The standard 8-key response envelope. Values are passed through unchecked. */
|
|
88
|
+
interface Envelope {
|
|
89
|
+
count: unknown;
|
|
90
|
+
data: unknown;
|
|
91
|
+
message: unknown;
|
|
92
|
+
options: unknown;
|
|
93
|
+
params: unknown;
|
|
94
|
+
status: unknown;
|
|
95
|
+
total: unknown;
|
|
96
|
+
totalResults: unknown;
|
|
97
|
+
}
|
|
98
|
+
/** A 2xx response. */
|
|
99
|
+
interface CallResult {
|
|
100
|
+
httpStatus: number;
|
|
101
|
+
/** Set when `body` is an object with all 8 envelope keys, otherwise `null` */
|
|
102
|
+
envelope: Envelope | null;
|
|
103
|
+
/** Parsed JSON, or the raw text when the body isn't JSON (`''` when empty) */
|
|
104
|
+
body: unknown;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/** A response as text, before any JSON parsing (what `call()` builds its result from). */
|
|
108
|
+
interface RawResponse {
|
|
109
|
+
status: number;
|
|
110
|
+
contentType: string;
|
|
111
|
+
text: string;
|
|
112
|
+
}
|
|
68
113
|
declare class HTTPClient {
|
|
69
114
|
private config;
|
|
70
115
|
private serviceName;
|
|
@@ -83,13 +128,25 @@ declare class HTTPClient {
|
|
|
83
128
|
*/
|
|
84
129
|
private handleFetchSuccess;
|
|
85
130
|
/**
|
|
86
|
-
*
|
|
131
|
+
* Read a successful response as text, for `raw()`. Never parses JSON.
|
|
132
|
+
*/
|
|
133
|
+
private readRaw;
|
|
134
|
+
/**
|
|
135
|
+
* Core request method using native fetch. `read` turns a 2xx response into
|
|
136
|
+
* the result, inside the same error handling and timeout as the fetch.
|
|
87
137
|
*/
|
|
88
138
|
private request;
|
|
89
139
|
/**
|
|
90
140
|
* Merge two AbortSignals — aborts when either fires
|
|
91
141
|
*/
|
|
92
142
|
private mergeSignals;
|
|
143
|
+
/**
|
|
144
|
+
* The one status-to-error switch, shared by typed methods and `call()`.
|
|
145
|
+
*
|
|
146
|
+
* @ensures 400 → ValidationError, 401 → AuthenticationError, 404 → NotFoundError,
|
|
147
|
+
* 429 → RateLimitError, any other status → AugurError (the class follows the status alone)
|
|
148
|
+
* @ensures thrown.endpoint = endpoint (callers pass the path template, so no param values leak)
|
|
149
|
+
*/
|
|
93
150
|
private handleHttpError;
|
|
94
151
|
/**
|
|
95
152
|
* Re-throw known error types or wrap as network error
|
|
@@ -126,6 +183,17 @@ declare class HTTPClient {
|
|
|
126
183
|
post<T>(url: string, data?: unknown, params?: unknown, config?: RequestConfig): Promise<T>;
|
|
127
184
|
put<T>(url: string, data?: unknown, params?: unknown, config?: RequestConfig): Promise<T>;
|
|
128
185
|
delete<T>(url: string, params?: unknown, config?: RequestConfig): Promise<T>;
|
|
186
|
+
/**
|
|
187
|
+
* Send a request and return the 2xx response as text, with no schema
|
|
188
|
+
* validation and no JSON assumption. Non-2xx responses throw through the same
|
|
189
|
+
* status switch as the typed methods. GET retries like `get()` (without its
|
|
190
|
+
* in-flight deduplication); other methods make one attempt, like `post()`.
|
|
191
|
+
*/
|
|
192
|
+
raw(method: string, url: string, options?: {
|
|
193
|
+
params?: unknown;
|
|
194
|
+
data?: unknown;
|
|
195
|
+
config?: RequestConfig;
|
|
196
|
+
}): Promise<RawResponse>;
|
|
129
197
|
}
|
|
130
198
|
|
|
131
199
|
/** PHP JSON encoding quirk: empty arrays become objects {}, so accept either. */
|
|
@@ -371,7 +439,11 @@ declare abstract class BaseServiceClient {
|
|
|
371
439
|
*/
|
|
372
440
|
private executeHttpRequest;
|
|
373
441
|
/**
|
|
374
|
-
* Create a
|
|
442
|
+
* Create a validation error for invalid params or an unexpected response.
|
|
443
|
+
*
|
|
444
|
+
* @ensures result.endpoint = config.path (the template; the filled path can hold param values)
|
|
445
|
+
* @ensures result.message holds no param values (issues name fields; valibot issue messages
|
|
446
|
+
* describe the expected type, and `received` is not copied)
|
|
375
447
|
*/
|
|
376
448
|
private createValidationError;
|
|
377
449
|
/**
|
|
@@ -2003,7 +2075,7 @@ declare class VMIClient extends BaseServiceClient {
|
|
|
2003
2075
|
/**
|
|
2004
2076
|
* Generated types for open-search service
|
|
2005
2077
|
* Source: shared/specs/open-search.json
|
|
2006
|
-
* Generated: 2026-09-
|
|
2078
|
+
* Generated: 2026-09-30T22:17:43Z
|
|
2007
2079
|
*
|
|
2008
2080
|
* DO NOT EDIT — regenerate with: python shared/scripts/generate-ts.py
|
|
2009
2081
|
*/
|
|
@@ -2027,6 +2099,7 @@ interface ItemSearchListParams extends EdgeCacheParams {
|
|
|
2027
2099
|
sourceFieldsList?: string;
|
|
2028
2100
|
stockStatus?: string;
|
|
2029
2101
|
tags?: string;
|
|
2102
|
+
useBrandFolderDoc?: string;
|
|
2030
2103
|
variantFilter?: string;
|
|
2031
2104
|
}
|
|
2032
2105
|
/** Params for GET /item-search-facets */
|
|
@@ -2053,11 +2126,16 @@ interface ItemSearchFacetsListParams extends EdgeCacheParams {
|
|
|
2053
2126
|
}
|
|
2054
2127
|
/** Params for GET /item-search/attributes */
|
|
2055
2128
|
interface ItemSearchAttributesListParams extends EdgeCacheParams {
|
|
2056
|
-
|
|
2057
|
-
|
|
2129
|
+
classId5List?: string;
|
|
2130
|
+
fields?: string;
|
|
2058
2131
|
filters?: string;
|
|
2132
|
+
from?: number;
|
|
2133
|
+
operator?: string;
|
|
2059
2134
|
q: string;
|
|
2060
2135
|
searchType: string;
|
|
2136
|
+
size?: number;
|
|
2137
|
+
sort?: string;
|
|
2138
|
+
sourceFieldsList?: string;
|
|
2061
2139
|
}
|
|
2062
2140
|
/** Params for GET /items */
|
|
2063
2141
|
interface ItemsListParams extends EdgeCacheParams {
|
|
@@ -2065,6 +2143,7 @@ interface ItemsListParams extends EdgeCacheParams {
|
|
|
2065
2143
|
limit?: number;
|
|
2066
2144
|
offset?: number;
|
|
2067
2145
|
online?: string;
|
|
2146
|
+
orderBy?: string;
|
|
2068
2147
|
statusCd?: number;
|
|
2069
2148
|
}
|
|
2070
2149
|
/** Params for GET /items/{invMastUid} */
|
|
@@ -2097,6 +2176,68 @@ interface SuggestionsSuggestListParams extends EdgeCacheParams {
|
|
|
2097
2176
|
}
|
|
2098
2177
|
/** Params for GET /suggestions/{suggestionsUid} */
|
|
2099
2178
|
type SuggestionsGetParams = EdgeCacheParams;
|
|
2179
|
+
/** Response data for GET /item-search/attributes — MINIMUM fields, extras pass through */
|
|
2180
|
+
interface ItemSearchAttributesListData {
|
|
2181
|
+
attributes: Array<{
|
|
2182
|
+
attributeUid: number;
|
|
2183
|
+
attributeId: string;
|
|
2184
|
+
attributeDesc: string | null;
|
|
2185
|
+
sequenceNo: number | null;
|
|
2186
|
+
values: Array<{
|
|
2187
|
+
attributeValueUid: number;
|
|
2188
|
+
attributeValue: string;
|
|
2189
|
+
sequenceNo: number;
|
|
2190
|
+
[key: string]: unknown;
|
|
2191
|
+
}>;
|
|
2192
|
+
valueCount: number;
|
|
2193
|
+
[key: string]: unknown;
|
|
2194
|
+
}>;
|
|
2195
|
+
[key: string]: unknown;
|
|
2196
|
+
}
|
|
2197
|
+
/** Response data for GET /items — MINIMUM fields, extras pass through */
|
|
2198
|
+
interface ItemsListItem {
|
|
2199
|
+
invMastUid: number;
|
|
2200
|
+
itemId: string | null;
|
|
2201
|
+
online: string;
|
|
2202
|
+
updateCd: number;
|
|
2203
|
+
doc: string | null;
|
|
2204
|
+
indexCd: number;
|
|
2205
|
+
statusCd: number;
|
|
2206
|
+
processCd: number;
|
|
2207
|
+
indexStatusCd: number;
|
|
2208
|
+
dateCreated: string;
|
|
2209
|
+
dateLastModified: string;
|
|
2210
|
+
classId5: string | null;
|
|
2211
|
+
dateLastChecked: string;
|
|
2212
|
+
embeddingCd: number;
|
|
2213
|
+
docHash: string | null;
|
|
2214
|
+
indexHash: string | null;
|
|
2215
|
+
location: string | null;
|
|
2216
|
+
uuid: string | null;
|
|
2217
|
+
[key: string]: unknown;
|
|
2218
|
+
}
|
|
2219
|
+
type ItemsListData = ItemsListItem[];
|
|
2220
|
+
/** Response data for PUT /items/refresh — MINIMUM fields, extras pass through */
|
|
2221
|
+
type ItemsRefreshUpdateData = boolean;
|
|
2222
|
+
/** Request body for PUT /items/refresh — MINIMUM fields, extras pass through */
|
|
2223
|
+
interface ItemsRefreshUpdateBody {
|
|
2224
|
+
updateCd?: boolean;
|
|
2225
|
+
indexCd?: boolean;
|
|
2226
|
+
processCd?: boolean;
|
|
2227
|
+
[key: string]: unknown;
|
|
2228
|
+
}
|
|
2229
|
+
/** Response data for GET /items/{invMastUid} — MINIMUM fields, extras pass through */
|
|
2230
|
+
type ItemsGetData = ItemsListItem;
|
|
2231
|
+
/** Response data for PUT /items/{invMastUid} — MINIMUM fields, extras pass through */
|
|
2232
|
+
type ItemsUpdateData = ItemsListItem;
|
|
2233
|
+
/** Request body for PUT /items/{invMastUid} — MINIMUM fields, extras pass through */
|
|
2234
|
+
interface ItemsUpdateBody {
|
|
2235
|
+
statusCd?: number | null;
|
|
2236
|
+
processCd?: number | null;
|
|
2237
|
+
[key: string]: unknown;
|
|
2238
|
+
}
|
|
2239
|
+
/** Response data for GET /items/{invMastUid}/refresh — MINIMUM fields, extras pass through */
|
|
2240
|
+
type ItemsRefreshGetData = ItemsListItem;
|
|
2100
2241
|
/** Response data for GET /query-string-redirect — MINIMUM fields, extras pass through */
|
|
2101
2242
|
interface QueryStringRedirectListItem {
|
|
2102
2243
|
queryStringRedirectUid: number;
|
|
@@ -2113,10 +2254,27 @@ interface QueryStringRedirectListItem {
|
|
|
2113
2254
|
type QueryStringRedirectListData = QueryStringRedirectListItem[];
|
|
2114
2255
|
/** Response data for POST /query-string-redirect — MINIMUM fields, extras pass through */
|
|
2115
2256
|
type QueryStringRedirectCreateData = QueryStringRedirectListItem;
|
|
2257
|
+
/** Request body for POST /query-string-redirect — MINIMUM fields, extras pass through */
|
|
2258
|
+
interface QueryStringRedirectCreateBody {
|
|
2259
|
+
queryString?: string | null;
|
|
2260
|
+
queryStringUid?: number | null;
|
|
2261
|
+
queryStringRedirectLink?: string | null;
|
|
2262
|
+
[key: string]: unknown;
|
|
2263
|
+
}
|
|
2116
2264
|
/** Response data for GET /query-string-redirect/{queryStringRedirectUid} — MINIMUM fields, extras pass through */
|
|
2117
2265
|
type QueryStringRedirectGetData = QueryStringRedirectListItem;
|
|
2118
2266
|
/** Response data for PUT /query-string-redirect/{queryStringRedirectUid} — MINIMUM fields, extras pass through */
|
|
2119
2267
|
type QueryStringRedirectUpdateData = QueryStringRedirectListItem;
|
|
2268
|
+
/** Request body for PUT /query-string-redirect/{queryStringRedirectUid} — MINIMUM fields, extras pass through */
|
|
2269
|
+
interface QueryStringRedirectUpdateBody {
|
|
2270
|
+
queryString?: string | null;
|
|
2271
|
+
queryStringUid?: number | null;
|
|
2272
|
+
queryStringRedirectLink?: string | null;
|
|
2273
|
+
statusCd?: number | null;
|
|
2274
|
+
processCd?: number | null;
|
|
2275
|
+
updateCd?: number | null;
|
|
2276
|
+
[key: string]: unknown;
|
|
2277
|
+
}
|
|
2120
2278
|
/** Response data for DELETE /query-string-redirect/{queryStringRedirectUid} — MINIMUM fields, extras pass through */
|
|
2121
2279
|
type QueryStringRedirectDeleteData = QueryStringRedirectListItem;
|
|
2122
2280
|
/** Response data for GET /suggestions — MINIMUM fields, extras pass through */
|
|
@@ -2134,50 +2292,76 @@ interface SuggestionsListItem {
|
|
|
2134
2292
|
[key: string]: unknown;
|
|
2135
2293
|
}
|
|
2136
2294
|
type SuggestionsListData = SuggestionsListItem[];
|
|
2295
|
+
/** Response data for GET /suggestions/suggest — MINIMUM fields, extras pass through */
|
|
2296
|
+
interface SuggestionsSuggestListItem {
|
|
2297
|
+
suggestionsUid: number;
|
|
2298
|
+
queryStringUid: number;
|
|
2299
|
+
suggestionsString: string;
|
|
2300
|
+
suggestionsMetaphone: string | null;
|
|
2301
|
+
avgTotalResults: number;
|
|
2302
|
+
dateCreated: string;
|
|
2303
|
+
dateLastModified: string;
|
|
2304
|
+
updateCd: number;
|
|
2305
|
+
statusCd: number;
|
|
2306
|
+
processCd: number;
|
|
2307
|
+
score: number;
|
|
2308
|
+
[key: string]: unknown;
|
|
2309
|
+
}
|
|
2310
|
+
type SuggestionsSuggestListData = SuggestionsSuggestListItem[];
|
|
2137
2311
|
/** Response data for GET /suggestions/{suggestionsUid} — MINIMUM fields, extras pass through */
|
|
2138
2312
|
type SuggestionsGetData = SuggestionsListItem;
|
|
2139
2313
|
interface OpenSearchClientSpec {
|
|
2140
2314
|
itemSearch: {
|
|
2141
2315
|
list: (params?: ItemSearchListParams) => Promise<BaseResponse$1<Record<string, unknown>>>;
|
|
2142
2316
|
attributes: {
|
|
2143
|
-
list: (params?: ItemSearchAttributesListParams) => Promise<BaseResponse$1<
|
|
2317
|
+
list: (params?: ItemSearchAttributesListParams) => Promise<BaseResponse$1<ItemSearchAttributesListData>>;
|
|
2144
2318
|
};
|
|
2145
2319
|
};
|
|
2146
2320
|
itemSearchFacets: {
|
|
2147
2321
|
list: (params?: ItemSearchFacetsListParams) => Promise<BaseResponse$1<Record<string, unknown>>>;
|
|
2148
2322
|
};
|
|
2149
2323
|
items: {
|
|
2150
|
-
list: (params?: ItemsListParams) => Promise<BaseResponse$1<
|
|
2151
|
-
get: (invMastUid: number, params?: ItemsGetParams) => Promise<BaseResponse$1<
|
|
2152
|
-
update: (invMastUid: number, data:
|
|
2324
|
+
list: (params?: ItemsListParams) => Promise<BaseResponse$1<ItemsListData>>;
|
|
2325
|
+
get: (invMastUid: number, params?: ItemsGetParams) => Promise<BaseResponse$1<ItemsGetData>>;
|
|
2326
|
+
update: (invMastUid: number, data: ItemsUpdateBody) => Promise<BaseResponse$1<ItemsUpdateData>>;
|
|
2153
2327
|
refresh: {
|
|
2154
|
-
update: (data:
|
|
2155
|
-
get: (invMastUid: number, params?: ItemsRefreshGetParams) => Promise<BaseResponse$1<
|
|
2328
|
+
update: (data: ItemsRefreshUpdateBody) => Promise<BaseResponse$1<ItemsRefreshUpdateData>>;
|
|
2329
|
+
get: (invMastUid: number, params?: ItemsRefreshGetParams) => Promise<BaseResponse$1<ItemsRefreshGetData>>;
|
|
2156
2330
|
};
|
|
2157
2331
|
};
|
|
2158
2332
|
queryStringRedirect: {
|
|
2159
2333
|
list: (params?: QueryStringRedirectListParams) => Promise<BaseResponse$1<QueryStringRedirectListData>>;
|
|
2160
|
-
create: (data:
|
|
2334
|
+
create: (data: QueryStringRedirectCreateBody) => Promise<BaseResponse$1<QueryStringRedirectCreateData>>;
|
|
2161
2335
|
get: (queryStringRedirectUid: number, params?: QueryStringRedirectGetParams) => Promise<BaseResponse$1<QueryStringRedirectGetData>>;
|
|
2162
|
-
update: (queryStringRedirectUid: number, data:
|
|
2336
|
+
update: (queryStringRedirectUid: number, data: QueryStringRedirectUpdateBody) => Promise<BaseResponse$1<QueryStringRedirectUpdateData>>;
|
|
2163
2337
|
delete: (queryStringRedirectUid: number) => Promise<BaseResponse$1<QueryStringRedirectDeleteData>>;
|
|
2164
2338
|
};
|
|
2165
2339
|
suggestions: {
|
|
2166
2340
|
list: (params?: SuggestionsListParams) => Promise<BaseResponse$1<SuggestionsListData>>;
|
|
2167
2341
|
get: (suggestionsUid: number, params?: SuggestionsGetParams) => Promise<BaseResponse$1<SuggestionsGetData>>;
|
|
2168
2342
|
suggest: {
|
|
2169
|
-
list: (params?: SuggestionsSuggestListParams) => Promise<BaseResponse$1<
|
|
2343
|
+
list: (params?: SuggestionsSuggestListParams) => Promise<BaseResponse$1<SuggestionsSuggestListData>>;
|
|
2170
2344
|
};
|
|
2171
2345
|
};
|
|
2172
2346
|
}
|
|
2173
2347
|
|
|
2348
|
+
type types$k_ItemSearchAttributesListData = ItemSearchAttributesListData;
|
|
2174
2349
|
type types$k_ItemSearchAttributesListParams = ItemSearchAttributesListParams;
|
|
2175
2350
|
type types$k_ItemSearchFacetsListParams = ItemSearchFacetsListParams;
|
|
2176
2351
|
type types$k_ItemSearchListParams = ItemSearchListParams;
|
|
2352
|
+
type types$k_ItemsGetData = ItemsGetData;
|
|
2177
2353
|
type types$k_ItemsGetParams = ItemsGetParams;
|
|
2354
|
+
type types$k_ItemsListData = ItemsListData;
|
|
2355
|
+
type types$k_ItemsListItem = ItemsListItem;
|
|
2178
2356
|
type types$k_ItemsListParams = ItemsListParams;
|
|
2357
|
+
type types$k_ItemsRefreshGetData = ItemsRefreshGetData;
|
|
2179
2358
|
type types$k_ItemsRefreshGetParams = ItemsRefreshGetParams;
|
|
2359
|
+
type types$k_ItemsRefreshUpdateBody = ItemsRefreshUpdateBody;
|
|
2360
|
+
type types$k_ItemsRefreshUpdateData = ItemsRefreshUpdateData;
|
|
2361
|
+
type types$k_ItemsUpdateBody = ItemsUpdateBody;
|
|
2362
|
+
type types$k_ItemsUpdateData = ItemsUpdateData;
|
|
2180
2363
|
type types$k_OpenSearchClientSpec = OpenSearchClientSpec;
|
|
2364
|
+
type types$k_QueryStringRedirectCreateBody = QueryStringRedirectCreateBody;
|
|
2181
2365
|
type types$k_QueryStringRedirectCreateData = QueryStringRedirectCreateData;
|
|
2182
2366
|
type types$k_QueryStringRedirectDeleteData = QueryStringRedirectDeleteData;
|
|
2183
2367
|
type types$k_QueryStringRedirectGetData = QueryStringRedirectGetData;
|
|
@@ -2185,21 +2369,24 @@ type types$k_QueryStringRedirectGetParams = QueryStringRedirectGetParams;
|
|
|
2185
2369
|
type types$k_QueryStringRedirectListData = QueryStringRedirectListData;
|
|
2186
2370
|
type types$k_QueryStringRedirectListItem = QueryStringRedirectListItem;
|
|
2187
2371
|
type types$k_QueryStringRedirectListParams = QueryStringRedirectListParams;
|
|
2372
|
+
type types$k_QueryStringRedirectUpdateBody = QueryStringRedirectUpdateBody;
|
|
2188
2373
|
type types$k_QueryStringRedirectUpdateData = QueryStringRedirectUpdateData;
|
|
2189
2374
|
type types$k_SuggestionsGetData = SuggestionsGetData;
|
|
2190
2375
|
type types$k_SuggestionsGetParams = SuggestionsGetParams;
|
|
2191
2376
|
type types$k_SuggestionsListData = SuggestionsListData;
|
|
2192
2377
|
type types$k_SuggestionsListItem = SuggestionsListItem;
|
|
2193
2378
|
type types$k_SuggestionsListParams = SuggestionsListParams;
|
|
2379
|
+
type types$k_SuggestionsSuggestListData = SuggestionsSuggestListData;
|
|
2380
|
+
type types$k_SuggestionsSuggestListItem = SuggestionsSuggestListItem;
|
|
2194
2381
|
type types$k_SuggestionsSuggestListParams = SuggestionsSuggestListParams;
|
|
2195
2382
|
declare namespace types$k {
|
|
2196
|
-
export type { types$k_ItemSearchAttributesListParams as ItemSearchAttributesListParams, types$k_ItemSearchFacetsListParams as ItemSearchFacetsListParams, types$k_ItemSearchListParams as ItemSearchListParams, types$k_ItemsGetParams as ItemsGetParams, types$k_ItemsListParams as ItemsListParams, types$k_ItemsRefreshGetParams as ItemsRefreshGetParams, types$k_OpenSearchClientSpec as OpenSearchClientSpec, types$k_QueryStringRedirectCreateData as QueryStringRedirectCreateData, types$k_QueryStringRedirectDeleteData as QueryStringRedirectDeleteData, types$k_QueryStringRedirectGetData as QueryStringRedirectGetData, types$k_QueryStringRedirectGetParams as QueryStringRedirectGetParams, types$k_QueryStringRedirectListData as QueryStringRedirectListData, types$k_QueryStringRedirectListItem as QueryStringRedirectListItem, types$k_QueryStringRedirectListParams as QueryStringRedirectListParams, types$k_QueryStringRedirectUpdateData as QueryStringRedirectUpdateData, types$k_SuggestionsGetData as SuggestionsGetData, types$k_SuggestionsGetParams as SuggestionsGetParams, types$k_SuggestionsListData as SuggestionsListData, types$k_SuggestionsListItem as SuggestionsListItem, types$k_SuggestionsListParams as SuggestionsListParams, types$k_SuggestionsSuggestListParams as SuggestionsSuggestListParams };
|
|
2383
|
+
export type { types$k_ItemSearchAttributesListData as ItemSearchAttributesListData, types$k_ItemSearchAttributesListParams as ItemSearchAttributesListParams, types$k_ItemSearchFacetsListParams as ItemSearchFacetsListParams, types$k_ItemSearchListParams as ItemSearchListParams, types$k_ItemsGetData as ItemsGetData, types$k_ItemsGetParams as ItemsGetParams, types$k_ItemsListData as ItemsListData, types$k_ItemsListItem as ItemsListItem, types$k_ItemsListParams as ItemsListParams, types$k_ItemsRefreshGetData as ItemsRefreshGetData, types$k_ItemsRefreshGetParams as ItemsRefreshGetParams, types$k_ItemsRefreshUpdateBody as ItemsRefreshUpdateBody, types$k_ItemsRefreshUpdateData as ItemsRefreshUpdateData, types$k_ItemsUpdateBody as ItemsUpdateBody, types$k_ItemsUpdateData as ItemsUpdateData, types$k_OpenSearchClientSpec as OpenSearchClientSpec, types$k_QueryStringRedirectCreateBody as QueryStringRedirectCreateBody, types$k_QueryStringRedirectCreateData as QueryStringRedirectCreateData, types$k_QueryStringRedirectDeleteData as QueryStringRedirectDeleteData, types$k_QueryStringRedirectGetData as QueryStringRedirectGetData, types$k_QueryStringRedirectGetParams as QueryStringRedirectGetParams, types$k_QueryStringRedirectListData as QueryStringRedirectListData, types$k_QueryStringRedirectListItem as QueryStringRedirectListItem, types$k_QueryStringRedirectListParams as QueryStringRedirectListParams, types$k_QueryStringRedirectUpdateBody as QueryStringRedirectUpdateBody, types$k_QueryStringRedirectUpdateData as QueryStringRedirectUpdateData, types$k_SuggestionsGetData as SuggestionsGetData, types$k_SuggestionsGetParams as SuggestionsGetParams, types$k_SuggestionsListData as SuggestionsListData, types$k_SuggestionsListItem as SuggestionsListItem, types$k_SuggestionsListParams as SuggestionsListParams, types$k_SuggestionsSuggestListData as SuggestionsSuggestListData, types$k_SuggestionsSuggestListItem as SuggestionsSuggestListItem, types$k_SuggestionsSuggestListParams as SuggestionsSuggestListParams };
|
|
2197
2384
|
}
|
|
2198
2385
|
|
|
2199
2386
|
/**
|
|
2200
2387
|
* Generated client for open-search service
|
|
2201
2388
|
* Source: shared/specs/open-search.json
|
|
2202
|
-
* Generated: 2026-09-
|
|
2389
|
+
* Generated: 2026-09-30T22:17:43Z
|
|
2203
2390
|
*
|
|
2204
2391
|
* DO NOT EDIT — regenerate with: python shared/scripts/generate-ts.py
|
|
2205
2392
|
*/
|
|
@@ -6782,7 +6969,7 @@ declare class AvalaraClient extends BaseServiceClient {
|
|
|
6782
6969
|
/**
|
|
6783
6970
|
* Generated types for brand-folder service
|
|
6784
6971
|
* Source: shared/specs/brand-folder.json
|
|
6785
|
-
* Generated: 2026-09-
|
|
6972
|
+
* Generated: 2026-09-30T22:17:42Z
|
|
6786
6973
|
*
|
|
6787
6974
|
* DO NOT EDIT — regenerate with: python shared/scripts/generate-ts.py
|
|
6788
6975
|
*/
|
|
@@ -6824,6 +7011,14 @@ interface CategoriesListItem {
|
|
|
6824
7011
|
[key: string]: unknown;
|
|
6825
7012
|
}
|
|
6826
7013
|
type CategoriesListData = CategoriesListItem[];
|
|
7014
|
+
/** Response data for POST /categories/focus — MINIMUM fields, extras pass through */
|
|
7015
|
+
type CategoriesFocusCreateData = boolean;
|
|
7016
|
+
/** Request body for POST /categories/focus — MINIMUM fields, extras pass through */
|
|
7017
|
+
interface CategoriesFocusCreateBody {
|
|
7018
|
+
itemCategoryUid?: number | null;
|
|
7019
|
+
itemCategoryId?: string | null;
|
|
7020
|
+
[key: string]: unknown;
|
|
7021
|
+
}
|
|
6827
7022
|
/** Response data for GET /categories/{itemCategoryUid} — MINIMUM fields, extras pass through */
|
|
6828
7023
|
type CategoriesGetData = CategoriesListItem;
|
|
6829
7024
|
interface BrandFolderClientSpec {
|
|
@@ -6831,25 +7026,27 @@ interface BrandFolderClientSpec {
|
|
|
6831
7026
|
list: (params?: CategoriesListParams) => Promise<BaseResponse$1<CategoriesListData>>;
|
|
6832
7027
|
get: (itemCategoryUid: number, params?: CategoriesGetParams) => Promise<BaseResponse$1<CategoriesGetData>>;
|
|
6833
7028
|
focus: {
|
|
6834
|
-
create: (data:
|
|
7029
|
+
create: (data: CategoriesFocusCreateBody) => Promise<BaseResponse$1<CategoriesFocusCreateData>>;
|
|
6835
7030
|
};
|
|
6836
7031
|
};
|
|
6837
7032
|
}
|
|
6838
7033
|
|
|
6839
7034
|
type types$9_BrandFolderClientSpec = BrandFolderClientSpec;
|
|
7035
|
+
type types$9_CategoriesFocusCreateBody = CategoriesFocusCreateBody;
|
|
7036
|
+
type types$9_CategoriesFocusCreateData = CategoriesFocusCreateData;
|
|
6840
7037
|
type types$9_CategoriesGetData = CategoriesGetData;
|
|
6841
7038
|
type types$9_CategoriesGetParams = CategoriesGetParams;
|
|
6842
7039
|
type types$9_CategoriesListData = CategoriesListData;
|
|
6843
7040
|
type types$9_CategoriesListItem = CategoriesListItem;
|
|
6844
7041
|
type types$9_CategoriesListParams = CategoriesListParams;
|
|
6845
7042
|
declare namespace types$9 {
|
|
6846
|
-
export type { types$9_BrandFolderClientSpec as BrandFolderClientSpec, types$9_CategoriesGetData as CategoriesGetData, types$9_CategoriesGetParams as CategoriesGetParams, types$9_CategoriesListData as CategoriesListData, types$9_CategoriesListItem as CategoriesListItem, types$9_CategoriesListParams as CategoriesListParams };
|
|
7043
|
+
export type { types$9_BrandFolderClientSpec as BrandFolderClientSpec, types$9_CategoriesFocusCreateBody as CategoriesFocusCreateBody, types$9_CategoriesFocusCreateData as CategoriesFocusCreateData, types$9_CategoriesGetData as CategoriesGetData, types$9_CategoriesGetParams as CategoriesGetParams, types$9_CategoriesListData as CategoriesListData, types$9_CategoriesListItem as CategoriesListItem, types$9_CategoriesListParams as CategoriesListParams };
|
|
6847
7044
|
}
|
|
6848
7045
|
|
|
6849
7046
|
/**
|
|
6850
7047
|
* Generated client for brand-folder service
|
|
6851
7048
|
* Source: shared/specs/brand-folder.json
|
|
6852
|
-
* Generated: 2026-09-
|
|
7049
|
+
* Generated: 2026-09-30T22:17:42Z
|
|
6853
7050
|
*
|
|
6854
7051
|
* DO NOT EDIT — regenerate with: python shared/scripts/generate-ts.py
|
|
6855
7052
|
*/
|
|
@@ -8757,6 +8954,20 @@ declare class AugurAPI {
|
|
|
8757
8954
|
* Canonical entries only; aliases are listed in each entry's `aliases`.
|
|
8758
8955
|
*/
|
|
8759
8956
|
static endpoints(): EndpointEntry[];
|
|
8957
|
+
/**
|
|
8958
|
+
* Call any endpoint by registry id (canonical or alias), with no typed method.
|
|
8959
|
+
*
|
|
8960
|
+
* Arguments are checked against the entry before any request is sent. A 2xx
|
|
8961
|
+
* always resolves, with no schema validation; other statuses throw the same
|
|
8962
|
+
* errors as the typed methods.
|
|
8963
|
+
*
|
|
8964
|
+
* @example
|
|
8965
|
+
* ```typescript
|
|
8966
|
+
* const result = await api.call('items.invMast.doc.get', { pathParams: { invMastUid: 123 } });
|
|
8967
|
+
* result.envelope?.data;
|
|
8968
|
+
* ```
|
|
8969
|
+
*/
|
|
8970
|
+
call(id: string, args?: CallArgs): Promise<CallResult>;
|
|
8760
8971
|
/**
|
|
8761
8972
|
* Create AugurAPI client from context object
|
|
8762
8973
|
*
|
|
@@ -9054,4 +9265,4 @@ declare class AugurAPI {
|
|
|
9054
9265
|
private calculateMultiWordMatches;
|
|
9055
9266
|
}
|
|
9056
9267
|
|
|
9057
|
-
export {
|
|
9268
|
+
export { types$e as $, AugurAPI as A, type BaseResponse$1 as B, type CallArgs as C, type DiscoveryEndpoint as D, type EndpointEntry as E, type Envelope as F, GregorovichClient as G, types$8 as H, type HealthCheckData as I, HealthCheckDataSchema as J, ItemsClient as K, types$j as L, JoomlaClient as M, types$o as N, LegacyClient as O, types$i as P, LogisticsClient as Q, types$7 as R, OpenSearchClient as S, types$k as T, OrdersClient as U, types$f as V, P21ApisClient as W, types$6 as X, P21CoreClient as Y, types$5 as Z, P21PimClient as _, AgrInfoClient as a, P21SismClient as a0, types$4 as a1, PaginationParamsSchema as a2, PaymentsClient as a3, types$d as a4, type PingData as a5, PricingClient as a6, types$m as a7, type RequestConfig as a8, type ServiceMap as a9, ShippingClient as aa, types$3 as ab, SmartyStreetsClient as ac, types$2 as ad, UPSClient as ae, types$1 as af, VMIClient as ag, types$l as ah, type WhoamiData as ai, WhoamiDataSchema as aj, AgrIntClient as b, types$b as c, AgrSiteClient as d, types$h as e, AgrWorkClient as f, type AugurAPIConfig as g, type AugurContext as h, type AugurRequestConfig as i, type AugurRequestError as j, type AugurResponse as k, AvalaraClient as l, types$a as m, BaseResponseSchema as n, Basecamp2Client as o, types as p, BrandFolderClient as q, types$9 as r, type CallResult as s, types$c as t, CommerceClient as u, types$n as v, ContextCreationError as w, CustomersClient as x, types$g as y, type EndpointSearchResult as z };
|