@viu/emporix-sdk 2.18.0 → 2.20.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 +35 -0
- package/dist/availability.cjs.map +1 -1
- package/dist/availability.d.cts +95 -9
- package/dist/availability.d.ts +95 -9
- package/dist/availability.js +1 -1
- package/dist/cart.d.cts +1 -1
- package/dist/cart.d.ts +1 -1
- package/dist/category.cjs +12 -0
- package/dist/category.cjs.map +1 -1
- package/dist/category.d.cts +12 -2
- package/dist/category.d.ts +12 -2
- package/dist/category.js +1 -1
- package/dist/checkout.d.cts +1 -1
- package/dist/checkout.d.ts +1 -1
- package/dist/{chunk-K3VQLW3P.js → chunk-IVCCGJN5.js} +2 -2
- package/dist/chunk-IVCCGJN5.js.map +1 -0
- package/dist/{chunk-6XND7SYV.js → chunk-ZNLHLFQM.js} +14 -2
- package/dist/chunk-ZNLHLFQM.js.map +1 -0
- package/dist/companies.d.cts +1 -1
- package/dist/companies.d.ts +1 -1
- package/dist/contacts.d.cts +1 -1
- package/dist/contacts.d.ts +1 -1
- package/dist/{context-DhoFgoKf.d.cts → context-Dawv2AtS.d.cts} +16 -0
- package/dist/{context-DhoFgoKf.d.ts → context-Dawv2AtS.d.ts} +16 -0
- package/dist/customer-groups.d.cts +1 -1
- package/dist/customer-groups.d.ts +1 -1
- package/dist/customer.d.cts +1 -1
- package/dist/customer.d.ts +1 -1
- package/dist/index.cjs +501 -297
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +439 -35
- package/dist/index.d.ts +439 -35
- package/dist/index.js +198 -6
- package/dist/index.js.map +1 -1
- package/dist/locations.d.cts +1 -1
- package/dist/locations.d.ts +1 -1
- package/dist/media.d.cts +17 -2
- package/dist/media.d.ts +17 -2
- package/dist/orders.d.cts +10 -27
- package/dist/orders.d.ts +10 -27
- package/dist/payment.d.cts +1 -1
- package/dist/payment.d.ts +1 -1
- package/dist/price.d.cts +5 -18
- package/dist/price.d.ts +5 -18
- package/dist/product.d.cts +7 -1
- package/dist/product.d.ts +7 -1
- package/dist/segment.d.cts +1 -1
- package/dist/segment.d.ts +1 -1
- package/package.json +1 -1
- package/dist/chunk-6XND7SYV.js.map +0 -1
- package/dist/chunk-K3VQLW3P.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-Dawv2AtS.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-Dawv2AtS.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';
|
|
@@ -421,6 +421,8 @@ declare class RagIndexerService {
|
|
|
421
421
|
* Schedule a full asynchronous re-index for `type` (default `"PRODUCT"`).
|
|
422
422
|
* Resolves once the rebuild is *scheduled* (HTTP 204); there is no progress
|
|
423
423
|
* to await or poll. Costly — avoid calling on a hot path.
|
|
424
|
+
* @deprecated since 2026-06-18, removal 2026-12-01 — use the indexing service:
|
|
425
|
+
* `client.indexing.createReindexJob({ entityType: "PRODUCT", rag: true })`.
|
|
424
426
|
*/
|
|
425
427
|
reindex(type?: RagType, auth?: AuthContext): Promise<void>;
|
|
426
428
|
}
|
|
@@ -832,7 +834,7 @@ declare class CloudFunctionsService {
|
|
|
832
834
|
|
|
833
835
|
type AbstractWebhookConfig = {
|
|
834
836
|
/**
|
|
835
|
-
* Indicates whether a given configuration is active. Only one configuration can be active.
|
|
837
|
+
* Indicates whether a given configuration is active. Only one configuration can be active at a time.
|
|
836
838
|
*/
|
|
837
839
|
active?: boolean;
|
|
838
840
|
provider?: Provider;
|
|
@@ -940,9 +942,16 @@ type ConfigurationGet = {
|
|
|
940
942
|
}>;
|
|
941
943
|
};
|
|
942
944
|
/**
|
|
943
|
-
* Unique identifier of webhook configuration.
|
|
945
|
+
* Unique identifier of the webhook configuration type.
|
|
944
946
|
*/
|
|
945
947
|
type ConfigCode = string;
|
|
948
|
+
/**
|
|
949
|
+
* Webhook provider strategy. Maps to configuration types as follows:
|
|
950
|
+
*
|
|
951
|
+
* * `SVIX` – `svix`
|
|
952
|
+
* * `SVIX_SHARED` – `svix_shared`
|
|
953
|
+
* * `HTTP` – `http`
|
|
954
|
+
*/
|
|
946
955
|
type Provider = 'SVIX_SHARED' | 'SVIX' | 'HTTP';
|
|
947
956
|
type WebhookConfigUpdate = AbstractWebhookConfig & {
|
|
948
957
|
configuration?: Configuration;
|
|
@@ -988,7 +997,7 @@ type WebhookEvent = {
|
|
|
988
997
|
*/
|
|
989
998
|
type WebhookSubscription$1 = {
|
|
990
999
|
event?: WebhookEvent;
|
|
991
|
-
metadata?: Metadata$
|
|
1000
|
+
metadata?: Metadata$8;
|
|
992
1001
|
/**
|
|
993
1002
|
* Status of the subscription.
|
|
994
1003
|
*/
|
|
@@ -1023,7 +1032,7 @@ type WebhookSubscriptionUpdateItem$1 = {
|
|
|
1023
1032
|
/**
|
|
1024
1033
|
* Auditing details.
|
|
1025
1034
|
*/
|
|
1026
|
-
type Metadata$
|
|
1035
|
+
type Metadata$8 = {
|
|
1027
1036
|
/**
|
|
1028
1037
|
* Date and time when the document was created.
|
|
1029
1038
|
*/
|
|
@@ -1175,7 +1184,7 @@ declare class WebhookService {
|
|
|
1175
1184
|
/**
|
|
1176
1185
|
* Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.
|
|
1177
1186
|
*/
|
|
1178
|
-
type SchemaType = 'CART' | 'CART_ITEM' | 'CATEGORY' | 'COMPANY' | 'COUPON' | 'CUSTOMER' | 'CUSTOMER_ADDRESS' | 'ORDER' | 'ORDER_ENTRY' | 'PRODUCT' | 'QUOTE' | 'RETURN' | 'PRICE_LIST' | 'SITE' | 'CUSTOM_ENTITY' | 'VENDOR';
|
|
1187
|
+
type SchemaType = 'CART' | 'CART_ITEM' | 'CATEGORY' | 'COMPANY' | 'COUPON' | 'CUSTOMER' | 'CUSTOMER_ADDRESS' | 'ORDER' | 'ORDER_ENTRY' | 'PRODUCT' | 'QUOTE' | 'RETURN' | 'PRICE_LIST' | 'SITE' | 'CUSTOM_ENTITY' | 'VENDOR' | 'MEDIA';
|
|
1179
1188
|
/**
|
|
1180
1189
|
* Type of the attribute.
|
|
1181
1190
|
*
|
|
@@ -1376,6 +1385,42 @@ type CustomInstanceResponse = {
|
|
|
1376
1385
|
media?: Array<string>;
|
|
1377
1386
|
metadata?: CustomInstanceMetadata;
|
|
1378
1387
|
};
|
|
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
|
+
type BulkResponse = Array<{
|
|
1401
|
+
/**
|
|
1402
|
+
* Index of the processed item, matching the item position in request body.
|
|
1403
|
+
*/
|
|
1404
|
+
index?: number;
|
|
1405
|
+
/**
|
|
1406
|
+
* HTTP Status Code.
|
|
1407
|
+
*/
|
|
1408
|
+
code?: number;
|
|
1409
|
+
/**
|
|
1410
|
+
* HTTP Status description
|
|
1411
|
+
*/
|
|
1412
|
+
status?: string;
|
|
1413
|
+
/**
|
|
1414
|
+
* Error message.
|
|
1415
|
+
*/
|
|
1416
|
+
message?: string;
|
|
1417
|
+
details?: Array<{
|
|
1418
|
+
/**
|
|
1419
|
+
* Error details.
|
|
1420
|
+
*/
|
|
1421
|
+
message?: string;
|
|
1422
|
+
}>;
|
|
1423
|
+
}>;
|
|
1379
1424
|
type CustomInstanceMetadata = {
|
|
1380
1425
|
/**
|
|
1381
1426
|
* Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`
|
|
@@ -1397,6 +1442,10 @@ type CustomInstanceMetadata = {
|
|
|
1397
1442
|
};
|
|
1398
1443
|
};
|
|
1399
1444
|
|
|
1445
|
+
/** One item for {@link SchemaService.bulkPatchInstances} — `{ id, data: op[] }`. */
|
|
1446
|
+
type BulkPatchInstanceItem = BulkPatchCustomInstanceRequest;
|
|
1447
|
+
/** Per-item results of a bulk operation (207) — `{ index?, code?, status?, message?, details? }[]`. */
|
|
1448
|
+
type BulkInstanceResult = BulkResponse;
|
|
1400
1449
|
/** A schema definition (typed attributes attached to one or more entity types). */
|
|
1401
1450
|
type Schema = SchemaResponse;
|
|
1402
1451
|
/** A single typed attribute within a schema (recursive for `OBJECT`). */
|
|
@@ -1539,6 +1588,13 @@ declare class SchemaService {
|
|
|
1539
1588
|
replaceInstance<T = Record<string, unknown>>(type: string, id: string, draft: CustomInstanceDraft<T>, auth?: AuthContext): Promise<CustomInstance<T>>;
|
|
1540
1589
|
/** Partially update an instance (`PATCH`). */
|
|
1541
1590
|
patchInstance<T = Record<string, unknown>>(type: string, id: string, patch: Partial<CustomInstanceDraft<T>>, auth?: AuthContext): Promise<CustomInstance<T>>;
|
|
1591
|
+
/**
|
|
1592
|
+
* Patch up to 200 custom instances of `type` in one call
|
|
1593
|
+
* (`PATCH /custom-entities/{type}/instances/bulk`). Returns a 207 envelope:
|
|
1594
|
+
* a per-item result array — a 207 is success, individual failures live in
|
|
1595
|
+
* each item's `code`/`status`.
|
|
1596
|
+
*/
|
|
1597
|
+
bulkPatchInstances(type: string, items: BulkPatchInstanceItem[], auth?: AuthContext): Promise<BulkInstanceResult>;
|
|
1542
1598
|
/** Delete an instance by id. */
|
|
1543
1599
|
deleteInstance(type: string, id: string, auth?: AuthContext): Promise<void>;
|
|
1544
1600
|
/**
|
|
@@ -1557,6 +1613,20 @@ type AgenticRequest = {
|
|
|
1557
1613
|
* The user message to the agent.
|
|
1558
1614
|
*/
|
|
1559
1615
|
message: string;
|
|
1616
|
+
attachments?: Array<{
|
|
1617
|
+
/**
|
|
1618
|
+
* Id of the attachment.
|
|
1619
|
+
*/
|
|
1620
|
+
attachmentId: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* Caption of the attachment.
|
|
1623
|
+
*/
|
|
1624
|
+
caption?: string;
|
|
1625
|
+
/**
|
|
1626
|
+
* Purpose of the attachment.
|
|
1627
|
+
*/
|
|
1628
|
+
purpose?: string;
|
|
1629
|
+
}>;
|
|
1560
1630
|
};
|
|
1561
1631
|
/**
|
|
1562
1632
|
* Type of the agent handling the request.
|
|
@@ -1603,9 +1673,9 @@ type ExpandedTokenResponse = InnerTokenResponse & {
|
|
|
1603
1673
|
*/
|
|
1604
1674
|
type ExpandableTokenResponse = InnerTokenResponse | ExpandedTokenResponse;
|
|
1605
1675
|
/**
|
|
1606
|
-
* Type of the native tool.
|
|
1676
|
+
* Type of the native tool. Value `teams` is in preview.
|
|
1607
1677
|
*/
|
|
1608
|
-
type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix';
|
|
1678
|
+
type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix' | 'teams';
|
|
1609
1679
|
type BaseNativeTool = {
|
|
1610
1680
|
type: NativeToolType;
|
|
1611
1681
|
/**
|
|
@@ -1733,15 +1803,11 @@ type RagEmporixNativeToolConfig = {
|
|
|
1733
1803
|
/**
|
|
1734
1804
|
* This field specifies the fields of the given entityType that are used for filtering the data before performing actual search.
|
|
1735
1805
|
*/
|
|
1736
|
-
filterFields
|
|
1806
|
+
filterFields?: Array<{
|
|
1737
1807
|
/**
|
|
1738
1808
|
* It should contain the description of the field, so LLM is able to know when to use this field in order to filter the data. For enums, possible values should be specified here.
|
|
1739
1809
|
*/
|
|
1740
1810
|
description?: string;
|
|
1741
|
-
/**
|
|
1742
|
-
* It can act as an alias for the field key.
|
|
1743
|
-
*/
|
|
1744
|
-
name?: string;
|
|
1745
1811
|
/**
|
|
1746
1812
|
* Unique value representing the entityType key.
|
|
1747
1813
|
*/
|
|
@@ -1769,6 +1835,49 @@ type SlackNativeToolResponse = BaseNativeTool & {
|
|
|
1769
1835
|
config?: SlackNativeToolConfigResponse;
|
|
1770
1836
|
metadata?: MetadataResponse$1;
|
|
1771
1837
|
};
|
|
1838
|
+
/**
|
|
1839
|
+
* MS Teams native tool operation identifier.
|
|
1840
|
+
*/
|
|
1841
|
+
type TeamsAllowedOperations = 'sendMessage' | 'createChat' | 'createChannel' | 'inviteParticipants' | 'collaborateOnChannel' | 'collaborateOnChat';
|
|
1842
|
+
/**
|
|
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
|
+
* Configuration of an MS Teams native tool instance.
|
|
1850
|
+
*/
|
|
1851
|
+
type TeamsNativeToolConfigResponse = {
|
|
1852
|
+
/**
|
|
1853
|
+
* Microsoft Teams team ID the tool is bound to.
|
|
1854
|
+
*/
|
|
1855
|
+
teamId: string;
|
|
1856
|
+
/**
|
|
1857
|
+
* Customer Azure AD tenant ID for the Teams workspace.
|
|
1858
|
+
*/
|
|
1859
|
+
tenantId?: string;
|
|
1860
|
+
/**
|
|
1861
|
+
* Agent ID that handles inbound Teams replies when no conversation-specific owner is set.
|
|
1862
|
+
*/
|
|
1863
|
+
defaultInboundAgentId?: string;
|
|
1864
|
+
/**
|
|
1865
|
+
* Operations the tool instance exposes to assigned agents. At least one value is required when the tool is enabled.
|
|
1866
|
+
*/
|
|
1867
|
+
allowedOperations?: Array<TeamsAllowedOperations>;
|
|
1868
|
+
};
|
|
1869
|
+
type TeamsNativeToolResponse = BaseNativeTool & {
|
|
1870
|
+
/**
|
|
1871
|
+
* Unique identifier of the tool.
|
|
1872
|
+
*/
|
|
1873
|
+
id?: string;
|
|
1874
|
+
/**
|
|
1875
|
+
* For TeamsNativeTool it has to be set to `teams`.
|
|
1876
|
+
*/
|
|
1877
|
+
type?: unknown;
|
|
1878
|
+
config?: TeamsNativeToolConfigResponse;
|
|
1879
|
+
metadata?: MetadataResponse$1;
|
|
1880
|
+
};
|
|
1772
1881
|
type RagCustomNativeToolResponse = BaseNativeTool & {
|
|
1773
1882
|
/**
|
|
1774
1883
|
* Unique identifier of the tool.
|
|
@@ -1796,7 +1905,40 @@ type RagEmporixNativeToolResponse = BaseNativeTool & {
|
|
|
1796
1905
|
/**
|
|
1797
1906
|
* List of native tools which agents should have access to.
|
|
1798
1907
|
*/
|
|
1799
|
-
type NativeToolsResponse = Array<SlackNativeToolResponse | RagCustomNativeToolResponse | RagEmporixNativeToolResponse>;
|
|
1908
|
+
type NativeToolsResponse = Array<SlackNativeToolResponse | RagCustomNativeToolResponse | RagEmporixNativeToolResponse | TeamsNativeToolResponse>;
|
|
1909
|
+
/**
|
|
1910
|
+
* Represents an active agent conversation context (MS Teams channel or group chat).
|
|
1911
|
+
*/
|
|
1912
|
+
type ConversationResponse = {
|
|
1913
|
+
/**
|
|
1914
|
+
* Provider-side conversation identifier (Teams conversation ID).
|
|
1915
|
+
*/
|
|
1916
|
+
conversationId?: string;
|
|
1917
|
+
/**
|
|
1918
|
+
* Human-readable name of the conversation channel or group chat.
|
|
1919
|
+
*/
|
|
1920
|
+
conversationName?: string;
|
|
1921
|
+
/**
|
|
1922
|
+
* Caller-supplied reference key used to reuse an existing conversation.
|
|
1923
|
+
*/
|
|
1924
|
+
contextRef?: string;
|
|
1925
|
+
/**
|
|
1926
|
+
* Teams channel or chat identifier.
|
|
1927
|
+
*/
|
|
1928
|
+
channelId?: string;
|
|
1929
|
+
/**
|
|
1930
|
+
* Identifier of the agent that owns this conversation.
|
|
1931
|
+
*/
|
|
1932
|
+
agentId?: string;
|
|
1933
|
+
/**
|
|
1934
|
+
* LangGraph session (checkpointer) ID for agent continuity.
|
|
1935
|
+
*/
|
|
1936
|
+
sessionId?: string;
|
|
1937
|
+
/**
|
|
1938
|
+
* Timestamp of the last message activity in this conversation.
|
|
1939
|
+
*/
|
|
1940
|
+
lastMessageAt?: string;
|
|
1941
|
+
};
|
|
1800
1942
|
type McpServerConfig = {
|
|
1801
1943
|
/**
|
|
1802
1944
|
* URL of the MCP server.
|
|
@@ -1881,11 +2023,11 @@ type BaseLlm = {
|
|
|
1881
2023
|
/**
|
|
1882
2024
|
* Value between 0.1 and 1.0 (inclusive), in steps of 0.1. The lower value the more creative (but less stable) the model is.
|
|
1883
2025
|
*/
|
|
1884
|
-
temperature
|
|
2026
|
+
temperature?: 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 1;
|
|
1885
2027
|
/**
|
|
1886
2028
|
* The limit of tokens which agent can burn during one request session.
|
|
1887
2029
|
*/
|
|
1888
|
-
maxTokens
|
|
2030
|
+
maxTokens?: number;
|
|
1889
2031
|
};
|
|
1890
2032
|
type EmporixLlm = BaseLlm & {
|
|
1891
2033
|
/**
|
|
@@ -1893,6 +2035,35 @@ type EmporixLlm = BaseLlm & {
|
|
|
1893
2035
|
*/
|
|
1894
2036
|
provider: 'emporix_openai';
|
|
1895
2037
|
};
|
|
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
|
+
};
|
|
1896
2067
|
type SelfHostedParams = {
|
|
1897
2068
|
/**
|
|
1898
2069
|
* Url of the self-hosted LLM.
|
|
@@ -1907,9 +2078,11 @@ type SelfHostedParamsRequest = SelfHostedParams & {
|
|
|
1907
2078
|
[key: string]: unknown;
|
|
1908
2079
|
} & {
|
|
1909
2080
|
authorizationHeaderToken?: InnerTokenRequest;
|
|
2081
|
+
oAuthParams?: OAuthParamsRequest;
|
|
1910
2082
|
};
|
|
1911
2083
|
type SelfHostedParamsResponse = SelfHostedParams & {
|
|
1912
2084
|
authorizationHeaderToken?: ExpandableTokenResponse;
|
|
2085
|
+
oAuthParams?: OAuthParamsResponse;
|
|
1913
2086
|
};
|
|
1914
2087
|
type SelfHostedLlm = BaseLlm & {
|
|
1915
2088
|
/**
|
|
@@ -1936,8 +2109,24 @@ type ApiKeyLlmRequest = ApiKeyLlm & {
|
|
|
1936
2109
|
type ApiKeyLlmResponse = ApiKeyLlm & {
|
|
1937
2110
|
token?: ExpandableTokenResponse;
|
|
1938
2111
|
};
|
|
1939
|
-
|
|
2112
|
+
/**
|
|
2113
|
+
* 
|
|
2114
|
+
*
|
|
2115
|
+
* {% hint style="danger" %}
|
|
2116
|
+
* This functionality is in preview mode - some of the features may not be fully operational yet.
|
|
2117
|
+
* {% endhint %}
|
|
2118
|
+
*
|
|
2119
|
+
* Reference to a native tool assigned to an agent.
|
|
2120
|
+
*/
|
|
2121
|
+
type NativeToolReferenceRequest = {
|
|
2122
|
+
/**
|
|
2123
|
+
* Identifier of the native tool.
|
|
2124
|
+
*/
|
|
1940
2125
|
id: string;
|
|
2126
|
+
/**
|
|
2127
|
+
* Optional per-agent override of allowed MS Teams operations. When omitted, the tool instance defaults apply.
|
|
2128
|
+
*/
|
|
2129
|
+
allowedOperations?: Array<TeamsAllowedOperations>;
|
|
1941
2130
|
};
|
|
1942
2131
|
/**
|
|
1943
2132
|
* List of agent collaborations which allows an agent to hand off its task to other agents.
|
|
@@ -1960,6 +2149,68 @@ type TriggerType = 'endpoint' | 'slack';
|
|
|
1960
2149
|
* Type of the trigger.
|
|
1961
2150
|
*/
|
|
1962
2151
|
type CommerceEventsTriggerType = 'commerce_events';
|
|
2152
|
+
/**
|
|
2153
|
+
* Logical operator used to combine multiple filter conditions.
|
|
2154
|
+
*/
|
|
2155
|
+
type CommerceEventTriggerFilterLogicalOperator = '$and' | '$or';
|
|
2156
|
+
/**
|
|
2157
|
+
* Scalar value used in commerce event filter comparisons.
|
|
2158
|
+
*/
|
|
2159
|
+
type CommerceEventTriggerFilterScalarValue = string | number | boolean;
|
|
2160
|
+
/**
|
|
2161
|
+
* Array value used by list-based operators in commerce event filters.
|
|
2162
|
+
*/
|
|
2163
|
+
type CommerceEventTriggerFilterScalarArrayValue = Array<CommerceEventTriggerFilterScalarValue>;
|
|
2164
|
+
/**
|
|
2165
|
+
* Filter condition for unary operators that do not accept `right`.
|
|
2166
|
+
*/
|
|
2167
|
+
type CommerceEventTriggerLeafFilterNoRight = {
|
|
2168
|
+
/**
|
|
2169
|
+
* Dot-notation path to a field in the commerce event payload.
|
|
2170
|
+
*/
|
|
2171
|
+
left: string;
|
|
2172
|
+
op: '$exists' | '$notExists' | '$isEmpty' | '$notEmpty';
|
|
2173
|
+
};
|
|
2174
|
+
/**
|
|
2175
|
+
* Filter condition for scalar comparison operators.
|
|
2176
|
+
*/
|
|
2177
|
+
type CommerceEventTriggerLeafFilterScalarRight = {
|
|
2178
|
+
/**
|
|
2179
|
+
* Dot-notation path to a field in the commerce event payload.
|
|
2180
|
+
*/
|
|
2181
|
+
left: string;
|
|
2182
|
+
op: '$eq' | '$ne';
|
|
2183
|
+
right: CommerceEventTriggerFilterScalarValue;
|
|
2184
|
+
};
|
|
2185
|
+
/**
|
|
2186
|
+
* Filter condition for array membership operators.
|
|
2187
|
+
*/
|
|
2188
|
+
type CommerceEventTriggerLeafFilterArrayRight = {
|
|
2189
|
+
/**
|
|
2190
|
+
* Dot-notation path to a field in the commerce event payload.
|
|
2191
|
+
*/
|
|
2192
|
+
left: string;
|
|
2193
|
+
op: '$in' | '$notIn';
|
|
2194
|
+
right: CommerceEventTriggerFilterScalarArrayValue;
|
|
2195
|
+
};
|
|
2196
|
+
/**
|
|
2197
|
+
* Filter condition applied to a single field in the commerce event payload.
|
|
2198
|
+
*/
|
|
2199
|
+
type CommerceEventTriggerLeafFilter = CommerceEventTriggerLeafFilterNoRight | CommerceEventTriggerLeafFilterScalarRight | CommerceEventTriggerLeafFilterArrayRight;
|
|
2200
|
+
/**
|
|
2201
|
+
* Filter that combines multiple conditions using logical operators.
|
|
2202
|
+
*/
|
|
2203
|
+
type CommerceEventTriggerCompoundFilter = {
|
|
2204
|
+
op: CommerceEventTriggerFilterLogicalOperator;
|
|
2205
|
+
/**
|
|
2206
|
+
* Nested filter conditions combined by the logical operator.
|
|
2207
|
+
*/
|
|
2208
|
+
conditions: Array<CommerceEventTriggerFilter>;
|
|
2209
|
+
};
|
|
2210
|
+
/**
|
|
2211
|
+
* Optional filter expression applied to commerce event payloads. When set, the agent is triggered only if the event payload matches the filter.
|
|
2212
|
+
*/
|
|
2213
|
+
type CommerceEventTriggerFilter = CommerceEventTriggerLeafFilter | CommerceEventTriggerCompoundFilter;
|
|
1963
2214
|
type AgentTrigger = {
|
|
1964
2215
|
type: TriggerType;
|
|
1965
2216
|
} | {
|
|
@@ -1972,6 +2223,7 @@ type AgentTrigger = {
|
|
|
1972
2223
|
* List of events that trigger the agent.
|
|
1973
2224
|
*/
|
|
1974
2225
|
events: string;
|
|
2226
|
+
filter?: CommerceEventTriggerFilter;
|
|
1975
2227
|
};
|
|
1976
2228
|
};
|
|
1977
2229
|
/**
|
|
@@ -2018,6 +2270,11 @@ type BaseForAgentAndTemplate = BaseForAgentAndTemplateAndHandOff & {
|
|
|
2018
2270
|
*/
|
|
2019
2271
|
icon?: string;
|
|
2020
2272
|
tags?: Array<string>;
|
|
2273
|
+
/**
|
|
2274
|
+
* Optional JSON Schema (provided as a JSON string) that constrains the structure of the agent's generated output. Use this when you need predictable, machine-readable output instead of free-form text.
|
|
2275
|
+
*
|
|
2276
|
+
*/
|
|
2277
|
+
outputFormat?: string;
|
|
2021
2278
|
/**
|
|
2022
2279
|
* Indicates whether the agent is enabled.
|
|
2023
2280
|
*/
|
|
@@ -2037,9 +2294,9 @@ type BaseForAgentRequestAndResponse = BaseForAgentAndTemplate & {
|
|
|
2037
2294
|
};
|
|
2038
2295
|
type AgentRequest = BaseForAgentRequestAndResponse & {
|
|
2039
2296
|
/**
|
|
2040
|
-
*
|
|
2297
|
+
* Native tools assigned to the agent, optionally with per-agent `allowedOperations` overrides.
|
|
2041
2298
|
*/
|
|
2042
|
-
nativeTools?: Array<
|
|
2299
|
+
nativeTools?: Array<NativeToolReferenceRequest>;
|
|
2043
2300
|
llmConfig: EmporixLlm | ApiKeyLlmRequest | SelfHostedLlmRequest;
|
|
2044
2301
|
mcpServers: AgentMcpServersRequest;
|
|
2045
2302
|
metadata?: MetadataRequest;
|
|
@@ -2111,6 +2368,7 @@ type PatchRequest = Array<{
|
|
|
2111
2368
|
[key: string]: unknown;
|
|
2112
2369
|
};
|
|
2113
2370
|
}>;
|
|
2371
|
+
type QParamSearchBody2 = QParamSearchBody;
|
|
2114
2372
|
|
|
2115
2373
|
/** Single-shot text generation request (`POST /texts`). Has `maxTokens`. */
|
|
2116
2374
|
type TextRequest = TextGenerationRequest;
|
|
@@ -2166,6 +2424,18 @@ interface DeleteAgentOptions {
|
|
|
2166
2424
|
/** Force deletion even if the agent is referenced elsewhere (`?force=true`). */
|
|
2167
2425
|
force?: boolean;
|
|
2168
2426
|
}
|
|
2427
|
+
/** Options for {@link AiService.chatStream}. */
|
|
2428
|
+
interface ChatStreamOptions {
|
|
2429
|
+
/**
|
|
2430
|
+
* Reuse an existing chat context (sent as the `session-id` header). If
|
|
2431
|
+
* omitted, the server generates a new session id.
|
|
2432
|
+
*/
|
|
2433
|
+
sessionId?: string;
|
|
2434
|
+
}
|
|
2435
|
+
/** A stored agentic conversation (Teams-backed). */
|
|
2436
|
+
type Conversation = ConversationResponse;
|
|
2437
|
+
/** Request body for `searchConversations` (`{ q? }`) — same shape as agent search. */
|
|
2438
|
+
type ConversationSearchQuery = QParamSearchBody2;
|
|
2169
2439
|
|
|
2170
2440
|
/**
|
|
2171
2441
|
* Emporix AI Service (`/ai-service/{tenant}/…`): text generation, chat
|
|
@@ -2217,9 +2487,20 @@ declare class AiService {
|
|
|
2217
2487
|
* Returns the job-id ARRAY verbatim.
|
|
2218
2488
|
*/
|
|
2219
2489
|
chatAsync(input: ChatRequest, auth?: AuthContext): Promise<JobIdResponse[]>;
|
|
2490
|
+
/**
|
|
2491
|
+
* Streaming agent chat (`POST /agentic/chat-stream`, `text/event-stream`).
|
|
2492
|
+
* Yields each SSE `data` payload verbatim — the upstream contract types the
|
|
2493
|
+
* stream body as an opaque string, so chunks are raw strings, not parsed
|
|
2494
|
+
* objects. Consume with `for await`.
|
|
2495
|
+
*/
|
|
2496
|
+
chatStream(input: ChatRequest, opts?: ChatStreamOptions, auth?: AuthContext): AsyncIterable<string>;
|
|
2497
|
+
/** List stored agentic conversations (`GET /agentic/conversations`). */
|
|
2498
|
+
listConversations(auth?: AuthContext): Promise<Conversation[]>;
|
|
2499
|
+
/** Server-side conversation search (`POST /agentic/conversations/search`). */
|
|
2500
|
+
searchConversations(query: ConversationSearchQuery, auth?: AuthContext): Promise<Conversation[]>;
|
|
2220
2501
|
}
|
|
2221
2502
|
|
|
2222
|
-
type Metadata$
|
|
2503
|
+
type Metadata$7 = {
|
|
2223
2504
|
/**
|
|
2224
2505
|
* Date and time when the object was created.
|
|
2225
2506
|
*/
|
|
@@ -2253,7 +2534,7 @@ type TaxRetrieval = {
|
|
|
2253
2534
|
* List of tax classes applicable in the specified country.
|
|
2254
2535
|
*/
|
|
2255
2536
|
taxClasses?: Array<TaxClass>;
|
|
2256
|
-
metadata?: Metadata$
|
|
2537
|
+
metadata?: Metadata$7;
|
|
2257
2538
|
};
|
|
2258
2539
|
/**
|
|
2259
2540
|
* Single tax class.
|
|
@@ -2426,7 +2707,7 @@ type Location$2 = {
|
|
|
2426
2707
|
countryCode: string;
|
|
2427
2708
|
};
|
|
2428
2709
|
type TaxUpdate = TaxCreation & {
|
|
2429
|
-
metadata: Metadata$
|
|
2710
|
+
metadata: Metadata$7;
|
|
2430
2711
|
};
|
|
2431
2712
|
|
|
2432
2713
|
/**
|
|
@@ -3428,7 +3709,7 @@ type Label$1 = {
|
|
|
3428
3709
|
description?: string | {
|
|
3429
3710
|
[key: string]: string;
|
|
3430
3711
|
};
|
|
3431
|
-
metadata?: Metadata$
|
|
3712
|
+
metadata?: Metadata$6;
|
|
3432
3713
|
};
|
|
3433
3714
|
/**
|
|
3434
3715
|
* If present and `isTrue` is actually true the label should be printed on associated products on the described position.
|
|
@@ -3440,7 +3721,7 @@ type Overlay = {
|
|
|
3440
3721
|
/**
|
|
3441
3722
|
* Metadata
|
|
3442
3723
|
*/
|
|
3443
|
-
type Metadata$
|
|
3724
|
+
type Metadata$6 = {
|
|
3444
3725
|
/**
|
|
3445
3726
|
* The creation date.
|
|
3446
3727
|
*/
|
|
@@ -3494,7 +3775,7 @@ declare class LabelService {
|
|
|
3494
3775
|
deleteLabel(labelId: string, auth?: AuthContext): Promise<void>;
|
|
3495
3776
|
}
|
|
3496
3777
|
|
|
3497
|
-
type Metadata$
|
|
3778
|
+
type Metadata$5 = {
|
|
3498
3779
|
/**
|
|
3499
3780
|
* Date and time when the document was created.
|
|
3500
3781
|
*/
|
|
@@ -3527,7 +3808,7 @@ type Country$1 = {
|
|
|
3527
3808
|
* The field indicating whether the given country is active for the tenant or not. Only active countries are visible in the system.
|
|
3528
3809
|
*/
|
|
3529
3810
|
active?: boolean;
|
|
3530
|
-
metadata?: Metadata$
|
|
3811
|
+
metadata?: Metadata$5;
|
|
3531
3812
|
};
|
|
3532
3813
|
type Region$1 = {
|
|
3533
3814
|
/**
|
|
@@ -3540,7 +3821,7 @@ type Region$1 = {
|
|
|
3540
3821
|
name?: {
|
|
3541
3822
|
[key: string]: string;
|
|
3542
3823
|
};
|
|
3543
|
-
metadata?: Metadata$
|
|
3824
|
+
metadata?: Metadata$5;
|
|
3544
3825
|
};
|
|
3545
3826
|
type CountryUpdate$1 = {
|
|
3546
3827
|
/**
|
|
@@ -3594,7 +3875,7 @@ declare class CountryService {
|
|
|
3594
3875
|
getRegion(regionCode: string, auth?: AuthContext): Promise<Region>;
|
|
3595
3876
|
}
|
|
3596
3877
|
|
|
3597
|
-
type Metadata$
|
|
3878
|
+
type Metadata$4 = {
|
|
3598
3879
|
/**
|
|
3599
3880
|
* Time of document creation.
|
|
3600
3881
|
*/
|
|
@@ -3684,7 +3965,7 @@ type CurrencyRetrieval = {
|
|
|
3684
3965
|
name?: string | {
|
|
3685
3966
|
[key: string]: string;
|
|
3686
3967
|
};
|
|
3687
|
-
metadata?: Metadata$
|
|
3968
|
+
metadata?: Metadata$4;
|
|
3688
3969
|
};
|
|
3689
3970
|
type ExchangeRateUpdateRequest = {
|
|
3690
3971
|
/**
|
|
@@ -3730,7 +4011,7 @@ type ExchangeRateRetrieval = {
|
|
|
3730
4011
|
* The value of the field is represented by a number where the cent part is separated by a dot. For example `1.09`. The cent part is not limited just to two digits. A rate with any precision can be returned. For example: `1.091934212`
|
|
3731
4012
|
*/
|
|
3732
4013
|
rate?: string;
|
|
3733
|
-
metadata?: Metadata$
|
|
4014
|
+
metadata?: Metadata$4;
|
|
3734
4015
|
};
|
|
3735
4016
|
|
|
3736
4017
|
/**
|
|
@@ -5010,6 +5291,9 @@ type SepaJobCreated = JobId;
|
|
|
5010
5291
|
/**
|
|
5011
5292
|
* Emporix SEPA Export Service (`/sepa-export/{tenant}/…`): export jobs and file
|
|
5012
5293
|
* retrieval. Server-side; defaults to the service token.
|
|
5294
|
+
*
|
|
5295
|
+
* @deprecated since 2026-05-25, removal 2026-08-24 — the SEPA Export service is
|
|
5296
|
+
* being sunset by Emporix; all endpoints are no longer maintained.
|
|
5013
5297
|
*/
|
|
5014
5298
|
declare class SepaExportService {
|
|
5015
5299
|
private readonly ctx;
|
|
@@ -5024,6 +5308,52 @@ declare class SepaExportService {
|
|
|
5024
5308
|
createJob(input: SepaJobInput, auth?: AuthContext): Promise<SepaJobCreated>;
|
|
5025
5309
|
}
|
|
5026
5310
|
|
|
5311
|
+
/**
|
|
5312
|
+
* Informs about status of reindex job. `PENDING` means that the maximum number of parallel `IN_PROGRESS` jobs is reached and such job will be processed when one of current `IN_PROGRESS` jobs is released. `PUBLISHED` means that all the indexing events were emitted. `SUCCESS` means that all the indexing events were consumed.
|
|
5313
|
+
*/
|
|
5314
|
+
type ReindexJobStatus$1 = 'FAILURE' | 'IN_PROGRESS' | 'PENDING' | 'PUBLISHED' | 'SUCCESS';
|
|
5315
|
+
type Metadata$3 = {
|
|
5316
|
+
/**
|
|
5317
|
+
* Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`
|
|
5318
|
+
*/
|
|
5319
|
+
createdAt?: string;
|
|
5320
|
+
/**
|
|
5321
|
+
* Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-30T13:18:02.379Z`
|
|
5322
|
+
*/
|
|
5323
|
+
modifiedAt?: string;
|
|
5324
|
+
};
|
|
5325
|
+
/**
|
|
5326
|
+
* Entity type which should be reindexed. For now, it supports only `PRODUCT` and custom schema types.
|
|
5327
|
+
*/
|
|
5328
|
+
type ReindexEntityType$1 = string;
|
|
5329
|
+
type ReindexJob$1 = {
|
|
5330
|
+
/**
|
|
5331
|
+
* Unique identifier of the reindex job.
|
|
5332
|
+
*/
|
|
5333
|
+
id?: string;
|
|
5334
|
+
entityType?: ReindexEntityType$1;
|
|
5335
|
+
/**
|
|
5336
|
+
* In case if reindex job finishes with `FAILURE` status, the message is populated with information what was the reason of the failure.
|
|
5337
|
+
*/
|
|
5338
|
+
message?: string;
|
|
5339
|
+
status?: ReindexJobStatus$1;
|
|
5340
|
+
/**
|
|
5341
|
+
* Expected number of entities which need to be indexed.
|
|
5342
|
+
*/
|
|
5343
|
+
expectedCount?: number;
|
|
5344
|
+
/**
|
|
5345
|
+
* Actual number of entities which were indexed. Allows to track the progress of reindexing process.
|
|
5346
|
+
*/
|
|
5347
|
+
processedCount?: number;
|
|
5348
|
+
metadata?: Metadata$3;
|
|
5349
|
+
};
|
|
5350
|
+
type ReindexRequest = {
|
|
5351
|
+
entityType: ReindexEntityType$1;
|
|
5352
|
+
/**
|
|
5353
|
+
* Whether products should be reindexed for RAG. This property is applicable only when `entityType` is `PRODUCT`.
|
|
5354
|
+
*/
|
|
5355
|
+
rag?: boolean;
|
|
5356
|
+
};
|
|
5027
5357
|
type IndexPublicConfiguration = {
|
|
5028
5358
|
/**
|
|
5029
5359
|
* API Key used for search purposes.
|
|
@@ -5052,9 +5382,16 @@ type IndexConfiguration = IndexPublicConfiguration & {
|
|
|
5052
5382
|
*/
|
|
5053
5383
|
writeKey?: string;
|
|
5054
5384
|
/**
|
|
5055
|
-
* Optional list of root product mixin keys to exclude from indexing. When set, the specified mixin keys are omitted from both the non-localized and localized portions of the indexed document. Applies only to the `BATTERY_INCLUDED` provider
|
|
5385
|
+
* Optional list of root product mixin keys to exclude from indexing. When set, the specified mixin keys are omitted from both the non-localized and localized portions of the indexed document. Applies only to the `BATTERY_INCLUDED` provider.
|
|
5056
5386
|
*/
|
|
5057
5387
|
excludedMixinKeys?: Array<string>;
|
|
5388
|
+
/**
|
|
5389
|
+
* Optional allowlist of product mixin paths to include in indexing for the `BATTERY_INCLUDED` provider. Patterns are matched against full dot-notation paths rooted at the mixin key, for example `class_EA673_toolsClassification.sk.OnlineIsService_P`.
|
|
5390
|
+
* `*` matches within a single path segment, `**` matches across one or more path segments, and matching is case sensitive.
|
|
5391
|
+
* If a matched path points to an object, the entire subtree under that object is included. When this field is absent or an empty list, path filtering is inactive and existing `excludedMixinKeys` behavior applies.
|
|
5392
|
+
* `includedMixinPaths` and `excludedMixinKeys` are mutually exclusive when `includedMixinPaths` is non-empty. Malformed glob patterns are rejected with a validation error on configuration writes.
|
|
5393
|
+
*/
|
|
5394
|
+
includedMixinPaths?: Array<string>;
|
|
5058
5395
|
};
|
|
5059
5396
|
type IndexCreationResponse = {
|
|
5060
5397
|
/**
|
|
@@ -5080,9 +5417,28 @@ type IndexConfig = IndexConfiguration;
|
|
|
5080
5417
|
type IndexConfigCreated = IndexCreationResponse;
|
|
5081
5418
|
/** A public indexing configuration. */
|
|
5082
5419
|
type IndexPublicConfig = IndexPublicConfiguration;
|
|
5083
|
-
/**
|
|
5420
|
+
/** A reindex job — tracks the progress of a `FULL` reindex. */
|
|
5421
|
+
type ReindexJob = ReindexJob$1;
|
|
5422
|
+
/** Body for `createReindexJob`: `{ entityType, rag? }` (`entityType` required). */
|
|
5423
|
+
type ReindexJobInput = ReindexRequest;
|
|
5424
|
+
/** Entity type to reindex — `"PRODUCT"` or a custom schema type. */
|
|
5425
|
+
type ReindexEntityType = ReindexEntityType$1;
|
|
5426
|
+
/** Lifecycle status of a {@link ReindexJob}. */
|
|
5427
|
+
type ReindexJobStatus = ReindexJobStatus$1;
|
|
5428
|
+
/**
|
|
5429
|
+
* Body for the legacy `reindex` endpoint.
|
|
5430
|
+
* @deprecated since 2026-06-18, removal 2026-12-01 — use {@link ReindexJobInput} with
|
|
5431
|
+
* `IndexingService.createReindexJob`.
|
|
5432
|
+
*/
|
|
5084
5433
|
type ReindexInput = Reindex;
|
|
5085
5434
|
|
|
5435
|
+
/** Options for {@link IndexingService.listReindexJobs}. */
|
|
5436
|
+
interface ListReindexJobsOptions {
|
|
5437
|
+
pageNumber?: number;
|
|
5438
|
+
pageSize?: number;
|
|
5439
|
+
/** Raw Emporix `q` filter string. */
|
|
5440
|
+
q?: string;
|
|
5441
|
+
}
|
|
5086
5442
|
/**
|
|
5087
5443
|
* Emporix Indexing Service (`/indexing/{tenant}/…`): search-index provider
|
|
5088
5444
|
* configurations and reindex. Server-side; defaults to the service token.
|
|
@@ -5106,7 +5462,22 @@ declare class IndexingService {
|
|
|
5106
5462
|
listPublicConfigurations(auth?: AuthContext): Promise<IndexPublicConfig[]>;
|
|
5107
5463
|
/** Get a public configuration by provider name. */
|
|
5108
5464
|
getPublicConfiguration(provider: string, auth?: AuthContext): Promise<IndexPublicConfig>;
|
|
5109
|
-
/**
|
|
5465
|
+
/**
|
|
5466
|
+
* Create a reindex job (replaces {@link reindex}). A `FULL` reindex of the
|
|
5467
|
+
* given `entityType`; set `rag: true` to also rebuild the RAG vector index
|
|
5468
|
+
* (PRODUCT only). Resolves to the created job (`201`) or, when a job for that
|
|
5469
|
+
* `entityType` is already `IN_PROGRESS`, that running job (`200`).
|
|
5470
|
+
*/
|
|
5471
|
+
createReindexJob(input: ReindexJobInput, auth?: AuthContext): Promise<ReindexJob>;
|
|
5472
|
+
/** List reindex jobs (paginated). */
|
|
5473
|
+
listReindexJobs(opts?: ListReindexJobsOptions, auth?: AuthContext): Promise<PaginatedItems<ReindexJob>>;
|
|
5474
|
+
/** Fetch one reindex job by id. */
|
|
5475
|
+
getReindexJob(reindexJobId: string, auth?: AuthContext): Promise<ReindexJob>;
|
|
5476
|
+
/**
|
|
5477
|
+
* Trigger a reindex.
|
|
5478
|
+
* @deprecated since 2026-06-18, removal 2026-12-01 — use {@link createReindexJob}
|
|
5479
|
+
* (`createReindexJob({ entityType: "PRODUCT" })`), which returns a trackable job.
|
|
5480
|
+
*/
|
|
5110
5481
|
reindex(input: ReindexInput, auth?: AuthContext): Promise<void>;
|
|
5111
5482
|
}
|
|
5112
5483
|
|
|
@@ -6250,6 +6621,9 @@ interface RecalculationJobCreated {
|
|
|
6250
6621
|
* orders, assignees, packaging, packing events, and recalculation jobs.
|
|
6251
6622
|
* Server-side; defaults to the service token. Several mutating endpoints return
|
|
6252
6623
|
* an acknowledgement (`{ message?, code? }`).
|
|
6624
|
+
*
|
|
6625
|
+
* @deprecated since 2026-05-25, removal 2026-08-24 — the Pick-Pack service is
|
|
6626
|
+
* being sunset by Emporix; all endpoints are no longer maintained.
|
|
6253
6627
|
*/
|
|
6254
6628
|
declare class PickPackService {
|
|
6255
6629
|
private readonly ctx;
|
|
@@ -6824,8 +7198,32 @@ type GetApprovalResponse = BasicApproval & {
|
|
|
6824
7198
|
approver?: User;
|
|
6825
7199
|
status?: ApprovalStatus;
|
|
6826
7200
|
expiryDate?: ExpiryDate;
|
|
7201
|
+
legalEntity?: LegalEntity;
|
|
7202
|
+
createdResource?: CreatedResource;
|
|
6827
7203
|
metadata?: Metadata;
|
|
6828
7204
|
};
|
|
7205
|
+
/**
|
|
7206
|
+
* Legal entity (company) the approval belongs to. Set when the approval is created from the customer token.
|
|
7207
|
+
*
|
|
7208
|
+
*/
|
|
7209
|
+
type LegalEntity = {
|
|
7210
|
+
/**
|
|
7211
|
+
* Identifier of the legal entity.
|
|
7212
|
+
*/
|
|
7213
|
+
id: string;
|
|
7214
|
+
};
|
|
7215
|
+
/**
|
|
7216
|
+
* Resource created when the approval flow completes and the approved action is executed. Present once the downstream system has created the linked entity; omitted until then.
|
|
7217
|
+
*
|
|
7218
|
+
* For checkout approvals (`action: CHECKOUT`), `id` is typically the order identifier (for example, from Order Service).
|
|
7219
|
+
*
|
|
7220
|
+
*/
|
|
7221
|
+
type CreatedResource = {
|
|
7222
|
+
/**
|
|
7223
|
+
* Identifier of the created resource (for checkout approvals, typically an order ID).
|
|
7224
|
+
*/
|
|
7225
|
+
id: string;
|
|
7226
|
+
};
|
|
6829
7227
|
/**
|
|
6830
7228
|
* Base schema for approval permitted response.
|
|
6831
7229
|
*/
|
|
@@ -7060,6 +7458,12 @@ type SearchUsersRequest = {
|
|
|
7060
7458
|
* `approval-service` types (single source of truth; faithful required/optional flags).
|
|
7061
7459
|
*
|
|
7062
7460
|
* Every endpoint is CustomerAccessToken-only (B2B cart/quote approval workflows).
|
|
7461
|
+
*
|
|
7462
|
+
* Deprecated upstream (since 2026-05-26, removal 2026-11-30) — these fields carry
|
|
7463
|
+
* `@deprecated` in the generated types; prefer the replacements:
|
|
7464
|
+
* - `totalPrice.amount` / `subTotalPrice.amount` → `netValue` / `grossValue` / `taxValue`
|
|
7465
|
+
* - `itemYrn` → `itemId`
|
|
7466
|
+
* - `itemPrice.amount` → `calculatedPrice` and `unitPrice`
|
|
7063
7467
|
*/
|
|
7064
7468
|
|
|
7065
7469
|
/** An approval document (read shape). */
|
|
@@ -7261,4 +7665,4 @@ declare function createEmporixClient<S extends Record<string, ServiceClass<unkno
|
|
|
7261
7665
|
*/
|
|
7262
7666
|
declare function productIdFromYrn(yrn: string | undefined): string;
|
|
7263
7667
|
|
|
7264
|
-
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, CartService, type Catalog, type CatalogCreated, type CatalogInput, type CatalogList, type CatalogPatch, CatalogService, type CatalogUpdate, CategoryService, type CgRelation, type CgRelationList, type ChatRequest, type ChatResponse, CheckoutService, ClientConfigService, type ClientConfiguration, ClientContext, CloudFunctionsService, CompaniesService, type CompletionMessage, type CompletionRequest, type CompletionResponse, type Configuration$1 as Configuration, type ConfigurationDraft, ContactsService, 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 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 ReindexInput, 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 };
|
|
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 };
|