@viu/emporix-sdk 2.19.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.
Files changed (46) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/dist/availability.d.cts +1 -1
  3. package/dist/availability.d.ts +1 -1
  4. package/dist/cart.d.cts +1 -1
  5. package/dist/cart.d.ts +1 -1
  6. package/dist/category.cjs +12 -0
  7. package/dist/category.cjs.map +1 -1
  8. package/dist/category.d.cts +12 -2
  9. package/dist/category.d.ts +12 -2
  10. package/dist/category.js +1 -1
  11. package/dist/checkout.d.cts +1 -1
  12. package/dist/checkout.d.ts +1 -1
  13. package/dist/{chunk-6XND7SYV.js → chunk-ZNLHLFQM.js} +14 -2
  14. package/dist/chunk-ZNLHLFQM.js.map +1 -0
  15. package/dist/companies.d.cts +1 -1
  16. package/dist/companies.d.ts +1 -1
  17. package/dist/contacts.d.cts +1 -1
  18. package/dist/contacts.d.ts +1 -1
  19. package/dist/{context-DhoFgoKf.d.cts → context-Dawv2AtS.d.cts} +16 -0
  20. package/dist/{context-DhoFgoKf.d.ts → context-Dawv2AtS.d.ts} +16 -0
  21. package/dist/customer-groups.d.cts +1 -1
  22. package/dist/customer-groups.d.ts +1 -1
  23. package/dist/customer.d.cts +1 -1
  24. package/dist/customer.d.ts +1 -1
  25. package/dist/index.cjs +461 -299
  26. package/dist/index.cjs.map +1 -1
  27. package/dist/index.d.cts +238 -17
  28. package/dist/index.d.ts +238 -17
  29. package/dist/index.js +153 -3
  30. package/dist/index.js.map +1 -1
  31. package/dist/locations.d.cts +1 -1
  32. package/dist/locations.d.ts +1 -1
  33. package/dist/media.d.cts +17 -2
  34. package/dist/media.d.ts +17 -2
  35. package/dist/orders.d.cts +10 -27
  36. package/dist/orders.d.ts +10 -27
  37. package/dist/payment.d.cts +1 -1
  38. package/dist/payment.d.ts +1 -1
  39. package/dist/price.d.cts +5 -18
  40. package/dist/price.d.ts +5 -18
  41. package/dist/product.d.cts +7 -1
  42. package/dist/product.d.ts +7 -1
  43. package/dist/segment.d.cts +1 -1
  44. package/dist/segment.d.ts +1 -1
  45. package/package.json +1 -1
  46. package/dist/chunk-6XND7SYV.js.map +0 -1
package/dist/index.d.cts 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-DhoFgoKf.cjs';
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-DhoFgoKf.cjs';
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.cjs';
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.cjs';
3
3
  import { CustomerService } from './customer.cjs';
4
4
  export { Address, AddressCreateInput, AddressUpdateInput, Customer, CustomerSession, CustomerSignupInput, CustomerUpdateInput, PasswordChangeInput, PasswordResetConfirmInput, PasswordResetRequestInput } from './customer.cjs';
5
5
  import { ProductService } from './product.cjs';
@@ -834,7 +834,7 @@ declare class CloudFunctionsService {
834
834
 
835
835
  type AbstractWebhookConfig = {
836
836
  /**
837
- * 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.
838
838
  */
839
839
  active?: boolean;
840
840
  provider?: Provider;
@@ -942,9 +942,16 @@ type ConfigurationGet = {
942
942
  }>;
943
943
  };
944
944
  /**
945
- * Unique identifier of webhook configuration.
945
+ * Unique identifier of the webhook configuration type.
946
946
  */
947
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
+ */
948
955
  type Provider = 'SVIX_SHARED' | 'SVIX' | 'HTTP';
949
956
  type WebhookConfigUpdate = AbstractWebhookConfig & {
950
957
  configuration?: Configuration;
@@ -1177,7 +1184,7 @@ declare class WebhookService {
1177
1184
  /**
1178
1185
  * Type which the schema should be assigned to. Can be one of the predefined values or any custom schema type id.
1179
1186
  */
1180
- 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';
1181
1188
  /**
1182
1189
  * Type of the attribute.
1183
1190
  *
@@ -1378,6 +1385,42 @@ type CustomInstanceResponse = {
1378
1385
  media?: Array<string>;
1379
1386
  metadata?: CustomInstanceMetadata;
1380
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
+ }>;
1381
1424
  type CustomInstanceMetadata = {
1382
1425
  /**
1383
1426
  * Date and time when the object was created, compliant with the ISO 8601 standard. For example: `2022-03-31T09:52:15.423Z`
@@ -1399,6 +1442,10 @@ type CustomInstanceMetadata = {
1399
1442
  };
1400
1443
  };
1401
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;
1402
1449
  /** A schema definition (typed attributes attached to one or more entity types). */
1403
1450
  type Schema = SchemaResponse;
1404
1451
  /** A single typed attribute within a schema (recursive for `OBJECT`). */
@@ -1541,6 +1588,13 @@ declare class SchemaService {
1541
1588
  replaceInstance<T = Record<string, unknown>>(type: string, id: string, draft: CustomInstanceDraft<T>, auth?: AuthContext): Promise<CustomInstance<T>>;
1542
1589
  /** Partially update an instance (`PATCH`). */
1543
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>;
1544
1598
  /** Delete an instance by id. */
1545
1599
  deleteInstance(type: string, id: string, auth?: AuthContext): Promise<void>;
1546
1600
  /**
@@ -1619,9 +1673,9 @@ type ExpandedTokenResponse = InnerTokenResponse & {
1619
1673
  */
1620
1674
  type ExpandableTokenResponse = InnerTokenResponse | ExpandedTokenResponse;
1621
1675
  /**
1622
- * Type of the native tool.
1676
+ * Type of the native tool. Value `teams` is in preview.
1623
1677
  */
1624
- type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix';
1678
+ type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix' | 'teams';
1625
1679
  type BaseNativeTool = {
1626
1680
  type: NativeToolType;
1627
1681
  /**
@@ -1781,6 +1835,49 @@ type SlackNativeToolResponse = BaseNativeTool & {
1781
1835
  config?: SlackNativeToolConfigResponse;
1782
1836
  metadata?: MetadataResponse$1;
1783
1837
  };
1838
+ /**
1839
+ * MS Teams native tool operation identifier.
1840
+ */
1841
+ type TeamsAllowedOperations = 'sendMessage' | 'createChat' | 'createChannel' | 'inviteParticipants' | 'collaborateOnChannel' | 'collaborateOnChat';
1842
+ /**
1843
+ * ![Preview](https://res.cloudinary.com/saas-ag/image/upload/v1752824268/emporix/icons/preview_api1.png)
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
+ };
1784
1881
  type RagCustomNativeToolResponse = BaseNativeTool & {
1785
1882
  /**
1786
1883
  * Unique identifier of the tool.
@@ -1808,7 +1905,40 @@ type RagEmporixNativeToolResponse = BaseNativeTool & {
1808
1905
  /**
1809
1906
  * List of native tools which agents should have access to.
1810
1907
  */
1811
- 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
+ };
1812
1942
  type McpServerConfig = {
1813
1943
  /**
1814
1944
  * URL of the MCP server.
@@ -1893,11 +2023,11 @@ type BaseLlm = {
1893
2023
  /**
1894
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.
1895
2025
  */
1896
- temperature: 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 1;
2026
+ temperature?: 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 1;
1897
2027
  /**
1898
2028
  * The limit of tokens which agent can burn during one request session.
1899
2029
  */
1900
- maxTokens: number;
2030
+ maxTokens?: number;
1901
2031
  };
1902
2032
  type EmporixLlm = BaseLlm & {
1903
2033
  /**
@@ -1905,6 +2035,35 @@ type EmporixLlm = BaseLlm & {
1905
2035
  */
1906
2036
  provider: 'emporix_openai';
1907
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
+ };
1908
2067
  type SelfHostedParams = {
1909
2068
  /**
1910
2069
  * Url of the self-hosted LLM.
@@ -1919,9 +2078,11 @@ type SelfHostedParamsRequest = SelfHostedParams & {
1919
2078
  [key: string]: unknown;
1920
2079
  } & {
1921
2080
  authorizationHeaderToken?: InnerTokenRequest;
2081
+ oAuthParams?: OAuthParamsRequest;
1922
2082
  };
1923
2083
  type SelfHostedParamsResponse = SelfHostedParams & {
1924
2084
  authorizationHeaderToken?: ExpandableTokenResponse;
2085
+ oAuthParams?: OAuthParamsResponse;
1925
2086
  };
1926
2087
  type SelfHostedLlm = BaseLlm & {
1927
2088
  /**
@@ -1948,8 +2109,24 @@ type ApiKeyLlmRequest = ApiKeyLlm & {
1948
2109
  type ApiKeyLlmResponse = ApiKeyLlm & {
1949
2110
  token?: ExpandableTokenResponse;
1950
2111
  };
1951
- type IdWrapper = {
2112
+ /**
2113
+ * ![Preview](https://res.cloudinary.com/saas-ag/image/upload/v1752824268/emporix/icons/preview_api1.png)
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
+ */
1952
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>;
1953
2130
  };
1954
2131
  /**
1955
2132
  * List of agent collaborations which allows an agent to hand off its task to other agents.
@@ -2093,6 +2270,11 @@ type BaseForAgentAndTemplate = BaseForAgentAndTemplateAndHandOff & {
2093
2270
  */
2094
2271
  icon?: string;
2095
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;
2096
2278
  /**
2097
2279
  * Indicates whether the agent is enabled.
2098
2280
  */
@@ -2112,9 +2294,9 @@ type BaseForAgentRequestAndResponse = BaseForAgentAndTemplate & {
2112
2294
  };
2113
2295
  type AgentRequest = BaseForAgentRequestAndResponse & {
2114
2296
  /**
2115
- * ID of the native tools.
2297
+ * Native tools assigned to the agent, optionally with per-agent `allowedOperations` overrides.
2116
2298
  */
2117
- nativeTools?: Array<IdWrapper>;
2299
+ nativeTools?: Array<NativeToolReferenceRequest>;
2118
2300
  llmConfig: EmporixLlm | ApiKeyLlmRequest | SelfHostedLlmRequest;
2119
2301
  mcpServers: AgentMcpServersRequest;
2120
2302
  metadata?: MetadataRequest;
@@ -2186,6 +2368,7 @@ type PatchRequest = Array<{
2186
2368
  [key: string]: unknown;
2187
2369
  };
2188
2370
  }>;
2371
+ type QParamSearchBody2 = QParamSearchBody;
2189
2372
 
2190
2373
  /** Single-shot text generation request (`POST /texts`). Has `maxTokens`. */
2191
2374
  type TextRequest = TextGenerationRequest;
@@ -2241,6 +2424,18 @@ interface DeleteAgentOptions {
2241
2424
  /** Force deletion even if the agent is referenced elsewhere (`?force=true`). */
2242
2425
  force?: boolean;
2243
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;
2244
2439
 
2245
2440
  /**
2246
2441
  * Emporix AI Service (`/ai-service/{tenant}/…`): text generation, chat
@@ -2292,6 +2487,17 @@ declare class AiService {
2292
2487
  * Returns the job-id ARRAY verbatim.
2293
2488
  */
2294
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[]>;
2295
2501
  }
2296
2502
 
2297
2503
  type Metadata$7 = {
@@ -5103,9 +5309,9 @@ declare class SepaExportService {
5103
5309
  }
5104
5310
 
5105
5311
  /**
5106
- * 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.
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.
5107
5313
  */
5108
- type ReindexJobStatus$1 = 'FAILURE' | 'IN_PROGRESS' | 'PENDING' | 'SUCCESS';
5314
+ type ReindexJobStatus$1 = 'FAILURE' | 'IN_PROGRESS' | 'PENDING' | 'PUBLISHED' | 'SUCCESS';
5109
5315
  type Metadata$3 = {
5110
5316
  /**
5111
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`
@@ -5131,6 +5337,14 @@ type ReindexJob$1 = {
5131
5337
  */
5132
5338
  message?: string;
5133
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;
5134
5348
  metadata?: Metadata$3;
5135
5349
  };
5136
5350
  type ReindexRequest = {
@@ -5168,9 +5382,16 @@ type IndexConfiguration = IndexPublicConfiguration & {
5168
5382
  */
5169
5383
  writeKey?: string;
5170
5384
  /**
5171
- * 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; ignored for `ALGOLIA`.
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.
5172
5386
  */
5173
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>;
5174
5395
  };
5175
5396
  type IndexCreationResponse = {
5176
5397
  /**
@@ -7444,4 +7665,4 @@ declare function createEmporixClient<S extends Record<string, ServiceClass<unkno
7444
7665
  */
7445
7666
  declare function productIdFromYrn(yrn: string | undefined): string;
7446
7667
 
7447
- 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 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 };
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 };