@simpleapps-com/augur-api 2026.10.10 → 2026.10.12
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 +4 -2
- package/SKILL.md +1 -1
- package/dist/{client-JXkUhee3.d.mts → client-XZzK8xkq.d.mts} +542 -511
- package/dist/{client-JXkUhee3.d.ts → client-XZzK8xkq.d.ts} +542 -511
- package/dist/index.d.mts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +601 -55
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +601 -55
- 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
package/README.md
CHANGED
|
@@ -167,12 +167,14 @@ result.body; // parsed JSON, or the raw text when the body isn't JSON
|
|
|
167
167
|
|
|
168
168
|
## Path Values
|
|
169
169
|
|
|
170
|
-
|
|
170
|
+
Each path value is percent-encoded as one segment: letters, digits and `- . _ ~ ! $ & ' ( ) * + , ; = : @` are sent as they are, and anything else (`/`, `?`, `#`, `%`, spaces, non-ASCII) as `%XX`. So bin `D/S` goes out as `/bins/D%2FS`, which the API decodes back to `D/S`. Pass the raw value, never a pre-encoded one (`%` becomes `%25`). Every value MUST be non-empty, and a value for a param with a published pattern MUST match it (the endpoint's `pathPatterns` in `AugurAPI.endpoints()`): integer ids match `^\d+$`, so `-1` or `SO-1` is rejected before any request.
|
|
171
171
|
|
|
172
172
|
```typescript
|
|
173
|
-
await api.call('items.locations.bins.
|
|
173
|
+
await api.call('items.locations.bins.get', { pathParams: { locationId: 100, bin: 'D/S' } });
|
|
174
174
|
```
|
|
175
175
|
|
|
176
|
+
Only routes whose backend decodes path values find such values. Elsewhere, use the query parameter where there is one.
|
|
177
|
+
|
|
176
178
|
## Typed Responses
|
|
177
179
|
|
|
178
180
|
Every endpoint returns a typed `data` (`import type { ItemsTypes } from '@simpleapps-com/augur-api'`).
|
package/SKILL.md
CHANGED
|
@@ -247,7 +247,7 @@ result.envelope?.data; // null envelope means the body isn't the 8-key envelope;
|
|
|
247
247
|
- Ids are `camelCase(service).chain.action`, the same as the typed call path.
|
|
248
248
|
- Arguments are checked before any request (`InvalidArgumentError`). A 2xx never fails validation.
|
|
249
249
|
- Errors: 400 → `ValidationError`, 401 → `AuthenticationError`, 404 → `NotFoundError`, 429 → `RateLimitError`, anything else → `AugurError`. `error.endpoint` is the path template.
|
|
250
|
-
- Path values are
|
|
250
|
+
- Path values are percent-encoded per segment (`D/S` → `D%2FS`; letters, digits and `-._~!$&'()*+,;=:@` stay as they are). Pass raw values, never pre-encoded ones. Only routes whose backend decodes path values find values like `D/S`; elsewhere use the query param.
|
|
251
251
|
|
|
252
252
|
## Key Differences from Python Client
|
|
253
253
|
|