@simpleapps-com/augur-api 2026.10.13 → 2026.10.14

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.
@@ -104,6 +104,16 @@ interface CallResult {
104
104
  body: unknown;
105
105
  }
106
106
 
107
+ /** One path or query param of an endpoint. */
108
+ interface EndpointParam {
109
+ /** Where the value goes */
110
+ readonly in: 'path' | 'query';
111
+ /** `integer|integer[]` is one value or a list (sent comma-joined) */
112
+ readonly type: 'string' | 'integer' | 'number' | 'boolean' | 'integer|integer[]';
113
+ readonly required: boolean;
114
+ /** The allowed values, when the spec lists them */
115
+ readonly enum?: readonly (string | number | boolean)[];
116
+ }
107
117
  /** One endpoint in the registry. */
108
118
  interface EndpointEntry {
109
119
  /** `camelCase(service).chain.action`, e.g. `items.invMast.doc.list` */
@@ -123,6 +133,10 @@ interface EndpointEntry {
123
133
  readonly hasBody: boolean;
124
134
  readonly auth: 'none' | 'site' | 'bearer';
125
135
  readonly edgeCache: boolean;
136
+ /** One-line summary from the spec; `''` when it has none */
137
+ readonly summary: string;
138
+ /** Every param by name, path params first (URL order), then query params */
139
+ readonly params: Readonly<Record<string, EndpointParam>>;
126
140
  /** Omitted unless set; a read is `readOnly ?? method === 'GET'` */
127
141
  readonly readOnly?: boolean;
128
142
  }
@@ -34977,7 +34991,7 @@ declare class AugurAPI {
34977
34991
  private _commerce?;
34978
34992
  private _pricing?;
34979
34993
  private _vmi?;
34980
- private _opensearch?;
34994
+ private _openSearch?;
34981
34995
  private _items?;
34982
34996
  private _legacy?;
34983
34997
  private _agrSite?;
@@ -35067,11 +35081,6 @@ declare class AugurAPI {
35067
35081
  * Access OpenSearch service endpoints
35068
35082
  */
35069
35083
  get openSearch(): OpenSearchClient;
35070
- /**
35071
- * Access OpenSearch service endpoints
35072
- * @deprecated Use `openSearch`, which matches the registry id (`openSearch.…`) and the PHP client.
35073
- */
35074
- get opensearch(): OpenSearchClient;
35075
35084
  /**
35076
35085
  * Access Items service endpoints
35077
35086
  */
@@ -35168,4 +35177,4 @@ declare class AugurAPI {
35168
35177
  setSiteId(siteId: string): void;
35169
35178
  }
35170
35179
 
35171
- export { P21SismClient as $, AugurAPI as A, type BaseResponse$1 as B, type CallArgs as C, types$8 as D, type EndpointEntry as E, HealthCheckDataSchema as F, GregorovichClient as G, type HealthCheckData as H, ItemsClient as I, types$j as J, JoomlaClient as K, types$o as L, type Known as M, LegacyClient as N, types$i as O, LogisticsClient as P, types$7 as Q, OpenSearchClient as R, types$k as S, OrdersClient as T, types$f as U, P21ApisClient as V, types$6 as W, P21CoreClient as X, types$5 as Y, P21PimClient as Z, types$e as _, AgrInfoClient as a, types$4 as a0, PaginationParamsSchema as a1, PaymentsClient as a2, types$d as a3, type PingData as a4, PricingClient as a5, types$m as a6, type RequestConfig as a7, ShippingClient as a8, types$3 as a9, SmartyStreetsClient as aa, types$2 as ab, UPSClient as ac, types$1 as ad, VMIClient as ae, types$l as af, type WhoamiData as ag, WhoamiDataSchema as ah, 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 Envelope as z };
35180
+ export { types$e as $, AugurAPI as A, type BaseResponse$1 as B, type CallArgs as C, type Envelope as D, type EndpointEntry as E, types$8 as F, GregorovichClient as G, type HealthCheckData as H, HealthCheckDataSchema as I, ItemsClient as J, types$j as K, JoomlaClient as L, types$o as M, type Known 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, ShippingClient as a9, types$3 as aa, SmartyStreetsClient as ab, types$2 as ac, UPSClient as ad, types$1 as ae, VMIClient as af, types$l as ag, type WhoamiData as ah, WhoamiDataSchema as ai, 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 EndpointParam as z };
@@ -104,6 +104,16 @@ interface CallResult {
104
104
  body: unknown;
105
105
  }
106
106
 
107
+ /** One path or query param of an endpoint. */
108
+ interface EndpointParam {
109
+ /** Where the value goes */
110
+ readonly in: 'path' | 'query';
111
+ /** `integer|integer[]` is one value or a list (sent comma-joined) */
112
+ readonly type: 'string' | 'integer' | 'number' | 'boolean' | 'integer|integer[]';
113
+ readonly required: boolean;
114
+ /** The allowed values, when the spec lists them */
115
+ readonly enum?: readonly (string | number | boolean)[];
116
+ }
107
117
  /** One endpoint in the registry. */
108
118
  interface EndpointEntry {
109
119
  /** `camelCase(service).chain.action`, e.g. `items.invMast.doc.list` */
@@ -123,6 +133,10 @@ interface EndpointEntry {
123
133
  readonly hasBody: boolean;
124
134
  readonly auth: 'none' | 'site' | 'bearer';
125
135
  readonly edgeCache: boolean;
136
+ /** One-line summary from the spec; `''` when it has none */
137
+ readonly summary: string;
138
+ /** Every param by name, path params first (URL order), then query params */
139
+ readonly params: Readonly<Record<string, EndpointParam>>;
126
140
  /** Omitted unless set; a read is `readOnly ?? method === 'GET'` */
127
141
  readonly readOnly?: boolean;
128
142
  }
@@ -34977,7 +34991,7 @@ declare class AugurAPI {
34977
34991
  private _commerce?;
34978
34992
  private _pricing?;
34979
34993
  private _vmi?;
34980
- private _opensearch?;
34994
+ private _openSearch?;
34981
34995
  private _items?;
34982
34996
  private _legacy?;
34983
34997
  private _agrSite?;
@@ -35067,11 +35081,6 @@ declare class AugurAPI {
35067
35081
  * Access OpenSearch service endpoints
35068
35082
  */
35069
35083
  get openSearch(): OpenSearchClient;
35070
- /**
35071
- * Access OpenSearch service endpoints
35072
- * @deprecated Use `openSearch`, which matches the registry id (`openSearch.…`) and the PHP client.
35073
- */
35074
- get opensearch(): OpenSearchClient;
35075
35084
  /**
35076
35085
  * Access Items service endpoints
35077
35086
  */
@@ -35168,4 +35177,4 @@ declare class AugurAPI {
35168
35177
  setSiteId(siteId: string): void;
35169
35178
  }
35170
35179
 
35171
- export { P21SismClient as $, AugurAPI as A, type BaseResponse$1 as B, type CallArgs as C, types$8 as D, type EndpointEntry as E, HealthCheckDataSchema as F, GregorovichClient as G, type HealthCheckData as H, ItemsClient as I, types$j as J, JoomlaClient as K, types$o as L, type Known as M, LegacyClient as N, types$i as O, LogisticsClient as P, types$7 as Q, OpenSearchClient as R, types$k as S, OrdersClient as T, types$f as U, P21ApisClient as V, types$6 as W, P21CoreClient as X, types$5 as Y, P21PimClient as Z, types$e as _, AgrInfoClient as a, types$4 as a0, PaginationParamsSchema as a1, PaymentsClient as a2, types$d as a3, type PingData as a4, PricingClient as a5, types$m as a6, type RequestConfig as a7, ShippingClient as a8, types$3 as a9, SmartyStreetsClient as aa, types$2 as ab, UPSClient as ac, types$1 as ad, VMIClient as ae, types$l as af, type WhoamiData as ag, WhoamiDataSchema as ah, 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 Envelope as z };
35180
+ export { types$e as $, AugurAPI as A, type BaseResponse$1 as B, type CallArgs as C, type Envelope as D, type EndpointEntry as E, types$8 as F, GregorovichClient as G, type HealthCheckData as H, HealthCheckDataSchema as I, ItemsClient as J, types$j as K, JoomlaClient as L, types$o as M, type Known 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, ShippingClient as a9, types$3 as aa, SmartyStreetsClient as ab, types$2 as ac, UPSClient as ad, types$1 as ae, VMIClient as af, types$l as ag, type WhoamiData as ah, WhoamiDataSchema as ai, 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 EndpointParam as z };
package/dist/index.d.mts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as AugurAPI } from './client-B10M0T65.mjs';
2
- export { a as AgrInfoClient, t as AgrInfoTypes, b as AgrIntClient, c as AgrIntTypes, d as AgrSiteClient, e as AgrSiteTypes, f as AgrWorkClient, g as AugurAPIConfig, h as AugurContext, i as AugurRequestConfig, j as AugurRequestError, k as AugurResponse, l as AvalaraClient, m as AvalaraTypes, B as BaseResponse, n as BaseResponseSchema, o as Basecamp2Client, p as Basecamp2Types, q as BrandFolderClient, r as BrandFolderTypes, C as CallArgs, s as CallResult, u as CommerceClient, v as CommerceTypes, w as ContextCreationError, x as CustomersClient, y as CustomersTypes, E as EndpointEntry, z as Envelope, G as GregorovichClient, D as GregorovichTypes, H as HealthCheckData, F as HealthCheckDataSchema, I as ItemsClient, J as ItemsTypes, K as JoomlaClient, L as JoomlaTypes, M as Known, N as LegacyClient, O as LegacyTypes, P as LogisticsClient, Q as LogisticsTypes, R as OpenSearchClient, S as OpenSearchTypes, T as OrdersClient, U as OrdersTypes, V as P21ApisClient, W as P21ApisTypes, X as P21CoreClient, Y as P21CoreTypes, Z as P21PimClient, _ as P21PimTypes, $ as P21SismClient, a0 as P21SismTypes, a1 as PaginationParamsSchema, a2 as PaymentsClient, a3 as PaymentsTypes, a4 as PingData, a5 as PricingClient, a6 as PricingTypes, a7 as RequestConfig, a8 as ShippingClient, a9 as ShippingTypes, aa as SmartyStreetsClient, ab as SmartyStreetsTypes, ac as UPSClient, ad as UPSTypes, ae as VMIClient, af as VMITypes, ag as WhoamiData, ah as WhoamiDataSchema } from './client-B10M0T65.mjs';
1
+ import { A as AugurAPI } from './client-CuHrZyBA.mjs';
2
+ export { a as AgrInfoClient, t as AgrInfoTypes, b as AgrIntClient, c as AgrIntTypes, d as AgrSiteClient, e as AgrSiteTypes, f as AgrWorkClient, g as AugurAPIConfig, h as AugurContext, i as AugurRequestConfig, j as AugurRequestError, k as AugurResponse, l as AvalaraClient, m as AvalaraTypes, B as BaseResponse, n as BaseResponseSchema, o as Basecamp2Client, p as Basecamp2Types, q as BrandFolderClient, r as BrandFolderTypes, C as CallArgs, s as CallResult, u as CommerceClient, v as CommerceTypes, w as ContextCreationError, x as CustomersClient, y as CustomersTypes, E as EndpointEntry, z as EndpointParam, D as Envelope, G as GregorovichClient, F as GregorovichTypes, H as HealthCheckData, I as HealthCheckDataSchema, J as ItemsClient, K as ItemsTypes, L as JoomlaClient, M as JoomlaTypes, N as Known, O as LegacyClient, P as LegacyTypes, Q as LogisticsClient, R as LogisticsTypes, S as OpenSearchClient, T as OpenSearchTypes, U as OrdersClient, V as OrdersTypes, W as P21ApisClient, X as P21ApisTypes, Y as P21CoreClient, Z as P21CoreTypes, _ as P21PimClient, $ as P21PimTypes, a0 as P21SismClient, a1 as P21SismTypes, a2 as PaginationParamsSchema, a3 as PaymentsClient, a4 as PaymentsTypes, a5 as PingData, a6 as PricingClient, a7 as PricingTypes, a8 as RequestConfig, a9 as ShippingClient, aa as ShippingTypes, ab as SmartyStreetsClient, ac as SmartyStreetsTypes, ad as UPSClient, ae as UPSTypes, af as VMIClient, ag as VMITypes, ah as WhoamiData, ai as WhoamiDataSchema } from './client-CuHrZyBA.mjs';
3
3
  import 'valibot';
4
4
 
5
5
  /**
@@ -204,6 +204,6 @@ declare namespace types {
204
204
  export type { types_AgrWorkClientSpec as AgrWorkClientSpec };
205
205
  }
206
206
 
207
- declare const VERSION = "2026.10.13";
207
+ declare const VERSION = "2026.10.14";
208
208
 
209
209
  export { types as AgrWorkTypes, AugurAPI, type AugurAPIError, AugurError, AuthenticationError, type CrossSiteAuthParams, type CrossSiteAuthResult, InvalidArgumentError, NotFoundError, RateLimitError, VERSION, ValidationError, authenticateUserForSite, createCrossSiteAuthenticator };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as AugurAPI } from './client-B10M0T65.js';
2
- export { a as AgrInfoClient, t as AgrInfoTypes, b as AgrIntClient, c as AgrIntTypes, d as AgrSiteClient, e as AgrSiteTypes, f as AgrWorkClient, g as AugurAPIConfig, h as AugurContext, i as AugurRequestConfig, j as AugurRequestError, k as AugurResponse, l as AvalaraClient, m as AvalaraTypes, B as BaseResponse, n as BaseResponseSchema, o as Basecamp2Client, p as Basecamp2Types, q as BrandFolderClient, r as BrandFolderTypes, C as CallArgs, s as CallResult, u as CommerceClient, v as CommerceTypes, w as ContextCreationError, x as CustomersClient, y as CustomersTypes, E as EndpointEntry, z as Envelope, G as GregorovichClient, D as GregorovichTypes, H as HealthCheckData, F as HealthCheckDataSchema, I as ItemsClient, J as ItemsTypes, K as JoomlaClient, L as JoomlaTypes, M as Known, N as LegacyClient, O as LegacyTypes, P as LogisticsClient, Q as LogisticsTypes, R as OpenSearchClient, S as OpenSearchTypes, T as OrdersClient, U as OrdersTypes, V as P21ApisClient, W as P21ApisTypes, X as P21CoreClient, Y as P21CoreTypes, Z as P21PimClient, _ as P21PimTypes, $ as P21SismClient, a0 as P21SismTypes, a1 as PaginationParamsSchema, a2 as PaymentsClient, a3 as PaymentsTypes, a4 as PingData, a5 as PricingClient, a6 as PricingTypes, a7 as RequestConfig, a8 as ShippingClient, a9 as ShippingTypes, aa as SmartyStreetsClient, ab as SmartyStreetsTypes, ac as UPSClient, ad as UPSTypes, ae as VMIClient, af as VMITypes, ag as WhoamiData, ah as WhoamiDataSchema } from './client-B10M0T65.js';
1
+ import { A as AugurAPI } from './client-CuHrZyBA.js';
2
+ export { a as AgrInfoClient, t as AgrInfoTypes, b as AgrIntClient, c as AgrIntTypes, d as AgrSiteClient, e as AgrSiteTypes, f as AgrWorkClient, g as AugurAPIConfig, h as AugurContext, i as AugurRequestConfig, j as AugurRequestError, k as AugurResponse, l as AvalaraClient, m as AvalaraTypes, B as BaseResponse, n as BaseResponseSchema, o as Basecamp2Client, p as Basecamp2Types, q as BrandFolderClient, r as BrandFolderTypes, C as CallArgs, s as CallResult, u as CommerceClient, v as CommerceTypes, w as ContextCreationError, x as CustomersClient, y as CustomersTypes, E as EndpointEntry, z as EndpointParam, D as Envelope, G as GregorovichClient, F as GregorovichTypes, H as HealthCheckData, I as HealthCheckDataSchema, J as ItemsClient, K as ItemsTypes, L as JoomlaClient, M as JoomlaTypes, N as Known, O as LegacyClient, P as LegacyTypes, Q as LogisticsClient, R as LogisticsTypes, S as OpenSearchClient, T as OpenSearchTypes, U as OrdersClient, V as OrdersTypes, W as P21ApisClient, X as P21ApisTypes, Y as P21CoreClient, Z as P21CoreTypes, _ as P21PimClient, $ as P21PimTypes, a0 as P21SismClient, a1 as P21SismTypes, a2 as PaginationParamsSchema, a3 as PaymentsClient, a4 as PaymentsTypes, a5 as PingData, a6 as PricingClient, a7 as PricingTypes, a8 as RequestConfig, a9 as ShippingClient, aa as ShippingTypes, ab as SmartyStreetsClient, ac as SmartyStreetsTypes, ad as UPSClient, ae as UPSTypes, af as VMIClient, ag as VMITypes, ah as WhoamiData, ai as WhoamiDataSchema } from './client-CuHrZyBA.js';
3
3
  import 'valibot';
4
4
 
5
5
  /**
@@ -204,6 +204,6 @@ declare namespace types {
204
204
  export type { types_AgrWorkClientSpec as AgrWorkClientSpec };
205
205
  }
206
206
 
207
- declare const VERSION = "2026.10.13";
207
+ declare const VERSION = "2026.10.14";
208
208
 
209
209
  export { types as AgrWorkTypes, AugurAPI, type AugurAPIError, AugurError, AuthenticationError, type CrossSiteAuthParams, type CrossSiteAuthResult, InvalidArgumentError, NotFoundError, RateLimitError, VERSION, ValidationError, authenticateUserForSite, createCrossSiteAuthenticator };