@viu/emporix-sdk 3.6.0 → 4.0.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 +108 -0
- package/README.md +2 -2
- package/dist/availability.d.cts +1 -1
- package/dist/availability.d.ts +1 -1
- package/dist/cart.d.cts +1 -1
- package/dist/cart.d.ts +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-3G5KROEC.js → chunk-XJJDCK2Z.js} +80 -3
- package/dist/chunk-XJJDCK2Z.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-CZdtWgQO.d.cts → context-5lt8Q0MT.d.cts} +1 -1
- package/dist/{context-CZdtWgQO.d.ts → context-5lt8Q0MT.d.ts} +1 -1
- package/dist/{customer-groups-OEnqHFsX.d.cts → customer-groups-8cgS8S5d.d.cts} +1 -1
- package/dist/{customer-groups-DhrOoC8M.d.ts → customer-groups-DizW_a-w.d.ts} +1 -1
- package/dist/customer-groups.d.cts +2 -2
- package/dist/customer-groups.d.ts +2 -2
- package/dist/customer.d.cts +1 -1
- package/dist/customer.d.ts +1 -1
- package/dist/index.cjs +201 -139
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +315 -601
- package/dist/index.d.ts +315 -601
- package/dist/index.js +126 -140
- 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 +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 +1 -1
- package/dist/price.d.ts +1 -1
- package/dist/product.d.cts +1 -1
- package/dist/product.d.ts +1 -1
- package/dist/segment.cjs +78 -1
- package/dist/segment.cjs.map +1 -1
- package/dist/segment.d.cts +90 -3
- package/dist/segment.d.ts +90 -3
- package/dist/segment.js +1 -1
- package/package.json +1 -1
- package/dist/chunk-3G5KROEC.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { q as StoredAnonymousSession, b as AuthContext, C as ClientContext, P as PaginatedItems, T as TokenProvider, o as ResolvedConfig, E as EmporixConfig, k as LogLevel, p 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, h as HttpResult, L as LEVEL, i as LevelResolver, j as LogFields, l as Logger, m as LoggerConfig, n as LoggerObjectConfig, R as RequestOptions, S as ServiceCredentials, r as StorefrontCredentials, s as auth, t as createConsoleLogger, u as createNoopLogger, v as iterateAll, w as redact, x as resolveToken, y as validateConfig } from './context-
|
|
1
|
+
import { q as StoredAnonymousSession, b as AuthContext, C as ClientContext, P as PaginatedItems, T as TokenProvider, o as ResolvedConfig, E as EmporixConfig, k as LogLevel, p as ServiceName, e as CustomerTokenRefresher } from './context-5lt8Q0MT.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, h as HttpResult, L as LEVEL, i as LevelResolver, j as LogFields, l as Logger, m as LoggerConfig, n as LoggerObjectConfig, R as RequestOptions, S as ServiceCredentials, r as StorefrontCredentials, s as auth, t as createConsoleLogger, u as createNoopLogger, v as iterateAll, w as redact, x as resolveToken, y as validateConfig } from './context-5lt8Q0MT.js';
|
|
3
3
|
import { CustomerService } from './customer.js';
|
|
4
4
|
export { Address, AddressCreateInput, AddressUpdateInput, ChangeEmailInput, ConfirmEmailChangeInput, Customer, CustomerSession, CustomerSignupInput, CustomerUpdateInput, PasswordChangeInput, PasswordResetConfirmInput, PasswordResetRequestInput, ResendActivationInput } from './customer.js';
|
|
5
5
|
import { ProductService } from './product.js';
|
|
@@ -21,7 +21,7 @@ export { Segment, SegmentAssignmentBulkResult, SegmentBulkItem, SegmentBulkResul
|
|
|
21
21
|
import { CompaniesService } from './companies.js';
|
|
22
22
|
import { ContactsService } from './contacts.js';
|
|
23
23
|
import { LocationsService } from './locations.js';
|
|
24
|
-
import { m as UserResponse, U as UserCreateRequest, l as UserIdResponse, k as UserExtendedResponse, o as UserUpdateRequest, j as GroupsQueryDocument, n as UserScopesResponse, a as AccessControlQueryDocument, G as GroupCreateRequest, h as GroupIdResponse, i as GroupUpdateRequest, c as AssignmentCreateRequest, d as AssignmentIdResponse, b as AccessControlUpsertRequest, A as AccessControlIdResponse, e as CustomScopeQueryDocument, f as CustomScopeUpsertRequest, C as CustomScopeIdResponse, g as CustomerGroupsService } from './customer-groups-
|
|
24
|
+
import { m as UserResponse, U as UserCreateRequest, l as UserIdResponse, k as UserExtendedResponse, o as UserUpdateRequest, j as GroupsQueryDocument, n as UserScopesResponse, a as AccessControlQueryDocument, G as GroupCreateRequest, h as GroupIdResponse, i as GroupUpdateRequest, c as AssignmentCreateRequest, d as AssignmentIdResponse, b as AccessControlUpsertRequest, A as AccessControlIdResponse, e as CustomScopeQueryDocument, f as CustomScopeUpsertRequest, C as CustomScopeIdResponse, g as CustomerGroupsService } from './customer-groups-DizW_a-w.js';
|
|
25
25
|
import { OrdersService, SalesOrdersService } from './orders.js';
|
|
26
26
|
export { GetOrderOptions, ListLegalEntityOrdersOptions, ListMyOrdersOptions, ListSalesOrdersOptions, Order, OrderEntry, OrderStatus, OrderTransitionOptions, SalesOrder, SalesOrderCalculationInput, SalesOrderCreateInput, SalesOrderCreated, SalesOrderEntriesInput, SalesOrderHistoricalTransitions, SalesOrderPatch, SalesOrderReplaceInput, SalesOrderSearchInput, SalesOrderSplitInput, SalesOrderSplitResult, Transition, UpdateSalesOrderOptions } from './orders.js';
|
|
27
27
|
import { AvailabilityService } from './availability.js';
|
|
@@ -2815,7 +2815,7 @@ type AgenticRequest = {
|
|
|
2815
2815
|
message: string;
|
|
2816
2816
|
attachments?: Array<{
|
|
2817
2817
|
/**
|
|
2818
|
-
*
|
|
2818
|
+
* Identifier returned by the upload. Required for each attached file. The attachment must belong to the current session and be attached to this request's `agentId`.
|
|
2819
2819
|
*/
|
|
2820
2820
|
attachmentId: string;
|
|
2821
2821
|
/**
|
|
@@ -3415,7 +3415,7 @@ type CommerceEventsResponse = {
|
|
|
3415
3415
|
*/
|
|
3416
3416
|
type McpServerType = 'custom' | 'predefined' | 'dynamic';
|
|
3417
3417
|
/**
|
|
3418
|
-
* Type of the communication between the agent and the MCP server. The `streamable_http` protocol is recommended, since the `sse` protocol is deprecated.
|
|
3418
|
+
* Type of the communication between the agent and the MCP server. The `streamable_http` protocol is recommended, since the `sse` protocol is deprecated as transport for custom MCP servers.
|
|
3419
3419
|
*/
|
|
3420
3420
|
type CustomMcpServerTransportType = 'streamable_http' | 'sse';
|
|
3421
3421
|
type BaseAgentMcpServer = {
|
|
@@ -3670,7 +3670,7 @@ type NativeToolReferenceRequest = {
|
|
|
3670
3670
|
allowedOperations?: Array<TeamsAllowedOperations | SlackAllowedOperations>;
|
|
3671
3671
|
};
|
|
3672
3672
|
/**
|
|
3673
|
-
* List of agent collaborations which allows an agent to hand off its task to other agents.
|
|
3673
|
+
* List of agent collaborations which allows an agent to hand off its task to other agents. Collaborations remain in the caller's session and do not enable memory by themselves.
|
|
3674
3674
|
*/
|
|
3675
3675
|
type AgentCollaborations = Array<{
|
|
3676
3676
|
/**
|
|
@@ -3772,7 +3772,9 @@ type AgentTrigger = {
|
|
|
3772
3772
|
};
|
|
3773
3773
|
};
|
|
3774
3774
|
/**
|
|
3775
|
-
* Indicates whether the agent is
|
|
3775
|
+
* Deprecated. Indicates whether the agent is a hand-off agent. This field is no longer used. Clients should ignore it.
|
|
3776
|
+
*
|
|
3777
|
+
* @deprecated
|
|
3776
3778
|
*/
|
|
3777
3779
|
type HandOff = boolean;
|
|
3778
3780
|
type BaseForAgentAndTemplateAndHandOff = {
|
|
@@ -3833,7 +3835,7 @@ type BaseForAgentRequestAndResponse = BaseForAgentAndTemplate & {
|
|
|
3833
3835
|
*/
|
|
3834
3836
|
maxRecursionLimit?: number;
|
|
3835
3837
|
/**
|
|
3836
|
-
* Defines whether
|
|
3838
|
+
* Defines whether session memory is stored between different agent calls. Memory is stored only for that agent and only within one `session-id`. The default is `false`. To keep conversational memory for targets in `agentCollaborations`, it is recommended to set the flag to `true` on each target as well.
|
|
3837
3839
|
*/
|
|
3838
3840
|
enabledMemory?: boolean;
|
|
3839
3841
|
};
|
|
@@ -3866,6 +3868,9 @@ type AgentResponse = BaseForAgentRequestAndResponse & {
|
|
|
3866
3868
|
nativeTools?: NativeToolsResponse;
|
|
3867
3869
|
llmConfig?: EmporixLlm | ApiKeyLlmResponse | SelfHostedLlmResponse;
|
|
3868
3870
|
mcpServers?: AgentMcpServersResponse;
|
|
3871
|
+
/**
|
|
3872
|
+
* @deprecated
|
|
3873
|
+
*/
|
|
3869
3874
|
handOff?: HandOff;
|
|
3870
3875
|
type?: AgentType;
|
|
3871
3876
|
/**
|
|
@@ -3912,7 +3917,7 @@ type Job$1 = {
|
|
|
3912
3917
|
exportResult?: ExportResult;
|
|
3913
3918
|
importResult?: ImportResult;
|
|
3914
3919
|
/**
|
|
3915
|
-
* Unique identifier of the session.
|
|
3920
|
+
* Unique identifier of the session. Send this value back as the `session-id` header on later chat and attachment calls.
|
|
3916
3921
|
*/
|
|
3917
3922
|
sessionId?: string;
|
|
3918
3923
|
/**
|
|
@@ -3995,7 +4000,7 @@ type AttachmentResponse = {
|
|
|
3995
4000
|
*/
|
|
3996
4001
|
id?: string;
|
|
3997
4002
|
/**
|
|
3998
|
-
* Unique identifier of the session.
|
|
4003
|
+
* Unique identifier of the session the attachment is on. Send this value as the `session-id` header on later chat requests. If the assign request omits `session-id`, this value is the generated session.
|
|
3999
4004
|
*/
|
|
4000
4005
|
sessionId?: string;
|
|
4001
4006
|
};
|
|
@@ -4056,6 +4061,14 @@ type AgentRequestResponse = {
|
|
|
4056
4061
|
* Duration of the request in seconds.
|
|
4057
4062
|
*/
|
|
4058
4063
|
duration?: number;
|
|
4064
|
+
/**
|
|
4065
|
+
* Cumulative LLM prompt token count for this request.
|
|
4066
|
+
*/
|
|
4067
|
+
promptTokens?: number;
|
|
4068
|
+
/**
|
|
4069
|
+
* Cumulative LLM completion token count for this request.
|
|
4070
|
+
*/
|
|
4071
|
+
completionTokens?: number;
|
|
4059
4072
|
metadata?: MetadataResponse$1;
|
|
4060
4073
|
};
|
|
4061
4074
|
type AgentSessionResponse = {
|
|
@@ -4080,6 +4093,14 @@ type AgentSessionResponse = {
|
|
|
4080
4093
|
* Duration of the session in seconds.
|
|
4081
4094
|
*/
|
|
4082
4095
|
duration?: number;
|
|
4096
|
+
/**
|
|
4097
|
+
* Cumulative LLM prompt token count for this session.
|
|
4098
|
+
*/
|
|
4099
|
+
promptTokens?: number;
|
|
4100
|
+
/**
|
|
4101
|
+
* Cumulative LLM completion token count for this session.
|
|
4102
|
+
*/
|
|
4103
|
+
completionTokens?: number;
|
|
4083
4104
|
metadata?: MetadataResponse$1;
|
|
4084
4105
|
};
|
|
4085
4106
|
/**
|
|
@@ -4326,14 +4347,17 @@ interface DeleteAgentOptions {
|
|
|
4326
4347
|
/** Force deletion even if the agent is referenced elsewhere (`?force=true`). */
|
|
4327
4348
|
force?: boolean;
|
|
4328
4349
|
}
|
|
4329
|
-
/** Options for {@link AiService.chatStream}. */
|
|
4330
|
-
interface
|
|
4350
|
+
/** Options for {@link AiService.chat}, {@link AiService.chatAsync} and {@link AiService.chatStream}. */
|
|
4351
|
+
interface ChatOptions {
|
|
4331
4352
|
/**
|
|
4332
4353
|
* Reuse an existing chat context (sent as the `session-id` header). If
|
|
4333
|
-
* omitted, the server generates a new session id.
|
|
4354
|
+
* omitted, the server generates a new session id. Required to chat about an
|
|
4355
|
+
* attachment: pass the `sessionId` its upload or reuse returned.
|
|
4334
4356
|
*/
|
|
4335
4357
|
sessionId?: string;
|
|
4336
4358
|
}
|
|
4359
|
+
/** @deprecated Use {@link ChatOptions}; the three chat methods share it. */
|
|
4360
|
+
type ChatStreamOptions = ChatOptions;
|
|
4337
4361
|
/** A stored agentic conversation (Teams-backed). */
|
|
4338
4362
|
type Conversation = ConversationResponse;
|
|
4339
4363
|
/** Request body for `searchConversations` (`{ q? }`) — same shape as agent search. */
|
|
@@ -4428,13 +4452,11 @@ interface AttachmentOptions {
|
|
|
4428
4452
|
sessionId?: string;
|
|
4429
4453
|
}
|
|
4430
4454
|
/**
|
|
4431
|
-
* Options for {@link AiService.reuseAttachment}. `
|
|
4432
|
-
*
|
|
4433
|
-
* the session named by the `session-id` header, so omitting it is a guaranteed
|
|
4434
|
-
* `400` rather than a new session.
|
|
4455
|
+
* Options for {@link AiService.reuseAttachment}. Sent as the `session-id`
|
|
4456
|
+
* header; omitted, the service opens a new session and returns its id.
|
|
4435
4457
|
*/
|
|
4436
4458
|
interface AttachmentReuseOptions {
|
|
4437
|
-
sessionId
|
|
4459
|
+
sessionId?: string;
|
|
4438
4460
|
}
|
|
4439
4461
|
/** Base64+checksum export of agents with their components. */
|
|
4440
4462
|
type AgentsExport = ExportResponse;
|
|
@@ -4605,20 +4627,25 @@ declare class AiService {
|
|
|
4605
4627
|
/**
|
|
4606
4628
|
* Synchronous agent chat (`POST /agentic/chat`). Returns the response
|
|
4607
4629
|
* ARRAY verbatim (the upstream contract is an array, not a single object).
|
|
4630
|
+
*
|
|
4631
|
+
* `opts.sessionId` is sent as the `session-id` header. It carries the
|
|
4632
|
+
* conversation — continuity needs it plus `enabledMemory` on the agent — and
|
|
4633
|
+
* it is how a chat reaches an attachment: pass the `sessionId` the upload or
|
|
4634
|
+
* reuse returned, and list the file under `input.attachments`.
|
|
4608
4635
|
*/
|
|
4609
|
-
chat(input: ChatRequest, auth?: AuthContext): Promise<ChatResponse[]>;
|
|
4636
|
+
chat(input: ChatRequest, opts?: ChatOptions, auth?: AuthContext): Promise<ChatResponse[]>;
|
|
4610
4637
|
/**
|
|
4611
4638
|
* Fire-and-forget agent chat (`POST /agentic/chat-async`, HTTP 201).
|
|
4612
|
-
* Returns the job-id ARRAY verbatim.
|
|
4639
|
+
* Returns the job-id ARRAY verbatim. `opts` as for {@link chat}.
|
|
4613
4640
|
*/
|
|
4614
|
-
chatAsync(input: ChatRequest, auth?: AuthContext): Promise<JobIdResponse[]>;
|
|
4641
|
+
chatAsync(input: ChatRequest, opts?: ChatOptions, auth?: AuthContext): Promise<JobIdResponse[]>;
|
|
4615
4642
|
/**
|
|
4616
4643
|
* Streaming agent chat (`POST /agentic/chat-stream`, `text/event-stream`).
|
|
4617
4644
|
* Yields each SSE `data` payload verbatim — the upstream contract types the
|
|
4618
4645
|
* stream body as an opaque string, so chunks are raw strings, not parsed
|
|
4619
|
-
* objects. Consume with `for await`.
|
|
4646
|
+
* objects. Consume with `for await`. `opts` as for {@link chat}.
|
|
4620
4647
|
*/
|
|
4621
|
-
chatStream(input: ChatRequest, opts?:
|
|
4648
|
+
chatStream(input: ChatRequest, opts?: ChatOptions, auth?: AuthContext): AsyncIterable<string>;
|
|
4622
4649
|
/** List stored agentic conversations (`GET /agentic/conversations`). */
|
|
4623
4650
|
listConversations(auth?: AuthContext): Promise<Conversation[]>;
|
|
4624
4651
|
/** Server-side conversation search (`POST /agentic/conversations/search`). */
|
|
@@ -4639,20 +4666,23 @@ declare class AiService {
|
|
|
4639
4666
|
*/
|
|
4640
4667
|
uploadAttachment(agentId: string, attachment: Blob | File, opts?: AttachmentOptions, auth?: AuthContext): Promise<Attachment>;
|
|
4641
4668
|
/**
|
|
4642
|
-
* Assign an
|
|
4669
|
+
* Assign an existing media asset to an agent as a chat attachment
|
|
4643
4670
|
* (`POST /agentic/{agentId}/attachments` with the `attachmentId` form field,
|
|
4644
|
-
* HTTP
|
|
4671
|
+
* HTTP 200). Resolves to the attachment `id` and the `sessionId` to send on
|
|
4672
|
+
* the following chat calls.
|
|
4645
4673
|
*
|
|
4646
4674
|
* Use it to hand a second agent the same file instead of uploading it twice.
|
|
4647
|
-
*
|
|
4648
|
-
*
|
|
4675
|
+
* Pass `opts.sessionId` to attach to an existing chat session; without it the
|
|
4676
|
+
* service opens a new one and returns its id — thread that into the chat, or
|
|
4677
|
+
* the agent never sees the file. With `ai.agentexecution_manage` the asset may
|
|
4678
|
+
* be any media asset, not only one uploaded to this session.
|
|
4649
4679
|
*
|
|
4650
4680
|
* ```ts
|
|
4651
4681
|
* const { id, sessionId } = await client.ai.uploadAttachment("agent-a", file);
|
|
4652
4682
|
* await client.ai.reuseAttachment("agent-b", id!, { sessionId: sessionId! });
|
|
4653
4683
|
* ```
|
|
4654
4684
|
*/
|
|
4655
|
-
reuseAttachment(agentId: string, attachmentId: string, opts
|
|
4685
|
+
reuseAttachment(agentId: string, attachmentId: string, opts?: AttachmentReuseOptions, auth?: AuthContext): Promise<Attachment>;
|
|
4656
4686
|
/** Export agents + components as a base64/checksum blob (`POST /agentic/agents/export`). */
|
|
4657
4687
|
exportAgents(body: AgentsExportRequest, auth?: AuthContext): Promise<AgentsExport>;
|
|
4658
4688
|
/** Import previously-exported agents (`POST /agentic/agents/import`). */
|
|
@@ -4679,7 +4709,7 @@ type Metadata$7 = {
|
|
|
4679
4709
|
* Tax configuration for a specified location. It consists of a country code and a list of tax classes applicable in that country.
|
|
4680
4710
|
*/
|
|
4681
4711
|
type TaxCreation = {
|
|
4682
|
-
location: Location$
|
|
4712
|
+
location: Location$1;
|
|
4683
4713
|
/**
|
|
4684
4714
|
* List of tax classes applicable in the specified country.
|
|
4685
4715
|
*/
|
|
@@ -4692,7 +4722,7 @@ type TaxCreation = {
|
|
|
4692
4722
|
*/
|
|
4693
4723
|
type TaxRetrieval = {
|
|
4694
4724
|
locationCode?: string;
|
|
4695
|
-
location?: Location$
|
|
4725
|
+
location?: Location$1;
|
|
4696
4726
|
/**
|
|
4697
4727
|
* List of tax classes applicable in the specified country.
|
|
4698
4728
|
*/
|
|
@@ -4773,7 +4803,7 @@ type TaxCalculationRequest = {
|
|
|
4773
4803
|
*
|
|
4774
4804
|
* **Note**: This field is only mandatory if the `includesTax` field is set to `true`.
|
|
4775
4805
|
*/
|
|
4776
|
-
sourceLocation?: Location$
|
|
4806
|
+
sourceLocation?: Location$1;
|
|
4777
4807
|
/**
|
|
4778
4808
|
* Tax class originally applied to the provided price.
|
|
4779
4809
|
*
|
|
@@ -4783,7 +4813,7 @@ type TaxCalculationRequest = {
|
|
|
4783
4813
|
/**
|
|
4784
4814
|
* Country for which the price should be calculated.
|
|
4785
4815
|
*/
|
|
4786
|
-
targetLocation: Location$
|
|
4816
|
+
targetLocation: Location$1;
|
|
4787
4817
|
/**
|
|
4788
4818
|
* Tax class that should be applied when calculating the price.
|
|
4789
4819
|
*/
|
|
@@ -4819,7 +4849,7 @@ type TaxCalculationResponse = {
|
|
|
4819
4849
|
/**
|
|
4820
4850
|
* Country for which the provided price was originally defined.
|
|
4821
4851
|
*/
|
|
4822
|
-
sourceLocation?: Location$
|
|
4852
|
+
sourceLocation?: Location$1;
|
|
4823
4853
|
/**
|
|
4824
4854
|
* Tax class originally applied to the provided price.
|
|
4825
4855
|
*/
|
|
@@ -4827,7 +4857,7 @@ type TaxCalculationResponse = {
|
|
|
4827
4857
|
/**
|
|
4828
4858
|
* Country for which the price was calculated.
|
|
4829
4859
|
*/
|
|
4830
|
-
targetLocation?: Location$
|
|
4860
|
+
targetLocation?: Location$1;
|
|
4831
4861
|
/**
|
|
4832
4862
|
* Tax class that was applied when calculating the price.
|
|
4833
4863
|
*/
|
|
@@ -4868,7 +4898,7 @@ type TaxCalculationResponse = {
|
|
|
4868
4898
|
targetTaxRate?: number;
|
|
4869
4899
|
};
|
|
4870
4900
|
};
|
|
4871
|
-
type Location$
|
|
4901
|
+
type Location$1 = {
|
|
4872
4902
|
/**
|
|
4873
4903
|
* Code of the country for which the tax classes are specified, as defined in the Country Service.
|
|
4874
4904
|
*/
|
|
@@ -4890,7 +4920,7 @@ type TaxUpdate = TaxCreation & {
|
|
|
4890
4920
|
*/
|
|
4891
4921
|
|
|
4892
4922
|
/** A country/location reference (`{ countryCode }`). */
|
|
4893
|
-
type TaxLocation = Location$
|
|
4923
|
+
type TaxLocation = Location$1;
|
|
4894
4924
|
/**
|
|
4895
4925
|
* A per-location tax configuration (read shape — `GET /taxes` /
|
|
4896
4926
|
* `/taxes/{locationCode}`). Built on the generated `TaxRetrieval`, with
|
|
@@ -6437,7 +6467,7 @@ type BasicDeliveryTime = {
|
|
|
6437
6467
|
/**
|
|
6438
6468
|
* Delivery Time
|
|
6439
6469
|
*/
|
|
6440
|
-
type DeliveryTime$
|
|
6470
|
+
type DeliveryTime$1 = BasicDeliveryTime & {
|
|
6441
6471
|
metadata?: MetaData;
|
|
6442
6472
|
};
|
|
6443
6473
|
/**
|
|
@@ -6955,15 +6985,15 @@ type MinimumFee = MinimumFee$1;
|
|
|
6955
6985
|
/** Shared create response (resource location). */
|
|
6956
6986
|
type ResourceCreated = ResourceCreatedResponse;
|
|
6957
6987
|
/** A delivery window for a cart/area. */
|
|
6958
|
-
type DeliveryWindow$
|
|
6988
|
+
type DeliveryWindow$1 = ActualDeliveryWindow;
|
|
6959
6989
|
/** List of delivery windows. */
|
|
6960
6990
|
type DeliveryWindowList = ActualDeliveryWindows;
|
|
6961
6991
|
/** Body for delivery-window validation / counter increment. */
|
|
6962
6992
|
type DeliveryWindowValidation = DeliveryWindowValidationDto;
|
|
6963
6993
|
/** A delivery time (read shape). */
|
|
6964
|
-
type DeliveryTime
|
|
6994
|
+
type DeliveryTime = DeliveryTime$1;
|
|
6965
6995
|
/** List of delivery times (`GET /delivery-times`). */
|
|
6966
|
-
type DeliveryTimeList = DeliveryTime
|
|
6996
|
+
type DeliveryTimeList = DeliveryTime[];
|
|
6967
6997
|
/** Create body (`POST /delivery-times`). */
|
|
6968
6998
|
type DeliveryTimeInput = BasicDeliveryTime;
|
|
6969
6999
|
/** Update body (`PUT /delivery-times/{id}`). */
|
|
@@ -7076,7 +7106,7 @@ declare class ShippingService {
|
|
|
7076
7106
|
/** List all delivery times. */
|
|
7077
7107
|
listDeliveryTimes(query?: Record<string, string | number>, auth?: AuthContext): Promise<DeliveryTimeList>;
|
|
7078
7108
|
/** Retrieve one delivery time. */
|
|
7079
|
-
getDeliveryTime(deliveryTimeId: string, auth?: AuthContext): Promise<DeliveryTime
|
|
7109
|
+
getDeliveryTime(deliveryTimeId: string, auth?: AuthContext): Promise<DeliveryTime>;
|
|
7080
7110
|
/** Create a delivery time. */
|
|
7081
7111
|
createDeliveryTime(input: DeliveryTimeInput, auth?: AuthContext): Promise<DeliveryCreated>;
|
|
7082
7112
|
/** Create multiple delivery times (`POST /delivery-times/bulk`). */
|
|
@@ -8286,7 +8316,7 @@ type BasicReturn = {
|
|
|
8286
8316
|
/**
|
|
8287
8317
|
* A list of orders that contain items to be returned. All the orders must have the same currency.
|
|
8288
8318
|
*/
|
|
8289
|
-
orders: Array<Order
|
|
8319
|
+
orders: Array<Order>;
|
|
8290
8320
|
/**
|
|
8291
8321
|
* A reason why the return is created. One of the values needs to be provided: `code` or `details`.
|
|
8292
8322
|
*/
|
|
@@ -8581,7 +8611,7 @@ type FullEmployeeReturn = FullCustomerReturn & {
|
|
|
8581
8611
|
id?: string;
|
|
8582
8612
|
};
|
|
8583
8613
|
};
|
|
8584
|
-
type FullReturnOrder = Order
|
|
8614
|
+
type FullReturnOrder = Order & {
|
|
8585
8615
|
items?: Array<FullReturnItem>;
|
|
8586
8616
|
};
|
|
8587
8617
|
type FullReturnItem = OrderItem & {
|
|
@@ -8627,7 +8657,7 @@ type FullReturnItem = OrderItem & {
|
|
|
8627
8657
|
/**
|
|
8628
8658
|
* Represents the order which is being (fully or partially) returned.
|
|
8629
8659
|
*/
|
|
8630
|
-
type Order
|
|
8660
|
+
type Order = {
|
|
8631
8661
|
/**
|
|
8632
8662
|
* Unique identifier of an order.
|
|
8633
8663
|
*/
|
|
@@ -9091,13 +9121,31 @@ type ImportStream$1 = {
|
|
|
9091
9121
|
[key: string]: string;
|
|
9092
9122
|
};
|
|
9093
9123
|
/**
|
|
9094
|
-
*
|
|
9095
|
-
|
|
9096
|
-
|
|
9097
|
-
/**
|
|
9098
|
-
* What happens when a record deleted in the target is seen in the source again.
|
|
9124
|
+
* How deletes are detected in the source and propagated to the target. Omit for an upsert-only
|
|
9125
|
+
* stream. `MARKER`: a field on the record flags it as deleted. `TOMBSTONE`: a separate source
|
|
9126
|
+
* record lists the deleted IDs.
|
|
9099
9127
|
*/
|
|
9100
|
-
|
|
9128
|
+
deleteConfig?: {
|
|
9129
|
+
/**
|
|
9130
|
+
* How a deleted record is recognised.
|
|
9131
|
+
*/
|
|
9132
|
+
mode?: 'MARKER' | 'TOMBSTONE';
|
|
9133
|
+
/**
|
|
9134
|
+
* `MARKER` only. The source field that flags a record as deleted.
|
|
9135
|
+
*/
|
|
9136
|
+
markerField?: string;
|
|
9137
|
+
/**
|
|
9138
|
+
* `MARKER` only. The values of `markerField` that mean deleted.
|
|
9139
|
+
*/
|
|
9140
|
+
markerValues?: Array<string>;
|
|
9141
|
+
/**
|
|
9142
|
+
* `TOMBSTONE` only. The explicit name of the source record that lists deleted IDs. Omit this
|
|
9143
|
+
* property when the name can be derived from the imported record by adding a prefix or suffix —
|
|
9144
|
+
* for example, `invoice_deleted` for an `invoice` stream. Specify it when the deletion record
|
|
9145
|
+
* does not follow that naming convention.
|
|
9146
|
+
*/
|
|
9147
|
+
record?: string;
|
|
9148
|
+
};
|
|
9101
9149
|
healthThresholds?: HealthThresholds;
|
|
9102
9150
|
/**
|
|
9103
9151
|
* When the stream was created.
|
|
@@ -9189,9 +9237,9 @@ type ImportRun$1 = {
|
|
|
9189
9237
|
*/
|
|
9190
9238
|
origin?: string;
|
|
9191
9239
|
/**
|
|
9192
|
-
* The run status.
|
|
9240
|
+
* The run status. `ABORTED` means the service refused to start the run because of the import configuration, for example mappings that have never been published or a changed target schema. Nothing was read or written.
|
|
9193
9241
|
*/
|
|
9194
|
-
status?: 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'PARTIAL' | 'FAILED' | 'CANCELLED';
|
|
9242
|
+
status?: 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'PARTIAL' | 'FAILED' | 'CANCELLED' | 'ABORTED';
|
|
9195
9243
|
/**
|
|
9196
9244
|
* The run mode.
|
|
9197
9245
|
*/
|
|
@@ -9260,6 +9308,23 @@ type ImportRun$1 = {
|
|
|
9260
9308
|
* For a dry run, how many mapped records were kept as a sample.
|
|
9261
9309
|
*/
|
|
9262
9310
|
dryRunSampleSize?: number;
|
|
9311
|
+
/**
|
|
9312
|
+
* Dry-run only. Whether the dry run used the published mappings (`true`) or the draft mappings (`false`).
|
|
9313
|
+
*/
|
|
9314
|
+
dryRunPublished?: boolean;
|
|
9315
|
+
/**
|
|
9316
|
+
* The published mapping version each stream uses in this run, fixed when the run starts. Version `0` means that the stream has no published mappings. The field is absent on a dry run of the draft mappings and on runs recorded before it existed.
|
|
9317
|
+
*/
|
|
9318
|
+
mappingVersions?: Array<{
|
|
9319
|
+
/**
|
|
9320
|
+
* The stream identifier.
|
|
9321
|
+
*/
|
|
9322
|
+
streamId?: string;
|
|
9323
|
+
/**
|
|
9324
|
+
* The published mapping version the stream uses.
|
|
9325
|
+
*/
|
|
9326
|
+
version?: number;
|
|
9327
|
+
}>;
|
|
9263
9328
|
};
|
|
9264
9329
|
/**
|
|
9265
9330
|
* Run stream progress
|
|
@@ -9284,9 +9349,9 @@ type ImportRunStream$1 = {
|
|
|
9284
9349
|
*/
|
|
9285
9350
|
streamName?: string;
|
|
9286
9351
|
/**
|
|
9287
|
-
* The stream's status within the run.
|
|
9352
|
+
* The stream's status within the run. `ABORTED` means the service refused to run the stream because of its configuration, for example because its mappings have never been published. It indicates a configuration problem to fix. The `message` field gives the reason.
|
|
9288
9353
|
*/
|
|
9289
|
-
status?: 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'PARTIAL' | 'FAILED' | 'SKIPPED';
|
|
9354
|
+
status?: 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'PARTIAL' | 'FAILED' | 'SKIPPED' | 'ABORTED';
|
|
9290
9355
|
/**
|
|
9291
9356
|
* Records read for this stream.
|
|
9292
9357
|
*/
|
|
@@ -9451,6 +9516,76 @@ type ImportedRecord$1 = {
|
|
|
9451
9516
|
*/
|
|
9452
9517
|
importedAt?: string;
|
|
9453
9518
|
};
|
|
9519
|
+
/**
|
|
9520
|
+
* A page of diagnostic rows with metadata that indicates whether the response contains all recorded rows or only part of a capped sample. Use `recorded`, `cap`, and `sampleTruncated` to interpret the page. The run's counters show the total number of affected rows.
|
|
9521
|
+
*/
|
|
9522
|
+
type DiagnosticPage = {
|
|
9523
|
+
rows?: Array<DiagnosticRecord>;
|
|
9524
|
+
/**
|
|
9525
|
+
* How many rows this response contains.
|
|
9526
|
+
*/
|
|
9527
|
+
returned?: number;
|
|
9528
|
+
/**
|
|
9529
|
+
* How many rows were recorded in total for this scope.
|
|
9530
|
+
*/
|
|
9531
|
+
recorded?: number;
|
|
9532
|
+
/**
|
|
9533
|
+
* The per-stream, per-kind recording cap.
|
|
9534
|
+
*/
|
|
9535
|
+
cap?: number;
|
|
9536
|
+
/**
|
|
9537
|
+
* Whether at least one stream reached the cap. When true, these rows are a sample, and the run's
|
|
9538
|
+
* own counters show the total number of affected rows.
|
|
9539
|
+
*/
|
|
9540
|
+
sampleTruncated?: boolean;
|
|
9541
|
+
/**
|
|
9542
|
+
* A human-readable statement of what this response is.
|
|
9543
|
+
*/
|
|
9544
|
+
note?: string;
|
|
9545
|
+
};
|
|
9546
|
+
/**
|
|
9547
|
+
* One row behind a feed-quality counter.
|
|
9548
|
+
*/
|
|
9549
|
+
type DiagnosticRecord = {
|
|
9550
|
+
id?: string;
|
|
9551
|
+
runId?: string;
|
|
9552
|
+
streamId?: string;
|
|
9553
|
+
/**
|
|
9554
|
+
* The stream that recorded the row.
|
|
9555
|
+
*/
|
|
9556
|
+
streamName?: string;
|
|
9557
|
+
/**
|
|
9558
|
+
* `UNRESOLVED_PARENT`: a child line whose parent instance did not exist when it was written.
|
|
9559
|
+
* `REPEATED_KEY`: a source row whose natural key this run had already imported.
|
|
9560
|
+
*/
|
|
9561
|
+
kind?: 'UNRESOLVED_PARENT' | 'REPEATED_KEY';
|
|
9562
|
+
/**
|
|
9563
|
+
* The record's own natural key in the source.
|
|
9564
|
+
*/
|
|
9565
|
+
naturalKey?: string;
|
|
9566
|
+
/**
|
|
9567
|
+
* `UNRESOLVED_PARENT` only. The field that points at the parent.
|
|
9568
|
+
*/
|
|
9569
|
+
linkingField?: string;
|
|
9570
|
+
/**
|
|
9571
|
+
* `UNRESOLVED_PARENT` only. The parent key the line pointed at — the value to look up in the
|
|
9572
|
+
* source system.
|
|
9573
|
+
*/
|
|
9574
|
+
linkingValue?: string;
|
|
9575
|
+
/**
|
|
9576
|
+
* The target type the row was headed for.
|
|
9577
|
+
*/
|
|
9578
|
+
targetType?: string;
|
|
9579
|
+
/**
|
|
9580
|
+
* `UNRESOLVED_PARENT` only. The number of child lines waiting for this parent.
|
|
9581
|
+
*/
|
|
9582
|
+
waitingLines?: number;
|
|
9583
|
+
/**
|
|
9584
|
+
* `REPEATED_KEY` only. How many times this key had already been seen in this run.
|
|
9585
|
+
*/
|
|
9586
|
+
occurrence?: number;
|
|
9587
|
+
createdAt?: string;
|
|
9588
|
+
};
|
|
9454
9589
|
/**
|
|
9455
9590
|
* Health thresholds
|
|
9456
9591
|
*
|
|
@@ -9785,6 +9920,28 @@ type ImportSourceIssue = {
|
|
|
9785
9920
|
*/
|
|
9786
9921
|
unresolvedParents?: number;
|
|
9787
9922
|
};
|
|
9923
|
+
/**
|
|
9924
|
+
* Restrict the rows to this kind.
|
|
9925
|
+
*/
|
|
9926
|
+
type TraitDiagnosticsKind = 'UNRESOLVED_PARENT' | 'REPEATED_KEY';
|
|
9927
|
+
type GetImporttoolStreamOrderResponses = {
|
|
9928
|
+
/**
|
|
9929
|
+
* The request was successful. The stream order is returned.
|
|
9930
|
+
*/
|
|
9931
|
+
200: {
|
|
9932
|
+
/**
|
|
9933
|
+
* Stream names in the order they run.
|
|
9934
|
+
*/
|
|
9935
|
+
order?: Array<string>;
|
|
9936
|
+
/**
|
|
9937
|
+
* For each stream name, the streams that must run before it. A stream with no dependencies has an empty list.
|
|
9938
|
+
*/
|
|
9939
|
+
prereqs?: {
|
|
9940
|
+
[key: string]: Array<string>;
|
|
9941
|
+
};
|
|
9942
|
+
};
|
|
9943
|
+
};
|
|
9944
|
+
type GetImporttoolStreamOrderResponse = GetImporttoolStreamOrderResponses[keyof GetImporttoolStreamOrderResponses];
|
|
9788
9945
|
type PostImporttoolTriggerRunData = {
|
|
9789
9946
|
body?: {
|
|
9790
9947
|
/**
|
|
@@ -9795,6 +9952,10 @@ type PostImporttoolTriggerRunData = {
|
|
|
9795
9952
|
* When `true`, the run maps and validates but performs no remote writes.
|
|
9796
9953
|
*/
|
|
9797
9954
|
dryRun?: boolean;
|
|
9955
|
+
/**
|
|
9956
|
+
* Dry-run only. Which mappings the dry run uses. `published` uses each stream's published mappings, which is what a real run executes. `draft` uses the draft mappings, so you can check them before publishing. When omitted, defaults to `published`. A dry run with `published` handles streams whose mappings have never been published in the same way as a real run. The field has no effect when `dryRun` is `false`, because a real run always uses the published mappings.
|
|
9957
|
+
*/
|
|
9958
|
+
mappings?: 'published' | 'draft';
|
|
9798
9959
|
/**
|
|
9799
9960
|
* When `true`, every extracted record is rewritten, even if unchanged. It bypasses the idempotency `skip-if-unchanged` check. Use it to force target IDs and values to be rewritten.
|
|
9800
9961
|
*/
|
|
@@ -9807,6 +9968,12 @@ type PostImporttoolTriggerRunData = {
|
|
|
9807
9968
|
* What requested this run. Examples: `Dashboard`, an integration scenario name, or a scheduler name. The `trigger` field records only `MANUAL` or `SCHEDULED`. Use `origin` when more than one system calls this endpoint. If you omit `origin` or send a blank value, the service stores the `trigger` value. The service rejects values longer than 40 characters and values that contain control characters. It does not shorten them.
|
|
9808
9969
|
*/
|
|
9809
9970
|
origin?: string;
|
|
9971
|
+
/**
|
|
9972
|
+
* The stream identifiers to run. Omit the field to run every stream in the configuration. Send a list of stream IDs to run only those streams. Do not send stream names; use the `id` values from the stream resource.
|
|
9973
|
+
* The service rejects an empty list. It also rejects a list that includes no stream from this configuration. Listed streams still run in the computed stream order, not in list order.
|
|
9974
|
+
* The service also rejects a stream that cannot produce data on its own. A `COMPOSITE_CHILD` stream with `childStrategy` set to `EMBED` is written by its parent. A child that reads values captured during the parent run also cannot run alone. Either stream without its parent would complete successfully without importing records.
|
|
9975
|
+
*/
|
|
9976
|
+
streamIds?: Array<string>;
|
|
9810
9977
|
};
|
|
9811
9978
|
path: {
|
|
9812
9979
|
/**
|
|
@@ -9822,6 +9989,35 @@ type PostImporttoolTriggerRunData = {
|
|
|
9822
9989
|
query?: never;
|
|
9823
9990
|
url: '/importtool/{tenant}/configs/{configId}/runs';
|
|
9824
9991
|
};
|
|
9992
|
+
type GetImporttoolListRunDiagnosticsData = {
|
|
9993
|
+
body?: never;
|
|
9994
|
+
path: {
|
|
9995
|
+
/**
|
|
9996
|
+
* The tenant you want to access.
|
|
9997
|
+
*
|
|
9998
|
+
*/
|
|
9999
|
+
tenant: string;
|
|
10000
|
+
/**
|
|
10001
|
+
* The run identifier.
|
|
10002
|
+
*/
|
|
10003
|
+
runId: string;
|
|
10004
|
+
};
|
|
10005
|
+
query?: {
|
|
10006
|
+
/**
|
|
10007
|
+
* Restrict the rows to those recorded for this stream.
|
|
10008
|
+
*/
|
|
10009
|
+
streamId?: string;
|
|
10010
|
+
/**
|
|
10011
|
+
* Restrict the rows to this kind.
|
|
10012
|
+
*/
|
|
10013
|
+
kind?: 'UNRESOLVED_PARENT' | 'REPEATED_KEY';
|
|
10014
|
+
/**
|
|
10015
|
+
* Maximum number of rows to return. Defaults differ between the JSON and CSV operations.
|
|
10016
|
+
*/
|
|
10017
|
+
limit?: number;
|
|
10018
|
+
};
|
|
10019
|
+
url: '/importtool/{tenant}/runs/{runId}/diagnostics';
|
|
10020
|
+
};
|
|
9825
10021
|
type GetImporttoolSearchDataRecordsData = {
|
|
9826
10022
|
body?: never;
|
|
9827
10023
|
path: {
|
|
@@ -9937,9 +10133,31 @@ type ImportErrorRecord = ErrorRecord;
|
|
|
9937
10133
|
/** A record that was imported, with its keys, stored fields and last outcome. */
|
|
9938
10134
|
type ImportedRecord = ImportedRecord$1;
|
|
9939
10135
|
/**
|
|
9940
|
-
*
|
|
10136
|
+
* A configuration's computed run order: `order` lists stream **names** in the
|
|
10137
|
+
* order they run, `prereqs` maps each name to the streams it waits for.
|
|
10138
|
+
*/
|
|
10139
|
+
type ImportStreamOrder = GetImporttoolStreamOrderResponse;
|
|
10140
|
+
/**
|
|
10141
|
+
* The rows behind a run's feed-quality counters. **A capped sample, not the
|
|
10142
|
+
* whole set**: `recorded` is how many rows were stored and `sampleTruncated`
|
|
10143
|
+
* says whether a stream hit the cap. The run's own `duplicateKeys` /
|
|
10144
|
+
* `unresolvedParents` are the true totals — `rows.length` is not.
|
|
10145
|
+
*/
|
|
10146
|
+
type ImportRunDiagnostics = DiagnosticPage;
|
|
10147
|
+
/** One diagnostic row: the record's natural key, its parent-linking field and value, and how many lines wait on it. */
|
|
10148
|
+
type ImportDiagnosticRecord = DiagnosticRecord;
|
|
10149
|
+
/** Which counter a diagnostic row belongs to: `REPEATED_KEY` (`duplicateKeys`) or `UNRESOLVED_PARENT` (`unresolvedParents`). */
|
|
10150
|
+
type ImportDiagnosticKind = TraitDiagnosticsKind;
|
|
10151
|
+
/** Filters for `listRunDiagnostics` / `downloadRunDiagnosticsCsv`: `{ streamId?, kind?, limit? }`. */
|
|
10152
|
+
type ImportRunDiagnosticsQuery = NonNullable<GetImporttoolListRunDiagnosticsData["query"]>;
|
|
10153
|
+
/**
|
|
10154
|
+
* Body for `triggerRun`: `{ mode?, dryRun?, force?, sampleSize?, origin?, streamIds? }`.
|
|
9941
10155
|
*
|
|
9942
10156
|
* - `mode` defaults to `DELTA` server-side.
|
|
10157
|
+
* - `streamIds` runs only those streams — **ids, not names** (`getStreamOrder`
|
|
10158
|
+
* reports names). Omitted, every stream runs. Rejected: an empty list, a list
|
|
10159
|
+
* with no stream of this configuration, and a child stream that cannot produce
|
|
10160
|
+
* data without its parent. Listed streams still run in the computed order.
|
|
9943
10161
|
* - `force` rewrites every extracted record, bypassing the skip-if-unchanged
|
|
9944
10162
|
* idempotency.
|
|
9945
10163
|
* - `sampleSize` is **dry-run only**: how many mapped records to sample per
|
|
@@ -10084,6 +10302,17 @@ declare class ImportService {
|
|
|
10084
10302
|
listStreams(configId: string, auth?: AuthContext): Promise<ImportStream[]>;
|
|
10085
10303
|
/** Fetch one stream by id. */
|
|
10086
10304
|
getStream(id: string, auth?: AuthContext): Promise<ImportStream>;
|
|
10305
|
+
/**
|
|
10306
|
+
* The order in which a configuration's streams run, and the dependencies
|
|
10307
|
+
* behind it. Read it here instead of deriving it from the stream definitions:
|
|
10308
|
+
* mapping transformations add dependencies that no single stream shows, so a
|
|
10309
|
+
* self-computed order can differ from the one used at run time.
|
|
10310
|
+
*
|
|
10311
|
+
* The result lists stream **names**, while {@link triggerRun}'s `streamIds`
|
|
10312
|
+
* takes stream **ids** — map through {@link listStreams} before passing a
|
|
10313
|
+
* subset back.
|
|
10314
|
+
*/
|
|
10315
|
+
getStreamOrder(configId: string, auth?: AuthContext): Promise<ImportStreamOrder>;
|
|
10087
10316
|
/**
|
|
10088
10317
|
* Fetch a configuration's schedule. Resolves to `null` when none is
|
|
10089
10318
|
* configured — the service answers `204`, not `404`, so an absent schedule is
|
|
@@ -10128,6 +10357,9 @@ declare class ImportService {
|
|
|
10128
10357
|
* integration scenario are indistinguishable in the history. Note the service
|
|
10129
10358
|
* **rejects** an `origin` over 40 characters instead of shortening it.
|
|
10130
10359
|
*
|
|
10360
|
+
* `streamIds` runs a subset — see {@link ImportRunInput} for what is rejected,
|
|
10361
|
+
* and note it takes ids where {@link getStreamOrder} reports names.
|
|
10362
|
+
*
|
|
10131
10363
|
* Not retried on a 5xx: a POST that timed out may already have queued a run.
|
|
10132
10364
|
*
|
|
10133
10365
|
* @example
|
|
@@ -10174,6 +10406,29 @@ declare class ImportService {
|
|
|
10174
10406
|
}, auth?: AuthContext): Promise<ImportCancelResult>;
|
|
10175
10407
|
/** List the errors recorded during a run. */
|
|
10176
10408
|
listRunErrors(runId: string, opts?: ImportPageOptions, auth?: AuthContext): Promise<ImportPage<ImportErrorRecord>>;
|
|
10409
|
+
/**
|
|
10410
|
+
* The rows behind a run's feed-quality counters: source rows that repeated a
|
|
10411
|
+
* natural key (`kind: "REPEATED_KEY"`, counted as `duplicateKeys`) and child
|
|
10412
|
+
* lines with no parent to attach to (`"UNRESOLVED_PARENT"`, counted as
|
|
10413
|
+
* `unresolvedParents`). Neither is a failure, which is why these rows are not
|
|
10414
|
+
* in {@link listRunErrors}.
|
|
10415
|
+
*
|
|
10416
|
+
* **A capped sample** — see {@link ImportRunDiagnostics} before reading
|
|
10417
|
+
* `rows.length` as the size of the problem. `limit` defaults to 500 here
|
|
10418
|
+
* (1–50 000); {@link downloadRunDiagnosticsCsv} defaults to 50 000.
|
|
10419
|
+
*/
|
|
10420
|
+
listRunDiagnostics(runId: string, query?: ImportRunDiagnosticsQuery, auth?: AuthContext): Promise<ImportRunDiagnostics>;
|
|
10421
|
+
/**
|
|
10422
|
+
* The same rows as {@link listRunDiagnostics}, as CSV text for a spreadsheet
|
|
10423
|
+
* or a ticket. Comment lines above the header record whether `limit` or the
|
|
10424
|
+
* recording cap cut rows off, so the file keeps that context when shared on
|
|
10425
|
+
* its own. `limit` defaults to 50 000 here, not 500.
|
|
10426
|
+
*
|
|
10427
|
+
* Every value is quoted, and a value starting with `=`, `+`, `-` or `@` is
|
|
10428
|
+
* prefixed with an apostrophe so spreadsheet software does not evaluate source
|
|
10429
|
+
* data as a formula. Strip it if you parse the file instead of opening it.
|
|
10430
|
+
*/
|
|
10431
|
+
downloadRunDiagnosticsCsv(runId: string, query?: ImportRunDiagnosticsQuery, auth?: AuthContext): Promise<string>;
|
|
10177
10432
|
/** List the target types that hold imported records — the valid `type` values for {@link searchRecords}. */
|
|
10178
10433
|
listDataTypes(auth?: AuthContext): Promise<string[]>;
|
|
10179
10434
|
/** Search imported records of one target type. */
|
|
@@ -10253,7 +10508,7 @@ type ChangelogChangeItem = {
|
|
|
10253
10508
|
*/
|
|
10254
10509
|
type?: 'create' | 'update' | 'delete';
|
|
10255
10510
|
/**
|
|
10256
|
-
* Logical entity type of the changed document, for example `order`, `customer`, `company`, `product`, `segment`, `group`, `group-assignment`, `coupon`, or a custom entity created with the Schema Service.
|
|
10511
|
+
* Logical entity type of the changed document, for example `order`, `customer`, `company`, `product`, `segment`, `group`, `group-assignment`, `coupon`, `quote`, `site`, or a custom entity created with the Schema Service.
|
|
10257
10512
|
*
|
|
10258
10513
|
*/
|
|
10259
10514
|
entity?: string;
|
|
@@ -10890,7 +11145,7 @@ type Vendor$1 = {
|
|
|
10890
11145
|
/**
|
|
10891
11146
|
* The list of locations assigned to the vendor.
|
|
10892
11147
|
*/
|
|
10893
|
-
locations?: Array<Location
|
|
11148
|
+
locations?: Array<Location>;
|
|
10894
11149
|
metadata?: Metadata$1;
|
|
10895
11150
|
/**
|
|
10896
11151
|
* Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
|
|
@@ -11025,7 +11280,7 @@ type VendorUpdate$1 = {
|
|
|
11025
11280
|
/**
|
|
11026
11281
|
* Location
|
|
11027
11282
|
*/
|
|
11028
|
-
type Location
|
|
11283
|
+
type Location = {
|
|
11029
11284
|
/**
|
|
11030
11285
|
* The location unique identifier.
|
|
11031
11286
|
*/
|
|
@@ -11151,7 +11406,7 @@ type VendorSearchQuery = Record<string, unknown> & {
|
|
|
11151
11406
|
q?: QueryFor<"VENDOR">;
|
|
11152
11407
|
};
|
|
11153
11408
|
/** A vendor location (read shape). */
|
|
11154
|
-
type VendorLocation = Location
|
|
11409
|
+
type VendorLocation = Location;
|
|
11155
11410
|
/** List of vendor locations. */
|
|
11156
11411
|
type VendorLocationList = VendorLocation[];
|
|
11157
11412
|
/** Create body (`POST /locations`). */
|
|
@@ -11194,546 +11449,6 @@ declare class VendorService {
|
|
|
11194
11449
|
deleteVendorLocation(locationId: string, auth?: AuthContext): Promise<void>;
|
|
11195
11450
|
}
|
|
11196
11451
|
|
|
11197
|
-
type OrderEntryEventResponse = {
|
|
11198
|
-
/**
|
|
11199
|
-
* The event id
|
|
11200
|
-
*/
|
|
11201
|
-
eventId?: string;
|
|
11202
|
-
/**
|
|
11203
|
-
* The product id for which the event was created
|
|
11204
|
-
*/
|
|
11205
|
-
productId?: string;
|
|
11206
|
-
/**
|
|
11207
|
-
* The delivery cycle for which the event was created
|
|
11208
|
-
*/
|
|
11209
|
-
deliveryCycle?: string;
|
|
11210
|
-
/**
|
|
11211
|
-
* The order number for which the event was created
|
|
11212
|
-
*/
|
|
11213
|
-
orderNumber?: string;
|
|
11214
|
-
/**
|
|
11215
|
-
* Timestamp when the event was created
|
|
11216
|
-
*/
|
|
11217
|
-
timestamp?: string;
|
|
11218
|
-
/**
|
|
11219
|
-
* The picked amount
|
|
11220
|
-
*/
|
|
11221
|
-
pickedAmount?: number;
|
|
11222
|
-
/**
|
|
11223
|
-
* The packed amount
|
|
11224
|
-
*/
|
|
11225
|
-
packedAmount?: number;
|
|
11226
|
-
/**
|
|
11227
|
-
* The canceled amount
|
|
11228
|
-
*/
|
|
11229
|
-
canceledAmount?: number;
|
|
11230
|
-
/**
|
|
11231
|
-
* The packed amount calculated into piece
|
|
11232
|
-
*/
|
|
11233
|
-
packedAmountInPc?: number;
|
|
11234
|
-
/**
|
|
11235
|
-
* The supplier id of the product for which the event was created
|
|
11236
|
-
*/
|
|
11237
|
-
supplierId?: string;
|
|
11238
|
-
/**
|
|
11239
|
-
* The ID of the user which has created the event
|
|
11240
|
-
*/
|
|
11241
|
-
user?: string;
|
|
11242
|
-
/**
|
|
11243
|
-
* The site code for which the event was created
|
|
11244
|
-
*/
|
|
11245
|
-
site?: string;
|
|
11246
|
-
/**
|
|
11247
|
-
* The unit in which the product is packed
|
|
11248
|
-
*/
|
|
11249
|
-
unit?: string;
|
|
11250
|
-
/**
|
|
11251
|
-
* The book product flag
|
|
11252
|
-
*/
|
|
11253
|
-
bookProduct?: boolean;
|
|
11254
|
-
};
|
|
11255
|
-
type OrderEntryEventCreate = {
|
|
11256
|
-
/**
|
|
11257
|
-
* The event id generated by the client
|
|
11258
|
-
*/
|
|
11259
|
-
eventId: string;
|
|
11260
|
-
/**
|
|
11261
|
-
* The order number for which the packing event is created
|
|
11262
|
-
*/
|
|
11263
|
-
orderNumber: string;
|
|
11264
|
-
/**
|
|
11265
|
-
* The product id for which the packing event is created
|
|
11266
|
-
*/
|
|
11267
|
-
productId: string;
|
|
11268
|
-
/**
|
|
11269
|
-
* The delivery cycle for which the packing event is created
|
|
11270
|
-
*/
|
|
11271
|
-
deliveryCycle?: string;
|
|
11272
|
-
/**
|
|
11273
|
-
* The amount of picked items
|
|
11274
|
-
*/
|
|
11275
|
-
pickedAmount?: number;
|
|
11276
|
-
/**
|
|
11277
|
-
* The amount of packed items
|
|
11278
|
-
*/
|
|
11279
|
-
packedAmount?: number;
|
|
11280
|
-
/**
|
|
11281
|
-
* The amount of cancelled items
|
|
11282
|
-
*/
|
|
11283
|
-
canceledAmount?: number;
|
|
11284
|
-
/**
|
|
11285
|
-
* The supplier id
|
|
11286
|
-
*/
|
|
11287
|
-
supplierId?: string;
|
|
11288
|
-
/**
|
|
11289
|
-
* The unit of the packed item
|
|
11290
|
-
*/
|
|
11291
|
-
unit: string;
|
|
11292
|
-
/**
|
|
11293
|
-
* Timestamp of the packing event in ISO format
|
|
11294
|
-
*/
|
|
11295
|
-
timestamp: string;
|
|
11296
|
-
/**
|
|
11297
|
-
* The site code for which the event is created
|
|
11298
|
-
*/
|
|
11299
|
-
site: string;
|
|
11300
|
-
bookProduct?: boolean;
|
|
11301
|
-
};
|
|
11302
|
-
type OrderStatusChange = {
|
|
11303
|
-
/**
|
|
11304
|
-
* The new status of the order
|
|
11305
|
-
*/
|
|
11306
|
-
packingStatus: 'INITIAL' | 'IN_PROGRESS' | 'PRE_PACKED' | 'PACKED' | 'CANCELLED';
|
|
11307
|
-
};
|
|
11308
|
-
type PackagingProductsChange = {
|
|
11309
|
-
/**
|
|
11310
|
-
* The id of the product that was packed
|
|
11311
|
-
*/
|
|
11312
|
-
entryId: string;
|
|
11313
|
-
/**
|
|
11314
|
-
* The amount of packed items
|
|
11315
|
-
*/
|
|
11316
|
-
packedCount: number;
|
|
11317
|
-
};
|
|
11318
|
-
/**
|
|
11319
|
-
* Assignee
|
|
11320
|
-
*/
|
|
11321
|
-
type Assignee$1 = {
|
|
11322
|
-
/**
|
|
11323
|
-
* Identifier of an assignment
|
|
11324
|
-
*/
|
|
11325
|
-
id: string;
|
|
11326
|
-
/**
|
|
11327
|
-
* Code of a site
|
|
11328
|
-
*/
|
|
11329
|
-
siteCode: string;
|
|
11330
|
-
/**
|
|
11331
|
-
* First name of assignee
|
|
11332
|
-
*/
|
|
11333
|
-
firstName: string;
|
|
11334
|
-
/**
|
|
11335
|
-
* Last name of assignee
|
|
11336
|
-
*/
|
|
11337
|
-
lastName: string;
|
|
11338
|
-
};
|
|
11339
|
-
/**
|
|
11340
|
-
* Order
|
|
11341
|
-
*/
|
|
11342
|
-
type Order = {
|
|
11343
|
-
/**
|
|
11344
|
-
* The id of the packed order
|
|
11345
|
-
*/
|
|
11346
|
-
id?: string;
|
|
11347
|
-
/**
|
|
11348
|
-
* The site code of the packed order
|
|
11349
|
-
*/
|
|
11350
|
-
siteCode?: string;
|
|
11351
|
-
/**
|
|
11352
|
-
* The order total amount
|
|
11353
|
-
*/
|
|
11354
|
-
orderTotal?: number;
|
|
11355
|
-
/**
|
|
11356
|
-
* The order subtotal
|
|
11357
|
-
*/
|
|
11358
|
-
valueOfGoods?: number;
|
|
11359
|
-
/**
|
|
11360
|
-
* The order deposit amount
|
|
11361
|
-
*/
|
|
11362
|
-
deposit?: number;
|
|
11363
|
-
/**
|
|
11364
|
-
* The order coupons amount
|
|
11365
|
-
*/
|
|
11366
|
-
coupons?: number;
|
|
11367
|
-
/**
|
|
11368
|
-
* The order currency
|
|
11369
|
-
*/
|
|
11370
|
-
currency?: string;
|
|
11371
|
-
/**
|
|
11372
|
-
* The order entries
|
|
11373
|
-
*/
|
|
11374
|
-
entries?: Array<Entry>;
|
|
11375
|
-
customer?: Customer;
|
|
11376
|
-
delivery?: Delivery;
|
|
11377
|
-
payment?: Payment$1;
|
|
11378
|
-
/**
|
|
11379
|
-
* The current packing status of the order
|
|
11380
|
-
*/
|
|
11381
|
-
packingStatus?: 'INITIAL' | 'IN_PROGRESS' | 'PRE_PACKED' | 'PACKED' | 'CANCELLED';
|
|
11382
|
-
/**
|
|
11383
|
-
* The user data of the person that is currently packing the order
|
|
11384
|
-
*/
|
|
11385
|
-
assignees?: Array<Assignee$1>;
|
|
11386
|
-
/**
|
|
11387
|
-
* The order packaging product
|
|
11388
|
-
*/
|
|
11389
|
-
packagingProducts?: Array<Entry>;
|
|
11390
|
-
/**
|
|
11391
|
-
* The order holding area number
|
|
11392
|
-
*/
|
|
11393
|
-
holdingAreaNumber?: number;
|
|
11394
|
-
};
|
|
11395
|
-
/**
|
|
11396
|
-
* Entry
|
|
11397
|
-
*/
|
|
11398
|
-
type Entry = {
|
|
11399
|
-
/**
|
|
11400
|
-
* The entry id
|
|
11401
|
-
*/
|
|
11402
|
-
entryId?: string;
|
|
11403
|
-
/**
|
|
11404
|
-
* The product name
|
|
11405
|
-
*/
|
|
11406
|
-
productName?: string;
|
|
11407
|
-
/**
|
|
11408
|
-
* The id of the product
|
|
11409
|
-
*/
|
|
11410
|
-
productId?: string;
|
|
11411
|
-
/**
|
|
11412
|
-
* The unit price of the product
|
|
11413
|
-
*/
|
|
11414
|
-
unitPrice?: number;
|
|
11415
|
-
/**
|
|
11416
|
-
* The overall price, which is the sum of the quantities of packed products.
|
|
11417
|
-
*/
|
|
11418
|
-
totalPrice?: number;
|
|
11419
|
-
/**
|
|
11420
|
-
* The link to product image
|
|
11421
|
-
*/
|
|
11422
|
-
imageUrl?: string;
|
|
11423
|
-
unitPricingMeasure?: PricingMeasure;
|
|
11424
|
-
pricingMeasure?: PricingMeasure;
|
|
11425
|
-
pricingMeasurePrice?: number;
|
|
11426
|
-
orderUnit?: string;
|
|
11427
|
-
/**
|
|
11428
|
-
* The currently packed count of the product
|
|
11429
|
-
*/
|
|
11430
|
-
packedCount?: number;
|
|
11431
|
-
/**
|
|
11432
|
-
* The currently canceled count of the product
|
|
11433
|
-
*/
|
|
11434
|
-
canceledCount?: number;
|
|
11435
|
-
/**
|
|
11436
|
-
* The currently picked count of the product
|
|
11437
|
-
*/
|
|
11438
|
-
pickedCount?: number;
|
|
11439
|
-
/**
|
|
11440
|
-
* The currently packed amount of the product packed in pieces
|
|
11441
|
-
*/
|
|
11442
|
-
packedAmountInPc?: number;
|
|
11443
|
-
totalCount?: number;
|
|
11444
|
-
/**
|
|
11445
|
-
* The location of the product
|
|
11446
|
-
*/
|
|
11447
|
-
location?: Array<Location>;
|
|
11448
|
-
packingGroup?: string;
|
|
11449
|
-
packaging?: string;
|
|
11450
|
-
cutting?: string;
|
|
11451
|
-
customerComment?: string;
|
|
11452
|
-
barcodes?: Array<string>;
|
|
11453
|
-
weightDependent?: boolean;
|
|
11454
|
-
basePrice?: BasePrice;
|
|
11455
|
-
mhd?: string;
|
|
11456
|
-
};
|
|
11457
|
-
/**
|
|
11458
|
-
* Customer
|
|
11459
|
-
*/
|
|
11460
|
-
type Customer = {
|
|
11461
|
-
id?: string;
|
|
11462
|
-
title?: string;
|
|
11463
|
-
firstName?: string;
|
|
11464
|
-
lastName?: string;
|
|
11465
|
-
name?: string;
|
|
11466
|
-
companyName?: string;
|
|
11467
|
-
email?: string;
|
|
11468
|
-
phoneNumber?: string;
|
|
11469
|
-
};
|
|
11470
|
-
/**
|
|
11471
|
-
* Delivery
|
|
11472
|
-
*/
|
|
11473
|
-
type Delivery = {
|
|
11474
|
-
deliveryTimeModel?: DeliveryTime;
|
|
11475
|
-
deliveryAddressModel?: DeliveryAddress;
|
|
11476
|
-
deliveryCostModel?: DeliveryCost;
|
|
11477
|
-
deliveryOptionModel?: DeliveryOption;
|
|
11478
|
-
deliveryWindow?: DeliveryWindow$1;
|
|
11479
|
-
};
|
|
11480
|
-
/**
|
|
11481
|
-
* Payment
|
|
11482
|
-
*/
|
|
11483
|
-
type Payment$1 = {
|
|
11484
|
-
invoiceNumber?: string;
|
|
11485
|
-
invoiceAddress?: InvoiceAddress;
|
|
11486
|
-
methods?: Array<string>;
|
|
11487
|
-
};
|
|
11488
|
-
/**
|
|
11489
|
-
* PricingMeasure
|
|
11490
|
-
*/
|
|
11491
|
-
type PricingMeasure = {
|
|
11492
|
-
unitCode?: string;
|
|
11493
|
-
value?: string;
|
|
11494
|
-
};
|
|
11495
|
-
/**
|
|
11496
|
-
* Location
|
|
11497
|
-
*/
|
|
11498
|
-
type Location = {
|
|
11499
|
-
zone?: string;
|
|
11500
|
-
rack?: string;
|
|
11501
|
-
rackName?: string;
|
|
11502
|
-
shelf?: string;
|
|
11503
|
-
section?: string;
|
|
11504
|
-
bin?: string;
|
|
11505
|
-
};
|
|
11506
|
-
/**
|
|
11507
|
-
* BasePrice
|
|
11508
|
-
*/
|
|
11509
|
-
type BasePrice = {
|
|
11510
|
-
effectiveAmount?: string;
|
|
11511
|
-
originalAmount?: string;
|
|
11512
|
-
priceFactor?: string;
|
|
11513
|
-
basePriceFactor?: string;
|
|
11514
|
-
measurementUnit?: MeasurementUnit;
|
|
11515
|
-
};
|
|
11516
|
-
/**
|
|
11517
|
-
* DeliveryTime
|
|
11518
|
-
*/
|
|
11519
|
-
type DeliveryTime = {
|
|
11520
|
-
deliveryDate?: string;
|
|
11521
|
-
deliveryTimeFrom?: string;
|
|
11522
|
-
deliveryTimeTo?: string;
|
|
11523
|
-
deliveryChargeType?: string;
|
|
11524
|
-
};
|
|
11525
|
-
/**
|
|
11526
|
-
* DeliveryAddress
|
|
11527
|
-
*/
|
|
11528
|
-
type DeliveryAddress = {
|
|
11529
|
-
title?: string;
|
|
11530
|
-
contactName?: string;
|
|
11531
|
-
companyName?: string;
|
|
11532
|
-
street?: string;
|
|
11533
|
-
streetNumber?: string;
|
|
11534
|
-
streetAppendix?: string;
|
|
11535
|
-
zip?: string;
|
|
11536
|
-
city?: string;
|
|
11537
|
-
country?: string;
|
|
11538
|
-
};
|
|
11539
|
-
/**
|
|
11540
|
-
* DeliveryCost
|
|
11541
|
-
*/
|
|
11542
|
-
type DeliveryCost = {
|
|
11543
|
-
amount?: number;
|
|
11544
|
-
currency?: string;
|
|
11545
|
-
};
|
|
11546
|
-
/**
|
|
11547
|
-
* DeliveryOption
|
|
11548
|
-
*/
|
|
11549
|
-
type DeliveryOption = {
|
|
11550
|
-
packaging?: string;
|
|
11551
|
-
replacement?: boolean;
|
|
11552
|
-
pickup?: boolean;
|
|
11553
|
-
deliveryNote?: string;
|
|
11554
|
-
};
|
|
11555
|
-
/**
|
|
11556
|
-
* DeliveryWindow
|
|
11557
|
-
*
|
|
11558
|
-
* This object contains attributes that are related to selected delivery window for a given order and allows to group orders by delivery cycle and sort by delivery time for a better and more efficient packing experience
|
|
11559
|
-
*/
|
|
11560
|
-
type DeliveryWindow$1 = {
|
|
11561
|
-
/**
|
|
11562
|
-
* The selected delivery cycle for the current order for the given date
|
|
11563
|
-
*/
|
|
11564
|
-
deliveryCycle?: string;
|
|
11565
|
-
/**
|
|
11566
|
-
* The selected delivery cycle name
|
|
11567
|
-
*/
|
|
11568
|
-
deliveryCycleName?: string;
|
|
11569
|
-
/**
|
|
11570
|
-
* The delivery time until the order should be delivered
|
|
11571
|
-
*/
|
|
11572
|
-
deliveryTimeTo?: string;
|
|
11573
|
-
};
|
|
11574
|
-
/**
|
|
11575
|
-
* InvoiceAddress
|
|
11576
|
-
*/
|
|
11577
|
-
type InvoiceAddress = {
|
|
11578
|
-
title?: string;
|
|
11579
|
-
contactName?: string;
|
|
11580
|
-
companyName?: string;
|
|
11581
|
-
street?: string;
|
|
11582
|
-
streetNumber?: string;
|
|
11583
|
-
streetAppendix?: string;
|
|
11584
|
-
zip?: string;
|
|
11585
|
-
city?: string;
|
|
11586
|
-
country?: string;
|
|
11587
|
-
};
|
|
11588
|
-
/**
|
|
11589
|
-
* RecalculationJobOrder
|
|
11590
|
-
*/
|
|
11591
|
-
type RecalculationJobOrder = {
|
|
11592
|
-
orderId?: string;
|
|
11593
|
-
message?: string;
|
|
11594
|
-
jobOrderStatus?: 'SUCCESS' | 'FAILURE' | 'PENDING';
|
|
11595
|
-
};
|
|
11596
|
-
/**
|
|
11597
|
-
* RecalculationJob
|
|
11598
|
-
*/
|
|
11599
|
-
type RecalculationJob$1 = {
|
|
11600
|
-
id?: string;
|
|
11601
|
-
jobType?: 'AUTOMATIC' | 'MANUAL';
|
|
11602
|
-
orders?: Array<RecalculationJobOrder>;
|
|
11603
|
-
jobStatus?: 'SUCCESS' | 'FAILURE' | 'IN_PROGRESS';
|
|
11604
|
-
startedAt?: string;
|
|
11605
|
-
finishedAt?: string;
|
|
11606
|
-
};
|
|
11607
|
-
/**
|
|
11608
|
-
* RecalculationJobCreation
|
|
11609
|
-
*/
|
|
11610
|
-
type RecalculationJobCreation = {
|
|
11611
|
-
/**
|
|
11612
|
-
* The order identifiers requiring recalculation. This attribute is optional. In case the job type is `AUTOMATIC` the orders for recalculation will be selected automatically based on last packing events.
|
|
11613
|
-
*/
|
|
11614
|
-
orderIds?: Array<string>;
|
|
11615
|
-
/**
|
|
11616
|
-
* The recalculation job types. Possible values:
|
|
11617
|
-
* - `MANUAL` - recalculates all orders provided in the `orderIds` attribute
|
|
11618
|
-
* - `AUTOMATIC` - finds orders that need recalculation and triggers recalculation for them
|
|
11619
|
-
*/
|
|
11620
|
-
jobType: 'AUTOMATIC' | 'MANUAL';
|
|
11621
|
-
};
|
|
11622
|
-
/**
|
|
11623
|
-
* MeasurementUnit
|
|
11624
|
-
*/
|
|
11625
|
-
type MeasurementUnit = {
|
|
11626
|
-
/**
|
|
11627
|
-
* The unit code of the measured quantity
|
|
11628
|
-
*/
|
|
11629
|
-
unitCode?: string;
|
|
11630
|
-
/**
|
|
11631
|
-
* The measured amount
|
|
11632
|
-
*/
|
|
11633
|
-
quantity?: number;
|
|
11634
|
-
};
|
|
11635
|
-
/**
|
|
11636
|
-
* OrderList
|
|
11637
|
-
*/
|
|
11638
|
-
type OrderList = {
|
|
11639
|
-
/**
|
|
11640
|
-
* The id of the order
|
|
11641
|
-
*/
|
|
11642
|
-
orderId?: string;
|
|
11643
|
-
/**
|
|
11644
|
-
* The name of the customer
|
|
11645
|
-
*/
|
|
11646
|
-
customerName?: string;
|
|
11647
|
-
/**
|
|
11648
|
-
* The current status of the order
|
|
11649
|
-
*/
|
|
11650
|
-
packingStatus?: 'INITIAL' | 'IN_PROGRESS' | 'PRE_PACKED' | 'PACKED' | 'CANCELLED';
|
|
11651
|
-
productsTotal?: number;
|
|
11652
|
-
productsPacked?: number;
|
|
11653
|
-
productsCanceled?: number;
|
|
11654
|
-
assignees?: Array<Assignee$1>;
|
|
11655
|
-
packagingProducts?: Array<Entry>;
|
|
11656
|
-
entries?: Array<Entry>;
|
|
11657
|
-
/**
|
|
11658
|
-
* The serial number of the location where the packed order awaits transportation
|
|
11659
|
-
*/
|
|
11660
|
-
holdingAreaNumber?: number;
|
|
11661
|
-
deliveryWindow?: DeliveryWindow$1;
|
|
11662
|
-
};
|
|
11663
|
-
|
|
11664
|
-
/**
|
|
11665
|
-
* Public types for the Pick-Pack Service — stable names aliased over the
|
|
11666
|
-
* generated `pick-pack` types. Several mutating endpoints return an inline
|
|
11667
|
-
* acknowledgement (`{ message?, code? }`) rather than the resource.
|
|
11668
|
-
*/
|
|
11669
|
-
|
|
11670
|
-
/** A pick-pack (fulfillment) order — single read shape. */
|
|
11671
|
-
type PickOrder = Order;
|
|
11672
|
-
/** Packlist — list of pick-pack order summaries (`GET /orders`). */
|
|
11673
|
-
type PickOrderList = OrderList[];
|
|
11674
|
-
/** An order assignee. */
|
|
11675
|
-
type Assignee = Assignee$1;
|
|
11676
|
-
/** A packing event (read). */
|
|
11677
|
-
type PackingEvent = OrderEntryEventResponse;
|
|
11678
|
-
/** List of packing events. */
|
|
11679
|
-
type PackingEventList = PackingEvent[];
|
|
11680
|
-
/** Order cycles (`GET /orderCycles`) — a list of ids. */
|
|
11681
|
-
type OrderCycleList = string[];
|
|
11682
|
-
/** Body for `triggerRecalculation`. */
|
|
11683
|
-
type RecalculationJobInput = RecalculationJobCreation;
|
|
11684
|
-
/** A recalculation job (read). */
|
|
11685
|
-
type RecalculationJob = RecalculationJob$1;
|
|
11686
|
-
/** Inline acknowledgement returned by several mutating endpoints. */
|
|
11687
|
-
interface PickPackAck {
|
|
11688
|
-
message?: string;
|
|
11689
|
-
code?: number;
|
|
11690
|
-
}
|
|
11691
|
-
/** `triggerRecalculation` response — the created job's id. */
|
|
11692
|
-
interface RecalculationJobCreated {
|
|
11693
|
-
jobId?: string;
|
|
11694
|
-
}
|
|
11695
|
-
|
|
11696
|
-
/**
|
|
11697
|
-
* Emporix Pick-Pack Service (`/pick-pack/{tenant}/…`): fulfillment/packlist
|
|
11698
|
-
* orders, assignees, packaging, packing events, and recalculation jobs.
|
|
11699
|
-
* Server-side; defaults to the service token. Several mutating endpoints return
|
|
11700
|
-
* an acknowledgement (`{ message?, code? }`).
|
|
11701
|
-
*
|
|
11702
|
-
* @deprecated since 2026-05-25, removal 2026-08-24 — the Pick-Pack service is
|
|
11703
|
-
* being sunset by Emporix; all endpoints are no longer maintained.
|
|
11704
|
-
*/
|
|
11705
|
-
declare class PickPackService {
|
|
11706
|
-
private readonly ctx;
|
|
11707
|
-
static readonly channel: "pick-pack";
|
|
11708
|
-
constructor(ctx: ClientContext);
|
|
11709
|
-
private base;
|
|
11710
|
-
private orderPath;
|
|
11711
|
-
/** List packlist orders. */
|
|
11712
|
-
listOrders(query?: Record<string, string | number>, auth?: AuthContext): Promise<PickOrderList>;
|
|
11713
|
-
/** Retrieve a packlist order by id. */
|
|
11714
|
-
getOrder(orderId: string, auth?: AuthContext): Promise<PickOrder>;
|
|
11715
|
-
/** Update an order's status (`PATCH`). Returns an acknowledgement. */
|
|
11716
|
-
updateOrder(orderId: string, change: OrderStatusChange, auth?: AuthContext): Promise<PickPackAck>;
|
|
11717
|
-
/** Finish an order. Returns an acknowledgement. */
|
|
11718
|
-
finishOrder(orderId: string, auth?: AuthContext): Promise<PickPackAck>;
|
|
11719
|
-
/** List order cycles (ids). */
|
|
11720
|
-
listOrderCycles(query?: Record<string, string | number>, auth?: AuthContext): Promise<OrderCycleList>;
|
|
11721
|
-
/** Add an assignee to an order. Returns an acknowledgement. */
|
|
11722
|
-
addAssignee(orderId: string, assignee: Assignee, auth?: AuthContext): Promise<PickPackAck>;
|
|
11723
|
-
/** Remove an assignee from an order. */
|
|
11724
|
-
removeAssignee(orderId: string, assigneeId: string, auth?: AuthContext): Promise<void>;
|
|
11725
|
-
/** Update packaging products for an order (`PUT`). Returns an acknowledgement. */
|
|
11726
|
-
updatePackaging(orderId: string, change: PackagingProductsChange, auth?: AuthContext): Promise<PickPackAck>;
|
|
11727
|
-
/** Create a packing event. Returns an acknowledgement. */
|
|
11728
|
-
createEvent(event: OrderEntryEventCreate, auth?: AuthContext): Promise<PickPackAck>;
|
|
11729
|
-
/** List packing events. */
|
|
11730
|
-
listEvents(query?: Record<string, string | number>, auth?: AuthContext): Promise<PackingEventList>;
|
|
11731
|
-
/** Trigger an order recalculation. Returns the created job's id. */
|
|
11732
|
-
triggerRecalculation(input: RecalculationJobInput, auth?: AuthContext): Promise<RecalculationJobCreated>;
|
|
11733
|
-
/** Retrieve a recalculation job by id. */
|
|
11734
|
-
getRecalculationJob(jobId: string, auth?: AuthContext): Promise<RecalculationJob>;
|
|
11735
|
-
}
|
|
11736
|
-
|
|
11737
11452
|
type AccountId = {
|
|
11738
11453
|
/**
|
|
11739
11454
|
* Customer email address.
|
|
@@ -12911,7 +12626,6 @@ declare class EmporixClient {
|
|
|
12911
12626
|
readonly units: UnitHandlingService;
|
|
12912
12627
|
readonly catalogs: CatalogService;
|
|
12913
12628
|
readonly vendors: VendorService;
|
|
12914
|
-
readonly pickPack: PickPackService;
|
|
12915
12629
|
readonly customerAdmin: CustomerAdminService;
|
|
12916
12630
|
readonly approvals: ApprovalService;
|
|
12917
12631
|
/** The validated tenant this client is bound to. */
|
|
@@ -13027,4 +12741,4 @@ declare function productIdFromYrn(yrn: string | undefined): string;
|
|
|
13027
12741
|
*/
|
|
13028
12742
|
declare function productYrn(tenant: string, productId: string): string;
|
|
13029
12743
|
|
|
13030
|
-
export { type AddedPoints, type AdminCustomer, type AdminCustomerAddress, type AdminCustomerAddressInput, type AdminCustomerAddressList, type AdminCustomerAddressUpdate, type AdminCustomerCreated, type AdminCustomerImport, type AdminCustomerImportAccount, type AdminCustomerImportResult, type AdminCustomerInput, type AdminCustomerLegacyAuth, type AdminCustomerList, type AdminCustomerPatch, type AdminCustomerSearchQuery, type AdminCustomerUpdate, type AdminPasswordMigrationRetention, type AdminPasswordMigrationRetentionInput, 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 ApprovalDecision, type ApprovalInput, type ApprovalList, type ApprovalPatch, type ApprovalPermittedInput, type ApprovalPermittedResult, ApprovalService, type ApprovalUsersQuery, type ApprovalUsersResult, type
|
|
12744
|
+
export { type AddedPoints, type AdminCustomer, type AdminCustomerAddress, type AdminCustomerAddressInput, type AdminCustomerAddressList, type AdminCustomerAddressUpdate, type AdminCustomerCreated, type AdminCustomerImport, type AdminCustomerImportAccount, type AdminCustomerImportResult, type AdminCustomerInput, type AdminCustomerLegacyAuth, type AdminCustomerList, type AdminCustomerPatch, type AdminCustomerSearchQuery, type AdminCustomerUpdate, type AdminPasswordMigrationRetention, type AdminPasswordMigrationRetentionInput, 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 ApprovalDecision, type ApprovalInput, type ApprovalList, type ApprovalPatch, type ApprovalPermittedInput, type ApprovalPermittedResult, ApprovalService, type ApprovalUsersQuery, type ApprovalUsersResult, type Attachment, type AttachmentOptions, type AttachmentReuseOptions, type AuditLogChangeType, type AuditLogEntry, type AuditLogPage, type AuditLogPathChange, type AuditLogQuery, type AuditLogRelatedEntity, AuditLogService, 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 ChatOptions, 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 CookieIo, 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 CustomerSessionState, type CustomerSessionStore, type CustomerSummaryBatch, CustomerTokenRefresher, type DeleteAgentOptions, type DeleteConfigOptions, type DeliveryCreated, type DeliveryCycleInput, type DeliverySlot, type DeliverySlotList, type DeliveryTime, type DeliveryTimeInput, type DeliveryTimeList, type DeliveryTimeUpdate, type DeliveryWindow$1 as DeliveryWindow, type DeliveryWindowList, type DeliveryWindowValidation, EmporixAuthError, EmporixClient, EmporixConfig, type EmporixCore, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNetworkError, EmporixNotFoundError, EmporixServerError, type EmporixStorage, type EmporixStorageKey, 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 IamAccessControl, type IamAccessControlCreated, type IamAccessControlUpsert, type IamGroup, type IamGroupCreate, type IamGroupCreated, AssignmentCreateRequest as IamGroupMemberAssignment, type IamGroupMemberCreated, type IamGroupMemberInput, type IamGroupUpdate, type IamScope, type IamScopeCreated, type IamScopeUpsert, IamService, type IamUser, type IamUserCreate, type IamUserCreated, type IamUserDetail, type IamUserScopes, type IamUserUpdate, type ImportCancelResult, type ImportConfig, type ImportDiagnosticKind, type ImportDiagnosticRecord, type ImportErrorRecord, type ImportPage, type ImportPageOptions, type ImportRecordOutcome, type ImportRun, type ImportRunDetail, type ImportRunDiagnostics, type ImportRunDiagnosticsQuery, type ImportRunEvent, type ImportRunInput, type ImportRunMode, type ImportRunStatus, type ImportRunStream, type ImportSchedule, ImportService, type ImportStream, type ImportStreamOrder, type ImportedRecord, 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 ItemFeeSearchByProductId, type ItemFeeSearchByProductIds, 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 ListSchemaReferencesQuery, 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, OrdersService, PaginatedItems, PaymentGatewayService, type PersistedAnonymousSession, 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 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, STORAGE_KEYS, SalesOrdersService, type Schema, type SchemaAttribute, type SchemaDraft, type SchemaExport, type SchemaImportInput, type SchemaInstanceBulkCreateItem, type SchemaInstanceBulkUpsertItem, type SchemaReference, type SchemaReferenceCreated, type SchemaReferenceInput, type SchemaReferenceUpdateInput, SchemaService, type SchemaTypeName, type SchemaUpdate, type SearchImportedRecordsOptions, type SearchInstancesQuery, type SearchQuery, type SearchStreamRecordsOptions, SegmentService, type SequenceSchema, type SequenceSchemaCreate, SequentialIdService, type ServerCookieJar, type ServiceClass, ServiceName, type SessionAttributeInput, type SessionContext, type SessionContextPatch, SessionContextService, type SetItemFeesOptions, type ShippingFee, type ShippingGroup, type ShippingGroupList, type ShippingMethod, type ShippingMethodList, type ShippingPatch, ShippingService, type ShoppingList, type ShoppingListDraft, type ShoppingListItem, ShoppingListService, type Site$1 as Site, type SiteCreated, type SiteFields, type SiteInput, type SiteList, type SiteMixin, type SiteMixinCreated, type SiteMixins, SiteService, StoredAnonymousSession, 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 TokenStorage, 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, approvalStatusPatch, createCookieBackedStorage, createCookieStorage, createCore, createEmporixClient, createListenerSet, createLocalStorage, createLocalStorageStorage, createMemoryStorage, createServerStorage, createSessionStorage, emporixKey, errorFromResponse, fromWebStorage, getCustomerSessionStore, parseAnonymousSession, pickFee, productIdFromYrn, productYrn, resolveZone, serverAuth, siteMeta };
|