@viu/emporix-sdk 2.20.0 → 2.21.0
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/CHANGELOG.md +59 -0
- package/dist/availability.d.cts +1 -1
- package/dist/availability.d.ts +1 -1
- package/dist/cart.cjs +23 -8
- package/dist/cart.cjs.map +1 -1
- package/dist/cart.d.cts +13 -3
- package/dist/cart.d.ts +13 -3
- package/dist/cart.js +1 -1
- package/dist/category.d.cts +1 -1
- package/dist/category.d.ts +1 -1
- package/dist/checkout.d.cts +1 -1
- package/dist/checkout.d.ts +1 -1
- package/dist/{chunk-BNX3JULF.js → chunk-44F52KRE.js} +7 -5
- package/dist/chunk-44F52KRE.js.map +1 -0
- package/dist/{chunk-NEXUWPHW.js → chunk-HBEQEIT6.js} +5 -5
- package/dist/chunk-HBEQEIT6.js.map +1 -0
- package/dist/{chunk-EAWGUZHS.js → chunk-HD5RBCM6.js} +7 -5
- package/dist/chunk-HD5RBCM6.js.map +1 -0
- package/dist/{chunk-PAT4CS36.js → chunk-HUEMYP2L.js} +25 -10
- package/dist/chunk-HUEMYP2L.js.map +1 -0
- package/dist/{chunk-DUVIIWFG.js → chunk-IAOWDMTA.js} +7 -5
- package/dist/chunk-IAOWDMTA.js.map +1 -0
- package/dist/companies.cjs +5 -3
- package/dist/companies.cjs.map +1 -1
- package/dist/companies.d.cts +5 -3
- package/dist/companies.d.ts +5 -3
- package/dist/companies.js +1 -1
- package/dist/contacts.cjs +5 -3
- package/dist/contacts.cjs.map +1 -1
- package/dist/contacts.d.cts +5 -3
- package/dist/contacts.d.ts +5 -3
- package/dist/contacts.js +1 -1
- package/dist/{context-Dawv2AtS.d.cts → context-CfXJcYKP.d.cts} +1 -1
- package/dist/{context-Dawv2AtS.d.ts → context-CfXJcYKP.d.ts} +1 -1
- package/dist/customer-groups.d.cts +1 -1
- package/dist/customer-groups.d.ts +1 -1
- package/dist/customer.cjs +3 -3
- package/dist/customer.cjs.map +1 -1
- package/dist/customer.d.cts +1 -1
- package/dist/customer.d.ts +1 -1
- package/dist/customer.js +1 -1
- package/dist/index.cjs +687 -235
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2167 -149
- package/dist/index.d.ts +2167 -149
- package/dist/index.js +655 -226
- package/dist/index.js.map +1 -1
- package/dist/locations.cjs +5 -3
- package/dist/locations.cjs.map +1 -1
- package/dist/locations.d.cts +5 -3
- package/dist/locations.d.ts +5 -3
- package/dist/locations.js +1 -1
- package/dist/media.d.cts +1 -1
- package/dist/media.d.ts +1 -1
- package/dist/orders.d.cts +1 -1
- package/dist/orders.d.ts +1 -1
- package/dist/payment.d.cts +1 -1
- package/dist/payment.d.ts +1 -1
- package/dist/price.d.cts +6 -6
- package/dist/price.d.ts +6 -6
- package/dist/product.d.cts +1 -1
- package/dist/product.d.ts +1 -1
- package/dist/segment.d.cts +1 -1
- package/dist/segment.d.ts +1 -1
- package/package.json +1 -1
- package/dist/chunk-BNX3JULF.js.map +0 -1
- package/dist/chunk-DUVIIWFG.js.map +0 -1
- package/dist/chunk-EAWGUZHS.js.map +0 -1
- package/dist/chunk-NEXUWPHW.js.map +0 -1
- package/dist/chunk-PAT4CS36.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { C as ClientContext, b as AuthContext, P as PaginatedItems, T as TokenProvider, n as ResolvedConfig, E as EmporixConfig, j as LogLevel, o as ServiceName, e as CustomerTokenRefresher } from './context-
|
|
2
|
-
export { A as AnonymousSession, a as AnonymousSessionStore, c as AuthKind, d as CustomerRefreshRegistry, D as DEFAULT_HOST, f as DefaultTokenProvider, H as HttpClient, g as HttpClientOptions, L as LEVEL, h as LevelResolver, i as LogFields, k as Logger, l as LoggerConfig, m as LoggerObjectConfig, R as RequestOptions, S as ServiceCredentials, p as StorefrontCredentials, q as auth, r as createConsoleLogger, s as createNoopLogger, t as iterateAll, u as redact, v as resolveToken, w as validateConfig } from './context-
|
|
1
|
+
import { C as ClientContext, b as AuthContext, P as PaginatedItems, T as TokenProvider, n as ResolvedConfig, E as EmporixConfig, j as LogLevel, o as ServiceName, e as CustomerTokenRefresher } from './context-CfXJcYKP.js';
|
|
2
|
+
export { A as AnonymousSession, a as AnonymousSessionStore, c as AuthKind, d as CustomerRefreshRegistry, D as DEFAULT_HOST, f as DefaultTokenProvider, H as HttpClient, g as HttpClientOptions, L as LEVEL, h as LevelResolver, i as LogFields, k as Logger, l as LoggerConfig, m as LoggerObjectConfig, R as RequestOptions, S as ServiceCredentials, p as StorefrontCredentials, q as auth, r as createConsoleLogger, s as createNoopLogger, t as iterateAll, u as redact, v as resolveToken, w as validateConfig } from './context-CfXJcYKP.js';
|
|
3
3
|
import { CustomerService } from './customer.js';
|
|
4
4
|
export { Address, AddressCreateInput, AddressUpdateInput, Customer, CustomerSession, CustomerSignupInput, CustomerUpdateInput, PasswordChangeInput, PasswordResetConfirmInput, PasswordResetRequestInput } from './customer.js';
|
|
5
5
|
import { ProductService } from './product.js';
|
|
@@ -72,35 +72,183 @@ declare class EmporixInsufficientScopeError extends EmporixForbiddenError {
|
|
|
72
72
|
declare function errorFromResponse(status: number, message: string, body: unknown): EmporixError;
|
|
73
73
|
|
|
74
74
|
/**
|
|
75
|
-
*
|
|
76
|
-
* SiteDto schema with the fields a storefront actually consumes.
|
|
75
|
+
* Site address.
|
|
77
76
|
*/
|
|
78
|
-
|
|
77
|
+
type AddressDto = {
|
|
78
|
+
street?: string;
|
|
79
|
+
streetNumber?: string;
|
|
80
|
+
streetAppendix?: string;
|
|
81
|
+
extraLine1?: string;
|
|
82
|
+
extraLine2?: string;
|
|
83
|
+
extraLine3?: string;
|
|
84
|
+
extraLine4?: string;
|
|
85
|
+
zipCode: string;
|
|
86
|
+
city?: string;
|
|
87
|
+
country: string;
|
|
88
|
+
state?: string;
|
|
89
|
+
};
|
|
90
|
+
/**
|
|
91
|
+
* Currency used by the site, compliant with the ISO 4217 standard.
|
|
92
|
+
*/
|
|
93
|
+
type CurrencyDto = string;
|
|
94
|
+
type DefaultDtoMetadata$1 = {
|
|
95
|
+
/**
|
|
96
|
+
* Mixin schema URLs.
|
|
97
|
+
*/
|
|
98
|
+
mixins?: {
|
|
99
|
+
[key: string]: unknown;
|
|
100
|
+
};
|
|
101
|
+
version?: number;
|
|
102
|
+
};
|
|
103
|
+
/**
|
|
104
|
+
* Site location.
|
|
105
|
+
*/
|
|
106
|
+
type HomeBaseDto = {
|
|
107
|
+
address: AddressDto;
|
|
108
|
+
location?: LocationDto;
|
|
109
|
+
/**
|
|
110
|
+
* The timezone of the site home base location. Must be a valid IANA timezone identifier.
|
|
111
|
+
*
|
|
112
|
+
* If not specified, no timezone will be set. When specified, the value must be a valid timezone ID as defined in the IANA Time Zone Database.
|
|
113
|
+
*
|
|
114
|
+
* Examples of valid timezones:
|
|
115
|
+
* - Europe/Paris
|
|
116
|
+
* - America/New_York
|
|
117
|
+
* - Asia/Tokyo
|
|
118
|
+
* - UTC
|
|
119
|
+
*
|
|
120
|
+
* Invalid timezone values (e.g., "Europe/Xp") will result in a 400 Bad Request response.
|
|
121
|
+
*
|
|
122
|
+
*/
|
|
123
|
+
timezone?: string;
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* Site geographical location.
|
|
127
|
+
*/
|
|
128
|
+
type LocationDto = {
|
|
129
|
+
latitude?: number;
|
|
130
|
+
longitude?: number;
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* Information about the site.
|
|
134
|
+
*/
|
|
135
|
+
type SiteDto = {
|
|
136
|
+
/**
|
|
137
|
+
* Site unique identifier.
|
|
138
|
+
*/
|
|
79
139
|
code: string;
|
|
140
|
+
/**
|
|
141
|
+
* Site name.
|
|
142
|
+
*/
|
|
80
143
|
name: string;
|
|
81
|
-
|
|
82
|
-
|
|
144
|
+
/**
|
|
145
|
+
* Flag indicating whether the site is active.
|
|
146
|
+
*/
|
|
147
|
+
active?: boolean;
|
|
148
|
+
/**
|
|
149
|
+
* Flag indicating whether the site is the tenant default site.
|
|
150
|
+
*/
|
|
151
|
+
default?: boolean;
|
|
152
|
+
/**
|
|
153
|
+
* Indicates whether prices for the site should be returned in gross (when includesTax=true) or net (when includesTax=false).
|
|
154
|
+
*/
|
|
83
155
|
includesTax?: boolean;
|
|
156
|
+
/**
|
|
157
|
+
* Site's default language, compliant with the ISO 639-1 standard.
|
|
158
|
+
*/
|
|
84
159
|
defaultLanguage: string;
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
160
|
+
/**
|
|
161
|
+
* Languages supported by the site.
|
|
162
|
+
*
|
|
163
|
+
* **Note**: The languages must be compliant with the ISO 639-1 standard.
|
|
164
|
+
*/
|
|
165
|
+
languages: Array<string>;
|
|
166
|
+
currency: CurrencyDto;
|
|
167
|
+
/**
|
|
168
|
+
* List of the currencies supported by the site
|
|
169
|
+
*/
|
|
170
|
+
availableCurrencies?: Array<CurrencyDto>;
|
|
171
|
+
homeBase: HomeBaseDto;
|
|
172
|
+
/**
|
|
173
|
+
* Codes of countries to which the site ships products.
|
|
174
|
+
*
|
|
175
|
+
* **Note**: The country codes must be compliant with the ISO 3166-1 alpha-2 standard.
|
|
176
|
+
*/
|
|
177
|
+
shipToCountries: Array<string>;
|
|
178
|
+
/**
|
|
179
|
+
* Shipping service configurations.
|
|
180
|
+
*/
|
|
181
|
+
shipping?: Array<ServiceConfigurationDto>;
|
|
182
|
+
/**
|
|
183
|
+
* Payment service configurations.
|
|
184
|
+
*/
|
|
185
|
+
payment?: Array<ServiceConfigurationDto>;
|
|
186
|
+
/**
|
|
187
|
+
* Tax service configurations.
|
|
188
|
+
*
|
|
189
|
+
* **The `tax` field is in preview mode** - some of the features may not be fully operational yet.
|
|
190
|
+
*/
|
|
191
|
+
tax?: Array<ServiceConfigurationDto>;
|
|
192
|
+
assistedBuying?: AssistedBuying$1;
|
|
193
|
+
metadata?: DefaultDtoMetadata$1;
|
|
194
|
+
taxDeterminationBasedOn: TaxDeterminationBasedOn;
|
|
195
|
+
/**
|
|
196
|
+
* Site additional properties.
|
|
197
|
+
*/
|
|
198
|
+
mixins?: {
|
|
199
|
+
[key: string]: unknown;
|
|
97
200
|
};
|
|
98
|
-
|
|
201
|
+
/**
|
|
202
|
+
* Number of decimal points used in the cart calculation. Must be zero or a positive value.
|
|
203
|
+
*/
|
|
99
204
|
cartCalculationScale?: number;
|
|
100
|
-
|
|
101
|
-
|
|
205
|
+
};
|
|
206
|
+
type ServiceConfigurationDto = {
|
|
207
|
+
/**
|
|
208
|
+
* Service configuration's unique identifier.
|
|
209
|
+
*/
|
|
210
|
+
id?: string;
|
|
211
|
+
/**
|
|
212
|
+
* Service configuration's name.
|
|
213
|
+
*/
|
|
214
|
+
name?: string;
|
|
215
|
+
serviceType?: string;
|
|
216
|
+
serviceUrl?: string;
|
|
217
|
+
/**
|
|
218
|
+
* Flag indicating whether the service is active.
|
|
219
|
+
*/
|
|
220
|
+
active?: boolean;
|
|
221
|
+
configuration?: ServiceSettingsDto;
|
|
222
|
+
};
|
|
223
|
+
type ServiceSettingsDto = {
|
|
224
|
+
public?: {
|
|
225
|
+
[key: string]: unknown;
|
|
102
226
|
};
|
|
103
|
-
|
|
227
|
+
restricted?: {
|
|
228
|
+
[key: string]: unknown;
|
|
229
|
+
};
|
|
230
|
+
};
|
|
231
|
+
type AssistedBuying$1 = {
|
|
232
|
+
/**
|
|
233
|
+
* Storefront URL, where an employee should be redirected when the assisted buying mechanism is used.
|
|
234
|
+
*/
|
|
235
|
+
storefrontUrl?: string;
|
|
236
|
+
};
|
|
237
|
+
/**
|
|
238
|
+
* Specifies whether tax calculation is based on customer billing address or shipping address. Default value is `BILLING_ADDRESS`.
|
|
239
|
+
*/
|
|
240
|
+
type TaxDeterminationBasedOn = 'BILLING_ADDRESS' | 'SHIPPING_ADDRESS';
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* A site as returned by the Site Settings Service. Mirrors the generated
|
|
244
|
+
* `SiteDto`, but re-tightens `active`/`default` to required — the storefront
|
|
245
|
+
* relies on both being present (see {@link SiteService.current}).
|
|
246
|
+
*/
|
|
247
|
+
type Site$1 = Omit<SiteDto, "active" | "default"> & {
|
|
248
|
+
active: boolean;
|
|
249
|
+
default: boolean;
|
|
250
|
+
};
|
|
251
|
+
|
|
104
252
|
/**
|
|
105
253
|
* Read-only access to the tenant's site catalog. List returns active sites
|
|
106
254
|
* visible to the storefront context (the `site_manage` scope is only needed
|
|
@@ -121,43 +269,116 @@ declare class SiteService {
|
|
|
121
269
|
current(authCtx?: AuthContext): Promise<Site$1>;
|
|
122
270
|
}
|
|
123
271
|
|
|
272
|
+
type SessionContextGet = SessionContextBase & {
|
|
273
|
+
context?: Context;
|
|
274
|
+
} & {
|
|
275
|
+
metadata?: Metadata$9;
|
|
276
|
+
};
|
|
124
277
|
/**
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
278
|
+
* Request body for partially updating own session context (PATCH /me/context).
|
|
279
|
+
* Only the following fields can be updated; all other fields are ignored.
|
|
280
|
+
*
|
|
128
281
|
*/
|
|
129
|
-
|
|
130
|
-
|
|
282
|
+
type SessionContextPatch$1 = {
|
|
283
|
+
/**
|
|
284
|
+
* Code of the site, as defined in the Site Settings Service.
|
|
285
|
+
*/
|
|
286
|
+
siteCode?: string;
|
|
287
|
+
/**
|
|
288
|
+
* Three-letter currency code, as defined in the Currency Service.
|
|
289
|
+
*/
|
|
290
|
+
currency?: string;
|
|
291
|
+
/**
|
|
292
|
+
* The country code, as defined in the country service.
|
|
293
|
+
*/
|
|
294
|
+
targetLocation?: string;
|
|
295
|
+
/**
|
|
296
|
+
* Language associated with the session.
|
|
297
|
+
*/
|
|
298
|
+
language?: string;
|
|
299
|
+
context?: Context;
|
|
300
|
+
metadata: MetadataUpdate$2;
|
|
301
|
+
};
|
|
302
|
+
type SessionContextBase = {
|
|
303
|
+
/**
|
|
304
|
+
* Unique identifier of the customer's session.
|
|
305
|
+
*/
|
|
306
|
+
sessionId?: string;
|
|
307
|
+
/**
|
|
308
|
+
* Customer unique identifier.
|
|
309
|
+
*
|
|
310
|
+
* **Note**: This field is only applicable to logged-in customers.
|
|
311
|
+
*/
|
|
131
312
|
customerId?: string;
|
|
313
|
+
/**
|
|
314
|
+
* Code of the site, as defined in the Site Settings Service.
|
|
315
|
+
*
|
|
316
|
+
* **Note**: The default country code for anonymous sessions is based on the home base address country of the default site. In the case of a logged-in customer session, the country code is derived from the customer's shipping address, with the billing address being used as a fallback if the former is not available. If both addresses are not set, the home base address country code from the default site is used.
|
|
317
|
+
*/
|
|
132
318
|
siteCode?: string;
|
|
319
|
+
/**
|
|
320
|
+
* Three-letter currency code, as defined in the Currency Service.
|
|
321
|
+
*
|
|
322
|
+
* **Note**: During an anonymous session, the default currency of the site serves as the initial currency. Whereas, for a user session, the customer's preferred currency is set as the initial currency.
|
|
323
|
+
*/
|
|
133
324
|
currency?: string;
|
|
325
|
+
/**
|
|
326
|
+
* Unique identifier of the active customer cart, generated when the cart is created through the Cart Service.
|
|
327
|
+
*/
|
|
134
328
|
cartId?: string;
|
|
329
|
+
/**
|
|
330
|
+
* The country code, as defined in the country service.
|
|
331
|
+
*
|
|
332
|
+
*
|
|
333
|
+
* **Note**: The default country code for anonymous sessions is based on the home base address country of the default site. In the case of a logged-in customer session, the country code is derived from the customer's shipping address, with the billing address being used as a fallback if the former is not available. If both addresses are not set, the home base address country code from the default site is used.
|
|
334
|
+
*/
|
|
135
335
|
targetLocation?: string;
|
|
336
|
+
/**
|
|
337
|
+
* Language associated with the session.
|
|
338
|
+
*/
|
|
136
339
|
language?: string;
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
340
|
+
};
|
|
341
|
+
type MetadataUpdate$2 = {
|
|
342
|
+
/**
|
|
343
|
+
* Version of the session context object.
|
|
344
|
+
*/
|
|
345
|
+
version?: number;
|
|
346
|
+
};
|
|
347
|
+
type Metadata$9 = MetadataUpdate$2 & {
|
|
348
|
+
/**
|
|
349
|
+
* Date and time when the object was created.
|
|
350
|
+
*/
|
|
351
|
+
createdAt?: string;
|
|
352
|
+
/**
|
|
353
|
+
* Date and time when the object was last modified.
|
|
354
|
+
*/
|
|
355
|
+
modifiedAt?: string;
|
|
356
|
+
};
|
|
357
|
+
type Context = {
|
|
358
|
+
[key: string]: {
|
|
359
|
+
[key: string]: unknown;
|
|
142
360
|
};
|
|
143
|
-
}
|
|
361
|
+
};
|
|
362
|
+
|
|
144
363
|
/**
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
* If `version` is omitted, the service fetches the current version via GET
|
|
149
|
-
* before PATCHing (one extra round-trip). Pass it explicitly when you already
|
|
150
|
-
* know it (e.g. after a `get()` call earlier in the same flow).
|
|
364
|
+
* The current session context (`GET /me/context`). Mirrors the generated
|
|
365
|
+
* `SessionContextGet` but re-tightens `sessionId` to required — a returned
|
|
366
|
+
* context always carries one.
|
|
151
367
|
*/
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
368
|
+
type SessionContext = Omit<SessionContextGet, "sessionId"> & {
|
|
369
|
+
sessionId: string;
|
|
370
|
+
};
|
|
371
|
+
/**
|
|
372
|
+
* Input for {@link SessionContextService.patch}. The updatable fields are
|
|
373
|
+
* derived from the generated patch body; `version` is a flat convenience for
|
|
374
|
+
* the wire's `metadata.version` (the service maps it). Omit `version` to have
|
|
375
|
+
* the service resolve it via a GET first.
|
|
376
|
+
*/
|
|
377
|
+
type SessionContextPatch = Pick<SessionContextPatch$1, "siteCode" | "currency" | "targetLocation" | "language" | "context"> & {
|
|
378
|
+
/** Optimistic-locking version. If omitted, resolved via GET. */
|
|
159
379
|
version?: number;
|
|
160
|
-
}
|
|
380
|
+
};
|
|
381
|
+
|
|
161
382
|
/**
|
|
162
383
|
* Session-context binding for the current storefront session. Both endpoints
|
|
163
384
|
* resolve the session-id from the `Authorization` token — no path/query
|
|
@@ -1385,18 +1606,6 @@ type CustomInstanceResponse = {
|
|
|
1385
1606
|
media?: Array<string>;
|
|
1386
1607
|
metadata?: CustomInstanceMetadata;
|
|
1387
1608
|
};
|
|
1388
|
-
type BulkPatchCustomInstanceRequest = {
|
|
1389
|
-
/**
|
|
1390
|
-
* Unique identifier of the custom instance to patch.
|
|
1391
|
-
*/
|
|
1392
|
-
id: string;
|
|
1393
|
-
/**
|
|
1394
|
-
* List of patch operations to apply to the custom instance.
|
|
1395
|
-
*/
|
|
1396
|
-
data: Array<{
|
|
1397
|
-
[key: string]: unknown;
|
|
1398
|
-
}>;
|
|
1399
|
-
};
|
|
1400
1609
|
type BulkResponse = Array<{
|
|
1401
1610
|
/**
|
|
1402
1611
|
* Index of the processed item, matching the item position in request body.
|
|
@@ -1421,6 +1630,16 @@ type BulkResponse = Array<{
|
|
|
1421
1630
|
message?: string;
|
|
1422
1631
|
}>;
|
|
1423
1632
|
}>;
|
|
1633
|
+
type BulkPatchCustomInstanceRequest = {
|
|
1634
|
+
/**
|
|
1635
|
+
* Unique identifier of the custom instance to patch.
|
|
1636
|
+
*/
|
|
1637
|
+
id: string;
|
|
1638
|
+
/**
|
|
1639
|
+
* List of patch operations to apply to the custom instance.
|
|
1640
|
+
*/
|
|
1641
|
+
data: Array<PatchOperation$1>;
|
|
1642
|
+
};
|
|
1424
1643
|
type CustomInstanceMetadata = {
|
|
1425
1644
|
/**
|
|
1426
1645
|
* Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`
|
|
@@ -1441,6 +1660,26 @@ type CustomInstanceMetadata = {
|
|
|
1441
1660
|
[key: string]: unknown;
|
|
1442
1661
|
};
|
|
1443
1662
|
};
|
|
1663
|
+
type PatchOperation$1 = {
|
|
1664
|
+
/**
|
|
1665
|
+
* Indicates an operation which should be done on a return. Available operations: `add` `remove` and `replace`
|
|
1666
|
+
*/
|
|
1667
|
+
op: 'add' | 'remove' | 'replace';
|
|
1668
|
+
/**
|
|
1669
|
+
* Path to the field to update.
|
|
1670
|
+
*
|
|
1671
|
+
* Examples: `/name`, `/mixins/additionalAttributes/externalId`, `/mixins/additionalAttributes/careInstructions/1`.
|
|
1672
|
+
*
|
|
1673
|
+
* To append an item to an array mixin field (for example, a table row), use `add` with a path ending in `/-`. The `-` means append after the last element.
|
|
1674
|
+
*/
|
|
1675
|
+
path: string;
|
|
1676
|
+
/**
|
|
1677
|
+
* Indicates a value that should be changed or added. The value can be of a primitive type, like string, number, boolean or it can be an object or an array.
|
|
1678
|
+
*/
|
|
1679
|
+
value?: {
|
|
1680
|
+
[key: string]: unknown;
|
|
1681
|
+
} | string | number;
|
|
1682
|
+
};
|
|
1444
1683
|
|
|
1445
1684
|
/** One item for {@link SchemaService.bulkPatchInstances} — `{ id, data: op[] }`. */
|
|
1446
1685
|
type BulkPatchInstanceItem = BulkPatchCustomInstanceRequest;
|
|
@@ -1649,19 +1888,13 @@ type TextGenerationRequest = {
|
|
|
1649
1888
|
*/
|
|
1650
1889
|
maxTokens?: number;
|
|
1651
1890
|
};
|
|
1652
|
-
type
|
|
1653
|
-
/**
|
|
1654
|
-
* ID of the token.
|
|
1655
|
-
*/
|
|
1656
|
-
id: string;
|
|
1657
|
-
};
|
|
1658
|
-
type InnerTokenResponse = {
|
|
1891
|
+
type IdResponse = {
|
|
1659
1892
|
/**
|
|
1660
|
-
*
|
|
1893
|
+
* Identifier of the resource.
|
|
1661
1894
|
*/
|
|
1662
1895
|
id?: string;
|
|
1663
1896
|
};
|
|
1664
|
-
type ExpandedTokenResponse =
|
|
1897
|
+
type ExpandedTokenResponse = IdResponse & {
|
|
1665
1898
|
/**
|
|
1666
1899
|
* Name of the token.
|
|
1667
1900
|
*/
|
|
@@ -1671,9 +1904,15 @@ type ExpandedTokenResponse = InnerTokenResponse & {
|
|
|
1671
1904
|
/**
|
|
1672
1905
|
* The full response representing token. If the `expand=token` is **not** used, then only `id` field is returned, otherwise all fields are returned.
|
|
1673
1906
|
*/
|
|
1674
|
-
type ExpandableTokenResponse =
|
|
1907
|
+
type ExpandableTokenResponse = IdResponse | ExpandedTokenResponse;
|
|
1675
1908
|
/**
|
|
1676
|
-
* Type of the native tool.
|
|
1909
|
+
* Type of the native tool. Possible values:
|
|
1910
|
+
* * `slack`
|
|
1911
|
+
* * `rag_custom`
|
|
1912
|
+
* * `rag_emporix`
|
|
1913
|
+
* * `teams`
|
|
1914
|
+
*
|
|
1915
|
+
* **The `teams` value is in preview mode** - some of the features may not be fully operational yet.
|
|
1677
1916
|
*/
|
|
1678
1917
|
type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix' | 'teams';
|
|
1679
1918
|
type BaseNativeTool = {
|
|
@@ -1693,6 +1932,9 @@ type RagCustomEmbeddingNativeToolConfig = {
|
|
|
1693
1932
|
*/
|
|
1694
1933
|
model: string;
|
|
1695
1934
|
};
|
|
1935
|
+
type RagCustomEmbeddingNativeToolConfigRequest = RagCustomEmbeddingNativeToolConfig & {
|
|
1936
|
+
token: IdWrapperRequest;
|
|
1937
|
+
};
|
|
1696
1938
|
type RagCustomEmbeddingNativeToolConfigResponse = RagCustomEmbeddingNativeToolConfig & {
|
|
1697
1939
|
token?: ExpandableTokenResponse;
|
|
1698
1940
|
};
|
|
@@ -1716,6 +1958,9 @@ type RagCustomDatabaseNativeToolConfig = {
|
|
|
1716
1958
|
*/
|
|
1717
1959
|
collectionName: string;
|
|
1718
1960
|
};
|
|
1961
|
+
type RagCustomDatabaseNativeToolConfigRequest = RagCustomDatabaseNativeToolConfig & {
|
|
1962
|
+
token: IdWrapperRequest;
|
|
1963
|
+
};
|
|
1719
1964
|
type RagCustomDatabaseNativeToolConfigResponse = RagCustomDatabaseNativeToolConfig & {
|
|
1720
1965
|
token?: ExpandableTokenResponse;
|
|
1721
1966
|
};
|
|
@@ -1729,6 +1974,10 @@ type RagCustomNativeToolConfig = {
|
|
|
1729
1974
|
*/
|
|
1730
1975
|
maxResults?: number;
|
|
1731
1976
|
};
|
|
1977
|
+
type RagCustomNativeToolConfigRequest = RagCustomNativeToolConfig & {
|
|
1978
|
+
databaseConfig: RagCustomDatabaseNativeToolConfigRequest;
|
|
1979
|
+
embeddingConfig: RagCustomEmbeddingNativeToolConfigRequest;
|
|
1980
|
+
};
|
|
1732
1981
|
type RagCustomNativeToolConfigResponse = RagCustomNativeToolConfig & {
|
|
1733
1982
|
databaseConfig?: RagCustomDatabaseNativeToolConfigResponse;
|
|
1734
1983
|
embeddingConfig?: RagCustomEmbeddingNativeToolConfigResponse;
|
|
@@ -1754,6 +2003,9 @@ type OpenAiRagEmporixEmbeddingNativeToolConfig = {
|
|
|
1754
2003
|
*/
|
|
1755
2004
|
dimensions: number;
|
|
1756
2005
|
};
|
|
2006
|
+
type OpenAiRagEmporixEmbeddingNativeToolConfigRequest = OpenAiRagEmporixEmbeddingNativeToolConfig & {
|
|
2007
|
+
token: IdWrapperRequest;
|
|
2008
|
+
};
|
|
1757
2009
|
type OpenAiRagEmporixEmbeddingNativeToolConfigResponse = OpenAiRagEmporixEmbeddingNativeToolConfig & {
|
|
1758
2010
|
token?: ExpandableTokenResponse;
|
|
1759
2011
|
};
|
|
@@ -1775,6 +2027,9 @@ type SelfHostedOllamaRagEmporixEmbeddingNativeToolConfig = {
|
|
|
1775
2027
|
*/
|
|
1776
2028
|
url: string;
|
|
1777
2029
|
};
|
|
2030
|
+
type SelfHostedOllamaRagEmporixEmbeddingNativeToolConfigRequest = SelfHostedOllamaRagEmporixEmbeddingNativeToolConfig & {
|
|
2031
|
+
token: IdWrapperRequest;
|
|
2032
|
+
};
|
|
1778
2033
|
type SelfHostedOllamaRagEmporixEmbeddingNativeToolConfigResponse = SelfHostedOllamaRagEmporixEmbeddingNativeToolConfig & {
|
|
1779
2034
|
token?: ExpandableTokenResponse;
|
|
1780
2035
|
};
|
|
@@ -1814,6 +2069,9 @@ type RagEmporixNativeToolConfig = {
|
|
|
1814
2069
|
key: string;
|
|
1815
2070
|
}>;
|
|
1816
2071
|
};
|
|
2072
|
+
type RagEmporixNativeToolConfigRequest = RagEmporixNativeToolConfig & {
|
|
2073
|
+
embeddingConfig: EmporixOpenAiRagEmporixEmbeddingNativeToolConfig | OpenAiRagEmporixEmbeddingNativeToolConfigRequest | SelfHostedOllamaRagEmporixEmbeddingNativeToolConfigRequest;
|
|
2074
|
+
};
|
|
1817
2075
|
type RagEmporixNativeToolConfigResponse = RagEmporixNativeToolConfig & {
|
|
1818
2076
|
embeddingConfig?: EmporixOpenAiRagEmporixEmbeddingNativeToolConfig | OpenAiRagEmporixEmbeddingNativeToolConfigResponse | SelfHostedOllamaRagEmporixEmbeddingNativeToolConfigResponse;
|
|
1819
2077
|
};
|
|
@@ -1823,6 +2081,20 @@ type SlackNativeToolConfigResponse = {
|
|
|
1823
2081
|
*/
|
|
1824
2082
|
teamId: string;
|
|
1825
2083
|
};
|
|
2084
|
+
type SlackNativeToolConfigRequest = SlackNativeToolConfigResponse & {
|
|
2085
|
+
/**
|
|
2086
|
+
* OAuth token used to authenticate the Slack bot within the specified workspace. Required for performing authorized actions on behalf of the bot. Format usually starts with `xoxb-...`. It is required only for creation, for update operation it can be omitted.
|
|
2087
|
+
*/
|
|
2088
|
+
botToken: string;
|
|
2089
|
+
};
|
|
2090
|
+
type SlackNativeToolRequest = BaseNativeTool & {
|
|
2091
|
+
/**
|
|
2092
|
+
* For SlackNativeTool it has to be set to `slack`.
|
|
2093
|
+
*/
|
|
2094
|
+
type?: unknown;
|
|
2095
|
+
config: SlackNativeToolConfigRequest;
|
|
2096
|
+
metadata?: MetadataRequest;
|
|
2097
|
+
};
|
|
1826
2098
|
type SlackNativeToolResponse = BaseNativeTool & {
|
|
1827
2099
|
/**
|
|
1828
2100
|
* Unique identifier of the tool.
|
|
@@ -1840,13 +2112,9 @@ type SlackNativeToolResponse = BaseNativeTool & {
|
|
|
1840
2112
|
*/
|
|
1841
2113
|
type TeamsAllowedOperations = 'sendMessage' | 'createChat' | 'createChannel' | 'inviteParticipants' | 'collaborateOnChannel' | 'collaborateOnChat';
|
|
1842
2114
|
/**
|
|
1843
|
-
* 
|
|
1844
|
-
*
|
|
1845
|
-
* {% hint style="danger" %}
|
|
1846
|
-
* This functionality is in preview mode - some of the features may not be fully operational yet.
|
|
1847
|
-
* {% endhint %}
|
|
1848
|
-
*
|
|
1849
2115
|
* Configuration of an MS Teams native tool instance.
|
|
2116
|
+
*
|
|
2117
|
+
* **The MS Teams native tool configuration is in preview mode** - some of the features may not be fully operational yet.
|
|
1850
2118
|
*/
|
|
1851
2119
|
type TeamsNativeToolConfigResponse = {
|
|
1852
2120
|
/**
|
|
@@ -1866,6 +2134,15 @@ type TeamsNativeToolConfigResponse = {
|
|
|
1866
2134
|
*/
|
|
1867
2135
|
allowedOperations?: Array<TeamsAllowedOperations>;
|
|
1868
2136
|
};
|
|
2137
|
+
type TeamsNativeToolConfigRequest = TeamsNativeToolConfigResponse;
|
|
2138
|
+
type TeamsNativeToolRequest = BaseNativeTool & {
|
|
2139
|
+
/**
|
|
2140
|
+
* For TeamsNativeTool it has to be set to `teams`.
|
|
2141
|
+
*/
|
|
2142
|
+
type?: unknown;
|
|
2143
|
+
config: TeamsNativeToolConfigRequest;
|
|
2144
|
+
metadata?: MetadataRequest;
|
|
2145
|
+
};
|
|
1869
2146
|
type TeamsNativeToolResponse = BaseNativeTool & {
|
|
1870
2147
|
/**
|
|
1871
2148
|
* Unique identifier of the tool.
|
|
@@ -1878,6 +2155,14 @@ type TeamsNativeToolResponse = BaseNativeTool & {
|
|
|
1878
2155
|
config?: TeamsNativeToolConfigResponse;
|
|
1879
2156
|
metadata?: MetadataResponse$1;
|
|
1880
2157
|
};
|
|
2158
|
+
type RagCustomNativeToolRequest = BaseNativeTool & {
|
|
2159
|
+
/**
|
|
2160
|
+
* For `RagCustomNativeTool`, it has to be set to `rag_custom`.
|
|
2161
|
+
*/
|
|
2162
|
+
type?: unknown;
|
|
2163
|
+
config: RagCustomNativeToolConfigRequest;
|
|
2164
|
+
metadata?: MetadataRequest;
|
|
2165
|
+
};
|
|
1881
2166
|
type RagCustomNativeToolResponse = BaseNativeTool & {
|
|
1882
2167
|
/**
|
|
1883
2168
|
* Unique identifier of the tool.
|
|
@@ -1890,6 +2175,14 @@ type RagCustomNativeToolResponse = BaseNativeTool & {
|
|
|
1890
2175
|
config?: RagCustomNativeToolConfigResponse;
|
|
1891
2176
|
metadata?: MetadataResponse$1;
|
|
1892
2177
|
};
|
|
2178
|
+
type RagEmporixNativeToolRequest = BaseNativeTool & {
|
|
2179
|
+
/**
|
|
2180
|
+
* For `RagEmporixNativeTool`, it has to be set to `rag_emporix`.
|
|
2181
|
+
*/
|
|
2182
|
+
type?: unknown;
|
|
2183
|
+
config: RagEmporixNativeToolConfigRequest;
|
|
2184
|
+
metadata?: MetadataRequest;
|
|
2185
|
+
};
|
|
1893
2186
|
type RagEmporixNativeToolResponse = BaseNativeTool & {
|
|
1894
2187
|
/**
|
|
1895
2188
|
* Unique identifier of the tool.
|
|
@@ -1949,6 +2242,9 @@ type McpServerConfig = {
|
|
|
1949
2242
|
*/
|
|
1950
2243
|
authorizationHeaderName?: string;
|
|
1951
2244
|
};
|
|
2245
|
+
type McpServerConfigRequest = McpServerConfig & {
|
|
2246
|
+
authorizationHeaderToken?: IdWrapperRequest;
|
|
2247
|
+
};
|
|
1952
2248
|
type McpServerConfigResponse = McpServerConfig & {
|
|
1953
2249
|
authorizationHeaderToken?: ExpandableTokenResponse;
|
|
1954
2250
|
};
|
|
@@ -1966,10 +2262,20 @@ type BaseMcpServer = {
|
|
|
1966
2262
|
enabled?: boolean;
|
|
1967
2263
|
transport?: CustomMcpServerTransportType;
|
|
1968
2264
|
};
|
|
1969
|
-
type
|
|
2265
|
+
type McpServerRequest = BaseMcpServer & {
|
|
2266
|
+
config: McpServerConfigRequest;
|
|
2267
|
+
metadata?: MetadataRequest;
|
|
2268
|
+
};
|
|
2269
|
+
type McpServerResponse = BaseMcpServer & {
|
|
1970
2270
|
config?: McpServerConfigResponse;
|
|
1971
2271
|
metadata?: MetadataResponse$1;
|
|
1972
2272
|
};
|
|
2273
|
+
type CommerceEventsResponse = {
|
|
2274
|
+
/**
|
|
2275
|
+
* List of events available to use by an agent with the `COMMERCE_EVENTS` trigger.
|
|
2276
|
+
*/
|
|
2277
|
+
events?: Array<string>;
|
|
2278
|
+
};
|
|
1973
2279
|
/**
|
|
1974
2280
|
* Type of the MCP server. The `custom` type allows you to integrate with your own MCP server instance, while the `predefined` type allows you to integrate with one of the instances provided by Emporix.
|
|
1975
2281
|
*/
|
|
@@ -2035,35 +2341,6 @@ type EmporixLlm = BaseLlm & {
|
|
|
2035
2341
|
*/
|
|
2036
2342
|
provider: 'emporix_openai';
|
|
2037
2343
|
};
|
|
2038
|
-
/**
|
|
2039
|
-
* OAuth 2.0 client-credentials settings for authenticating with a self-hosted LLM backend.
|
|
2040
|
-
*/
|
|
2041
|
-
type OAuthParams = {
|
|
2042
|
-
/**
|
|
2043
|
-
* Base URL of the OAuth 2.0 authorization server. The access token is requested from `{url}/token`.
|
|
2044
|
-
*/
|
|
2045
|
-
url: string;
|
|
2046
|
-
/**
|
|
2047
|
-
* OAuth 2.0 client identifier registered with the authorization server.
|
|
2048
|
-
*/
|
|
2049
|
-
clientId: string;
|
|
2050
|
-
/**
|
|
2051
|
-
* OAuth 2.0 grant type used to obtain an access token.
|
|
2052
|
-
*/
|
|
2053
|
-
grantType: 'client_credentials';
|
|
2054
|
-
/**
|
|
2055
|
-
* Optional space-separated list of scopes to request for the access token.
|
|
2056
|
-
*/
|
|
2057
|
-
scope?: string;
|
|
2058
|
-
};
|
|
2059
|
-
type OAuthParamsRequest = OAuthParams & {
|
|
2060
|
-
[key: string]: unknown;
|
|
2061
|
-
} & {
|
|
2062
|
-
clientSecret?: InnerTokenRequest;
|
|
2063
|
-
};
|
|
2064
|
-
type OAuthParamsResponse = OAuthParams & {
|
|
2065
|
-
clientSecret?: ExpandableTokenResponse;
|
|
2066
|
-
};
|
|
2067
2344
|
type SelfHostedParams = {
|
|
2068
2345
|
/**
|
|
2069
2346
|
* Url of the self-hosted LLM.
|
|
@@ -2077,12 +2354,12 @@ type SelfHostedParams = {
|
|
|
2077
2354
|
type SelfHostedParamsRequest = SelfHostedParams & {
|
|
2078
2355
|
[key: string]: unknown;
|
|
2079
2356
|
} & {
|
|
2080
|
-
authorizationHeaderToken?:
|
|
2081
|
-
|
|
2357
|
+
authorizationHeaderToken?: IdWrapperRequest;
|
|
2358
|
+
oauth?: IdWrapperRequest;
|
|
2082
2359
|
};
|
|
2083
2360
|
type SelfHostedParamsResponse = SelfHostedParams & {
|
|
2084
2361
|
authorizationHeaderToken?: ExpandableTokenResponse;
|
|
2085
|
-
|
|
2362
|
+
oauth?: ExpandableOAuthResponse;
|
|
2086
2363
|
};
|
|
2087
2364
|
type SelfHostedLlm = BaseLlm & {
|
|
2088
2365
|
/**
|
|
@@ -2100,22 +2377,105 @@ type SelfHostedLlmResponse = SelfHostedLlm & {
|
|
|
2100
2377
|
* Type of the LLM Provider. The supported providers allows you to provide your own API key. When using this providers, the `apiKey` property cannot be omitted.
|
|
2101
2378
|
*/
|
|
2102
2379
|
type ApiKeyLlmProvider = 'openai' | 'google' | 'anthropic';
|
|
2380
|
+
type ModelResponse = {
|
|
2381
|
+
/**
|
|
2382
|
+
* Model identifier to use in agent LLM configuration.
|
|
2383
|
+
*/
|
|
2384
|
+
id: string;
|
|
2385
|
+
/**
|
|
2386
|
+
* Display name of the model.
|
|
2387
|
+
*/
|
|
2388
|
+
name: string;
|
|
2389
|
+
/**
|
|
2390
|
+
* Short description of the model. Available for some providers, such as Google.
|
|
2391
|
+
*/
|
|
2392
|
+
description?: string;
|
|
2393
|
+
/**
|
|
2394
|
+
* Indicates whether the model supports thinking capabilities.
|
|
2395
|
+
*/
|
|
2396
|
+
thinking?: boolean;
|
|
2397
|
+
};
|
|
2398
|
+
type ProviderModelsResponse = {
|
|
2399
|
+
provider: ApiKeyLlmProvider;
|
|
2400
|
+
/**
|
|
2401
|
+
* List of models available for the provider.
|
|
2402
|
+
*/
|
|
2403
|
+
models: Array<ModelResponse>;
|
|
2404
|
+
};
|
|
2103
2405
|
type ApiKeyLlm = BaseLlm & {
|
|
2104
2406
|
provider: ApiKeyLlmProvider;
|
|
2105
2407
|
};
|
|
2106
2408
|
type ApiKeyLlmRequest = ApiKeyLlm & {
|
|
2107
|
-
token:
|
|
2409
|
+
token: IdWrapperRequest;
|
|
2108
2410
|
};
|
|
2109
2411
|
type ApiKeyLlmResponse = ApiKeyLlm & {
|
|
2110
2412
|
token?: ExpandableTokenResponse;
|
|
2111
2413
|
};
|
|
2112
2414
|
/**
|
|
2113
|
-
*
|
|
2114
|
-
|
|
2115
|
-
|
|
2116
|
-
|
|
2117
|
-
|
|
2118
|
-
|
|
2415
|
+
* OAuth 2.0 client-credentials settings for authenticating with a self-hosted LLM backend.
|
|
2416
|
+
*/
|
|
2417
|
+
type OAuth = {
|
|
2418
|
+
/**
|
|
2419
|
+
* Token endpoint URL of the OAuth 2.0 authorization server used to request an access token.
|
|
2420
|
+
*/
|
|
2421
|
+
url: string;
|
|
2422
|
+
/**
|
|
2423
|
+
* OAuth 2.0 client identifier registered with the authorization server.
|
|
2424
|
+
*/
|
|
2425
|
+
clientId: string;
|
|
2426
|
+
/**
|
|
2427
|
+
* OAuth 2.0 grant type used to obtain an access token. Currently only `client_credentials` is supported.
|
|
2428
|
+
*/
|
|
2429
|
+
grantType: 'client_credentials';
|
|
2430
|
+
/**
|
|
2431
|
+
* Optional space-separated list of scopes to request for the access token.
|
|
2432
|
+
*/
|
|
2433
|
+
scope?: string;
|
|
2434
|
+
/**
|
|
2435
|
+
* Indicates whether the OAuth configuration is enabled.
|
|
2436
|
+
*/
|
|
2437
|
+
enabled?: boolean;
|
|
2438
|
+
};
|
|
2439
|
+
type OAuthRequest = OAuth & {
|
|
2440
|
+
clientSecretToken?: IdWrapperRequest;
|
|
2441
|
+
metadata?: MetadataRequest;
|
|
2442
|
+
};
|
|
2443
|
+
type OAuthResponse = OAuth & {
|
|
2444
|
+
/**
|
|
2445
|
+
* Unique identifier of the entity.
|
|
2446
|
+
*/
|
|
2447
|
+
id?: string;
|
|
2448
|
+
clientSecretToken?: ExpandableTokenResponse;
|
|
2449
|
+
metadata?: MetadataResponse$1;
|
|
2450
|
+
};
|
|
2451
|
+
/**
|
|
2452
|
+
* The full response representing OAuth. If the `expand=oauth` is **not** used, then only `id` field is returned, otherwise all fields are returned.
|
|
2453
|
+
*/
|
|
2454
|
+
type ExpandableOAuthResponse = IdResponse | OAuthResponse;
|
|
2455
|
+
type BaseToken = {
|
|
2456
|
+
/**
|
|
2457
|
+
* Name of the token.
|
|
2458
|
+
*/
|
|
2459
|
+
name: string;
|
|
2460
|
+
};
|
|
2461
|
+
type TokenRequest = BaseToken & {
|
|
2462
|
+
/**
|
|
2463
|
+
* Value which represents token.
|
|
2464
|
+
*/
|
|
2465
|
+
value: string;
|
|
2466
|
+
metadata?: MetadataRequest;
|
|
2467
|
+
};
|
|
2468
|
+
type TokenResponse = BaseToken & {
|
|
2469
|
+
/**
|
|
2470
|
+
* Unique identifier of the token.
|
|
2471
|
+
*/
|
|
2472
|
+
id?: string;
|
|
2473
|
+
metadata?: MetadataResponse$1;
|
|
2474
|
+
};
|
|
2475
|
+
type IdWrapperRequest = {
|
|
2476
|
+
id: string;
|
|
2477
|
+
};
|
|
2478
|
+
/**
|
|
2119
2479
|
* Reference to a native tool assigned to an agent.
|
|
2120
2480
|
*/
|
|
2121
2481
|
type NativeToolReferenceRequest = {
|
|
@@ -2125,6 +2485,8 @@ type NativeToolReferenceRequest = {
|
|
|
2125
2485
|
id: string;
|
|
2126
2486
|
/**
|
|
2127
2487
|
* Optional per-agent override of allowed MS Teams operations. When omitted, the tool instance defaults apply.
|
|
2488
|
+
*
|
|
2489
|
+
* **The `allowedOperations` field is in preview mode** - some of the features may not be fully operational yet.
|
|
2128
2490
|
*/
|
|
2129
2491
|
allowedOperations?: Array<TeamsAllowedOperations>;
|
|
2130
2492
|
};
|
|
@@ -2292,6 +2654,18 @@ type BaseForAgentRequestAndResponse = BaseForAgentAndTemplate & {
|
|
|
2292
2654
|
*/
|
|
2293
2655
|
enabledMemory?: boolean;
|
|
2294
2656
|
};
|
|
2657
|
+
type AgentTemplateResponse = BaseForAgentAndTemplate & {
|
|
2658
|
+
/**
|
|
2659
|
+
* Immutable LLM base prompt which is concatenated with the `userPrompt`.
|
|
2660
|
+
*/
|
|
2661
|
+
templatePrompt?: string;
|
|
2662
|
+
/**
|
|
2663
|
+
* Identifier of the agent.
|
|
2664
|
+
*/
|
|
2665
|
+
id?: string;
|
|
2666
|
+
nativeTools?: NativeToolsResponse;
|
|
2667
|
+
mcpServers?: AgentMcpServersResponse;
|
|
2668
|
+
};
|
|
2295
2669
|
type AgentRequest = BaseForAgentRequestAndResponse & {
|
|
2296
2670
|
/**
|
|
2297
2671
|
* Native tools assigned to the agent, optionally with per-agent `allowedOperations` overrides.
|
|
@@ -2333,6 +2707,176 @@ type MetadataResponse$1 = MetadataRequest & {
|
|
|
2333
2707
|
*/
|
|
2334
2708
|
modifiedAt: string;
|
|
2335
2709
|
};
|
|
2710
|
+
/**
|
|
2711
|
+
* Status of the job.
|
|
2712
|
+
*/
|
|
2713
|
+
type JobStatus = 'in_progress' | 'success' | 'failure' | 'skipped';
|
|
2714
|
+
/**
|
|
2715
|
+
* Type of the job.
|
|
2716
|
+
*/
|
|
2717
|
+
type JobType = 'IMPORT' | 'EXPORT' | 'AGENT_CHAT';
|
|
2718
|
+
/**
|
|
2719
|
+
* Contains information about the job result - whether it was successful or not, what was the agent output etc.
|
|
2720
|
+
*/
|
|
2721
|
+
type Job$1 = {
|
|
2722
|
+
/**
|
|
2723
|
+
* Unique identifier of the job.
|
|
2724
|
+
*/
|
|
2725
|
+
id?: string;
|
|
2726
|
+
agentType?: AgentType;
|
|
2727
|
+
status?: JobStatus;
|
|
2728
|
+
type?: JobType;
|
|
2729
|
+
exportResult?: ExportResult;
|
|
2730
|
+
importResult?: ImportResult;
|
|
2731
|
+
/**
|
|
2732
|
+
* Unique identifier of the session.
|
|
2733
|
+
*/
|
|
2734
|
+
sessionId?: string;
|
|
2735
|
+
/**
|
|
2736
|
+
* Unique identifier of the agent.
|
|
2737
|
+
*/
|
|
2738
|
+
agentId?: string;
|
|
2739
|
+
/**
|
|
2740
|
+
* Agent message.
|
|
2741
|
+
*/
|
|
2742
|
+
message?: string;
|
|
2743
|
+
/**
|
|
2744
|
+
* Commerce event which triggered the job.
|
|
2745
|
+
*/
|
|
2746
|
+
commerceEvent?: string;
|
|
2747
|
+
metadata?: MetadataResponse$1;
|
|
2748
|
+
};
|
|
2749
|
+
type ImportResult = {
|
|
2750
|
+
/**
|
|
2751
|
+
* Short summary of the import.
|
|
2752
|
+
*/
|
|
2753
|
+
message?: string;
|
|
2754
|
+
/**
|
|
2755
|
+
* Summary of the import.
|
|
2756
|
+
*/
|
|
2757
|
+
summary?: {
|
|
2758
|
+
agents?: Array<ImportedEntity>;
|
|
2759
|
+
tools?: Array<ImportedEntity>;
|
|
2760
|
+
mcpServers?: Array<ImportedEntity>;
|
|
2761
|
+
};
|
|
2762
|
+
};
|
|
2763
|
+
type ExportResult = {
|
|
2764
|
+
/**
|
|
2765
|
+
* The base64 encoded JSON value of the exported agents with related tools and MCP servers.
|
|
2766
|
+
*/
|
|
2767
|
+
data?: string;
|
|
2768
|
+
/**
|
|
2769
|
+
* Checksum calculated based on JSON value. Validates if importing JSON is exactly the same as the exported one.
|
|
2770
|
+
*/
|
|
2771
|
+
checksum?: string;
|
|
2772
|
+
};
|
|
2773
|
+
type ImportedEntity = {
|
|
2774
|
+
/**
|
|
2775
|
+
* ID of the imported entity.
|
|
2776
|
+
*/
|
|
2777
|
+
id?: string;
|
|
2778
|
+
/**
|
|
2779
|
+
* Name of the imported entity.
|
|
2780
|
+
*/
|
|
2781
|
+
name?: string;
|
|
2782
|
+
/**
|
|
2783
|
+
* State of the imported entity.
|
|
2784
|
+
*/
|
|
2785
|
+
state?: 'TO_CREATE' | 'ENABLED' | 'DISABLED' | 'EXISTS';
|
|
2786
|
+
};
|
|
2787
|
+
type AttachmentResponse = {
|
|
2788
|
+
/**
|
|
2789
|
+
* Unique identifier of the created attachment.
|
|
2790
|
+
*/
|
|
2791
|
+
id?: string;
|
|
2792
|
+
/**
|
|
2793
|
+
* Unique identifier of the session. The same sessionId must be used when calling chat endpoints to ensure the correct attachment is found.
|
|
2794
|
+
*/
|
|
2795
|
+
sessionId?: string;
|
|
2796
|
+
};
|
|
2797
|
+
/**
|
|
2798
|
+
* Severity level of the log entry.
|
|
2799
|
+
*/
|
|
2800
|
+
type LogSeverity = 'INFO' | 'WARNING' | 'ERROR';
|
|
2801
|
+
type AgentLogMessageResponse = {
|
|
2802
|
+
/**
|
|
2803
|
+
* Timestamp when the log message was created.
|
|
2804
|
+
*/
|
|
2805
|
+
timestamp?: string;
|
|
2806
|
+
severity?: LogSeverity;
|
|
2807
|
+
/**
|
|
2808
|
+
* The log message content.
|
|
2809
|
+
*/
|
|
2810
|
+
message?: string;
|
|
2811
|
+
/**
|
|
2812
|
+
* Unique identifier of the agent that generated the log.
|
|
2813
|
+
*/
|
|
2814
|
+
agentId?: string;
|
|
2815
|
+
/**
|
|
2816
|
+
* Unique identifier of the request associated with the log.
|
|
2817
|
+
*/
|
|
2818
|
+
requestId?: string;
|
|
2819
|
+
/**
|
|
2820
|
+
* Whether this is a business log entry.
|
|
2821
|
+
*/
|
|
2822
|
+
isBusinessLog?: boolean;
|
|
2823
|
+
};
|
|
2824
|
+
type AgentRequestResponse = {
|
|
2825
|
+
/**
|
|
2826
|
+
* Unique identifier of the request log.
|
|
2827
|
+
*/
|
|
2828
|
+
id?: string;
|
|
2829
|
+
/**
|
|
2830
|
+
* Unique identifier of the session.
|
|
2831
|
+
*/
|
|
2832
|
+
sessionId?: string;
|
|
2833
|
+
/**
|
|
2834
|
+
* Unique identifier of the request.
|
|
2835
|
+
*/
|
|
2836
|
+
requestId?: string;
|
|
2837
|
+
/**
|
|
2838
|
+
* Unique identifier of the agent that triggered the request.
|
|
2839
|
+
*/
|
|
2840
|
+
triggerAgentId?: string;
|
|
2841
|
+
/**
|
|
2842
|
+
* List of agent IDs that collaborated in this request.
|
|
2843
|
+
*/
|
|
2844
|
+
collaborationAgents?: Array<string>;
|
|
2845
|
+
severity?: LogSeverity;
|
|
2846
|
+
/**
|
|
2847
|
+
* List of log messages associated with this request.
|
|
2848
|
+
*/
|
|
2849
|
+
messages?: Array<AgentLogMessageResponse>;
|
|
2850
|
+
/**
|
|
2851
|
+
* Duration of the request in seconds.
|
|
2852
|
+
*/
|
|
2853
|
+
duration?: number;
|
|
2854
|
+
metadata?: MetadataResponse$1;
|
|
2855
|
+
};
|
|
2856
|
+
type AgentSessionResponse = {
|
|
2857
|
+
/**
|
|
2858
|
+
* Unique identifier of the session.
|
|
2859
|
+
*/
|
|
2860
|
+
sessionId?: string;
|
|
2861
|
+
/**
|
|
2862
|
+
* Unique identifier of the agent that triggered the session.
|
|
2863
|
+
*/
|
|
2864
|
+
triggerAgentId?: string;
|
|
2865
|
+
severity?: LogSeverity;
|
|
2866
|
+
/**
|
|
2867
|
+
* List of agent IDs that participated in this session.
|
|
2868
|
+
*/
|
|
2869
|
+
agents?: Array<string>;
|
|
2870
|
+
/**
|
|
2871
|
+
* List of log messages associated with this session.
|
|
2872
|
+
*/
|
|
2873
|
+
messages?: Array<AgentLogMessageResponse>;
|
|
2874
|
+
/**
|
|
2875
|
+
* Duration of the session in seconds.
|
|
2876
|
+
*/
|
|
2877
|
+
duration?: number;
|
|
2878
|
+
metadata?: MetadataResponse$1;
|
|
2879
|
+
};
|
|
2336
2880
|
type CompletionRequest$1 = {
|
|
2337
2881
|
/**
|
|
2338
2882
|
* Identifier of the request. The value is not mandatory - if provided, then the ID is returned in the text generation response.
|
|
@@ -2358,6 +2902,12 @@ type QParamSearchBody = {
|
|
|
2358
2902
|
*/
|
|
2359
2903
|
q?: string;
|
|
2360
2904
|
};
|
|
2905
|
+
type AgentFromTemplateRequest = BaseForAgentAndTemplateAndHandOff & {
|
|
2906
|
+
/**
|
|
2907
|
+
* LLM Prompt which describes how agent should work in a detailed way, which tools it could use to solve problems etc; it can contain examples and step by step guidance.
|
|
2908
|
+
*/
|
|
2909
|
+
userPrompt: string;
|
|
2910
|
+
};
|
|
2361
2911
|
/**
|
|
2362
2912
|
* Partial update operation list.
|
|
2363
2913
|
*/
|
|
@@ -2368,39 +2918,183 @@ type PatchRequest = Array<{
|
|
|
2368
2918
|
[key: string]: unknown;
|
|
2369
2919
|
};
|
|
2370
2920
|
}>;
|
|
2371
|
-
type
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
|
|
2921
|
+
type ExportResponse = DataWithChecksum & {
|
|
2922
|
+
/**
|
|
2923
|
+
* Date of the export process.
|
|
2924
|
+
*/
|
|
2925
|
+
exportedAt?: string;
|
|
2926
|
+
/**
|
|
2927
|
+
* ID of the job.
|
|
2928
|
+
*/
|
|
2929
|
+
jobId?: string;
|
|
2930
|
+
};
|
|
2931
|
+
type DataWithChecksum = {
|
|
2932
|
+
/**
|
|
2933
|
+
* The base64 encoded JSON value of the exported agents with related tools and MCP servers.
|
|
2934
|
+
*/
|
|
2935
|
+
data?: string;
|
|
2936
|
+
/**
|
|
2937
|
+
* Checksum calculated based on decoded `data` value. Validates if importing JSON is exactly the same as the exported one.
|
|
2938
|
+
*/
|
|
2939
|
+
checksum?: string;
|
|
2940
|
+
};
|
|
2941
|
+
type ExportRequest = {
|
|
2942
|
+
/**
|
|
2943
|
+
* List of the agents IDs.
|
|
2944
|
+
*/
|
|
2945
|
+
agentIds: Array<string>;
|
|
2946
|
+
};
|
|
2947
|
+
type ImportResponse = ImportResult & {
|
|
2948
|
+
/**
|
|
2949
|
+
* Date of the import process.
|
|
2950
|
+
*/
|
|
2951
|
+
importedAt?: string;
|
|
2952
|
+
/**
|
|
2953
|
+
* ID of the job.
|
|
2954
|
+
*/
|
|
2955
|
+
jobId?: string;
|
|
2956
|
+
};
|
|
2957
|
+
type ImportRequest = DataWithChecksum;
|
|
2375
2958
|
/**
|
|
2376
|
-
*
|
|
2377
|
-
* `result` optional, but a 2xx text generation always returns it; the public
|
|
2378
|
-
* contract guarantees `result` so callers need not null-check.
|
|
2959
|
+
* Request log counts by severity.
|
|
2379
2960
|
*/
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
type CompletionMessage = CompletionRequest$1["messages"][number];
|
|
2386
|
-
/** Chat completion request (`POST /completions`). No `maxTokens` (server-fixed model). */
|
|
2387
|
-
type CompletionRequest = CompletionRequest$1;
|
|
2388
|
-
/** Chat completion response — `{ id?, result }` (shares the text generation shape). */
|
|
2389
|
-
interface CompletionResponse {
|
|
2390
|
-
id?: string;
|
|
2391
|
-
result: string;
|
|
2392
|
-
}
|
|
2393
|
-
/** An agentic agent definition (the read/response shape, returned by every agent method). */
|
|
2394
|
-
type Agent = AgentResponse;
|
|
2395
|
-
/** The write shape for {@link AiService.upsertAgent} (`PUT /agentic/agents/{id}`). */
|
|
2396
|
-
type AgentInput = AgentRequest;
|
|
2961
|
+
type AnalyticsSeverityCounts = {
|
|
2962
|
+
info?: number;
|
|
2963
|
+
warning?: number;
|
|
2964
|
+
error?: number;
|
|
2965
|
+
};
|
|
2397
2966
|
/**
|
|
2398
|
-
*
|
|
2399
|
-
* (`ADD | REMOVE | REPLACE`) — NOT RFC-6902 lowercase. Passed verbatim.
|
|
2967
|
+
* Session counts by outcome severity.
|
|
2400
2968
|
*/
|
|
2401
|
-
type
|
|
2402
|
-
|
|
2403
|
-
|
|
2969
|
+
type AnalyticsSessionSeverityCounts = {
|
|
2970
|
+
success?: number;
|
|
2971
|
+
warning?: number;
|
|
2972
|
+
error?: number;
|
|
2973
|
+
};
|
|
2974
|
+
type AnalyticsLogMetrics = {
|
|
2975
|
+
/**
|
|
2976
|
+
* Total number of request logs in scope.
|
|
2977
|
+
*/
|
|
2978
|
+
total?: number;
|
|
2979
|
+
bySeverity?: AnalyticsSeverityCounts;
|
|
2980
|
+
/**
|
|
2981
|
+
* Share of error-severity logs among request logs.
|
|
2982
|
+
*/
|
|
2983
|
+
errorRate?: number;
|
|
2984
|
+
};
|
|
2985
|
+
type AnalyticsSessionMetrics = {
|
|
2986
|
+
/**
|
|
2987
|
+
* Total number of sessions in scope.
|
|
2988
|
+
*/
|
|
2989
|
+
total?: number;
|
|
2990
|
+
bySeverity?: AnalyticsSessionSeverityCounts;
|
|
2991
|
+
/**
|
|
2992
|
+
* Share of error outcome sessions among sessions.
|
|
2993
|
+
*/
|
|
2994
|
+
errorRate?: number;
|
|
2995
|
+
};
|
|
2996
|
+
type AnalyticsResolutionEfficiency = {
|
|
2997
|
+
/**
|
|
2998
|
+
* Average number of requests per session.
|
|
2999
|
+
*/
|
|
3000
|
+
requestsPerSession?: number;
|
|
3001
|
+
totalRequests?: number;
|
|
3002
|
+
totalSessions?: number;
|
|
3003
|
+
};
|
|
3004
|
+
type AnalyticsRequestTrendPoint = {
|
|
3005
|
+
/**
|
|
3006
|
+
* Week start instant (UTC).
|
|
3007
|
+
*/
|
|
3008
|
+
date?: string;
|
|
3009
|
+
total?: number;
|
|
3010
|
+
errors?: number;
|
|
3011
|
+
errorRate?: number;
|
|
3012
|
+
};
|
|
3013
|
+
type AnalyticsSessionTrendPoint = {
|
|
3014
|
+
/**
|
|
3015
|
+
* Week start instant (UTC).
|
|
3016
|
+
*/
|
|
3017
|
+
date?: string;
|
|
3018
|
+
totalSessions?: number;
|
|
3019
|
+
errorSessions?: number;
|
|
3020
|
+
errorRate?: number;
|
|
3021
|
+
};
|
|
3022
|
+
/**
|
|
3023
|
+
* Combined analytics payload for admin and partner dashboards.
|
|
3024
|
+
*/
|
|
3025
|
+
type AgentAnalyticsResponse = {
|
|
3026
|
+
requests?: AnalyticsLogMetrics;
|
|
3027
|
+
sessions?: AnalyticsSessionMetrics;
|
|
3028
|
+
resolutionEfficiency?: AnalyticsResolutionEfficiency;
|
|
3029
|
+
requestTrend?: Array<AnalyticsRequestTrendPoint>;
|
|
3030
|
+
sessionTrend?: Array<AnalyticsSessionTrendPoint>;
|
|
3031
|
+
};
|
|
3032
|
+
type AnalyticsPeriod = {
|
|
3033
|
+
/**
|
|
3034
|
+
* Human-readable period label (e.g. quarter name).
|
|
3035
|
+
*/
|
|
3036
|
+
label?: string;
|
|
3037
|
+
/**
|
|
3038
|
+
* Period start (inclusive), UTC.
|
|
3039
|
+
*/
|
|
3040
|
+
start?: string;
|
|
3041
|
+
/**
|
|
3042
|
+
* Period end (exclusive), UTC.
|
|
3043
|
+
*/
|
|
3044
|
+
end?: string;
|
|
3045
|
+
};
|
|
3046
|
+
type AgentExecutionSeries = {
|
|
3047
|
+
agentId?: string;
|
|
3048
|
+
/**
|
|
3049
|
+
* Execution counts per period, same order as `periods`.
|
|
3050
|
+
*/
|
|
3051
|
+
counts?: Array<number>;
|
|
3052
|
+
};
|
|
3053
|
+
type ExecutionsResponse = {
|
|
3054
|
+
/**
|
|
3055
|
+
* Time bucket used for periods and series (enum constant name).
|
|
3056
|
+
*/
|
|
3057
|
+
granularity?: 'QUARTER' | 'MONTH' | 'WEEK';
|
|
3058
|
+
periods?: Array<AnalyticsPeriod>;
|
|
3059
|
+
series?: Array<AgentExecutionSeries>;
|
|
3060
|
+
};
|
|
3061
|
+
type QParamSearchBody2 = QParamSearchBody;
|
|
3062
|
+
type McpServerUpsertBody = McpServerRequest;
|
|
3063
|
+
type TokenUpsertBody = TokenRequest;
|
|
3064
|
+
type OauthUpsertBody = OAuthRequest;
|
|
3065
|
+
type ToolUpsertBody = SlackNativeToolRequest | RagCustomNativeToolRequest | RagEmporixNativeToolRequest | TeamsNativeToolRequest;
|
|
3066
|
+
|
|
3067
|
+
/** Single-shot text generation request (`POST /texts`). Has `maxTokens`. */
|
|
3068
|
+
type TextRequest = TextGenerationRequest;
|
|
3069
|
+
/**
|
|
3070
|
+
* Text generation response — `{ id?, result }`. The upstream schema marks
|
|
3071
|
+
* `result` optional, but a 2xx text generation always returns it; the public
|
|
3072
|
+
* contract guarantees `result` so callers need not null-check.
|
|
3073
|
+
*/
|
|
3074
|
+
interface TextResponse {
|
|
3075
|
+
id?: string;
|
|
3076
|
+
result: string;
|
|
3077
|
+
}
|
|
3078
|
+
/** One message in a completion request. `role` ∈ `USER | SYSTEM | ASSISTANT`. */
|
|
3079
|
+
type CompletionMessage = CompletionRequest$1["messages"][number];
|
|
3080
|
+
/** Chat completion request (`POST /completions`). No `maxTokens` (server-fixed model). */
|
|
3081
|
+
type CompletionRequest = CompletionRequest$1;
|
|
3082
|
+
/** Chat completion response — `{ id?, result }` (shares the text generation shape). */
|
|
3083
|
+
interface CompletionResponse {
|
|
3084
|
+
id?: string;
|
|
3085
|
+
result: string;
|
|
3086
|
+
}
|
|
3087
|
+
/** An agentic agent definition (the read/response shape, returned by every agent method). */
|
|
3088
|
+
type Agent = AgentResponse;
|
|
3089
|
+
/** The write shape for {@link AiService.upsertAgent} (`PUT /agentic/agents/{id}`). */
|
|
3090
|
+
type AgentInput = AgentRequest;
|
|
3091
|
+
/**
|
|
3092
|
+
* One PATCH operation for `patchAgent`. `op` is the upstream UPPERCASE enum
|
|
3093
|
+
* (`ADD | REMOVE | REPLACE`) — NOT RFC-6902 lowercase. Passed verbatim.
|
|
3094
|
+
*/
|
|
3095
|
+
type AgentPatchOp = PatchRequest[number];
|
|
3096
|
+
/** Request body for `POST /agentic/agents/search` (`{ q? }`). */
|
|
3097
|
+
type AgentSearchQuery = QParamSearchBody;
|
|
2404
3098
|
/** Request body for `chat` / `chatAsync` — `{ agentId, message }`. */
|
|
2405
3099
|
type ChatRequest = AgenticRequest;
|
|
2406
3100
|
/**
|
|
@@ -2436,6 +3130,196 @@ interface ChatStreamOptions {
|
|
|
2436
3130
|
type Conversation = ConversationResponse;
|
|
2437
3131
|
/** Request body for `searchConversations` (`{ q? }`) — same shape as agent search. */
|
|
2438
3132
|
type ConversationSearchQuery = QParamSearchBody2;
|
|
3133
|
+
/** `{ id? }` — returned by an upsert on create (HTTP 201). */
|
|
3134
|
+
type Created = IdResponse;
|
|
3135
|
+
/**
|
|
3136
|
+
* One PATCH op for any agentic resource. `op` is the upstream UPPERCASE enum
|
|
3137
|
+
* (`ADD | REMOVE | REPLACE`) — NOT RFC-6902. Passed verbatim. Same shape as
|
|
3138
|
+
* {@link AgentPatchOp}.
|
|
3139
|
+
*/
|
|
3140
|
+
type AgenticPatchOp = PatchRequest[number];
|
|
3141
|
+
/** Query for a CRUD `list` (`q`/paging/sort/fields/expand). Extra keys pass through. */
|
|
3142
|
+
interface ListQuery {
|
|
3143
|
+
q?: string;
|
|
3144
|
+
pageSize?: number;
|
|
3145
|
+
pageNumber?: number;
|
|
3146
|
+
sort?: string;
|
|
3147
|
+
fields?: string;
|
|
3148
|
+
expand?: string;
|
|
3149
|
+
[key: string]: string | number | undefined;
|
|
3150
|
+
}
|
|
3151
|
+
/** Options for a CRUD `get`. */
|
|
3152
|
+
interface GetOptions {
|
|
3153
|
+
fields?: string;
|
|
3154
|
+
expand?: string;
|
|
3155
|
+
[key: string]: string | number | undefined;
|
|
3156
|
+
}
|
|
3157
|
+
/** Options for a mutating CRUD call (`upsert`/`delete`). */
|
|
3158
|
+
interface MutateOptions {
|
|
3159
|
+
/** Cascade even if the entity is referenced elsewhere (`?force=true`). */
|
|
3160
|
+
force?: boolean;
|
|
3161
|
+
}
|
|
3162
|
+
/** Body for any agentic `/search` endpoint. */
|
|
3163
|
+
interface SearchQuery {
|
|
3164
|
+
q?: string;
|
|
3165
|
+
}
|
|
3166
|
+
/** An OAuth 2.0 client-credentials configuration (read shape). */
|
|
3167
|
+
type OAuthConfig = OAuthResponse;
|
|
3168
|
+
/** Write shape for {@link AiService.oauths}`.upsert` (`OAuthRequest`). */
|
|
3169
|
+
type OAuthInput = OauthUpsertBody;
|
|
3170
|
+
/** One agentic tool (union of the native-tool response variants). */
|
|
3171
|
+
type Tool = NativeToolsResponse[number];
|
|
3172
|
+
/** Write shape for {@link AiService.tools}`.upsert`. */
|
|
3173
|
+
type ToolInput = ToolUpsertBody;
|
|
3174
|
+
/** A stored token (holds an OAuth client secret, referenced by OAuth configs). */
|
|
3175
|
+
type Token = TokenResponse;
|
|
3176
|
+
/** Write shape for {@link AiService.tokens}`.upsert`. */
|
|
3177
|
+
type TokenInput = TokenUpsertBody;
|
|
3178
|
+
/** An MCP-server configuration for the agentic layer. */
|
|
3179
|
+
type McpServer = McpServerResponse;
|
|
3180
|
+
/** Write shape for {@link AiService.mcpServers}`.upsert`. */
|
|
3181
|
+
type McpServerInput = McpServerUpsertBody;
|
|
3182
|
+
/** An async AI job (`IMPORT` / `EXPORT` / `AGENT_CHAT`) with status + result. */
|
|
3183
|
+
type Job = Job$1;
|
|
3184
|
+
/** An available agent template. */
|
|
3185
|
+
type AgentTemplate = AgentTemplateResponse;
|
|
3186
|
+
/** Body for {@link AiService.templates}`.clone` — the user prompt + overrides. */
|
|
3187
|
+
type AgentFromTemplate = AgentFromTemplateRequest;
|
|
3188
|
+
/** One agent request-log entry. */
|
|
3189
|
+
type AgentRequestLog = AgentRequestResponse;
|
|
3190
|
+
/** One agent session-log entry. */
|
|
3191
|
+
type AgentSessionLog = AgentSessionResponse;
|
|
3192
|
+
/** Aggregated agent analytics (request/session metrics, trends). */
|
|
3193
|
+
type AgentAnalytics = AgentAnalyticsResponse;
|
|
3194
|
+
/** Per-agent execution counts aligned to returned periods. */
|
|
3195
|
+
type AgentExecutions = ExecutionsResponse;
|
|
3196
|
+
/** Query for {@link AiService.analytics}`.get`. */
|
|
3197
|
+
interface AnalyticsQuery {
|
|
3198
|
+
/** Scope metrics to one agent; omit for tenant-wide aggregates. */
|
|
3199
|
+
agentId?: string;
|
|
3200
|
+
}
|
|
3201
|
+
/** Query for {@link AiService.analytics}`.executions` — `agentIds` is required. */
|
|
3202
|
+
interface ExecutionsQuery {
|
|
3203
|
+
/** Comma-separated agent IDs (no spaces, ≤100). */
|
|
3204
|
+
agentIds: string;
|
|
3205
|
+
/** Time bucket per period (UTC). */
|
|
3206
|
+
granularity?: "QUARTER" | "MONTH" | "WEEK";
|
|
3207
|
+
}
|
|
3208
|
+
/** Models available to the tenant, grouped by LLM provider. */
|
|
3209
|
+
type ProviderModels = ProviderModelsResponse;
|
|
3210
|
+
/** The set of commerce events an agent trigger can subscribe to. */
|
|
3211
|
+
type CommerceEvents = CommerceEventsResponse;
|
|
3212
|
+
/** Result of an attachment upload — `{ id?, sessionId? }`. */
|
|
3213
|
+
type Attachment = AttachmentResponse;
|
|
3214
|
+
/** Options for {@link AiService.uploadAttachment}. */
|
|
3215
|
+
interface AttachmentOptions {
|
|
3216
|
+
/**
|
|
3217
|
+
* Reuse a chat context — sent as the `session-id` header. Thread the
|
|
3218
|
+
* returned `sessionId` into chat calls to bind the file.
|
|
3219
|
+
*/
|
|
3220
|
+
sessionId?: string;
|
|
3221
|
+
}
|
|
3222
|
+
/** Base64+checksum export of agents with their components. */
|
|
3223
|
+
type AgentsExport = ExportResponse;
|
|
3224
|
+
/** Body for {@link AiService.exportAgents} — `{ agentIds }`. */
|
|
3225
|
+
type AgentsExportRequest = ExportRequest;
|
|
3226
|
+
/** Result of an agents import. */
|
|
3227
|
+
type AgentsImport = ImportResponse;
|
|
3228
|
+
/** Body for {@link AiService.importAgents} — `{ data, checksum }`. */
|
|
3229
|
+
type AgentsImportRequest = ImportRequest;
|
|
3230
|
+
|
|
3231
|
+
/**
|
|
3232
|
+
* A symmetric CRUD resource over an agentic sub-collection (`tools`,
|
|
3233
|
+
* `mcp-servers`, `tokens`, `oauths`). All six operations share the upstream
|
|
3234
|
+
* shape; only the base path and the Read/Write types differ. Server-side only
|
|
3235
|
+
* — every call defaults to the SERVICE (backend) token.
|
|
3236
|
+
*/
|
|
3237
|
+
declare class AgenticCrudResource<Read, Write> {
|
|
3238
|
+
private readonly ctx;
|
|
3239
|
+
private readonly path;
|
|
3240
|
+
constructor(ctx: ClientContext, path: string);
|
|
3241
|
+
private item;
|
|
3242
|
+
/** List the collection (`GET {path}`). Optional `q`/paging/sort/fields/expand. */
|
|
3243
|
+
list(query?: ListQuery, auth?: AuthContext): Promise<Read[]>;
|
|
3244
|
+
/** Structured search (`POST {path}/search`). Body is `{ q? }`. */
|
|
3245
|
+
search(query: SearchQuery, auth?: AuthContext): Promise<Read[]>;
|
|
3246
|
+
/** Retrieve one entry by id (`GET {path}/{id}`). */
|
|
3247
|
+
get(id: string, opts?: GetOptions, auth?: AuthContext): Promise<Read>;
|
|
3248
|
+
/**
|
|
3249
|
+
* Create-or-replace by id (`PUT {path}/{id}`). Resolves to `{ id }` on create
|
|
3250
|
+
* (HTTP 201) and `undefined` on update (HTTP 204). `{ force: true }`
|
|
3251
|
+
* cascade-disables dependents.
|
|
3252
|
+
*/
|
|
3253
|
+
upsert(id: string, body: Write, opts?: MutateOptions, auth?: AuthContext): Promise<Created | undefined>;
|
|
3254
|
+
/**
|
|
3255
|
+
* Partial update with an op array (`PATCH {path}/{id}`, 204). `ops` use the
|
|
3256
|
+
* upstream UPPERCASE enum (`ADD | REMOVE | REPLACE`), sent verbatim.
|
|
3257
|
+
*/
|
|
3258
|
+
patch(id: string, ops: AgenticPatchOp[], auth?: AuthContext): Promise<void>;
|
|
3259
|
+
/** Delete by id (`DELETE {path}/{id}`). `{ force: true }` removes even if referenced. */
|
|
3260
|
+
delete(id: string, opts?: MutateOptions, auth?: AuthContext): Promise<void>;
|
|
3261
|
+
}
|
|
3262
|
+
/**
|
|
3263
|
+
* AI async jobs (`/ai-service/{tenant}/jobs`). NOTE: not under `/agentic`.
|
|
3264
|
+
* `chatAsync` returns a `jobId`; poll/list/delete it here.
|
|
3265
|
+
*/
|
|
3266
|
+
declare class JobsResource {
|
|
3267
|
+
private readonly ctx;
|
|
3268
|
+
private readonly base;
|
|
3269
|
+
constructor(ctx: ClientContext, base: string);
|
|
3270
|
+
/** List jobs (`GET /jobs`). */
|
|
3271
|
+
list(query?: ListQuery, auth?: AuthContext): Promise<Job[]>;
|
|
3272
|
+
/** Structured job search (`POST /jobs/search`). */
|
|
3273
|
+
search(query: SearchQuery, auth?: AuthContext): Promise<Job[]>;
|
|
3274
|
+
/** Retrieve one job (`GET /jobs/{jobId}`). */
|
|
3275
|
+
get(jobId: string, auth?: AuthContext): Promise<Job>;
|
|
3276
|
+
/** Delete one job (`DELETE /jobs/{jobId}`). */
|
|
3277
|
+
delete(jobId: string, auth?: AuthContext): Promise<void>;
|
|
3278
|
+
}
|
|
3279
|
+
/** Agent templates (`/agentic/templates`). `list · search · clone`. */
|
|
3280
|
+
declare class TemplatesResource {
|
|
3281
|
+
private readonly ctx;
|
|
3282
|
+
private readonly path;
|
|
3283
|
+
constructor(ctx: ClientContext, path: string);
|
|
3284
|
+
/** List available templates (`GET /agentic/templates`). */
|
|
3285
|
+
list(query?: ListQuery, auth?: AuthContext): Promise<AgentTemplate[]>;
|
|
3286
|
+
/** Structured template search (`POST /agentic/templates/search`). */
|
|
3287
|
+
search(query: SearchQuery, auth?: AuthContext): Promise<AgentTemplate[]>;
|
|
3288
|
+
/**
|
|
3289
|
+
* Instantiate a new agent from a template
|
|
3290
|
+
* (`POST /agentic/templates/{templateId}/agents`, HTTP 201). Returns the
|
|
3291
|
+
* created agent's id.
|
|
3292
|
+
*/
|
|
3293
|
+
clone(templateId: string, body: AgentFromTemplate, auth?: AuthContext): Promise<Created>;
|
|
3294
|
+
}
|
|
3295
|
+
/** Agent logs (`/agentic/logs`): request logs and session logs. */
|
|
3296
|
+
declare class LogsResource {
|
|
3297
|
+
private readonly ctx;
|
|
3298
|
+
private readonly path;
|
|
3299
|
+
constructor(ctx: ClientContext, path: string);
|
|
3300
|
+
/** List request logs (`GET /agentic/logs/requests`). */
|
|
3301
|
+
listRequests(query?: ListQuery, auth?: AuthContext): Promise<AgentRequestLog[]>;
|
|
3302
|
+
/** Retrieve one request log (`GET /agentic/logs/requests/{requestId}`). */
|
|
3303
|
+
getRequest(requestId: string, auth?: AuthContext): Promise<AgentRequestLog>;
|
|
3304
|
+
/** Structured request-log search (`POST /agentic/logs/requests/search`). */
|
|
3305
|
+
searchRequests(query: SearchQuery, auth?: AuthContext): Promise<AgentRequestLog[]>;
|
|
3306
|
+
/** List session logs (`GET /agentic/logs/sessions`). */
|
|
3307
|
+
listSessions(query?: ListQuery, auth?: AuthContext): Promise<AgentSessionLog[]>;
|
|
3308
|
+
/** Retrieve one session log (`GET /agentic/logs/sessions/{sessionId}`). */
|
|
3309
|
+
getSession(sessionId: string, auth?: AuthContext): Promise<AgentSessionLog>;
|
|
3310
|
+
/** Structured session-log search (`POST /agentic/logs/sessions/search`). */
|
|
3311
|
+
searchSessions(query: SearchQuery, auth?: AuthContext): Promise<AgentSessionLog[]>;
|
|
3312
|
+
}
|
|
3313
|
+
/** Agent analytics (`/agentic/analytics`). */
|
|
3314
|
+
declare class AnalyticsResource {
|
|
3315
|
+
private readonly ctx;
|
|
3316
|
+
private readonly path;
|
|
3317
|
+
constructor(ctx: ClientContext, path: string);
|
|
3318
|
+
/** Aggregated metrics (`GET /agentic/analytics`); scope with `agentId`. */
|
|
3319
|
+
get(opts?: AnalyticsQuery, auth?: AuthContext): Promise<AgentAnalytics>;
|
|
3320
|
+
/** Per-agent execution counts (`GET /agentic/analytics/executions`). `agentIds` required. */
|
|
3321
|
+
executions(query: ExecutionsQuery, auth?: AuthContext): Promise<AgentExecutions>;
|
|
3322
|
+
}
|
|
2439
3323
|
|
|
2440
3324
|
/**
|
|
2441
3325
|
* Emporix AI Service (`/ai-service/{tenant}/…`): text generation, chat
|
|
@@ -2454,6 +3338,30 @@ declare class AiService {
|
|
|
2454
3338
|
static readonly channel: "ai";
|
|
2455
3339
|
constructor(ctx: ClientContext);
|
|
2456
3340
|
private base;
|
|
3341
|
+
private _oauths?;
|
|
3342
|
+
/** OAuth 2.0 client-credentials configs (`/agentic/oauths`). CRUD sub-resource. */
|
|
3343
|
+
get oauths(): AgenticCrudResource<OAuthConfig, OAuthInput>;
|
|
3344
|
+
private _tools?;
|
|
3345
|
+
/** Agentic tools (`/agentic/tools`). CRUD sub-resource. */
|
|
3346
|
+
get tools(): AgenticCrudResource<Tool, ToolInput>;
|
|
3347
|
+
private _tokens?;
|
|
3348
|
+
/** Stored tokens (`/agentic/tokens`) — an OAuth config's client secret. CRUD sub-resource. */
|
|
3349
|
+
get tokens(): AgenticCrudResource<Token, TokenInput>;
|
|
3350
|
+
private _mcpServers?;
|
|
3351
|
+
/** MCP-server configs (`/agentic/mcp-servers`). CRUD sub-resource. */
|
|
3352
|
+
get mcpServers(): AgenticCrudResource<McpServer, McpServerInput>;
|
|
3353
|
+
private _jobs?;
|
|
3354
|
+
/** AI async jobs (`/jobs`). `list · search · get · delete`. */
|
|
3355
|
+
get jobs(): JobsResource;
|
|
3356
|
+
private _templates?;
|
|
3357
|
+
/** Agent templates (`/agentic/templates`). `list · search · clone`. */
|
|
3358
|
+
get templates(): TemplatesResource;
|
|
3359
|
+
private _logs?;
|
|
3360
|
+
/** Agent logs (`/agentic/logs`): request + session logs. */
|
|
3361
|
+
get logs(): LogsResource;
|
|
3362
|
+
private _analytics?;
|
|
3363
|
+
/** Agent analytics (`/agentic/analytics`). `get · executions`. */
|
|
3364
|
+
get analytics(): AnalyticsResource;
|
|
2457
3365
|
/** Generate text from a single prompt (`POST /texts`). Honors `maxTokens`. */
|
|
2458
3366
|
generateText(input: TextRequest, auth?: AuthContext): Promise<TextResponse>;
|
|
2459
3367
|
/** Run a chat completion over a message list (`POST /completions`). No `maxTokens`. */
|
|
@@ -2498,6 +3406,21 @@ declare class AiService {
|
|
|
2498
3406
|
listConversations(auth?: AuthContext): Promise<Conversation[]>;
|
|
2499
3407
|
/** Server-side conversation search (`POST /agentic/conversations/search`). */
|
|
2500
3408
|
searchConversations(query: ConversationSearchQuery, auth?: AuthContext): Promise<Conversation[]>;
|
|
3409
|
+
/** List models available to the tenant, grouped by provider (`GET /agentic/models`). */
|
|
3410
|
+
listModels(auth?: AuthContext): Promise<ProviderModels[]>;
|
|
3411
|
+
/** List commerce events available to agent triggers (`GET /agentic/commerce-events`). */
|
|
3412
|
+
listCommerceEvents(auth?: AuthContext): Promise<CommerceEvents>;
|
|
3413
|
+
/**
|
|
3414
|
+
* Upload a chat attachment for an agent
|
|
3415
|
+
* (`POST /agentic/{agentId}/attachments`, multipart, HTTP 201). The response
|
|
3416
|
+
* `sessionId` must be threaded into subsequent chat calls to bind the file.
|
|
3417
|
+
* Pass `opts.sessionId` to attach to an existing session.
|
|
3418
|
+
*/
|
|
3419
|
+
uploadAttachment(agentId: string, attachment: Blob | File, opts?: AttachmentOptions, auth?: AuthContext): Promise<Attachment>;
|
|
3420
|
+
/** Export agents + components as a base64/checksum blob (`POST /agentic/agents/export`). */
|
|
3421
|
+
exportAgents(body: AgentsExportRequest, auth?: AuthContext): Promise<AgentsExport>;
|
|
3422
|
+
/** Import previously-exported agents (`POST /agentic/agents/import`). */
|
|
3423
|
+
importAgents(body: AgentsImportRequest, auth?: AuthContext): Promise<AgentsImport>;
|
|
2501
3424
|
}
|
|
2502
3425
|
|
|
2503
3426
|
type Metadata$7 = {
|
|
@@ -4488,7 +5411,7 @@ type Address$2 = {
|
|
|
4488
5411
|
/**
|
|
4489
5412
|
* Example quote response which contains a list of fees for various methods and delivery zone.
|
|
4490
5413
|
*/
|
|
4491
|
-
type QuoteResponse = Array<QuoteResponseItem>;
|
|
5414
|
+
type QuoteResponse$1 = Array<QuoteResponseItem>;
|
|
4492
5415
|
/**
|
|
4493
5416
|
* Example quote response which contains fee for specific method and zone.
|
|
4494
5417
|
*/
|
|
@@ -4592,7 +5515,7 @@ type CgRelationList = CgRelationList$1;
|
|
|
4592
5515
|
/** Body for `quote` / `quoteMinimum`. */
|
|
4593
5516
|
type QuoteInput = QuotePayload;
|
|
4594
5517
|
/** `quote` result. */
|
|
4595
|
-
type QuoteResult = QuoteResponse;
|
|
5518
|
+
type QuoteResult = QuoteResponse$1;
|
|
4596
5519
|
/** Body for `quoteSlot`. */
|
|
4597
5520
|
type QuoteSlotInput = QuoteSlot;
|
|
4598
5521
|
/** `quoteMinimum` / `quoteSlot` result. */
|
|
@@ -4730,6 +5653,1099 @@ declare class ShippingService {
|
|
|
4730
5653
|
generateDeliveryCycle(input: DeliveryCycleInput, auth?: AuthContext): Promise<string>;
|
|
4731
5654
|
}
|
|
4732
5655
|
|
|
5656
|
+
type JobRequest = {
|
|
5657
|
+
/**
|
|
5658
|
+
* A list of order IDs for which the invoices should be created.
|
|
5659
|
+
*/
|
|
5660
|
+
orderIds?: Array<string>;
|
|
5661
|
+
/**
|
|
5662
|
+
* A job type determines if the orders are searched automatically based on parameters configured in configuration service or are manually provided in orderIds array.
|
|
5663
|
+
*/
|
|
5664
|
+
jobType: 'AUTOMATIC' | 'MANUAL';
|
|
5665
|
+
};
|
|
5666
|
+
type JobCreationResponse = {
|
|
5667
|
+
/**
|
|
5668
|
+
* The created job ID.
|
|
5669
|
+
*/
|
|
5670
|
+
jobId?: string;
|
|
5671
|
+
};
|
|
5672
|
+
type JobStatusResponse = {
|
|
5673
|
+
/**
|
|
5674
|
+
* Status of the processed job. Possible values: `DONE`,` IN_PROGRESS`
|
|
5675
|
+
*/
|
|
5676
|
+
jobStatus?: 'DONE' | 'IN_PROGRESS';
|
|
5677
|
+
/**
|
|
5678
|
+
* Job type determines if the orders are provided manually or searched by a parametrized query.
|
|
5679
|
+
*/
|
|
5680
|
+
jobType?: 'AUTOMATIC' | 'MANUAL';
|
|
5681
|
+
orders?: Array<{
|
|
5682
|
+
/**
|
|
5683
|
+
* The ID of the processed order.
|
|
5684
|
+
*/
|
|
5685
|
+
orderId?: string;
|
|
5686
|
+
/**
|
|
5687
|
+
* Status determining if the order was processed successfully.
|
|
5688
|
+
*/
|
|
5689
|
+
orderStatus?: 'SUCCESS' | 'FAILURE' | 'PENDING';
|
|
5690
|
+
/**
|
|
5691
|
+
* Information about the result of order processing.
|
|
5692
|
+
*/
|
|
5693
|
+
message?: string;
|
|
5694
|
+
/**
|
|
5695
|
+
* URL to the generated invoice PDF.
|
|
5696
|
+
*/
|
|
5697
|
+
downloadLink?: string;
|
|
5698
|
+
/**
|
|
5699
|
+
* Number of the generated invoice.
|
|
5700
|
+
*/
|
|
5701
|
+
invoiceNumber?: string;
|
|
5702
|
+
}>;
|
|
5703
|
+
};
|
|
5704
|
+
|
|
5705
|
+
/** Input for {@link InvoiceService.createJob} — order ids + job type. */
|
|
5706
|
+
type InvoiceJobDraft = JobRequest;
|
|
5707
|
+
/** Result of creating an invoice job — `{ jobId? }`. */
|
|
5708
|
+
type InvoiceJobCreated = JobCreationResponse;
|
|
5709
|
+
/** Status of an invoice job + per-order results. */
|
|
5710
|
+
type InvoiceJob = JobStatusResponse;
|
|
5711
|
+
|
|
5712
|
+
/**
|
|
5713
|
+
* Invoice Service (`/invoice/{tenant}/…`): create invoice-generation jobs and
|
|
5714
|
+
* poll their status. Backend-only — default auth: service.
|
|
5715
|
+
*/
|
|
5716
|
+
declare class InvoiceService {
|
|
5717
|
+
private readonly ctx;
|
|
5718
|
+
static readonly channel: "invoice";
|
|
5719
|
+
constructor(ctx: ClientContext);
|
|
5720
|
+
private base;
|
|
5721
|
+
/** Create an invoice-generation job (`POST …/jobs/invoices`, 201). */
|
|
5722
|
+
createJob(draft: InvoiceJobDraft, auth?: AuthContext): Promise<InvoiceJobCreated>;
|
|
5723
|
+
/** Retrieve a job and its per-order results (`GET …/jobs/invoices/{jobId}`). */
|
|
5724
|
+
getJob(jobId: string, auth?: AuthContext): Promise<InvoiceJob>;
|
|
5725
|
+
}
|
|
5726
|
+
|
|
5727
|
+
/**
|
|
5728
|
+
* Access control identifier that determines who can view or manage the quotes.
|
|
5729
|
+
*
|
|
5730
|
+
* **Purpose**: Restricts quote visibility based on scope permissions. Only users/applications
|
|
5731
|
+
* with matching restriction scopes can access quotes with a specific restriction value.
|
|
5732
|
+
*
|
|
5733
|
+
* **Access Control**:
|
|
5734
|
+
* - *Reading*: Users can only query and view quotes with the `restriction` value that matches one of their authorized restrictions.
|
|
5735
|
+
*
|
|
5736
|
+
* **Validation**: The value must exist in the tenant's configured list of valid restrictions.
|
|
5737
|
+
*
|
|
5738
|
+
* **Restriction Synchronization**:
|
|
5739
|
+
* - If quote is created by a customer (based on a cart) and `restriction` property is not set, the `restriction` value of quote is inherited from customer's restriction.
|
|
5740
|
+
* - If a quote is created by an employee and the `restriction` property is not set with tenant configuration property `enableSyncBetweenRestrictionsAndSiteCodes` set to `true`, the `restriction` field automatically syncs with quote's siteCode property.
|
|
5741
|
+
*
|
|
5742
|
+
*/
|
|
5743
|
+
type Restriction$1 = string | null;
|
|
5744
|
+
/**
|
|
5745
|
+
* Price details
|
|
5746
|
+
*/
|
|
5747
|
+
type QuoteItemUpdatePriceRow = {
|
|
5748
|
+
/**
|
|
5749
|
+
* The ID of the matched price
|
|
5750
|
+
*/
|
|
5751
|
+
priceId?: string;
|
|
5752
|
+
/**
|
|
5753
|
+
* The effective unit price of the product
|
|
5754
|
+
*/
|
|
5755
|
+
unitePrice?: number;
|
|
5756
|
+
/**
|
|
5757
|
+
* The total net value for the entire quantity of the item.
|
|
5758
|
+
*/
|
|
5759
|
+
totalNetValue?: number;
|
|
5760
|
+
/**
|
|
5761
|
+
* The tax information of the item.
|
|
5762
|
+
*/
|
|
5763
|
+
tax: {
|
|
5764
|
+
/**
|
|
5765
|
+
* The matched tax class of the item.
|
|
5766
|
+
*/
|
|
5767
|
+
taxClass: string;
|
|
5768
|
+
/**
|
|
5769
|
+
* The tax rate of the item.
|
|
5770
|
+
*/
|
|
5771
|
+
taxRate?: number;
|
|
5772
|
+
};
|
|
5773
|
+
};
|
|
5774
|
+
/**
|
|
5775
|
+
* Quote status.
|
|
5776
|
+
*/
|
|
5777
|
+
type QuoteUpdateStatus = {
|
|
5778
|
+
/**
|
|
5779
|
+
* The status value of the code.
|
|
5780
|
+
*/
|
|
5781
|
+
value: string;
|
|
5782
|
+
/**
|
|
5783
|
+
* The comment to the status.
|
|
5784
|
+
*/
|
|
5785
|
+
comment?: string;
|
|
5786
|
+
/**
|
|
5787
|
+
* The ID of the quote reason. Can be provided only in following scenarios:
|
|
5788
|
+
* - when changing state from OPEN to IN_PROGRESS - quote reason has to be of CHANGE type
|
|
5789
|
+
* - when changing state from OPEN to DECLINED - quote reason has to be of DECLINE type
|
|
5790
|
+
* - when changing state from IN_PROGRESS to DECLINED_BY_MERCHANT - quote reason has to be of DECLINE type
|
|
5791
|
+
*/
|
|
5792
|
+
quoteReasonId?: string;
|
|
5793
|
+
};
|
|
5794
|
+
/**
|
|
5795
|
+
* ID of the generated quote.
|
|
5796
|
+
*/
|
|
5797
|
+
type QuoteIdResponse = {
|
|
5798
|
+
/**
|
|
5799
|
+
* ID of the generated document.
|
|
5800
|
+
*/
|
|
5801
|
+
id?: string;
|
|
5802
|
+
};
|
|
5803
|
+
/**
|
|
5804
|
+
* ID of the generated quote reason.
|
|
5805
|
+
*/
|
|
5806
|
+
type QuoteReasonIdResponse = {
|
|
5807
|
+
/**
|
|
5808
|
+
* ID of the generated document.
|
|
5809
|
+
*/
|
|
5810
|
+
id?: string;
|
|
5811
|
+
};
|
|
5812
|
+
/**
|
|
5813
|
+
* TotalNetValue item model.
|
|
5814
|
+
*/
|
|
5815
|
+
type QuoteItemUpdatePrice = {
|
|
5816
|
+
totalNetValue?: number;
|
|
5817
|
+
};
|
|
5818
|
+
/**
|
|
5819
|
+
* Quote item model.
|
|
5820
|
+
*/
|
|
5821
|
+
type QuoteItemUpdate = {
|
|
5822
|
+
quantity: {
|
|
5823
|
+
quantity?: number;
|
|
5824
|
+
unitCode?: string;
|
|
5825
|
+
};
|
|
5826
|
+
price: QuoteItemUpdatePriceRow;
|
|
5827
|
+
product: {
|
|
5828
|
+
productId?: string;
|
|
5829
|
+
};
|
|
5830
|
+
};
|
|
5831
|
+
/**
|
|
5832
|
+
* Quote item ID.
|
|
5833
|
+
*/
|
|
5834
|
+
type QuoteItemsReplaceUpdate = Array<QuoteItemUpdate & {
|
|
5835
|
+
/**
|
|
5836
|
+
* ID of the item. It's generated automatically when it's not provided.
|
|
5837
|
+
*/
|
|
5838
|
+
itemId?: string;
|
|
5839
|
+
}>;
|
|
5840
|
+
type AddressResponse = {
|
|
5841
|
+
/**
|
|
5842
|
+
* The ID of the address.
|
|
5843
|
+
*/
|
|
5844
|
+
id?: string;
|
|
5845
|
+
/**
|
|
5846
|
+
* The name of the address.
|
|
5847
|
+
*/
|
|
5848
|
+
name?: string;
|
|
5849
|
+
/**
|
|
5850
|
+
* First line of the address.
|
|
5851
|
+
*/
|
|
5852
|
+
addressLine1?: string;
|
|
5853
|
+
/**
|
|
5854
|
+
* Second line of the address.
|
|
5855
|
+
*/
|
|
5856
|
+
addressLine2?: string;
|
|
5857
|
+
/**
|
|
5858
|
+
* City name.
|
|
5859
|
+
*/
|
|
5860
|
+
city?: string;
|
|
5861
|
+
/**
|
|
5862
|
+
* The postal code of the city.
|
|
5863
|
+
*/
|
|
5864
|
+
postcode?: string;
|
|
5865
|
+
/**
|
|
5866
|
+
* The state where the city is located.
|
|
5867
|
+
*/
|
|
5868
|
+
state?: string;
|
|
5869
|
+
/**
|
|
5870
|
+
* The code of the country location.
|
|
5871
|
+
*/
|
|
5872
|
+
countryCode?: string;
|
|
5873
|
+
};
|
|
5874
|
+
type QuoteReasonResponse = {
|
|
5875
|
+
/**
|
|
5876
|
+
* The quote reason ID.
|
|
5877
|
+
*/
|
|
5878
|
+
id?: string;
|
|
5879
|
+
/**
|
|
5880
|
+
* Type of the quote reason.
|
|
5881
|
+
*/
|
|
5882
|
+
type?: 'CHANGE' | 'DECLINE';
|
|
5883
|
+
/**
|
|
5884
|
+
* Localized message - can be either string or map with languages as map's keys accordingly to specified 'Accept-Language' header.
|
|
5885
|
+
*/
|
|
5886
|
+
message?: {
|
|
5887
|
+
[key: string]: string;
|
|
5888
|
+
} | string;
|
|
5889
|
+
/**
|
|
5890
|
+
* Code of the reason for the quote status change.
|
|
5891
|
+
*/
|
|
5892
|
+
code?: string;
|
|
5893
|
+
/**
|
|
5894
|
+
* The Quote Reason metadata details.
|
|
5895
|
+
*/
|
|
5896
|
+
metadata?: {
|
|
5897
|
+
/**
|
|
5898
|
+
* Version of the quote reason that is used for the optimistic locking handling.
|
|
5899
|
+
*/
|
|
5900
|
+
version?: number;
|
|
5901
|
+
/**
|
|
5902
|
+
* The Quote Reason creation timestamp.
|
|
5903
|
+
*/
|
|
5904
|
+
createdAt?: string;
|
|
5905
|
+
/**
|
|
5906
|
+
* The Quote Reason modification timestamp.
|
|
5907
|
+
*/
|
|
5908
|
+
modifiedAt?: string;
|
|
5909
|
+
};
|
|
5910
|
+
};
|
|
5911
|
+
type QuoteResponse = {
|
|
5912
|
+
/**
|
|
5913
|
+
* Quote ID
|
|
5914
|
+
*
|
|
5915
|
+
* **NOTE**:
|
|
5916
|
+
* If not specified during creation, this attribute is automatically generated. It is also possible to assign a custom ID.
|
|
5917
|
+
*/
|
|
5918
|
+
id?: string;
|
|
5919
|
+
/**
|
|
5920
|
+
* Business model of the quote.
|
|
5921
|
+
*/
|
|
5922
|
+
businessModel?: 'B2B' | 'B2C';
|
|
5923
|
+
/**
|
|
5924
|
+
* Customer-provided reference stored on the quote.
|
|
5925
|
+
*/
|
|
5926
|
+
customerReference?: string;
|
|
5927
|
+
/**
|
|
5928
|
+
* Customer-provided comment stored on the quote.
|
|
5929
|
+
*/
|
|
5930
|
+
customerComment?: string;
|
|
5931
|
+
/**
|
|
5932
|
+
* This attribute contains details about the customer for whom the quote was created.
|
|
5933
|
+
*/
|
|
5934
|
+
customer?: {
|
|
5935
|
+
/**
|
|
5936
|
+
* The ID of the customer for whom the quote was created.
|
|
5937
|
+
*/
|
|
5938
|
+
customerId?: string;
|
|
5939
|
+
/**
|
|
5940
|
+
* Customer's first name
|
|
5941
|
+
*
|
|
5942
|
+
* **NOTE**:
|
|
5943
|
+
* This attribute is filled automatically after the quote is created.
|
|
5944
|
+
*/
|
|
5945
|
+
firstName?: string;
|
|
5946
|
+
/**
|
|
5947
|
+
* Customer's last name
|
|
5948
|
+
*
|
|
5949
|
+
* **NOTE**:
|
|
5950
|
+
* This attribute is filled automatically after the quote is created.
|
|
5951
|
+
*/
|
|
5952
|
+
lastName?: string;
|
|
5953
|
+
/**
|
|
5954
|
+
* Customer's contact email
|
|
5955
|
+
*
|
|
5956
|
+
* **NOTE**:
|
|
5957
|
+
* This attribute is filled automatically after the quote is created.
|
|
5958
|
+
*/
|
|
5959
|
+
contactEmail?: string;
|
|
5960
|
+
};
|
|
5961
|
+
/**
|
|
5962
|
+
* This attribute contains details about the employee that is processing the quote.
|
|
5963
|
+
*/
|
|
5964
|
+
employee?: {
|
|
5965
|
+
/**
|
|
5966
|
+
* The ID of the employee that is processing the quote.
|
|
5967
|
+
*/
|
|
5968
|
+
employeeId?: string;
|
|
5969
|
+
/**
|
|
5970
|
+
* Employee's first name
|
|
5971
|
+
*
|
|
5972
|
+
* **NOTE**:
|
|
5973
|
+
* This attribute is filled automatically after the quote is created or the employee ID is updated.
|
|
5974
|
+
*/
|
|
5975
|
+
firstName?: string;
|
|
5976
|
+
/**
|
|
5977
|
+
* Employee's last name.
|
|
5978
|
+
*
|
|
5979
|
+
* **NOTE**:
|
|
5980
|
+
* This attribute is filled automatically after the quote is created or the employee ID is updated.
|
|
5981
|
+
*/
|
|
5982
|
+
lastName?: string;
|
|
5983
|
+
};
|
|
5984
|
+
/**
|
|
5985
|
+
* The ID of the cart from which the quote was created (not available when the quote was created manually)
|
|
5986
|
+
*/
|
|
5987
|
+
cartId?: string;
|
|
5988
|
+
/**
|
|
5989
|
+
* The company for which the quote was created.
|
|
5990
|
+
*/
|
|
5991
|
+
company?: {
|
|
5992
|
+
/**
|
|
5993
|
+
* The company name for which the quote was created.
|
|
5994
|
+
*/
|
|
5995
|
+
name?: string;
|
|
5996
|
+
};
|
|
5997
|
+
/**
|
|
5998
|
+
* The site code for which the quote was created
|
|
5999
|
+
*/
|
|
6000
|
+
siteCode?: string;
|
|
6001
|
+
/**
|
|
6002
|
+
* The ID of the order which was created based on the quote. The order is created and assigned to the quote when status of the quote transitions to `ACCEPTED`.
|
|
6003
|
+
*/
|
|
6004
|
+
orderId?: string;
|
|
6005
|
+
/**
|
|
6006
|
+
* The currency of the quote prices.
|
|
6007
|
+
*/
|
|
6008
|
+
currency?: string;
|
|
6009
|
+
/**
|
|
6010
|
+
* The status of the quote.
|
|
6011
|
+
*/
|
|
6012
|
+
status?: {
|
|
6013
|
+
/**
|
|
6014
|
+
* The status value of the quote.
|
|
6015
|
+
*/
|
|
6016
|
+
value?: string;
|
|
6017
|
+
/**
|
|
6018
|
+
* Comment relating to the status.
|
|
6019
|
+
*/
|
|
6020
|
+
comment?: string;
|
|
6021
|
+
quoteReason?: QuoteReasonResponse & {
|
|
6022
|
+
[key: string]: unknown;
|
|
6023
|
+
};
|
|
6024
|
+
};
|
|
6025
|
+
/**
|
|
6026
|
+
* The date until which the quote is valid and can be accepted by the customer.
|
|
6027
|
+
*/
|
|
6028
|
+
validTo?: string;
|
|
6029
|
+
/**
|
|
6030
|
+
* Employee and customer comments.
|
|
6031
|
+
*/
|
|
6032
|
+
comment?: {
|
|
6033
|
+
/**
|
|
6034
|
+
* Employee comment
|
|
6035
|
+
*/
|
|
6036
|
+
employeeComment?: string;
|
|
6037
|
+
};
|
|
6038
|
+
billingAddress?: AddressResponse;
|
|
6039
|
+
shippingAddress?: AddressResponse;
|
|
6040
|
+
/**
|
|
6041
|
+
* The calculated total price details.
|
|
6042
|
+
*/
|
|
6043
|
+
totalPrice?: {
|
|
6044
|
+
/**
|
|
6045
|
+
* Currency of the value.
|
|
6046
|
+
*/
|
|
6047
|
+
currency?: string;
|
|
6048
|
+
/**
|
|
6049
|
+
* The total net value.
|
|
6050
|
+
*/
|
|
6051
|
+
netValue?: number;
|
|
6052
|
+
/**
|
|
6053
|
+
* The total gross value.
|
|
6054
|
+
*/
|
|
6055
|
+
grossValue?: number;
|
|
6056
|
+
/**
|
|
6057
|
+
* The amount of the tax for the total price.
|
|
6058
|
+
*/
|
|
6059
|
+
taxValue?: number;
|
|
6060
|
+
};
|
|
6061
|
+
/**
|
|
6062
|
+
* The calculated quote subtotal price.
|
|
6063
|
+
*/
|
|
6064
|
+
subtotalPrice?: {
|
|
6065
|
+
/**
|
|
6066
|
+
* Currency of the value.
|
|
6067
|
+
*/
|
|
6068
|
+
currency?: string;
|
|
6069
|
+
/**
|
|
6070
|
+
* The subtotal net value.
|
|
6071
|
+
*/
|
|
6072
|
+
netValue?: number;
|
|
6073
|
+
/**
|
|
6074
|
+
* The subtotal gross value.
|
|
6075
|
+
*/
|
|
6076
|
+
grossValue?: number;
|
|
6077
|
+
/**
|
|
6078
|
+
* The subtotal tax value.
|
|
6079
|
+
*/
|
|
6080
|
+
taxValue?: number;
|
|
6081
|
+
};
|
|
6082
|
+
/**
|
|
6083
|
+
* Tax aggregation of the total price.
|
|
6084
|
+
*/
|
|
6085
|
+
taxAggregate?: {
|
|
6086
|
+
lines?: Array<{
|
|
6087
|
+
/**
|
|
6088
|
+
* The tax code.
|
|
6089
|
+
*/
|
|
6090
|
+
name?: string;
|
|
6091
|
+
/**
|
|
6092
|
+
* The amount of the tax.
|
|
6093
|
+
*/
|
|
6094
|
+
amount?: number;
|
|
6095
|
+
/**
|
|
6096
|
+
* The tax rate.
|
|
6097
|
+
*/
|
|
6098
|
+
rate?: number;
|
|
6099
|
+
/**
|
|
6100
|
+
* The total taxable amount.
|
|
6101
|
+
*/
|
|
6102
|
+
taxable?: number;
|
|
6103
|
+
}>;
|
|
6104
|
+
};
|
|
6105
|
+
shipping?: QuoteShipping & {
|
|
6106
|
+
/**
|
|
6107
|
+
* Gross value of the shipping cost.
|
|
6108
|
+
*/
|
|
6109
|
+
grossValue?: number;
|
|
6110
|
+
/**
|
|
6111
|
+
* Localized name of the shipping method selected by the customer.
|
|
6112
|
+
*/
|
|
6113
|
+
methodName?: {
|
|
6114
|
+
[key: string]: string;
|
|
6115
|
+
};
|
|
6116
|
+
};
|
|
6117
|
+
/**
|
|
6118
|
+
* A list of quote items.
|
|
6119
|
+
*/
|
|
6120
|
+
items?: Array<{
|
|
6121
|
+
/**
|
|
6122
|
+
* The ID of the quote item used for patch operations on the item.
|
|
6123
|
+
*/
|
|
6124
|
+
id?: string;
|
|
6125
|
+
/**
|
|
6126
|
+
* The attribute contains details about the item quantity.
|
|
6127
|
+
*/
|
|
6128
|
+
quantity?: {
|
|
6129
|
+
/**
|
|
6130
|
+
* The quantity of the item that is used for the price calculation.
|
|
6131
|
+
*/
|
|
6132
|
+
quantity?: number;
|
|
6133
|
+
/**
|
|
6134
|
+
* The unit code of the quantity (it must be one of the units defined in the Unit Handling Service).
|
|
6135
|
+
*/
|
|
6136
|
+
unitCode?: string;
|
|
6137
|
+
};
|
|
6138
|
+
/**
|
|
6139
|
+
* Item price details.
|
|
6140
|
+
*/
|
|
6141
|
+
price?: {
|
|
6142
|
+
/**
|
|
6143
|
+
* Defines if product is external or internal. If the product is internal, it's taken from the Emporix Product Service. If the price is external, it's a custom product from external system.
|
|
6144
|
+
*/
|
|
6145
|
+
type?: 'INTERNAL' | 'EXTERNAL';
|
|
6146
|
+
/**
|
|
6147
|
+
* The ID of the price that was initially assigned to the item.
|
|
6148
|
+
*/
|
|
6149
|
+
priceId?: string;
|
|
6150
|
+
/**
|
|
6151
|
+
* The original unit price of the item that is copied from the initial price.
|
|
6152
|
+
*/
|
|
6153
|
+
unitPrice?: number;
|
|
6154
|
+
/**
|
|
6155
|
+
* The new unit price that is auto-calculated based on provided `quantity` and `totalNetValue` values.
|
|
6156
|
+
*/
|
|
6157
|
+
newUnitPrice?: number;
|
|
6158
|
+
/**
|
|
6159
|
+
* The difference in percentage between `unitPrice` and `newUnitPrice`.
|
|
6160
|
+
*/
|
|
6161
|
+
discount?: number;
|
|
6162
|
+
/**
|
|
6163
|
+
* The total net price of the item that is initially based on the provided price, but it can be overridden to allow for a merchant discount.
|
|
6164
|
+
*/
|
|
6165
|
+
totalNetValue?: number;
|
|
6166
|
+
/**
|
|
6167
|
+
* This attribute contains information about the calculated item tax.
|
|
6168
|
+
*/
|
|
6169
|
+
tax?: {
|
|
6170
|
+
/**
|
|
6171
|
+
* The tax class assigned to the item is initially copied from the initial price.
|
|
6172
|
+
*/
|
|
6173
|
+
taxClass?: string;
|
|
6174
|
+
/**
|
|
6175
|
+
* The tax rate that is copied from the initial price.
|
|
6176
|
+
*/
|
|
6177
|
+
taxRate?: number;
|
|
6178
|
+
/**
|
|
6179
|
+
* The auto-calculated item net and gross prices
|
|
6180
|
+
*/
|
|
6181
|
+
prices?: {
|
|
6182
|
+
grossValue?: number;
|
|
6183
|
+
netValue?: number;
|
|
6184
|
+
};
|
|
6185
|
+
};
|
|
6186
|
+
/**
|
|
6187
|
+
* Mixins request.
|
|
6188
|
+
*/
|
|
6189
|
+
mixins?: {
|
|
6190
|
+
[key: string]: unknown;
|
|
6191
|
+
};
|
|
6192
|
+
/**
|
|
6193
|
+
* Metadata request.
|
|
6194
|
+
*/
|
|
6195
|
+
metadata?: {
|
|
6196
|
+
/**
|
|
6197
|
+
* Links to the mixin schemas.
|
|
6198
|
+
*/
|
|
6199
|
+
mixins?: {
|
|
6200
|
+
[key: string]: unknown;
|
|
6201
|
+
};
|
|
6202
|
+
};
|
|
6203
|
+
};
|
|
6204
|
+
/**
|
|
6205
|
+
* Product details.
|
|
6206
|
+
*/
|
|
6207
|
+
product?: {
|
|
6208
|
+
/**
|
|
6209
|
+
* Defines if product is external or internal. If the product is internal, it's taken from the Emporix Product Service. If the price is external, it's a custom product from external system.
|
|
6210
|
+
*/
|
|
6211
|
+
type?: 'INTERNAL' | 'EXTERNAL';
|
|
6212
|
+
/**
|
|
6213
|
+
* The ID of the product or variant assigned to the quote item.
|
|
6214
|
+
*/
|
|
6215
|
+
productId?: string;
|
|
6216
|
+
/**
|
|
6217
|
+
* This attribute contains the product name language map.
|
|
6218
|
+
*
|
|
6219
|
+
* **NOTE**:
|
|
6220
|
+
* After the item has been added to the quote, the product name language map attribute is automatically populated.
|
|
6221
|
+
*/
|
|
6222
|
+
name?: {
|
|
6223
|
+
[key: string]: unknown;
|
|
6224
|
+
};
|
|
6225
|
+
/**
|
|
6226
|
+
* This attribute comprises the product media information and is automatically populated upon the creation of the quote.
|
|
6227
|
+
*/
|
|
6228
|
+
media?: {
|
|
6229
|
+
/**
|
|
6230
|
+
* ID of the media.
|
|
6231
|
+
*/
|
|
6232
|
+
id?: string;
|
|
6233
|
+
/**
|
|
6234
|
+
* The content type of the media. For example: `image/jpg`.
|
|
6235
|
+
*/
|
|
6236
|
+
contentType?: string;
|
|
6237
|
+
/**
|
|
6238
|
+
* The url to the product media.
|
|
6239
|
+
*/
|
|
6240
|
+
url?: string;
|
|
6241
|
+
};
|
|
6242
|
+
/**
|
|
6243
|
+
* Map of key-value pairs that associates tax classes with locations (countries).
|
|
6244
|
+
*/
|
|
6245
|
+
taxClasses?: {
|
|
6246
|
+
[key: string]: unknown;
|
|
6247
|
+
};
|
|
6248
|
+
/**
|
|
6249
|
+
* Mixins request.
|
|
6250
|
+
*/
|
|
6251
|
+
mixins?: {
|
|
6252
|
+
[key: string]: unknown;
|
|
6253
|
+
};
|
|
6254
|
+
/**
|
|
6255
|
+
* Metadata request.
|
|
6256
|
+
*/
|
|
6257
|
+
metadata?: {
|
|
6258
|
+
/**
|
|
6259
|
+
* Links to the mixin schemas.
|
|
6260
|
+
*/
|
|
6261
|
+
mixins?: {
|
|
6262
|
+
[key: string]: unknown;
|
|
6263
|
+
};
|
|
6264
|
+
};
|
|
6265
|
+
};
|
|
6266
|
+
}>;
|
|
6267
|
+
/**
|
|
6268
|
+
* Mixins request.
|
|
6269
|
+
*/
|
|
6270
|
+
mixins?: {
|
|
6271
|
+
[key: string]: unknown;
|
|
6272
|
+
};
|
|
6273
|
+
/**
|
|
6274
|
+
* Quote metadata details.
|
|
6275
|
+
*/
|
|
6276
|
+
metadata?: {
|
|
6277
|
+
/**
|
|
6278
|
+
* Links to the mixin schemas.
|
|
6279
|
+
*/
|
|
6280
|
+
mixins?: {
|
|
6281
|
+
[key: string]: unknown;
|
|
6282
|
+
};
|
|
6283
|
+
/**
|
|
6284
|
+
* Version of the quote that is used for the optimistic locking handling.
|
|
6285
|
+
*/
|
|
6286
|
+
version?: number;
|
|
6287
|
+
/**
|
|
6288
|
+
* Quote creation timestamp.
|
|
6289
|
+
*/
|
|
6290
|
+
createdAt?: string;
|
|
6291
|
+
/**
|
|
6292
|
+
* Quote modification timestamp.
|
|
6293
|
+
*/
|
|
6294
|
+
modifiedAt?: string;
|
|
6295
|
+
};
|
|
6296
|
+
restriction?: Restriction$1;
|
|
6297
|
+
};
|
|
6298
|
+
/**
|
|
6299
|
+
* The schema specifies the attributes that must be provided when creating a quote reason.
|
|
6300
|
+
*/
|
|
6301
|
+
type QuoteReasonCreateRequest = {
|
|
6302
|
+
/**
|
|
6303
|
+
* The ID for a quote reason can either be manually provided at the time of the quote reason creation, or is automatically generated if not provided.
|
|
6304
|
+
*/
|
|
6305
|
+
id?: string;
|
|
6306
|
+
/**
|
|
6307
|
+
* Type of the quote reason.
|
|
6308
|
+
*/
|
|
6309
|
+
type: 'CHANGE' | 'DECLINE';
|
|
6310
|
+
/**
|
|
6311
|
+
* Code of the reason for the quote status change.
|
|
6312
|
+
*/
|
|
6313
|
+
code: string;
|
|
6314
|
+
/**
|
|
6315
|
+
* Localized message in the form of a map of translations.
|
|
6316
|
+
*/
|
|
6317
|
+
message: {
|
|
6318
|
+
[key: string]: string;
|
|
6319
|
+
};
|
|
6320
|
+
};
|
|
6321
|
+
/**
|
|
6322
|
+
* The schema specifies the attributes that must be provided when creating a quote reason.
|
|
6323
|
+
*/
|
|
6324
|
+
type QuoteReasonUpdateRequest = {
|
|
6325
|
+
/**
|
|
6326
|
+
* Type of the quote reason.
|
|
6327
|
+
*/
|
|
6328
|
+
type: 'CHANGE' | 'DECLINE';
|
|
6329
|
+
/**
|
|
6330
|
+
* Code of the reason for the quote status change.
|
|
6331
|
+
*/
|
|
6332
|
+
code: string;
|
|
6333
|
+
/**
|
|
6334
|
+
* Localized message in the form of a map of translations.
|
|
6335
|
+
*/
|
|
6336
|
+
message: {
|
|
6337
|
+
[key: string]: string;
|
|
6338
|
+
};
|
|
6339
|
+
/**
|
|
6340
|
+
* The Quote Reason metadata details
|
|
6341
|
+
*/
|
|
6342
|
+
metadata: {
|
|
6343
|
+
/**
|
|
6344
|
+
* Version of the quote reason that is used for the optimistic locking handling
|
|
6345
|
+
*/
|
|
6346
|
+
version: number;
|
|
6347
|
+
};
|
|
6348
|
+
};
|
|
6349
|
+
/**
|
|
6350
|
+
* The schema specifies the attributes that must be provided when creating a quote manually.
|
|
6351
|
+
*/
|
|
6352
|
+
type QuoteCreateRequest = {
|
|
6353
|
+
/**
|
|
6354
|
+
* The ID for a quote can either be manually provided at the time of the quote creation, or is automatically generated if not provided.
|
|
6355
|
+
*/
|
|
6356
|
+
id?: string;
|
|
6357
|
+
/**
|
|
6358
|
+
* The customer ID for which the new quote is created. Either this attribute or the `customerEmail` attribute is required for the quote creation
|
|
6359
|
+
*/
|
|
6360
|
+
customerId: string;
|
|
6361
|
+
/**
|
|
6362
|
+
* The employee ID for which the new quote is created. By default, the employeeId is taken from session token, but in case the session token is not provided, employeeId is taken from the payload. Default employee from the configuration will be assigned to the quote in case session token nor 'employeeId' is not provided.
|
|
6363
|
+
*/
|
|
6364
|
+
employeeId?: string;
|
|
6365
|
+
/**
|
|
6366
|
+
* The name of the merchant company.
|
|
6367
|
+
*/
|
|
6368
|
+
companyName?: string;
|
|
6369
|
+
/**
|
|
6370
|
+
* The site code for which the quote is created.
|
|
6371
|
+
*/
|
|
6372
|
+
siteCode: string;
|
|
6373
|
+
/**
|
|
6374
|
+
* The currency for which the quote is created.
|
|
6375
|
+
*/
|
|
6376
|
+
currency: string;
|
|
6377
|
+
/**
|
|
6378
|
+
* For B2B customers, it represents the location which should specify the billing address. For B2C customers, it represents identifier of customer's billing address.
|
|
6379
|
+
*/
|
|
6380
|
+
billingAddressId: string;
|
|
6381
|
+
/**
|
|
6382
|
+
* For B2B customers, it represents the location which should specify the shipping address. For B2C customers, it represents identifier of customer's shipping address.
|
|
6383
|
+
*/
|
|
6384
|
+
shippingAddressId: string;
|
|
6385
|
+
/**
|
|
6386
|
+
* The date until which the quote is valid for the customer. After this date, the quote cannot be approved and transformed into order by the customer.
|
|
6387
|
+
*/
|
|
6388
|
+
validTo?: string;
|
|
6389
|
+
shipping?: QuoteShipping;
|
|
6390
|
+
/**
|
|
6391
|
+
* Quote items.
|
|
6392
|
+
*/
|
|
6393
|
+
items?: Array<{
|
|
6394
|
+
/**
|
|
6395
|
+
* ID of the item. It's generated automatically when it's not provided.
|
|
6396
|
+
*/
|
|
6397
|
+
itemId?: string;
|
|
6398
|
+
/**
|
|
6399
|
+
* The quantity of the quote item in a given unit.
|
|
6400
|
+
*/
|
|
6401
|
+
quantity?: {
|
|
6402
|
+
/**
|
|
6403
|
+
* The quantity of quote items.
|
|
6404
|
+
*/
|
|
6405
|
+
quantity: number;
|
|
6406
|
+
/**
|
|
6407
|
+
* The unit of the quantity as defined in the Unit Handling Service.
|
|
6408
|
+
*/
|
|
6409
|
+
unitCode: string;
|
|
6410
|
+
};
|
|
6411
|
+
/**
|
|
6412
|
+
* Product reference.
|
|
6413
|
+
*/
|
|
6414
|
+
product: {
|
|
6415
|
+
/**
|
|
6416
|
+
* Defines if product is external or internal. If the product is internal, it's taken from the Emporix Product Service. If the price is external, it's a custom product from external system.
|
|
6417
|
+
*/
|
|
6418
|
+
type?: 'INTERNAL' | 'EXTERNAL';
|
|
6419
|
+
/**
|
|
6420
|
+
* Product or variant ID.
|
|
6421
|
+
*/
|
|
6422
|
+
productId: string;
|
|
6423
|
+
/**
|
|
6424
|
+
* Localized name of a product. Used for the `EXTERNAL` products as the `INTERNAL` ones are populated from the product catalog data.
|
|
6425
|
+
*/
|
|
6426
|
+
name?: {
|
|
6427
|
+
[key: string]: string;
|
|
6428
|
+
};
|
|
6429
|
+
/**
|
|
6430
|
+
* Media object that can be provided for an `EXTERNAL` product. `INTERNAL` products have media populated automatically and override the given value.
|
|
6431
|
+
*/
|
|
6432
|
+
media?: {
|
|
6433
|
+
/**
|
|
6434
|
+
* ID of the media.
|
|
6435
|
+
*/
|
|
6436
|
+
id?: string;
|
|
6437
|
+
/**
|
|
6438
|
+
* The content type of the media. For example: `image/jpg`.
|
|
6439
|
+
*/
|
|
6440
|
+
contentType?: string;
|
|
6441
|
+
/**
|
|
6442
|
+
* The url to the product media.
|
|
6443
|
+
*/
|
|
6444
|
+
url?: string;
|
|
6445
|
+
};
|
|
6446
|
+
/**
|
|
6447
|
+
* Mixins request.
|
|
6448
|
+
*/
|
|
6449
|
+
mixins?: {
|
|
6450
|
+
[key: string]: unknown;
|
|
6451
|
+
};
|
|
6452
|
+
/**
|
|
6453
|
+
* Metadata request.
|
|
6454
|
+
*/
|
|
6455
|
+
metadata?: {
|
|
6456
|
+
/**
|
|
6457
|
+
* Links to the mixin schemas.
|
|
6458
|
+
*/
|
|
6459
|
+
mixins?: {
|
|
6460
|
+
[key: string]: unknown;
|
|
6461
|
+
};
|
|
6462
|
+
};
|
|
6463
|
+
};
|
|
6464
|
+
/**
|
|
6465
|
+
* Matched price of the product.
|
|
6466
|
+
*/
|
|
6467
|
+
price?: {
|
|
6468
|
+
/**
|
|
6469
|
+
* Defines if price is internal or external. If the price is internal, it's taken from the Emporix Price Service. If the price is external, it's a custom price from external system.
|
|
6470
|
+
*/
|
|
6471
|
+
type?: 'INTERNAL' | 'EXTERNAL';
|
|
6472
|
+
/**
|
|
6473
|
+
* ID of the matched price. Required only for type=`INTERNAL`.
|
|
6474
|
+
*/
|
|
6475
|
+
priceId: string;
|
|
6476
|
+
/**
|
|
6477
|
+
* Identifier of price list. The field should be populated only in case when the price belongs to any price list.
|
|
6478
|
+
*/
|
|
6479
|
+
priceListId?: string;
|
|
6480
|
+
/**
|
|
6481
|
+
* Effective unit price of the product.
|
|
6482
|
+
*/
|
|
6483
|
+
unitPrice: number;
|
|
6484
|
+
/**
|
|
6485
|
+
* Total net value for the entire quantity of the item.
|
|
6486
|
+
*/
|
|
6487
|
+
totalNetValue: number;
|
|
6488
|
+
/**
|
|
6489
|
+
* Tax information of the item.
|
|
6490
|
+
*/
|
|
6491
|
+
tax: {
|
|
6492
|
+
/**
|
|
6493
|
+
* Matched tax class of the item.
|
|
6494
|
+
*/
|
|
6495
|
+
taxClass: string;
|
|
6496
|
+
/**
|
|
6497
|
+
* Tax rate of the item.
|
|
6498
|
+
*/
|
|
6499
|
+
taxRate: number;
|
|
6500
|
+
};
|
|
6501
|
+
};
|
|
6502
|
+
/**
|
|
6503
|
+
* Mixins request.
|
|
6504
|
+
*/
|
|
6505
|
+
mixins?: {
|
|
6506
|
+
[key: string]: unknown;
|
|
6507
|
+
};
|
|
6508
|
+
/**
|
|
6509
|
+
* Metadata request.
|
|
6510
|
+
*/
|
|
6511
|
+
metadata?: {
|
|
6512
|
+
/**
|
|
6513
|
+
* Links to the mixin schemas.
|
|
6514
|
+
*/
|
|
6515
|
+
mixins?: {
|
|
6516
|
+
[key: string]: unknown;
|
|
6517
|
+
};
|
|
6518
|
+
};
|
|
6519
|
+
}>;
|
|
6520
|
+
restriction?: Restriction$1;
|
|
6521
|
+
/**
|
|
6522
|
+
* Mixins request.
|
|
6523
|
+
*/
|
|
6524
|
+
mixins?: {
|
|
6525
|
+
[key: string]: unknown;
|
|
6526
|
+
};
|
|
6527
|
+
/**
|
|
6528
|
+
* Metadata request.
|
|
6529
|
+
*/
|
|
6530
|
+
metadata?: {
|
|
6531
|
+
/**
|
|
6532
|
+
* Links to the mixin schemas.
|
|
6533
|
+
*/
|
|
6534
|
+
mixins?: {
|
|
6535
|
+
[key: string]: unknown;
|
|
6536
|
+
};
|
|
6537
|
+
};
|
|
6538
|
+
/**
|
|
6539
|
+
* The contact email that identifies the customer. Either this attribute or the `customerId` attribute is mandatory for the quote creation request.
|
|
6540
|
+
*/
|
|
6541
|
+
customerEmail?: string;
|
|
6542
|
+
};
|
|
6543
|
+
/**
|
|
6544
|
+
* The shipping cost of the quote.
|
|
6545
|
+
*/
|
|
6546
|
+
type QuoteShipping = {
|
|
6547
|
+
/**
|
|
6548
|
+
* Net value of the shipping cost.
|
|
6549
|
+
*/
|
|
6550
|
+
value?: number;
|
|
6551
|
+
/**
|
|
6552
|
+
* Shipping method's unique identifier.
|
|
6553
|
+
*/
|
|
6554
|
+
methodId?: string;
|
|
6555
|
+
/**
|
|
6556
|
+
* Shipping zone identifier.
|
|
6557
|
+
*/
|
|
6558
|
+
zoneId?: string;
|
|
6559
|
+
/**
|
|
6560
|
+
* Tax code of the shipping method.
|
|
6561
|
+
*/
|
|
6562
|
+
shippingTaxCode?: string;
|
|
6563
|
+
};
|
|
6564
|
+
/**
|
|
6565
|
+
* List of item IDs.
|
|
6566
|
+
*/
|
|
6567
|
+
type QuoteItemIds = Array<{
|
|
6568
|
+
/**
|
|
6569
|
+
* ID of the item.
|
|
6570
|
+
*/
|
|
6571
|
+
itemId?: string;
|
|
6572
|
+
}>;
|
|
6573
|
+
/**
|
|
6574
|
+
* Quote update operation list.
|
|
6575
|
+
*/
|
|
6576
|
+
type QuoteUpdateRequest = Array<{
|
|
6577
|
+
op: 'ADD' | 'REMOVE' | 'REPLACE';
|
|
6578
|
+
path: '/status' | '/validTo' | '/comment' | '/billingAddressId' | '/shippingAddressId' | '/companyName' | '/customerId' | '/shipping' | '/restriction' | '/items' | '/items/{itemId}' | '/items/{itemId}/price' | '/items/{itemId}/mixins/{mixinsPath}' | '/items/{itemId}/metadata/mixins/{mixinsPath}' | '/items/{itemId}/product/mixins/{mixinsPath}' | '/items/{itemId}/product/metadata/mixins/{mixinsPath}' | '/mixins/{mixinsPath}' | '/metadata/{mixinsPath}';
|
|
6579
|
+
value?: QuoteUpdateValues;
|
|
6580
|
+
}>;
|
|
6581
|
+
type QuoteUpdateValues = QuoteItemUpdate | QuoteItemsReplaceUpdate | QuoteItemUpdatePrice | QuoteUpdateStatus | QuoteShipping | QuoteItemIds | string | {
|
|
6582
|
+
[key: string]: unknown;
|
|
6583
|
+
};
|
|
6584
|
+
/**
|
|
6585
|
+
* Quote update operation list.
|
|
6586
|
+
*/
|
|
6587
|
+
type QuoteHistory$1 = Array<{
|
|
6588
|
+
/**
|
|
6589
|
+
* The unique ID of the audit log.
|
|
6590
|
+
*/
|
|
6591
|
+
id?: string;
|
|
6592
|
+
/**
|
|
6593
|
+
* operation type
|
|
6594
|
+
*/
|
|
6595
|
+
op?: 'ADD' | 'REMOVE' | 'REPLACE' | 'CREATE';
|
|
6596
|
+
/**
|
|
6597
|
+
* Path that indicates on which element the update has been executed.
|
|
6598
|
+
*/
|
|
6599
|
+
path?: '/quote' | '/status' | '/validTo' | '/comment' | '/billingAddressId' | '/shippingAddressId' | '/companyName' | '/customerId' | '/shipping' | '/restriction' | '/items' | '/items/{itemId}' | '/items/{itemId}/price' | '/items/{itemId}/mixins/{mixinsPath}' | '/items/{itemId}/metadata/mixins/{mixinsPath}' | '/items/{itemId}/product/mixins/{mixinsPath}' | '/items/{itemId}/product/metadata/mixins/{mixinsPath}' | '/mixins/{mixinsPath}' | '/metadata/{mixinsPath}';
|
|
6600
|
+
newValue?: QuoteUpdateValues & {
|
|
6601
|
+
[key: string]: unknown;
|
|
6602
|
+
};
|
|
6603
|
+
/**
|
|
6604
|
+
* Value before update.
|
|
6605
|
+
*/
|
|
6606
|
+
previousValue?: QuoteUpdateValues & {
|
|
6607
|
+
[key: string]: unknown;
|
|
6608
|
+
};
|
|
6609
|
+
/**
|
|
6610
|
+
* ID of the user who modified the item.
|
|
6611
|
+
*/
|
|
6612
|
+
userId?: string;
|
|
6613
|
+
/**
|
|
6614
|
+
* First name of the user who modified the item.
|
|
6615
|
+
*/
|
|
6616
|
+
userFirstName?: string;
|
|
6617
|
+
/**
|
|
6618
|
+
* Last name of the user who modified the item.
|
|
6619
|
+
*/
|
|
6620
|
+
userLastName?: string;
|
|
6621
|
+
userType?: 'EMPLOYEE' | 'CUSTOMER' | 'SYSTEM';
|
|
6622
|
+
restriction?: Restriction$1;
|
|
6623
|
+
/**
|
|
6624
|
+
* Modification date.
|
|
6625
|
+
*/
|
|
6626
|
+
modifiedAt?: string;
|
|
6627
|
+
}>;
|
|
6628
|
+
/**
|
|
6629
|
+
* This schema includes the attributes that are required to be provided when creating a quote from the cart.
|
|
6630
|
+
*/
|
|
6631
|
+
type QuoteCreateFromCartRequest = {
|
|
6632
|
+
/**
|
|
6633
|
+
* ID of the cart from which the new quote should be created.
|
|
6634
|
+
*/
|
|
6635
|
+
cartId: string;
|
|
6636
|
+
/**
|
|
6637
|
+
* The employee ID for which the new quote is created. By default, the employeeId is taken from the configuration, but in case the 'employeeId' property is provided, the employeeId from the request is assigned to the quote. Only user of EMPLOYEE type can assign employee to the quote.
|
|
6638
|
+
*/
|
|
6639
|
+
employeeId?: string;
|
|
6640
|
+
/**
|
|
6641
|
+
* For B2B customers, it represents the location which should specify the billing address. For B2C customers, it represents identifier of customer's billing address.
|
|
6642
|
+
*/
|
|
6643
|
+
billingAddressId?: string;
|
|
6644
|
+
/**
|
|
6645
|
+
* For B2B customers, it represents the location which should specify the shipping address. For B2C customers, it represents identifier of customer's shipping address.
|
|
6646
|
+
*/
|
|
6647
|
+
shippingAddressId?: string;
|
|
6648
|
+
shipping?: QuoteShipping;
|
|
6649
|
+
/**
|
|
6650
|
+
* Customer-provided reference stored on the quote.
|
|
6651
|
+
*/
|
|
6652
|
+
customerReference?: string;
|
|
6653
|
+
/**
|
|
6654
|
+
* Customer-provided comment stored on the quote.
|
|
6655
|
+
*/
|
|
6656
|
+
customerComment?: string;
|
|
6657
|
+
};
|
|
6658
|
+
|
|
6659
|
+
/** A quote (read shape). */
|
|
6660
|
+
type Quote = QuoteResponse;
|
|
6661
|
+
/** Body for {@link QuoteService.create} — a from-scratch quote or a from-cart quote. */
|
|
6662
|
+
type QuoteDraft = QuoteCreateRequest | QuoteCreateFromCartRequest;
|
|
6663
|
+
/** Result of creating a quote — `{ id? }`. */
|
|
6664
|
+
type QuoteCreated = QuoteIdResponse;
|
|
6665
|
+
/** Body for {@link QuoteService.update} — the upstream update-op array. */
|
|
6666
|
+
type QuoteUpdate = QuoteUpdateRequest;
|
|
6667
|
+
/** A quote's change history. */
|
|
6668
|
+
type QuoteHistory = QuoteHistory$1;
|
|
6669
|
+
/** A quote reason (read shape). */
|
|
6670
|
+
type QuoteReason = QuoteReasonResponse;
|
|
6671
|
+
/** Body for `reasons.create`. */
|
|
6672
|
+
type QuoteReasonDraft = QuoteReasonCreateRequest;
|
|
6673
|
+
/** Body for `reasons.update` (`metadata.version` required for optimistic locking). */
|
|
6674
|
+
type QuoteReasonUpdate = QuoteReasonUpdateRequest;
|
|
6675
|
+
/** Result of creating a quote reason — `{ id? }`. */
|
|
6676
|
+
type QuoteReasonCreated = QuoteReasonIdResponse;
|
|
6677
|
+
/** Filter/pagination for {@link QuoteService.list}. */
|
|
6678
|
+
interface ListQuotesQuery {
|
|
6679
|
+
/** Emporix `q`-syntax filter. */
|
|
6680
|
+
q?: string;
|
|
6681
|
+
/** Sort spec (e.g. `createdAt:desc`). */
|
|
6682
|
+
sort?: string;
|
|
6683
|
+
pageNumber?: number;
|
|
6684
|
+
pageSize?: number;
|
|
6685
|
+
}
|
|
6686
|
+
/** Pagination for `reasons.list`. */
|
|
6687
|
+
interface ListQuoteReasonsQuery {
|
|
6688
|
+
pageNumber?: number;
|
|
6689
|
+
pageSize?: number;
|
|
6690
|
+
}
|
|
6691
|
+
|
|
6692
|
+
/**
|
|
6693
|
+
* Quote Service (`/quote/{tenant}/…`): B2B quotes and quote reasons. Quotes are
|
|
6694
|
+
* customer-owned and never anonymous, so every method takes a REQUIRED `auth`:
|
|
6695
|
+
* pass `auth.customer(token)` for a customer's own quotes, or `auth.service()`
|
|
6696
|
+
* (an admin token) for `quote_manage`-scoped ops (`delete`, reason mutations).
|
|
6697
|
+
*/
|
|
6698
|
+
declare class QuoteService {
|
|
6699
|
+
private readonly ctx;
|
|
6700
|
+
static readonly channel: "quote";
|
|
6701
|
+
constructor(ctx: ClientContext);
|
|
6702
|
+
private quotesBase;
|
|
6703
|
+
private _reasons?;
|
|
6704
|
+
/** Quote reasons config (`/quote-reasons`). CRUD sub-resource. */
|
|
6705
|
+
get reasons(): QuoteReasonsResource;
|
|
6706
|
+
/** List quotes, wrapped in {@link PaginatedItems}. Pass `{}` for no filter. */
|
|
6707
|
+
list(query: ListQuotesQuery, auth: AuthContext): Promise<PaginatedItems<Quote>>;
|
|
6708
|
+
/** Create a quote (`POST /quotes`, 201). */
|
|
6709
|
+
create(draft: QuoteDraft, auth: AuthContext): Promise<QuoteCreated>;
|
|
6710
|
+
/** Retrieve one quote by id. */
|
|
6711
|
+
get(quoteId: string, auth: AuthContext): Promise<Quote>;
|
|
6712
|
+
/** Apply an update-op array to a quote (`PATCH /quotes/{id}`, 204). */
|
|
6713
|
+
update(quoteId: string, update: QuoteUpdate, auth: AuthContext): Promise<void>;
|
|
6714
|
+
/** Delete a quote (`DELETE /quotes/{id}`). Requires the admin `quote_manage` scope. */
|
|
6715
|
+
delete(quoteId: string, auth: AuthContext): Promise<void>;
|
|
6716
|
+
/** Retrieve a quote's change history (`GET /quotes/{id}/history`). */
|
|
6717
|
+
history(quoteId: string, auth: AuthContext): Promise<QuoteHistory>;
|
|
6718
|
+
/**
|
|
6719
|
+
* Generate a quote PDF (`POST /quotes/{id}/pdf`). Returns the raw PDF bytes.
|
|
6720
|
+
* Uses `requestRaw` (no typed-error mapping) — a non-2xx is thrown explicitly.
|
|
6721
|
+
*/
|
|
6722
|
+
generatePdf(quoteId: string, auth: AuthContext): Promise<Blob>;
|
|
6723
|
+
}
|
|
6724
|
+
/**
|
|
6725
|
+
* Quote reasons (`/quote/{tenant}/quote-reasons`). Config data. Like the rest
|
|
6726
|
+
* of the quote domain, every method takes a REQUIRED `auth`: reads accept a
|
|
6727
|
+
* customer or admin token; `create`/`update`/`delete` need the admin
|
|
6728
|
+
* `quote.quote_manage` scope (`auth.service()`).
|
|
6729
|
+
*/
|
|
6730
|
+
declare class QuoteReasonsResource {
|
|
6731
|
+
private readonly ctx;
|
|
6732
|
+
constructor(ctx: ClientContext);
|
|
6733
|
+
private base;
|
|
6734
|
+
/** List reasons, wrapped in {@link PaginatedItems}. Pass `{}` for no paging override. */
|
|
6735
|
+
list(query: ListQuoteReasonsQuery, auth: AuthContext): Promise<PaginatedItems<QuoteReason>>;
|
|
6736
|
+
/** Retrieve one reason by id. */
|
|
6737
|
+
get(reasonId: string, auth: AuthContext): Promise<QuoteReason>;
|
|
6738
|
+
/** Create a reason (`POST /quote-reasons`). Requires the admin `quote_manage` scope. */
|
|
6739
|
+
create(draft: QuoteReasonDraft, auth: AuthContext): Promise<QuoteReasonCreated>;
|
|
6740
|
+
/**
|
|
6741
|
+
* Replace a reason (`PUT /quote-reasons/{id}`, 204). `draft.metadata.version`
|
|
6742
|
+
* is required for optimistic locking. Requires the admin `quote_manage` scope.
|
|
6743
|
+
*/
|
|
6744
|
+
update(reasonId: string, draft: QuoteReasonUpdate, auth: AuthContext): Promise<void>;
|
|
6745
|
+
/** Delete a reason (`DELETE /quote-reasons/{id}`). Requires the admin `quote_manage` scope. */
|
|
6746
|
+
delete(reasonId: string, auth: AuthContext): Promise<void>;
|
|
6747
|
+
}
|
|
6748
|
+
|
|
4733
6749
|
/**
|
|
4734
6750
|
* Price calculation derived from the order entry `calculatedPrice.finalPrice`. The `finalPrice` reflects already applied discounts and fees.
|
|
4735
6751
|
*/
|
|
@@ -7554,6 +9570,8 @@ declare class EmporixClient {
|
|
|
7554
9570
|
readonly countries: CountryService;
|
|
7555
9571
|
readonly currencies: CurrencyService;
|
|
7556
9572
|
readonly shipping: ShippingService;
|
|
9573
|
+
readonly invoices: InvoiceService;
|
|
9574
|
+
readonly quotes: QuoteService;
|
|
7557
9575
|
readonly returns: ReturnsService;
|
|
7558
9576
|
readonly sepaExport: SepaExportService;
|
|
7559
9577
|
readonly indexing: IndexingService;
|
|
@@ -7665,4 +9683,4 @@ declare function createEmporixClient<S extends Record<string, ServiceClass<unkno
|
|
|
7665
9683
|
*/
|
|
7666
9684
|
declare function productIdFromYrn(yrn: string | undefined): string;
|
|
7667
9685
|
|
|
7668
|
-
export { type AddedPoints, type AdminCustomer, type AdminCustomerAddress, type AdminCustomerAddressInput, type AdminCustomerAddressList, type AdminCustomerAddressUpdate, type AdminCustomerCreated, type AdminCustomerInput, type AdminCustomerList, type AdminCustomerPatch, type AdminCustomerSearchQuery, type AdminCustomerUpdate, type Agent, type AgentInput, type AgentPatchOp, type AgentSearchQuery, AiService, type Approval, type ApprovalCreated, type ApprovalInput, type ApprovalList, type ApprovalPatch, type ApprovalPermittedInput, type ApprovalPermittedResult, ApprovalService, type ApprovalUsersQuery, type ApprovalUsersResult, type Assignee, AuthContext, AvailabilityService, type BatchNextIdEntry, type Brand, type BrandInput, type BrandList, BrandService, type BrandUpdate, type BulkInstanceResult, type BulkPatchInstanceItem, CartService, type Catalog, type CatalogCreated, type CatalogInput, type CatalogList, type CatalogPatch, CatalogService, type CatalogUpdate, CategoryService, type CgRelation, type CgRelationList, type ChatRequest, type ChatResponse, type ChatStreamOptions, CheckoutService, ClientConfigService, type ClientConfiguration, ClientContext, CloudFunctionsService, CompaniesService, type CompletionMessage, type CompletionRequest, type CompletionResponse, type Configuration$1 as Configuration, type ConfigurationDraft, ContactsService, type Conversation, type ConversationSearchQuery, type ConversionFactorInput, type ConversionFactorResult, type ConvertUnitInput, type ConvertUnitResult, type Country, type CountryList, CountryService, type CountryUpdate, type Coupon$1 as Coupon, type CouponCreated, type CouponInput, type CouponList, CouponService, type CouponUpdate, type Currency, type CurrencyCreated, type CurrencyInput, type CurrencyList, CurrencyService, type CurrencyUpdate, type CustomEntity, type CustomEntityDraft, type CustomInstance, type CustomInstanceDraft, CustomerAdminService, CustomerGroupsService, CustomerService, type CustomerSummaryBatch, CustomerTokenRefresher, type DeleteAgentOptions, type DeleteConfigOptions, type DeliveryCreated, type DeliveryCycleInput, type DeliverySlot, type DeliverySlotList, type DeliveryTime$1 as DeliveryTime, type DeliveryTimeInput, type DeliveryTimeList, type DeliveryTimeUpdate, type DeliveryWindow$2 as DeliveryWindow, type DeliveryWindowList, type DeliveryWindowValidation, EmporixAuthError, EmporixClient, EmporixConfig, type EmporixCore, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNetworkError, EmporixNotFoundError, EmporixServerError, EmporixTimeoutError, EmporixValidationError, type ExchangeRate, type ExchangeRateCreated, type ExchangeRateInput, type ExchangeRateList, type ExchangeRateUpdate, type Fee$1 as Fee, type FeeDraft, FeeService, type FindSiteInput, type IndexConfig, type IndexConfigCreated, type IndexPublicConfig, IndexingService, type InstanceSearchBody, type InvokeCloudFunctionOptions, type ItemFee, type ItemFeeDraft, type ItemFeeSearch, type JobIdResponse, type Label, type LabelInput, type LabelList, LabelService, type LabelUpdate, type ListConfigOptions, type ListCustomEntitiesOptions, type ListFeesQuery, type ListInstancesQuery, type ListReindexJobsOptions, type ListSchemasQuery, LocationsService, LogLevel, MediaService, type MetadataFilter, type MinimumFee, type NewPointsEntry, type NextIdCommandRequest, type NextIdOptions, type NextIdResponse, type NextIdsBatchRequest, type NextIdsBatchResponse, type OrderCycleList, type OrderEntryEventCreate, type OrderStatusChange, OrdersService, type PackagingProductsChange, type PackingEvent, type PackingEventList, PaginatedItems, PaymentGatewayService, type PickOrder, type PickOrderList, type PickPackAck, PickPackService, type PointsSummary, PriceService, ProductService, QueryFor, type QuoteInput, type QuoteResult, type QuoteSlotInput, RagIndexerService, type RagType, type RecalculationJob, type RecalculationJobCreated, type RecalculationJobInput, type RedeemCouponResult, type RedeemMyPointsInput, type RedeemOption, type RedeemOptionList, type RedeemedPoints, type Redemption, type RedemptionCreated, type RedemptionInput, type ReferralCoupon, type Region, type RegionList, type ReindexEntityType, type ReindexInput, type ReindexJob, type ReindexJobInput, type ReindexJobStatus, ResolvedConfig, type ResourceCreated, type Return, type ReturnCreated, type ReturnInput, type ReturnList, type ReturnPatch, type ReturnUpdate, ReturnsService, RewardPointsService, SalesOrdersService, type Schema, type SchemaAttribute, type SchemaDraft, SchemaService, type SchemaTypeName, type SchemaUpdate, SegmentService, SepaExportService, type SepaJob, type SepaJobCreated, type SepaJobInput, type SequenceSchema, type SequenceSchemaCreate, SequentialIdService, type ServiceClass, ServiceName, type SessionContext, type SessionContextPatch, SessionContextService, type SetItemFeesOptions, type ShippingGroup, type ShippingGroupList, type ShippingMethod, type ShippingMethodList, type ShippingPatch, ShippingService, type ShoppingList, type ShoppingListDraft, type ShoppingListItem, ShoppingListService, type Site$1 as Site, type SiteList, SiteService, type TaxCalculationInput, type TaxCalculationRequest, type TaxCalculationResult, type TaxClass, type TaxConfig, type TaxConfigCreated, type TaxCreation as TaxConfigInput, type TaxUpdate as TaxConfigUpdate, type TaxLocation, TaxService, TenantConfigService, type TextRequest, type TextResponse, TokenProvider, type Unit, type UnitCreated, UnitHandlingService, type UnitInput, type UnitUpdate, type Vendor, type VendorCreated, type VendorInput, type VendorList, type VendorLocation, type VendorLocationInput, type VendorLocationList, type VendorLocationUpdate, type VendorSearchQuery, VendorService, type VendorUpdate, type WebhookConfig, type WebhookConfigCreated, type WebhookConfigDraft, type WebhookConfigPatch, type WebhookDashboardAccess, WebhookService, type WebhookStatistics, type WebhookStatisticsQuery, type WebhookSubscription, type WebhookSubscriptionUpdateItem, type WebhookSubscriptionUpdateResultItem, type Zone, type ZoneList, createCore, createEmporixClient, errorFromResponse, productIdFromYrn };
|
|
9686
|
+
export { type AddedPoints, type AdminCustomer, type AdminCustomerAddress, type AdminCustomerAddressInput, type AdminCustomerAddressList, type AdminCustomerAddressUpdate, type AdminCustomerCreated, type AdminCustomerInput, type AdminCustomerList, type AdminCustomerPatch, type AdminCustomerSearchQuery, type AdminCustomerUpdate, type Agent, type AgentAnalytics, type AgentExecutions, type AgentFromTemplate, type AgentInput, type AgentPatchOp, type AgentRequestLog, type AgentSearchQuery, type AgentSessionLog, type AgentTemplate, type AgenticPatchOp, type AgentsExport, type AgentsExportRequest, type AgentsImport, type AgentsImportRequest, AiService, type AnalyticsQuery, type Approval, type ApprovalCreated, type ApprovalInput, type ApprovalList, type ApprovalPatch, type ApprovalPermittedInput, type ApprovalPermittedResult, ApprovalService, type ApprovalUsersQuery, type ApprovalUsersResult, type Assignee, type Attachment, type AttachmentOptions, AuthContext, AvailabilityService, type BatchNextIdEntry, type Brand, type BrandInput, type BrandList, BrandService, type BrandUpdate, type BulkInstanceResult, type BulkPatchInstanceItem, CartService, type Catalog, type CatalogCreated, type CatalogInput, type CatalogList, type CatalogPatch, CatalogService, type CatalogUpdate, CategoryService, type CgRelation, type CgRelationList, type ChatRequest, type ChatResponse, type ChatStreamOptions, CheckoutService, ClientConfigService, type ClientConfiguration, ClientContext, CloudFunctionsService, type CommerceEvents, CompaniesService, type CompletionMessage, type CompletionRequest, type CompletionResponse, type Configuration$1 as Configuration, type ConfigurationDraft, ContactsService, type Conversation, type ConversationSearchQuery, type ConversionFactorInput, type ConversionFactorResult, type ConvertUnitInput, type ConvertUnitResult, type Country, type CountryList, CountryService, type CountryUpdate, type Coupon$1 as Coupon, type CouponCreated, type CouponInput, type CouponList, CouponService, type CouponUpdate, type Created, type Currency, type CurrencyCreated, type CurrencyInput, type CurrencyList, CurrencyService, type CurrencyUpdate, type CustomEntity, type CustomEntityDraft, type CustomInstance, type CustomInstanceDraft, CustomerAdminService, CustomerGroupsService, CustomerService, type CustomerSummaryBatch, CustomerTokenRefresher, type DeleteAgentOptions, type DeleteConfigOptions, type DeliveryCreated, type DeliveryCycleInput, type DeliverySlot, type DeliverySlotList, type DeliveryTime$1 as DeliveryTime, type DeliveryTimeInput, type DeliveryTimeList, type DeliveryTimeUpdate, type DeliveryWindow$2 as DeliveryWindow, type DeliveryWindowList, type DeliveryWindowValidation, EmporixAuthError, EmporixClient, EmporixConfig, type EmporixCore, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNetworkError, EmporixNotFoundError, EmporixServerError, EmporixTimeoutError, EmporixValidationError, type ExchangeRate, type ExchangeRateCreated, type ExchangeRateInput, type ExchangeRateList, type ExchangeRateUpdate, type ExecutionsQuery, type Fee$1 as Fee, type FeeDraft, FeeService, type FindSiteInput, type GetOptions, type IndexConfig, type IndexConfigCreated, type IndexPublicConfig, IndexingService, type InstanceSearchBody, type InvoiceJob, type InvoiceJobCreated, type InvoiceJobDraft, InvoiceService, type InvokeCloudFunctionOptions, type ItemFee, type ItemFeeDraft, type ItemFeeSearch, type Job, type JobIdResponse, type Label, type LabelInput, type LabelList, LabelService, type LabelUpdate, type ListConfigOptions, type ListCustomEntitiesOptions, type ListFeesQuery, type ListInstancesQuery, type ListQuery, type ListQuoteReasonsQuery, type ListQuotesQuery, type ListReindexJobsOptions, type ListSchemasQuery, LocationsService, LogLevel, type McpServer, type McpServerInput, MediaService, type MetadataFilter, type MinimumFee, type MutateOptions, type NewPointsEntry, type NextIdCommandRequest, type NextIdOptions, type NextIdResponse, type NextIdsBatchRequest, type NextIdsBatchResponse, type OAuthConfig, type OAuthInput, type OrderCycleList, type OrderEntryEventCreate, type OrderStatusChange, OrdersService, type PackagingProductsChange, type PackingEvent, type PackingEventList, PaginatedItems, PaymentGatewayService, type PickOrder, type PickOrderList, type PickPackAck, PickPackService, type PointsSummary, PriceService, ProductService, type ProviderModels, QueryFor, type Quote, type QuoteCreated, type QuoteDraft, type QuoteHistory, type QuoteInput, type QuoteReason, type QuoteReasonCreated, type QuoteReasonDraft, type QuoteReasonUpdate, type QuoteResult, QuoteService, type QuoteSlotInput, type QuoteUpdate, RagIndexerService, type RagType, type RecalculationJob, type RecalculationJobCreated, type RecalculationJobInput, type RedeemCouponResult, type RedeemMyPointsInput, type RedeemOption, type RedeemOptionList, type RedeemedPoints, type Redemption, type RedemptionCreated, type RedemptionInput, type ReferralCoupon, type Region, type RegionList, type ReindexEntityType, type ReindexInput, type ReindexJob, type ReindexJobInput, type ReindexJobStatus, ResolvedConfig, type ResourceCreated, type Return, type ReturnCreated, type ReturnInput, type ReturnList, type ReturnPatch, type ReturnUpdate, ReturnsService, RewardPointsService, SalesOrdersService, type Schema, type SchemaAttribute, type SchemaDraft, SchemaService, type SchemaTypeName, type SchemaUpdate, type SearchQuery, SegmentService, SepaExportService, type SepaJob, type SepaJobCreated, type SepaJobInput, type SequenceSchema, type SequenceSchemaCreate, SequentialIdService, type ServiceClass, ServiceName, type SessionContext, type SessionContextPatch, SessionContextService, type SetItemFeesOptions, type ShippingGroup, type ShippingGroupList, type ShippingMethod, type ShippingMethodList, type ShippingPatch, ShippingService, type ShoppingList, type ShoppingListDraft, type ShoppingListItem, ShoppingListService, type Site$1 as Site, type SiteList, SiteService, type TaxCalculationInput, type TaxCalculationRequest, type TaxCalculationResult, type TaxClass, type TaxConfig, type TaxConfigCreated, type TaxCreation as TaxConfigInput, type TaxUpdate as TaxConfigUpdate, type TaxLocation, TaxService, TenantConfigService, type TextRequest, type TextResponse, type Token, type TokenInput, TokenProvider, type Tool, type ToolInput, type Unit, type UnitCreated, UnitHandlingService, type UnitInput, type UnitUpdate, type Vendor, type VendorCreated, type VendorInput, type VendorList, type VendorLocation, type VendorLocationInput, type VendorLocationList, type VendorLocationUpdate, type VendorSearchQuery, VendorService, type VendorUpdate, type WebhookConfig, type WebhookConfigCreated, type WebhookConfigDraft, type WebhookConfigPatch, type WebhookDashboardAccess, WebhookService, type WebhookStatistics, type WebhookStatisticsQuery, type WebhookSubscription, type WebhookSubscriptionUpdateItem, type WebhookSubscriptionUpdateResultItem, type Zone, type ZoneList, createCore, createEmporixClient, errorFromResponse, productIdFromYrn };
|