@viu/emporix-sdk 4.8.0 → 4.9.1
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 +18 -0
- package/dist/index.cjs +98 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +492 -20
- package/dist/index.d.ts +492 -20
- package/dist/index.js +98 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1190,6 +1190,10 @@ type MetadataFilter$1 = {
|
|
|
1190
1190
|
* Type of the field.
|
|
1191
1191
|
*/
|
|
1192
1192
|
type?: 'string' | 'integer' | 'float' | 'boolean' | 'datetime' | 'date' | 'time' | 'dictionary' | 'list' | 'object';
|
|
1193
|
+
/**
|
|
1194
|
+
* Path of the list of objects that contains this field. Omitted when the field is not inside a list.
|
|
1195
|
+
*/
|
|
1196
|
+
parent?: string;
|
|
1193
1197
|
};
|
|
1194
1198
|
|
|
1195
1199
|
/**
|
|
@@ -2999,8 +3003,9 @@ type ExpandableTokenResponse = IdResponse | ExpandedTokenResponse;
|
|
|
2999
3003
|
* * `rag_custom`
|
|
3000
3004
|
* * `rag_emporix`
|
|
3001
3005
|
* * `teams`
|
|
3006
|
+
* * `search`
|
|
3002
3007
|
*/
|
|
3003
|
-
type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix' | 'teams';
|
|
3008
|
+
type NativeToolType = 'slack' | 'rag_custom' | 'rag_emporix' | 'teams' | 'search';
|
|
3004
3009
|
type BaseNativeTool = {
|
|
3005
3010
|
type: NativeToolType;
|
|
3006
3011
|
/**
|
|
@@ -3125,7 +3130,12 @@ type RagEmporixNativeToolConfig = {
|
|
|
3125
3130
|
*/
|
|
3126
3131
|
prompt: string;
|
|
3127
3132
|
/**
|
|
3128
|
-
* Type of the entity which is stored in the given collection.
|
|
3133
|
+
* Type of the entity which is stored in the given collection. Possible values:
|
|
3134
|
+
* * `product`
|
|
3135
|
+
* * `order`
|
|
3136
|
+
* * `customer`
|
|
3137
|
+
* * `legal-entity`
|
|
3138
|
+
* * a custom entity type defined in the Schema Service
|
|
3129
3139
|
*/
|
|
3130
3140
|
entityType: string;
|
|
3131
3141
|
/**
|
|
@@ -3254,6 +3264,46 @@ type TeamsNativeToolResponse = BaseNativeTool & {
|
|
|
3254
3264
|
config?: TeamsNativeToolConfigResponse;
|
|
3255
3265
|
metadata?: MetadataResponse$1;
|
|
3256
3266
|
};
|
|
3267
|
+
/**
|
|
3268
|
+
* Type of documents the tool searches. Possible values:
|
|
3269
|
+
* * `customer`
|
|
3270
|
+
* * `legal-entity`
|
|
3271
|
+
*/
|
|
3272
|
+
type SearchEntityType = 'customer' | 'legal-entity';
|
|
3273
|
+
/**
|
|
3274
|
+
* Configuration of a search native tool instance.
|
|
3275
|
+
*/
|
|
3276
|
+
type SearchNativeToolConfig = {
|
|
3277
|
+
/**
|
|
3278
|
+
* Instructions for the agent on when and why to call this tool. They are added to the tool description.
|
|
3279
|
+
*/
|
|
3280
|
+
prompt?: string;
|
|
3281
|
+
entityType: SearchEntityType;
|
|
3282
|
+
/**
|
|
3283
|
+
* Maximum number of documents the tool returns for one search.
|
|
3284
|
+
*/
|
|
3285
|
+
maxResults?: number;
|
|
3286
|
+
};
|
|
3287
|
+
type SearchNativeToolRequest = BaseNativeTool & {
|
|
3288
|
+
/**
|
|
3289
|
+
* For `SearchNativeTool`, it has to be set to `search`.
|
|
3290
|
+
*/
|
|
3291
|
+
type?: unknown;
|
|
3292
|
+
config: SearchNativeToolConfig;
|
|
3293
|
+
metadata?: MetadataRequest;
|
|
3294
|
+
};
|
|
3295
|
+
type SearchNativeToolResponse = BaseNativeTool & {
|
|
3296
|
+
/**
|
|
3297
|
+
* Unique identifier of the tool.
|
|
3298
|
+
*/
|
|
3299
|
+
id?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* For `SearchNativeTool`, it has to be set to `search`.
|
|
3302
|
+
*/
|
|
3303
|
+
type?: unknown;
|
|
3304
|
+
config?: SearchNativeToolConfig;
|
|
3305
|
+
metadata?: MetadataResponse$1;
|
|
3306
|
+
};
|
|
3257
3307
|
type RagCustomNativeToolRequest = BaseNativeTool & {
|
|
3258
3308
|
/**
|
|
3259
3309
|
* For `RagCustomNativeTool`, it has to be set to `rag_custom`.
|
|
@@ -3297,7 +3347,7 @@ type RagEmporixNativeToolResponse = BaseNativeTool & {
|
|
|
3297
3347
|
/**
|
|
3298
3348
|
* List of native tools which agents should have access to.
|
|
3299
3349
|
*/
|
|
3300
|
-
type NativeToolsResponse = Array<SlackNativeToolResponse | RagCustomNativeToolResponse | RagEmporixNativeToolResponse | TeamsNativeToolResponse>;
|
|
3350
|
+
type NativeToolsResponse = Array<SlackNativeToolResponse | RagCustomNativeToolResponse | RagEmporixNativeToolResponse | TeamsNativeToolResponse | SearchNativeToolResponse>;
|
|
3301
3351
|
/**
|
|
3302
3352
|
* Represents an active agent conversation context (MS Teams channel or group chat).
|
|
3303
3353
|
*/
|
|
@@ -4475,7 +4525,7 @@ type QParamSearchBody2 = QParamSearchBody;
|
|
|
4475
4525
|
type McpServerUpsertBody = McpServerRequest;
|
|
4476
4526
|
type TokenUpsertBody = TokenRequest;
|
|
4477
4527
|
type OauthUpsertBody = OAuthRequest;
|
|
4478
|
-
type ToolUpsertBody = SlackNativeToolRequest | RagCustomNativeToolRequest | RagEmporixNativeToolRequest | TeamsNativeToolRequest;
|
|
4528
|
+
type ToolUpsertBody = SlackNativeToolRequest | RagCustomNativeToolRequest | RagEmporixNativeToolRequest | TeamsNativeToolRequest | SearchNativeToolRequest;
|
|
4479
4529
|
|
|
4480
4530
|
/** Single-shot text generation request (`POST /texts`). Has `maxTokens`. */
|
|
4481
4531
|
type TextRequest = TextGenerationRequest;
|
|
@@ -9034,7 +9084,15 @@ type Metadata$3 = {
|
|
|
9034
9084
|
modifiedAt?: string;
|
|
9035
9085
|
};
|
|
9036
9086
|
/**
|
|
9037
|
-
* Entity type
|
|
9087
|
+
* Entity type to reindex. The following values are supported:
|
|
9088
|
+
* * `PRODUCT`
|
|
9089
|
+
* * `ORDER`
|
|
9090
|
+
* * `CUSTOMER`
|
|
9091
|
+
* * `LEGAL-ENTITY`
|
|
9092
|
+
*
|
|
9093
|
+
* You can also use a custom schema type.
|
|
9094
|
+
*
|
|
9095
|
+
* Values are case-insensitive. `LEGAL-ENTITY` uses a hyphen, not an underscore.
|
|
9038
9096
|
*/
|
|
9039
9097
|
type ReindexEntityType$1 = string;
|
|
9040
9098
|
type ReindexJob$1 = {
|
|
@@ -9242,9 +9300,13 @@ type IndexRequest = {
|
|
|
9242
9300
|
/**
|
|
9243
9301
|
* Fields to index. At least one field is required.
|
|
9244
9302
|
*
|
|
9245
|
-
* A string field needs `text`, `autocomplete`, or `exact`. A number, boolean, or date field supports only `exact` set to `true`. `time`, `
|
|
9303
|
+
* A string field needs `text`, `autocomplete`, or `exact`. A number, boolean, or date field supports only `exact` set to `true`. `time`, `object`, and `dictionary` fields cannot be indexed. A list of objects is indexed with `itemFields` on `IndexField`. A path must be a field defined on the type, or `metadata.createdAt`, or `metadata.modifiedAt`. Any other path is rejected.
|
|
9246
9304
|
*/
|
|
9247
9305
|
fields: Array<IndexField>;
|
|
9306
|
+
/**
|
|
9307
|
+
* Named text comparison rules. Optional. Every analyzer must be selected by a field.
|
|
9308
|
+
*/
|
|
9309
|
+
analyzers?: Array<IndexAnalyzer>;
|
|
9248
9310
|
metadata?: IndexMetadataRequest;
|
|
9249
9311
|
};
|
|
9250
9312
|
/**
|
|
@@ -9267,6 +9329,57 @@ type IndexField = {
|
|
|
9267
9329
|
* Indexes the field for equality, list, range, existence, and sort. Required for number, boolean, and date fields.
|
|
9268
9330
|
*/
|
|
9269
9331
|
exact?: boolean;
|
|
9332
|
+
/**
|
|
9333
|
+
* Comparison rules for a string field with `text` set to `true`. Use a preset (`STANDARD`, `FOLDED`, `IDENTIFIER`, `SOUNDS_LIKE`) or the `name` of an analyzer on the index. When omitted, `STANDARD` is used.
|
|
9334
|
+
*/
|
|
9335
|
+
analyzer?: string;
|
|
9336
|
+
/**
|
|
9337
|
+
* Extra comparison rules for the same field. Each entry is a preset or the `name` of an analyzer on the index. A query uses one only when it selects it. Requires `text` set to `true`.
|
|
9338
|
+
*/
|
|
9339
|
+
additionalAnalyzers?: Array<string>;
|
|
9340
|
+
/**
|
|
9341
|
+
* Fields inside one list of objects. `path` is that list. The catalog `parent` of each child must be this path. Matching within one list item uses these fields. Do not set `text`, `autocomplete`, `exact`, or `analyzer` on the list itself.
|
|
9342
|
+
*/
|
|
9343
|
+
itemFields?: Array<IndexField>;
|
|
9344
|
+
};
|
|
9345
|
+
/**
|
|
9346
|
+
* Rules for comparing text. The service applies the same rules to the stored value and to the query. Unknown properties are ignored.
|
|
9347
|
+
*
|
|
9348
|
+
* `basedOn` starts from a preset. A property you set replaces that preset's value. `STANDARD` compares words and ignores case. `FOLDED` also ignores accents. `IDENTIFIER` compares the whole value, ignores case, and removes spaces, `-`, `.`, and `/`. `SOUNDS_LIKE` matches words that sound alike.
|
|
9349
|
+
*/
|
|
9350
|
+
type IndexAnalyzer = {
|
|
9351
|
+
/**
|
|
9352
|
+
* Analyzer name. A letter, then up to 39 letters, digits, underscores, or hyphens. Preset names, `keyword`, and `folded` are reserved.
|
|
9353
|
+
*/
|
|
9354
|
+
name: string;
|
|
9355
|
+
/**
|
|
9356
|
+
* Preset these rules start from.
|
|
9357
|
+
*/
|
|
9358
|
+
basedOn?: 'STANDARD' | 'FOLDED' | 'IDENTIFIER' | 'SOUNDS_LIKE';
|
|
9359
|
+
/**
|
|
9360
|
+
* `WORDS` compares word by word. `WHOLE_VALUE` compares the whole value as one token.
|
|
9361
|
+
*/
|
|
9362
|
+
split?: 'WORDS' | 'WHOLE_VALUE';
|
|
9363
|
+
/**
|
|
9364
|
+
* If set to `true`, upper and lower case are treated as equal.
|
|
9365
|
+
*/
|
|
9366
|
+
ignoreCase?: boolean;
|
|
9367
|
+
/**
|
|
9368
|
+
* If set to `true`, letters with and without accents are treated as equal.
|
|
9369
|
+
*/
|
|
9370
|
+
ignoreAccents?: boolean;
|
|
9371
|
+
/**
|
|
9372
|
+
* Characters removed before comparing. Each entry is one character.
|
|
9373
|
+
*/
|
|
9374
|
+
ignoreCharacters?: Array<string>;
|
|
9375
|
+
/**
|
|
9376
|
+
* Words ignored when comparing. With `WORDS`, each word contains only letters and digits, is at most 50 characters, and must stay one word when text is split. For example, `中文` is two words.
|
|
9377
|
+
*/
|
|
9378
|
+
ignoreWords?: Array<string>;
|
|
9379
|
+
/**
|
|
9380
|
+
* `SPELLING` compares the letters. `SOUND` matches words that sound alike.
|
|
9381
|
+
*/
|
|
9382
|
+
compare?: 'SPELLING' | 'SOUND';
|
|
9270
9383
|
};
|
|
9271
9384
|
/**
|
|
9272
9385
|
* Optimistic lock for an index update. The object can be omitted on create and on update. A missing object still updates an existing index.
|
|
@@ -9284,7 +9397,7 @@ type IndexMetadataRequest = {
|
|
|
9284
9397
|
*/
|
|
9285
9398
|
type IndexSelection = {
|
|
9286
9399
|
/**
|
|
9287
|
-
*
|
|
9400
|
+
* Type this index belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9288
9401
|
*/
|
|
9289
9402
|
type: string;
|
|
9290
9403
|
/**
|
|
@@ -9295,7 +9408,7 @@ type IndexSelection = {
|
|
|
9295
9408
|
/**
|
|
9296
9409
|
* Package of search index configuration. `data` is the base64 encoding of a JSON array.
|
|
9297
9410
|
*
|
|
9298
|
-
* Each decoded item has `id`, `type`, and `fields`. `name` and `
|
|
9411
|
+
* Each decoded item has `id`, `type`, and `fields`. `name`, `description`, and `analyzers` are optional. Export omits `status` and `metadata`. Import accepts `metadata.version` when the caller sends it.
|
|
9299
9412
|
*/
|
|
9300
9413
|
type IndexExportPackage = {
|
|
9301
9414
|
/**
|
|
@@ -9316,7 +9429,7 @@ type IndexImportResult = {
|
|
|
9316
9429
|
*/
|
|
9317
9430
|
id: string;
|
|
9318
9431
|
/**
|
|
9319
|
-
*
|
|
9432
|
+
* Type this index belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9320
9433
|
*/
|
|
9321
9434
|
type: string;
|
|
9322
9435
|
/**
|
|
@@ -9339,7 +9452,7 @@ type SearchIndex$1 = {
|
|
|
9339
9452
|
*/
|
|
9340
9453
|
id?: string;
|
|
9341
9454
|
/**
|
|
9342
|
-
*
|
|
9455
|
+
* Type this index belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9343
9456
|
*/
|
|
9344
9457
|
type?: string;
|
|
9345
9458
|
/**
|
|
@@ -9358,6 +9471,10 @@ type SearchIndex$1 = {
|
|
|
9358
9471
|
* Fields stored for this index.
|
|
9359
9472
|
*/
|
|
9360
9473
|
fields?: Array<IndexField>;
|
|
9474
|
+
/**
|
|
9475
|
+
* Text comparison rules stored for this index. Omitted when the index has none.
|
|
9476
|
+
*/
|
|
9477
|
+
analyzers?: Array<IndexAnalyzer>;
|
|
9361
9478
|
/**
|
|
9362
9479
|
* Build state of the index.
|
|
9363
9480
|
*/
|
|
@@ -9442,7 +9559,7 @@ type SavedSearchCall = {
|
|
|
9442
9559
|
*/
|
|
9443
9560
|
query: string;
|
|
9444
9561
|
/**
|
|
9445
|
-
* Id of the saved search for this
|
|
9562
|
+
* Id of the saved search for this type.
|
|
9446
9563
|
*/
|
|
9447
9564
|
searchQueryId: string;
|
|
9448
9565
|
};
|
|
@@ -9513,7 +9630,7 @@ type SavedQuery = {
|
|
|
9513
9630
|
[key: string]: string;
|
|
9514
9631
|
};
|
|
9515
9632
|
/**
|
|
9516
|
-
*
|
|
9633
|
+
* Type this saved search belongs to. A custom schema type, `customer`, or `legal-entity`.
|
|
9517
9634
|
*/
|
|
9518
9635
|
type?: string;
|
|
9519
9636
|
/**
|
|
@@ -9542,7 +9659,7 @@ type QueryNode = {
|
|
|
9542
9659
|
*/
|
|
9543
9660
|
query?: string;
|
|
9544
9661
|
/**
|
|
9545
|
-
* Document field to match. `id` is stored as `_id`.
|
|
9662
|
+
* Document field to match. `id` is stored as `_id`. A field inside `itemFields` uses its full path, such as `addresses.city`. Conditions on one list joined by `and` must match the same item. The list path itself cannot be searched.
|
|
9546
9663
|
*/
|
|
9547
9664
|
field?: string;
|
|
9548
9665
|
/**
|
|
@@ -9550,6 +9667,12 @@ type QueryNode = {
|
|
|
9550
9667
|
*/
|
|
9551
9668
|
boost?: number;
|
|
9552
9669
|
fuzzy?: Fuzzy;
|
|
9670
|
+
/**
|
|
9671
|
+
* Optional analyzer for this clause. Allowed only when `type` is `TEXT` or `PHRASE`.
|
|
9672
|
+
*
|
|
9673
|
+
* The value is the field's `analyzer`, or one name from that field's `additionalAnalyzers`. The name is not case-sensitive. When omitted, the query uses the field's `analyzer`.
|
|
9674
|
+
*/
|
|
9675
|
+
analyzer?: string;
|
|
9553
9676
|
};
|
|
9554
9677
|
/**
|
|
9555
9678
|
* Match mode.
|
|
@@ -9588,7 +9711,7 @@ type FilterNode = {
|
|
|
9588
9711
|
*/
|
|
9589
9712
|
or?: Array<FilterNode>;
|
|
9590
9713
|
/**
|
|
9591
|
-
* Document field to compare. `id` is stored as `_id`.
|
|
9714
|
+
* Document field to compare. `id` is stored as `_id`. A field inside `itemFields` uses its full path, such as `addresses.city`. Conditions on one list joined by `and` must match the same item. A lone `NEQ`, `NOT_IN`, or `EXISTS` `false` on a list excludes the document when any item matches the value. A document with no items in that list matches. The same operator joined by `and` with another condition on that list still applies to one item. The list path itself cannot be searched.
|
|
9592
9715
|
*/
|
|
9593
9716
|
field?: string;
|
|
9594
9717
|
operator?: FilterOperator;
|
|
@@ -9848,6 +9971,85 @@ type ImportConfig$1 = {
|
|
|
9848
9971
|
*/
|
|
9849
9972
|
updatedAt?: string;
|
|
9850
9973
|
};
|
|
9974
|
+
/**
|
|
9975
|
+
* Import file
|
|
9976
|
+
*
|
|
9977
|
+
* One file a file-based stream has been given, and what became of it.
|
|
9978
|
+
*/
|
|
9979
|
+
type ImportFile$1 = {
|
|
9980
|
+
/**
|
|
9981
|
+
* The file's identifier.
|
|
9982
|
+
*/
|
|
9983
|
+
id?: string;
|
|
9984
|
+
/**
|
|
9985
|
+
* The name the file was given, used to display it and to infer compression.
|
|
9986
|
+
*/
|
|
9987
|
+
fileName?: string;
|
|
9988
|
+
/**
|
|
9989
|
+
* The file's size in bytes.
|
|
9990
|
+
*/
|
|
9991
|
+
size?: number;
|
|
9992
|
+
/**
|
|
9993
|
+
* Where the file is in its life. Possible values:
|
|
9994
|
+
*
|
|
9995
|
+
* * `PENDING` – waiting to be imported.
|
|
9996
|
+
* * `IN_PROGRESS` – a run has claimed it and is reading it.
|
|
9997
|
+
* * `PROCESSED` – read to completion. Set only once its records have been written, so a run that
|
|
9998
|
+
* fails part-way leaves the file importable.
|
|
9999
|
+
* * `FAILED` – the stream that read the file finished `FAILED`. The file could not be read
|
|
10000
|
+
* (malformed, truncated, wrong charset), or the import failed for another reason, such as the
|
|
10001
|
+
* target being unavailable. Such a file can be sent again. Records that fail individually do not
|
|
10002
|
+
* put a file here: a stream that finishes with record failures still marks its file imported.
|
|
10003
|
+
*/
|
|
10004
|
+
status?: 'PENDING' | 'IN_PROGRESS' | 'PROCESSED' | 'FAILED';
|
|
10005
|
+
/**
|
|
10006
|
+
* The position in the drain order. For an incremental feed the order is part of the data: a later file's values win on a key an earlier one also carries.
|
|
10007
|
+
*/
|
|
10008
|
+
loadRank?: number;
|
|
10009
|
+
/**
|
|
10010
|
+
* When the file was added to the queue.
|
|
10011
|
+
*/
|
|
10012
|
+
queuedAt?: string;
|
|
10013
|
+
/**
|
|
10014
|
+
* When the file finished being imported.
|
|
10015
|
+
*/
|
|
10016
|
+
processedAt?: string;
|
|
10017
|
+
/**
|
|
10018
|
+
* The run that consumed it.
|
|
10019
|
+
*/
|
|
10020
|
+
runId?: string;
|
|
10021
|
+
/**
|
|
10022
|
+
* How many records came out of it.
|
|
10023
|
+
*/
|
|
10024
|
+
recordsRead?: number;
|
|
10025
|
+
/**
|
|
10026
|
+
* Why the file ended as it did, when that needs saying — a file superseded by a newer snapshot in the same run, or one imported with record-level failures.
|
|
10027
|
+
*/
|
|
10028
|
+
message?: string;
|
|
10029
|
+
};
|
|
10030
|
+
/**
|
|
10031
|
+
* File queue
|
|
10032
|
+
*
|
|
10033
|
+
* What a stream still has to import, and what it has already dealt with.
|
|
10034
|
+
*/
|
|
10035
|
+
type FileQueue = {
|
|
10036
|
+
/**
|
|
10037
|
+
* The files waiting to be imported, in the order they will be read.
|
|
10038
|
+
*/
|
|
10039
|
+
pending?: Array<ImportFile$1>;
|
|
10040
|
+
/**
|
|
10041
|
+
* Files already dealt with, newest first.
|
|
10042
|
+
*/
|
|
10043
|
+
history?: Array<ImportFile$1>;
|
|
10044
|
+
/**
|
|
10045
|
+
* True when more files are waiting than this response carries. The load order cannot be changed while it is true, because an order that cannot name every waiting file has no meaning.
|
|
10046
|
+
*/
|
|
10047
|
+
pendingTruncated?: boolean;
|
|
10048
|
+
/**
|
|
10049
|
+
* How many files are waiting in total, however many this response lists.
|
|
10050
|
+
*/
|
|
10051
|
+
pendingTotal?: number;
|
|
10052
|
+
};
|
|
9851
10053
|
/**
|
|
9852
10054
|
* Stream
|
|
9853
10055
|
*
|
|
@@ -9955,6 +10157,80 @@ type ImportStream$1 = {
|
|
|
9955
10157
|
* Whether the stream is active.
|
|
9956
10158
|
*/
|
|
9957
10159
|
enabled?: boolean;
|
|
10160
|
+
/**
|
|
10161
|
+
* The source connection this stream reads from, when it has its own. Omitted means the configuration's default connection is used. One configuration can therefore mix sources.
|
|
10162
|
+
*/
|
|
10163
|
+
connectionId?: string;
|
|
10164
|
+
/**
|
|
10165
|
+
* How this stream addresses its source. The recognised properties depend on the source type; the
|
|
10166
|
+
* ones below are common.
|
|
10167
|
+
*
|
|
10168
|
+
* * `keyField` – the source column holding the natural key.
|
|
10169
|
+
* * `keyFields` and `keyName` – a key that may resolve from more than one column: the first
|
|
10170
|
+
* non-empty of `keyFields` wins, and `keyName` is the single canonical name recorded for it,
|
|
10171
|
+
* so the same entity keeps one target id whichever column supplied the value. Put the stable
|
|
10172
|
+
* identifier first: a lower-priority column winning on an earlier run and a higher-priority
|
|
10173
|
+
* one later re-keys the record.
|
|
10174
|
+
* * `limit` – the maximum number of records one run reads (`Max records`). A positive number
|
|
10175
|
+
* only; text or zero means no cap. A dry run reads at most the smaller of this and its own sample size.
|
|
10176
|
+
* * `record` – the source record, table, or endpoint to read.
|
|
10177
|
+
* * For a file source: the delimited-file format (`delimiter`, `quote`, `escape`, `charset`,
|
|
10178
|
+
* `header`, `skipLines`, `nullLiterals`, `trimValues`, `compression`, `failOnRaggedRow`) and
|
|
10179
|
+
* `arrays`, which reshapes repeated flat columns into nested form. The original columns are kept,
|
|
10180
|
+
* and each array is added beside them under its name followed by `[]` — for example `lineItems[]`
|
|
10181
|
+
* for `lineItems.0.sku`, or `COUNTRIES[]` for a delimited `COUNTRIES` column:
|
|
10182
|
+
* * `style` – how a repeated column is recognised: `DOT` (`lineItems.0.sku`), `BRACKET`
|
|
10183
|
+
* (`lineItems[0].sku`), `SUFFIX` (`phone_1`), or `NONE` (the default), which recognises no
|
|
10184
|
+
* repeated columns.
|
|
10185
|
+
* * `delimited` – a list of column names whose cells each hold a list of values.
|
|
10186
|
+
* * `separator` – the character a `delimited` cell is split on. Defaults to `;`.
|
|
10187
|
+
* * `maxElements` – the maximum number of elements one array can hold. Defaults to 1000; the
|
|
10188
|
+
* highest allowed value is 10000. A row with a longer array is not truncated: only that row
|
|
10189
|
+
* fails, with the error code `REJECTED_BY_SOURCE`, and the rest of the file is imported.
|
|
10190
|
+
* * For an HTTP source: `pagination`, `queryParams`, `bodyTemplate`, and `format` (`JSON` or
|
|
10191
|
+
* `XML`).
|
|
10192
|
+
*/
|
|
10193
|
+
sourceDataset?: {
|
|
10194
|
+
[key: string]: unknown;
|
|
10195
|
+
};
|
|
10196
|
+
/**
|
|
10197
|
+
* For a file-based source, what one file represents. `SNAPSHOT`: each file is the whole picture, so only the most recently arrived one is read, and the per-record content hash decides what is written. A record missing from a newer file is not deleted. `INCREMENTAL`: each file is a change set, so every queued file is read in order and a later file's values win. Defaults to `SNAPSHOT`.
|
|
10198
|
+
*/
|
|
10199
|
+
fileMode?: 'SNAPSHOT' | 'INCREMENTAL';
|
|
10200
|
+
/**
|
|
10201
|
+
* For an `EMBED` composite child, the source column its parent matches records by. Required for such a stream: without it the parent cannot find its children and writes an empty array.
|
|
10202
|
+
*/
|
|
10203
|
+
parentKeyField?: string;
|
|
10204
|
+
/**
|
|
10205
|
+
* Whether the delta field counts as content when deciding a record has changed. Off by default: a modified timestamp is metadata about a change, not content, and a source that restamps every row on reload would otherwise make every run rewrite the whole table. Turn it on only when the timestamp moving genuinely means the record is different.
|
|
10206
|
+
*/
|
|
10207
|
+
hashIncludesDeltaField?: boolean;
|
|
10208
|
+
/**
|
|
10209
|
+
* Extra target attributes to declare on the type beyond those the mappings cover, for fields written by something other than this import, keyed by attribute name.
|
|
10210
|
+
*/
|
|
10211
|
+
schemaAttributes?: {
|
|
10212
|
+
[key: string]: unknown;
|
|
10213
|
+
};
|
|
10214
|
+
/**
|
|
10215
|
+
* The target mixin schema version this stream's mappings were written against, keyed by schema id. An instance is validated against the version it was written under, so a stream pinned here is also written at that version. Set by the mapping editor, not by a stream update: a stream update that carried this property would blank the pins.
|
|
10216
|
+
*/
|
|
10217
|
+
mappingSchemaVersions?: {
|
|
10218
|
+
[key: string]: number;
|
|
10219
|
+
};
|
|
10220
|
+
/**
|
|
10221
|
+
* Whether to refuse to start a run when a pinned mixin's current version has moved past the pinned one, before any record is read. Opt-in, and bypassed by triggering a run with `force`.
|
|
10222
|
+
*/
|
|
10223
|
+
abortOnSchemaVersionDrift?: boolean;
|
|
10224
|
+
/**
|
|
10225
|
+
* Names of streams that must run before this one, beyond the ordering a composite parent already implies.
|
|
10226
|
+
*/
|
|
10227
|
+
dependsOn?: Array<string>;
|
|
10228
|
+
/**
|
|
10229
|
+
* The source field used as the instance's display name. Superseded by mapping a field to the standard `name` attribute, which a mapping's transformations also apply to; a `name` mapping wins over this property. Kept for streams configured before that existed.
|
|
10230
|
+
*
|
|
10231
|
+
* @deprecated
|
|
10232
|
+
*/
|
|
10233
|
+
nameField?: string;
|
|
9958
10234
|
};
|
|
9959
10235
|
/**
|
|
9960
10236
|
* Schedule
|
|
@@ -10093,7 +10369,7 @@ type ImportRun$1 = {
|
|
|
10093
10369
|
*/
|
|
10094
10370
|
lastRequestedAt?: string;
|
|
10095
10371
|
/**
|
|
10096
|
-
* Records read
|
|
10372
|
+
* Records read. The counters reconcile: `recordsRead` = created + updated + skipped + unresolvedParents + deleted + failed + collapsed + embedded. A client that sums only some of them will not balance.
|
|
10097
10373
|
*/
|
|
10098
10374
|
recordsRead?: number;
|
|
10099
10375
|
/**
|
|
@@ -10124,6 +10400,14 @@ type ImportRun$1 = {
|
|
|
10124
10400
|
* Child records that were not imported because their parent could not be found. Counted separately from `skipped`, which counts records that were already up to date.
|
|
10125
10401
|
*/
|
|
10126
10402
|
unresolvedParents?: number;
|
|
10403
|
+
/**
|
|
10404
|
+
* Source rows that repeated a key already present in the same batch. They are merged before the write, last row wins, and counted here — so the report adds up however the source feed is batched. A repeat in a *later* batch is written again and counted as created or updated instead; `duplicateKeys` is the signal for a feed that is not unique on its key.
|
|
10405
|
+
*/
|
|
10406
|
+
collapsed?: number;
|
|
10407
|
+
/**
|
|
10408
|
+
* Child records an `EMBED` composite child handed to its parent, which the parent then wrote inside its own instance. One write of the parent covers them all, so they are never counted as created or updated (that would count each line as an instance) and never as skipped (which means "already up to date"). If the parent turned out to be unchanged, failed, or absent, these are settled onto `skipped`, `failed`, or `unresolvedParents` once the parent's pass completes.
|
|
10409
|
+
*/
|
|
10410
|
+
embedded?: number;
|
|
10127
10411
|
/**
|
|
10128
10412
|
* A terminal status message, typically set on failure.
|
|
10129
10413
|
*/
|
|
@@ -10193,7 +10477,7 @@ type ImportRunStream$1 = {
|
|
|
10193
10477
|
*/
|
|
10194
10478
|
status?: 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'PARTIAL' | 'FAILED' | 'SKIPPED' | 'ABORTED';
|
|
10195
10479
|
/**
|
|
10196
|
-
* Records read for this stream.
|
|
10480
|
+
* Records read for this stream. The counters reconcile: `recordsRead` = created + updated + skipped + unresolvedParents + deleted + failed + collapsed + embedded.
|
|
10197
10481
|
*/
|
|
10198
10482
|
recordsRead?: number;
|
|
10199
10483
|
/**
|
|
@@ -10224,10 +10508,40 @@ type ImportRunStream$1 = {
|
|
|
10224
10508
|
* Child records that were not imported because their parent could not be found. Counted separately from `skipped`, which counts records that were already up to date.
|
|
10225
10509
|
*/
|
|
10226
10510
|
unresolvedParents?: number;
|
|
10511
|
+
/**
|
|
10512
|
+
* Source rows that repeated a key already present in the same batch. They are merged before the write, last row wins, and counted here — so the report adds up however the source feed is batched. A repeat in a *later* batch is written again and counted as created or updated instead; `duplicateKeys` is the signal for a feed that is not unique on its key.
|
|
10513
|
+
*/
|
|
10514
|
+
collapsed?: number;
|
|
10515
|
+
/**
|
|
10516
|
+
* Child records an `EMBED` composite child handed to its parent, which the parent then wrote inside its own instance. One write of the parent covers them all, so they are never counted as created or updated (that would count each line as an instance) and never as skipped (which means "already up to date"). If the parent turned out to be unchanged, failed, or absent, these are settled onto `skipped`, `failed`, or `unresolvedParents` once the parent's pass completes.
|
|
10517
|
+
*/
|
|
10518
|
+
embedded?: number;
|
|
10227
10519
|
/**
|
|
10228
10520
|
* A per-stream status message.
|
|
10229
10521
|
*/
|
|
10230
10522
|
message?: string;
|
|
10523
|
+
/**
|
|
10524
|
+
* For a file-based source, the file locators this stream actually read, in the order it read them. Recorded so a retry re-reads exactly the same bytes: the file behind a locator can be replaced by a later drop, and re-running against a different file would report a clean success having repaired nothing.
|
|
10525
|
+
*/
|
|
10526
|
+
filesRead?: Array<string>;
|
|
10527
|
+
/**
|
|
10528
|
+
* The display name of each locator in `filesRead`, keyed by locator. A file is addressed by an opaque id, so the name is carried beside it rather than derived from it.
|
|
10529
|
+
*/
|
|
10530
|
+
fileNames?: {
|
|
10531
|
+
[key: string]: string;
|
|
10532
|
+
};
|
|
10533
|
+
/**
|
|
10534
|
+
* True when the tenant's licensed `maxRecordsPerEntity` was reached and the remaining records were read but not written. They are counted as `skipped` and the stream is `PARTIAL`: the data is not lost, but it is not imported either until the limit is raised. See the license endpoint.
|
|
10535
|
+
*/
|
|
10536
|
+
capSkipped?: boolean;
|
|
10537
|
+
/**
|
|
10538
|
+
* True when at least one source record had no value in its key column. Such a record is counted as both read and failed and is reported under error code `NO_KEY` — the import does not invent a key, because a synthesised one collides across records and changes whenever the record does.
|
|
10539
|
+
*/
|
|
10540
|
+
keylessSeen?: boolean;
|
|
10541
|
+
/**
|
|
10542
|
+
* True for the extra row produced by the unresolved-parent sweep, which re-fetches the parents a composite child could not find and then re-reads their lines. A child's sweep row is folded into its original row and removed; a parent's sweep row remains, because its reads are genuinely new. Treat a row with this flag as a repair pass, not as a second stream.
|
|
10543
|
+
*/
|
|
10544
|
+
sweep?: boolean;
|
|
10231
10545
|
};
|
|
10232
10546
|
/**
|
|
10233
10547
|
* Run detail
|
|
@@ -10291,7 +10605,27 @@ type ErrorRecord = {
|
|
|
10291
10605
|
*/
|
|
10292
10606
|
stage?: string;
|
|
10293
10607
|
/**
|
|
10294
|
-
* A machine-readable error code
|
|
10608
|
+
* A machine-readable error code:
|
|
10609
|
+
*
|
|
10610
|
+
* * `VALIDATION` – the mapped record failed validation before any write was attempted.
|
|
10611
|
+
* * `NO_KEY` – the record's key column was empty, so it cannot be identified.
|
|
10612
|
+
* * `UPSERT` – the target rejected the write.
|
|
10613
|
+
* * `CONFIGURATION` – something to change in the import's own configuration, not a fault: a
|
|
10614
|
+
* missing base URL, refused credentials, an unknown path, a stream that names no parent.
|
|
10615
|
+
* * `EXTERNAL_SYSTEM` – another system answered with an error, for example the source returning
|
|
10616
|
+
* 5xx or a source-side extraction failure.
|
|
10617
|
+
* * `MERGE`, `PATCH_EMBED` – a composite merge or an embed patch onto the parent failed.
|
|
10618
|
+
* * `NO_LINKING_VALUE` – a composite child row carried no value in its linking field.
|
|
10619
|
+
* * `MARKER_DELETE`, `TOMBSTONE_DELETE`, `TOMBSTONE_NO_KEY` – a delete detected by a status
|
|
10620
|
+
* marker or a tombstone record could not be applied.
|
|
10621
|
+
* * `REJECTED_BY_SOURCE` – the source rejected a single record because of its data, for example a
|
|
10622
|
+
* delimited-file row whose array has more elements than `sourceDataset.arrays.maxElements`. That
|
|
10623
|
+
* record is not imported, but the other records are; `message` names the column, its number of
|
|
10624
|
+
* elements, and the limit.
|
|
10625
|
+
* * `STREAM_ERROR` – the stream failed as a whole; the record-level detail is in `message`.
|
|
10626
|
+
*
|
|
10627
|
+
* `CONFIGURATION` and `EXTERNAL_SYSTEM` are reported as a plain sentence naming what to change.
|
|
10628
|
+
* They are not application faults and are not alerted on as such.
|
|
10295
10629
|
*/
|
|
10296
10630
|
errorCode?: string;
|
|
10297
10631
|
/**
|
|
@@ -10764,6 +11098,26 @@ type ImportSourceIssue = {
|
|
|
10764
11098
|
* Restrict the rows to this kind.
|
|
10765
11099
|
*/
|
|
10766
11100
|
type TraitDiagnosticsKind = 'UNRESOLVED_PARENT' | 'REPEATED_KEY';
|
|
11101
|
+
type GetImporttoolStreamFileLimitsResponses = {
|
|
11102
|
+
/**
|
|
11103
|
+
* The request was successful.
|
|
11104
|
+
*/
|
|
11105
|
+
200: {
|
|
11106
|
+
/**
|
|
11107
|
+
* The largest file accepted, in bytes.
|
|
11108
|
+
*/
|
|
11109
|
+
maxUploadBytes?: number;
|
|
11110
|
+
/**
|
|
11111
|
+
* Whether `maxUploadBytes` is set by the API gateway in front of the service rather than by the service itself. A larger file is then refused by the gateway, with the gateway's own `413` error body, before it reaches the service. Use the connection's file URL for it.
|
|
11112
|
+
*/
|
|
11113
|
+
gatewayLimited?: boolean;
|
|
11114
|
+
/**
|
|
11115
|
+
* False when the environment has nowhere to store an uploaded file. A file URL on the connection does not help: a fetched file is stored in the same place.
|
|
11116
|
+
*/
|
|
11117
|
+
uploadSupported?: boolean;
|
|
11118
|
+
};
|
|
11119
|
+
};
|
|
11120
|
+
type GetImporttoolStreamFileLimitsResponse = GetImporttoolStreamFileLimitsResponses[keyof GetImporttoolStreamFileLimitsResponses];
|
|
10767
11121
|
type GetImporttoolStreamOrderResponses = {
|
|
10768
11122
|
/**
|
|
10769
11123
|
* The request was successful. The stream order is returned.
|
|
@@ -10944,13 +11298,30 @@ type GetImporttoolStatsData = {
|
|
|
10944
11298
|
|
|
10945
11299
|
/** An import configuration, grouping one or more streams. */
|
|
10946
11300
|
type ImportConfig = ImportConfig$1;
|
|
10947
|
-
/**
|
|
11301
|
+
/**
|
|
11302
|
+
* A stream: extracts from a source, maps fields, upserts into an Emporix target type.
|
|
11303
|
+
*
|
|
11304
|
+
* `sourceDataset` says how the stream addresses its source — its properties
|
|
11305
|
+
* depend on the source type (`keyField`, `limit`, a delimited file's format,
|
|
11306
|
+
* …), so it stays an open record. For a file source, `fileMode` says what one
|
|
11307
|
+
* file represents: `SNAPSHOT` (the default) reads only the newest queued file
|
|
11308
|
+
* and does not delete records missing from it; `INCREMENTAL` reads every queued
|
|
11309
|
+
* file in load order, a later file's values winning.
|
|
11310
|
+
*/
|
|
10948
11311
|
type ImportStream = ImportStream$1;
|
|
10949
11312
|
/** A cron schedule for a configuration. `cron` is a six-field Spring expression. */
|
|
10950
11313
|
type ImportSchedule = Schedule;
|
|
10951
11314
|
/**
|
|
10952
11315
|
* An import run with its reconciled counters.
|
|
10953
11316
|
*
|
|
11317
|
+
* **The counters add up** (since 2026-10-28), on the run and on each stream:
|
|
11318
|
+
* `recordsRead` = `created` + `updated` + `skipped` + `unresolvedParents` +
|
|
11319
|
+
* `deleted` + `failed` + `collapsed` + `embedded`. A sum over only some of them
|
|
11320
|
+
* will not balance. `collapsed` counts source rows that repeated a key within
|
|
11321
|
+
* one batch and were merged before the write; `embedded` counts child records
|
|
11322
|
+
* an `EMBED` child handed to its parent, which wrote them inside its own
|
|
11323
|
+
* instance.
|
|
11324
|
+
*
|
|
10954
11325
|
* Two counters describe the **source feed** rather than the import: a run can
|
|
10955
11326
|
* report `SUCCEEDED` while `duplicateKeys` (source rows repeating a key already
|
|
10956
11327
|
* imported in the run — only the last survives) and `unresolvedParents` (child
|
|
@@ -10981,13 +11352,27 @@ type ImportRun = ImportRun$1;
|
|
|
10981
11352
|
* Per-stream progress within a run. A stream `ABORTED` was not run because of
|
|
10982
11353
|
* its configuration — typically mappings that were never published — and its
|
|
10983
11354
|
* `message` says why.
|
|
11355
|
+
*
|
|
11356
|
+
* For a file source, `filesRead` lists the files the stream read, in order,
|
|
11357
|
+
* and `fileNames` maps each of those opaque locators to its display name. A
|
|
11358
|
+
* retry re-reads exactly these bytes, even if a newer file arrived since.
|
|
10984
11359
|
*/
|
|
10985
11360
|
type ImportRunStream = ImportRunStream$1;
|
|
10986
11361
|
/** A run together with its per-stream progress — what `getRun` resolves to. */
|
|
10987
11362
|
type ImportRunDetail = RunDetail;
|
|
10988
11363
|
/** The outcome of a cancellation request. `accepted: false` means unknown or already finished. */
|
|
10989
11364
|
type ImportCancelResult = CancelResult;
|
|
10990
|
-
/**
|
|
11365
|
+
/**
|
|
11366
|
+
* A single error recorded during a run.
|
|
11367
|
+
*
|
|
11368
|
+
* `errorCode` is a plain string upstream, not an enum, so expect values beyond
|
|
11369
|
+
* the documented ones. `CONFIGURATION` (something to change in the import's own
|
|
11370
|
+
* setup) and `EXTERNAL_SYSTEM` (another system answered with an error) are not
|
|
11371
|
+
* faults of the import, and their `message` is a sentence naming what to
|
|
11372
|
+
* change. `REJECTED_BY_SOURCE` fails one record because of its data — a
|
|
11373
|
+
* delimited-file row with too many array elements, say — while the rest of the
|
|
11374
|
+
* file is imported.
|
|
11375
|
+
*/
|
|
10991
11376
|
type ImportErrorRecord = ErrorRecord;
|
|
10992
11377
|
/** A record that was imported, with its keys, stored fields and last outcome. */
|
|
10993
11378
|
type ImportedRecord = ImportedRecord$1;
|
|
@@ -10996,6 +11381,32 @@ type ImportedRecord = ImportedRecord$1;
|
|
|
10996
11381
|
* order they run, `prereqs` maps each name to the streams it waits for.
|
|
10997
11382
|
*/
|
|
10998
11383
|
type ImportStreamOrder = GetImporttoolStreamOrderResponse;
|
|
11384
|
+
/**
|
|
11385
|
+
* One file a file-based stream was given, and what became of it. `id` is what
|
|
11386
|
+
* `setStreamFileOrder` and `deleteStreamFile` take. `loadRank` is its place in
|
|
11387
|
+
* the drain order; `runId`, `processedAt` and `recordsRead` are set once a run
|
|
11388
|
+
* consumed it.
|
|
11389
|
+
*/
|
|
11390
|
+
type ImportFile = ImportFile$1;
|
|
11391
|
+
/**
|
|
11392
|
+
* Where an {@link ImportFile} is in its life: `PENDING`, `IN_PROGRESS`,
|
|
11393
|
+
* `PROCESSED` or `FAILED`. A file whose records failed individually still ends
|
|
11394
|
+
* `PROCESSED`; `FAILED` means the stream reading it failed, and such a file can
|
|
11395
|
+
* be uploaded again.
|
|
11396
|
+
*/
|
|
11397
|
+
type ImportFileStatus = NonNullable<ImportFile["status"]>;
|
|
11398
|
+
/**
|
|
11399
|
+
* A stream's file queue: `pending` in load order, `history` newest first.
|
|
11400
|
+
* `pending` is complete up to 2000 files; beyond that `pendingTruncated` is
|
|
11401
|
+
* `true`, `pendingTotal` has the real count, and the order cannot be changed.
|
|
11402
|
+
*/
|
|
11403
|
+
type ImportFileQueue = FileQueue;
|
|
11404
|
+
/**
|
|
11405
|
+
* The upload limits of the environment: `maxUploadBytes`, whether the API
|
|
11406
|
+
* gateway rather than the service sets it (`gatewayLimited`), and whether
|
|
11407
|
+
* uploading is available at all (`uploadSupported`).
|
|
11408
|
+
*/
|
|
11409
|
+
type ImportFileUploadLimits = GetImporttoolStreamFileLimitsResponse;
|
|
10999
11410
|
/**
|
|
11000
11411
|
* The rows behind a run's feed-quality counters. **A capped sample, not the
|
|
11001
11412
|
* whole set**: `recorded` is how many rows were stored and `sampleTruncated`
|
|
@@ -11382,6 +11793,67 @@ declare class ImportService {
|
|
|
11382
11793
|
* **Preview upstream**: the contract may change without a major bump.
|
|
11383
11794
|
*/
|
|
11384
11795
|
retryRun(runId: string, auth?: AuthContext): Promise<ImportRun>;
|
|
11796
|
+
/**
|
|
11797
|
+
* A file-based stream's queue: what it still has to import, in load order,
|
|
11798
|
+
* and the files it already dealt with, newest first. `historyLimit` caps
|
|
11799
|
+
* `history` only (1–500, default 100); `pending` comes back whole up to 2000
|
|
11800
|
+
* files — see {@link ImportFileQueue}.
|
|
11801
|
+
*/
|
|
11802
|
+
listStreamFiles(streamId: string, opts?: {
|
|
11803
|
+
historyLimit?: number;
|
|
11804
|
+
}, auth?: AuthContext): Promise<ImportFileQueue>;
|
|
11805
|
+
/**
|
|
11806
|
+
* Queue a delimited file (CSV or one of its variants) for a file-based
|
|
11807
|
+
* stream's next run. Nothing is imported by this call — trigger a run for
|
|
11808
|
+
* that.
|
|
11809
|
+
*
|
|
11810
|
+
* `fileName` is required: the service displays it and infers the compression
|
|
11811
|
+
* from it, and a bare `Blob` would otherwise arrive named «blob».
|
|
11812
|
+
*
|
|
11813
|
+
* The service recognises a file by the SHA-256 of its content, whatever its
|
|
11814
|
+
* name, and answers `409` when the stream already imported or queued those
|
|
11815
|
+
* bytes; a file that previously `FAILED` is accepted again. It also answers
|
|
11816
|
+
* `409` when the stream does not read files, or when a run in flight uses
|
|
11817
|
+
* bytes this upload would replace. `413`: the file is over the limit from
|
|
11818
|
+
* {@link getStreamFileLimits}. `503`: uploading is not configured in this
|
|
11819
|
+
* environment.
|
|
11820
|
+
*
|
|
11821
|
+
* Not retried on a 5xx: a request that timed out may have queued the file,
|
|
11822
|
+
* and sending it again would then answer `409`. Check {@link listStreamFiles}
|
|
11823
|
+
* instead.
|
|
11824
|
+
*/
|
|
11825
|
+
uploadStreamFile(streamId: string, file: Blob, fileName: string, auth?: AuthContext): Promise<ImportFile>;
|
|
11826
|
+
/**
|
|
11827
|
+
* The largest file this environment accepts, and whether uploading is
|
|
11828
|
+
* available at all — check it to refuse an oversize file before sending it.
|
|
11829
|
+
*
|
|
11830
|
+
* When `gatewayLimited` is `true`, a larger file is refused by the API gateway
|
|
11831
|
+
* with the gateway's own `413` body, before it reaches the service. Publish
|
|
11832
|
+
* such a file at an HTTP(S) URL and set it as the connection's file URL
|
|
11833
|
+
* instead.
|
|
11834
|
+
*/
|
|
11835
|
+
getStreamFileLimits(streamId: string, auth?: AuthContext): Promise<ImportFileUploadLimits>;
|
|
11836
|
+
/**
|
|
11837
|
+
* Set the order in which a stream's waiting files are read, and resolve to
|
|
11838
|
+
* the queue in that order. For an `INCREMENTAL` feed the order is the data: a
|
|
11839
|
+
* later file's values win on a key an earlier one also carries, so place an
|
|
11840
|
+
* older export first.
|
|
11841
|
+
*
|
|
11842
|
+
* Takes **every** waiting file's id, in load order — not a single file to
|
|
11843
|
+
* move. A list that is not exactly the waiting set answers `400`. `409` means
|
|
11844
|
+
* the job has a run in flight, or the queue is too long to reorder (the
|
|
11845
|
+
* queue's `pendingTruncated`).
|
|
11846
|
+
*/
|
|
11847
|
+
setStreamFileOrder(streamId: string, fileIds: string[], auth?: AuthContext): Promise<ImportFile[]>;
|
|
11848
|
+
/**
|
|
11849
|
+
* Remove a waiting file from the queue and delete its stored bytes.
|
|
11850
|
+
*
|
|
11851
|
+
* Only a `PENDING` file can go: a file a run has claimed or already imported
|
|
11852
|
+
* answers `409`, and so does any file while the job has a run in flight. An
|
|
11853
|
+
* imported file stays in the history on purpose — removing it would make the
|
|
11854
|
+
* same bytes importable again.
|
|
11855
|
+
*/
|
|
11856
|
+
deleteStreamFile(streamId: string, fileId: string, auth?: AuthContext): Promise<void>;
|
|
11385
11857
|
}
|
|
11386
11858
|
|
|
11387
11859
|
/**
|
|
@@ -13652,4 +14124,4 @@ declare function productIdFromYrn(yrn: string | undefined): string;
|
|
|
13652
14124
|
*/
|
|
13653
14125
|
declare function productYrn(tenant: string, productId: string): string;
|
|
13654
14126
|
|
|
13655
|
-
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, AgenticCrudResource, type AgenticPatchOp, type AgentsExport, type AgentsExportRequest, type AgentsImport, type AgentsImportRequest, AiService, type AnalyticsQuery, AnalyticsResource, 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 CustomEntityCreated, type CustomEntityDraft, type CustomEntityUpdate, type CustomInstance, type CustomInstanceCreated, type CustomInstanceDraft, type CustomInstancePatch, type CustomInstanceReplace, 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, EmporixConflictError, 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 ImportHealthThresholds, type ImportJobGroup, type ImportLicense, 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 ImportStats, type ImportStatsQuery, 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, JobsResource, 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, LogsResource, 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, QuoteReasonsResource, 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 SavedSearch, type SavedSearchCreated, type SavedSearchInput, type Schema, type SchemaAttribute, type SchemaCreated, type SchemaDraft, type SchemaExport, type SchemaImportInput, type SchemaInstanceBulkCreateItem, type SchemaInstanceBulkUpsertItem, type SchemaReference, type SchemaReferenceCreated, type SchemaReferenceInput, type SchemaReferenceUpdateInput, SchemaService, type SchemaTargetType, type SchemaTypeName, type SchemaUpdate, type SearchFilterNode, type SearchHit, type SearchImportedRecordsOptions, type SearchIndex, type SearchIndexExport, type SearchIndexField, type SearchIndexImportResult, type SearchIndexInput, type SearchIndexJob, type SearchIndexJobRef, type SearchIndexSelection, type SearchInput, type SearchInstancesQuery, type SearchListOptions, type SearchOptions, SearchPaging, type SearchQuery, type SearchQueryNode, SearchService, type SearchStreamRecordsOptions, type SearchTypeListOptions, SegmentService, type SequenceSchema, type SequenceSchemaCreate, SequentialIdService, type ServerCookieJar, type ServiceClass, ServiceName, type SessionAttributeInput, type SessionContext, type SessionContextData, 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 SiteAddress, type SiteCreated, type SiteFields, type SiteHomeBase, 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, TemplatesResource, 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 };
|
|
14127
|
+
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, AgenticCrudResource, type AgenticPatchOp, type AgentsExport, type AgentsExportRequest, type AgentsImport, type AgentsImportRequest, AiService, type AnalyticsQuery, AnalyticsResource, 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 CustomEntityCreated, type CustomEntityDraft, type CustomEntityUpdate, type CustomInstance, type CustomInstanceCreated, type CustomInstanceDraft, type CustomInstancePatch, type CustomInstanceReplace, 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, EmporixConflictError, 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 ImportFile, type ImportFileQueue, type ImportFileStatus, type ImportFileUploadLimits, type ImportHealthThresholds, type ImportJobGroup, type ImportLicense, 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 ImportStats, type ImportStatsQuery, 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, JobsResource, 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, LogsResource, 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, QuoteReasonsResource, 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 SavedSearch, type SavedSearchCreated, type SavedSearchInput, type Schema, type SchemaAttribute, type SchemaCreated, type SchemaDraft, type SchemaExport, type SchemaImportInput, type SchemaInstanceBulkCreateItem, type SchemaInstanceBulkUpsertItem, type SchemaReference, type SchemaReferenceCreated, type SchemaReferenceInput, type SchemaReferenceUpdateInput, SchemaService, type SchemaTargetType, type SchemaTypeName, type SchemaUpdate, type SearchFilterNode, type SearchHit, type SearchImportedRecordsOptions, type SearchIndex, type SearchIndexExport, type SearchIndexField, type SearchIndexImportResult, type SearchIndexInput, type SearchIndexJob, type SearchIndexJobRef, type SearchIndexSelection, type SearchInput, type SearchInstancesQuery, type SearchListOptions, type SearchOptions, SearchPaging, type SearchQuery, type SearchQueryNode, SearchService, type SearchStreamRecordsOptions, type SearchTypeListOptions, SegmentService, type SequenceSchema, type SequenceSchemaCreate, SequentialIdService, type ServerCookieJar, type ServiceClass, ServiceName, type SessionAttributeInput, type SessionContext, type SessionContextData, 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 SiteAddress, type SiteCreated, type SiteFields, type SiteHomeBase, 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, TemplatesResource, 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 };
|