@viu/emporix-sdk 2.4.0 → 2.5.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 +41 -0
- package/README.md +23 -3
- 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/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-hksRbb95.d.cts → context-CgUWXqEt.d.cts} +1 -1
- package/dist/{context-hksRbb95.d.ts → context-CgUWXqEt.d.ts} +1 -1
- package/dist/customer-groups.d.cts +1 -1
- package/dist/customer-groups.d.ts +1 -1
- package/dist/customer.d.cts +1 -1
- package/dist/customer.d.ts +1 -1
- package/dist/index.cjs +450 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1858 -49
- package/dist/index.d.ts +1858 -49
- package/dist/index.js +446 -2
- 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.d.cts +1 -1
- package/dist/segment.d.ts +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { C as ClientContext, b as AuthContext, P as PaginatedItems, T as TokenProvider, l as ResolvedConfig, E as EmporixConfig, h as LogLevel, m as ServiceName } from './context-
|
|
2
|
-
export { A as AnonymousSession, a as AnonymousSessionStore, c as AuthKind, D as DEFAULT_HOST, d as DefaultTokenProvider, H as HttpClient, e as HttpClientOptions, L as LEVEL, f as LevelResolver, g as LogFields, i as Logger, j as LoggerConfig, k as LoggerObjectConfig, R as RequestOptions, S as ServiceCredentials, n as StorefrontCredentials, o as auth, p as createConsoleLogger, q as createNoopLogger, r as iterateAll, s as redact, t as resolveToken, v as validateConfig } from './context-
|
|
1
|
+
import { C as ClientContext, b as AuthContext, P as PaginatedItems, T as TokenProvider, l as ResolvedConfig, E as EmporixConfig, h as LogLevel, m as ServiceName } from './context-CgUWXqEt.js';
|
|
2
|
+
export { A as AnonymousSession, a as AnonymousSessionStore, c as AuthKind, D as DEFAULT_HOST, d as DefaultTokenProvider, H as HttpClient, e as HttpClientOptions, L as LEVEL, f as LevelResolver, g as LogFields, i as Logger, j as LoggerConfig, k as LoggerObjectConfig, R as RequestOptions, S as ServiceCredentials, n as StorefrontCredentials, o as auth, p as createConsoleLogger, q as createNoopLogger, r as iterateAll, s as redact, t as resolveToken, v as validateConfig } from './context-CgUWXqEt.js';
|
|
3
3
|
import { CustomerService } from './customer.js';
|
|
4
4
|
export { Address, AddressCreateInput, AddressUpdateInput, Customer, CustomerSession, CustomerSignupInput, CustomerUpdateInput, PasswordChangeInput, PasswordResetConfirmInput, PasswordResetRequestInput } from './customer.js';
|
|
5
5
|
import { ProductService } from './product.js';
|
|
@@ -946,7 +946,7 @@ type WebhookEvent = {
|
|
|
946
946
|
*/
|
|
947
947
|
type WebhookSubscription$1 = {
|
|
948
948
|
event?: WebhookEvent;
|
|
949
|
-
metadata?: Metadata$
|
|
949
|
+
metadata?: Metadata$7;
|
|
950
950
|
/**
|
|
951
951
|
* Status of the subscription.
|
|
952
952
|
*/
|
|
@@ -981,7 +981,7 @@ type WebhookSubscriptionUpdateItem$1 = {
|
|
|
981
981
|
/**
|
|
982
982
|
* Auditing details.
|
|
983
983
|
*/
|
|
984
|
-
type Metadata$
|
|
984
|
+
type Metadata$7 = {
|
|
985
985
|
/**
|
|
986
986
|
* Date and time when the document was created.
|
|
987
987
|
*/
|
|
@@ -2174,7 +2174,7 @@ declare class AiService {
|
|
|
2174
2174
|
chatAsync(input: ChatRequest, auth?: AuthContext): Promise<JobIdResponse[]>;
|
|
2175
2175
|
}
|
|
2176
2176
|
|
|
2177
|
-
type Metadata$
|
|
2177
|
+
type Metadata$6 = {
|
|
2178
2178
|
/**
|
|
2179
2179
|
* Date and time when the object was created.
|
|
2180
2180
|
*/
|
|
@@ -2192,7 +2192,7 @@ type Metadata$3 = {
|
|
|
2192
2192
|
* Tax configuration for a specified location. It consists of a country code and a list of tax classes applicable in that country.
|
|
2193
2193
|
*/
|
|
2194
2194
|
type TaxCreation = {
|
|
2195
|
-
location: Location;
|
|
2195
|
+
location: Location$2;
|
|
2196
2196
|
/**
|
|
2197
2197
|
* List of tax classes applicable in the specified country.
|
|
2198
2198
|
*/
|
|
@@ -2203,12 +2203,12 @@ type TaxCreation = {
|
|
|
2203
2203
|
*/
|
|
2204
2204
|
type TaxRetrieval = {
|
|
2205
2205
|
locationCode?: string;
|
|
2206
|
-
location?: Location;
|
|
2206
|
+
location?: Location$2;
|
|
2207
2207
|
/**
|
|
2208
2208
|
* List of tax classes applicable in the specified country.
|
|
2209
2209
|
*/
|
|
2210
2210
|
taxClasses?: Array<TaxClass>;
|
|
2211
|
-
metadata?: Metadata$
|
|
2211
|
+
metadata?: Metadata$6;
|
|
2212
2212
|
};
|
|
2213
2213
|
/**
|
|
2214
2214
|
* Single tax class.
|
|
@@ -2279,7 +2279,7 @@ type TaxCalculationRequest = {
|
|
|
2279
2279
|
*
|
|
2280
2280
|
* **Note**: This field is only mandatory if the `includesTax` field is set to `true`.
|
|
2281
2281
|
*/
|
|
2282
|
-
sourceLocation?: Location;
|
|
2282
|
+
sourceLocation?: Location$2;
|
|
2283
2283
|
/**
|
|
2284
2284
|
* Tax class originally applied to the provided price.
|
|
2285
2285
|
*
|
|
@@ -2289,7 +2289,7 @@ type TaxCalculationRequest = {
|
|
|
2289
2289
|
/**
|
|
2290
2290
|
* Country for which the price should be calculated.
|
|
2291
2291
|
*/
|
|
2292
|
-
targetLocation: Location;
|
|
2292
|
+
targetLocation: Location$2;
|
|
2293
2293
|
/**
|
|
2294
2294
|
* Tax class that should be applied when calculating the price.
|
|
2295
2295
|
*/
|
|
@@ -2325,7 +2325,7 @@ type TaxCalculationResponse = {
|
|
|
2325
2325
|
/**
|
|
2326
2326
|
* Country for which the provided price was originally defined.
|
|
2327
2327
|
*/
|
|
2328
|
-
sourceLocation?: Location;
|
|
2328
|
+
sourceLocation?: Location$2;
|
|
2329
2329
|
/**
|
|
2330
2330
|
* Tax class originally applied to the provided price.
|
|
2331
2331
|
*/
|
|
@@ -2333,7 +2333,7 @@ type TaxCalculationResponse = {
|
|
|
2333
2333
|
/**
|
|
2334
2334
|
* Country for which the price was calculated.
|
|
2335
2335
|
*/
|
|
2336
|
-
targetLocation?: Location;
|
|
2336
|
+
targetLocation?: Location$2;
|
|
2337
2337
|
/**
|
|
2338
2338
|
* Tax class that was applied when calculating the price.
|
|
2339
2339
|
*/
|
|
@@ -2374,14 +2374,14 @@ type TaxCalculationResponse = {
|
|
|
2374
2374
|
targetTaxRate?: number;
|
|
2375
2375
|
};
|
|
2376
2376
|
};
|
|
2377
|
-
type Location = {
|
|
2377
|
+
type Location$2 = {
|
|
2378
2378
|
/**
|
|
2379
2379
|
* Code of the country for which the tax classes are specified, as defined in the Country Service.
|
|
2380
2380
|
*/
|
|
2381
2381
|
countryCode: string;
|
|
2382
2382
|
};
|
|
2383
2383
|
type TaxUpdate = TaxCreation & {
|
|
2384
|
-
metadata: Metadata$
|
|
2384
|
+
metadata: Metadata$6;
|
|
2385
2385
|
};
|
|
2386
2386
|
|
|
2387
2387
|
/**
|
|
@@ -2393,7 +2393,7 @@ type TaxUpdate = TaxCreation & {
|
|
|
2393
2393
|
*/
|
|
2394
2394
|
|
|
2395
2395
|
/** A country/location reference (`{ countryCode }`). */
|
|
2396
|
-
type TaxLocation = Location;
|
|
2396
|
+
type TaxLocation = Location$2;
|
|
2397
2397
|
/**
|
|
2398
2398
|
* A per-location tax configuration (read shape — `GET /taxes` /
|
|
2399
2399
|
* `/taxes/{locationCode}`). Built on the generated `TaxRetrieval`, with
|
|
@@ -2696,7 +2696,7 @@ type Restrictions$1 = {
|
|
|
2696
2696
|
*/
|
|
2697
2697
|
segments?: Array<string>;
|
|
2698
2698
|
};
|
|
2699
|
-
type ResourceLocation = {
|
|
2699
|
+
type ResourceLocation$1 = {
|
|
2700
2700
|
/**
|
|
2701
2701
|
* Identifier of the link.
|
|
2702
2702
|
*/
|
|
@@ -2831,9 +2831,9 @@ type CouponUpdate = BaseCoupon;
|
|
|
2831
2831
|
*/
|
|
2832
2832
|
type RedemptionInput = RedemptionCreation;
|
|
2833
2833
|
/** `POST /redemptions` 201 response — the created redemption's `{ id?, yrn? }`. */
|
|
2834
|
-
type RedemptionCreated = ResourceLocation;
|
|
2834
|
+
type RedemptionCreated = ResourceLocation$1;
|
|
2835
2835
|
/** `POST /coupons` 201 response — the created coupon's `{ id?, yrn? }`. */
|
|
2836
|
-
type CouponCreated = ResourceLocation;
|
|
2836
|
+
type CouponCreated = ResourceLocation$1;
|
|
2837
2837
|
|
|
2838
2838
|
/**
|
|
2839
2839
|
* Emporix Coupon Service (`/coupon/{tenant}/…`): coupon CRUD, validation,
|
|
@@ -3379,7 +3379,7 @@ type Label$1 = {
|
|
|
3379
3379
|
description?: string | {
|
|
3380
3380
|
[key: string]: string;
|
|
3381
3381
|
};
|
|
3382
|
-
metadata?: Metadata$
|
|
3382
|
+
metadata?: Metadata$5;
|
|
3383
3383
|
};
|
|
3384
3384
|
/**
|
|
3385
3385
|
* If present and `isTrue` is actually true the label should be printed on associated products on the described position.
|
|
@@ -3391,7 +3391,7 @@ type Overlay = {
|
|
|
3391
3391
|
/**
|
|
3392
3392
|
* Metadata
|
|
3393
3393
|
*/
|
|
3394
|
-
type Metadata$
|
|
3394
|
+
type Metadata$5 = {
|
|
3395
3395
|
/**
|
|
3396
3396
|
* The creation date.
|
|
3397
3397
|
*/
|
|
@@ -3444,7 +3444,7 @@ declare class LabelService {
|
|
|
3444
3444
|
deleteLabel(labelId: string, auth?: AuthContext): Promise<void>;
|
|
3445
3445
|
}
|
|
3446
3446
|
|
|
3447
|
-
type Metadata$
|
|
3447
|
+
type Metadata$4 = {
|
|
3448
3448
|
/**
|
|
3449
3449
|
* Date and time when the document was created.
|
|
3450
3450
|
*/
|
|
@@ -3477,7 +3477,7 @@ type Country$1 = {
|
|
|
3477
3477
|
* The field indicating whether the given country is active for the tenant or not. Only active countries are visible in the system.
|
|
3478
3478
|
*/
|
|
3479
3479
|
active?: boolean;
|
|
3480
|
-
metadata?: Metadata$
|
|
3480
|
+
metadata?: Metadata$4;
|
|
3481
3481
|
};
|
|
3482
3482
|
type Region$1 = {
|
|
3483
3483
|
/**
|
|
@@ -3490,7 +3490,7 @@ type Region$1 = {
|
|
|
3490
3490
|
name?: {
|
|
3491
3491
|
[key: string]: string;
|
|
3492
3492
|
};
|
|
3493
|
-
metadata?: Metadata$
|
|
3493
|
+
metadata?: Metadata$4;
|
|
3494
3494
|
};
|
|
3495
3495
|
type CountryUpdate$1 = {
|
|
3496
3496
|
/**
|
|
@@ -3543,7 +3543,7 @@ declare class CountryService {
|
|
|
3543
3543
|
getRegion(regionCode: string, auth?: AuthContext): Promise<Region>;
|
|
3544
3544
|
}
|
|
3545
3545
|
|
|
3546
|
-
type Metadata = {
|
|
3546
|
+
type Metadata$3 = {
|
|
3547
3547
|
/**
|
|
3548
3548
|
* Time of document creation.
|
|
3549
3549
|
*/
|
|
@@ -3557,7 +3557,7 @@ type Metadata = {
|
|
|
3557
3557
|
*/
|
|
3558
3558
|
version?: number;
|
|
3559
3559
|
};
|
|
3560
|
-
type UpdateMetadata = {
|
|
3560
|
+
type UpdateMetadata$1 = {
|
|
3561
3561
|
/**
|
|
3562
3562
|
* Current version of the updated document.
|
|
3563
3563
|
*/
|
|
@@ -3593,7 +3593,7 @@ type CurrencyUpdate$1 = {
|
|
|
3593
3593
|
name: string | {
|
|
3594
3594
|
[key: string]: string;
|
|
3595
3595
|
};
|
|
3596
|
-
metadata: UpdateMetadata;
|
|
3596
|
+
metadata: UpdateMetadata$1;
|
|
3597
3597
|
};
|
|
3598
3598
|
/**
|
|
3599
3599
|
* Represents the response after a successful currency creation.
|
|
@@ -3633,7 +3633,7 @@ type CurrencyRetrieval = {
|
|
|
3633
3633
|
name?: string | {
|
|
3634
3634
|
[key: string]: string;
|
|
3635
3635
|
};
|
|
3636
|
-
metadata?: Metadata;
|
|
3636
|
+
metadata?: Metadata$3;
|
|
3637
3637
|
};
|
|
3638
3638
|
type ExchangeRateUpdateRequest = {
|
|
3639
3639
|
/**
|
|
@@ -3642,7 +3642,7 @@ type ExchangeRateUpdateRequest = {
|
|
|
3642
3642
|
* The value of the field is represented by a number where the cent part is separated by a comma. For example, `1.09`. The cent part is not limited just to two digits. A rate with any precision can be returned. For example: `1.09193421`
|
|
3643
3643
|
*/
|
|
3644
3644
|
rate: string;
|
|
3645
|
-
metadata: UpdateMetadata;
|
|
3645
|
+
metadata: UpdateMetadata$1;
|
|
3646
3646
|
};
|
|
3647
3647
|
type ExchangeRateCreationRequest = {
|
|
3648
3648
|
/**
|
|
@@ -3679,7 +3679,7 @@ type ExchangeRateRetrieval = {
|
|
|
3679
3679
|
* The value of the field is represented by a number where the cent part is separated by a dot. For example `1.09`. The cent part is not limited just to two digits. A rate with any precision can be returned. For example: `1.091934212`
|
|
3680
3680
|
*/
|
|
3681
3681
|
rate?: string;
|
|
3682
|
-
metadata?: Metadata;
|
|
3682
|
+
metadata?: Metadata$3;
|
|
3683
3683
|
};
|
|
3684
3684
|
|
|
3685
3685
|
/**
|
|
@@ -3829,7 +3829,7 @@ type BasicDeliveryTime = {
|
|
|
3829
3829
|
*/
|
|
3830
3830
|
deliveryDayShift?: number;
|
|
3831
3831
|
};
|
|
3832
|
-
type DeliveryTime$
|
|
3832
|
+
type DeliveryTime$2 = BasicDeliveryTime & {
|
|
3833
3833
|
metadata?: MetaData;
|
|
3834
3834
|
};
|
|
3835
3835
|
type UpdateDeliveryTime = BasicDeliveryTime & {
|
|
@@ -4099,8 +4099,8 @@ type QuotePayload = {
|
|
|
4099
4099
|
*/
|
|
4100
4100
|
currency: string;
|
|
4101
4101
|
};
|
|
4102
|
-
shipFromAddress?: Address;
|
|
4103
|
-
shipToAddress: Address;
|
|
4102
|
+
shipFromAddress?: Address$2;
|
|
4103
|
+
shipToAddress: Address$2;
|
|
4104
4104
|
};
|
|
4105
4105
|
/**
|
|
4106
4106
|
* Example of payload for shipping cost calculation.
|
|
@@ -4123,8 +4123,8 @@ type QuoteSlot = {
|
|
|
4123
4123
|
*/
|
|
4124
4124
|
currency: string;
|
|
4125
4125
|
};
|
|
4126
|
-
shipFromAddress?: Address;
|
|
4127
|
-
shipToAddress?: Address;
|
|
4126
|
+
shipFromAddress?: Address$2;
|
|
4127
|
+
shipToAddress?: Address$2;
|
|
4128
4128
|
/**
|
|
4129
4129
|
* The `slotId`` which the quote should be calculated for.
|
|
4130
4130
|
*/
|
|
@@ -4137,7 +4137,7 @@ type QuoteSlot = {
|
|
|
4137
4137
|
/**
|
|
4138
4138
|
* Address of billing or delivery that contains customer or company name and location including street, street number, zipcode, and country.
|
|
4139
4139
|
*/
|
|
4140
|
-
type Address = {
|
|
4140
|
+
type Address$2 = {
|
|
4141
4141
|
/**
|
|
4142
4142
|
* Name of the street.
|
|
4143
4143
|
*/
|
|
@@ -4267,15 +4267,15 @@ type MinimumFee = MinimumFee$1;
|
|
|
4267
4267
|
/** Shared create response (resource location). */
|
|
4268
4268
|
type ResourceCreated = ResourceCreatedResponse;
|
|
4269
4269
|
/** A delivery window for a cart/area. */
|
|
4270
|
-
type DeliveryWindow = ActualDeliveryWindow;
|
|
4270
|
+
type DeliveryWindow$2 = ActualDeliveryWindow;
|
|
4271
4271
|
/** List of delivery windows. */
|
|
4272
4272
|
type DeliveryWindowList = ActualDeliveryWindows;
|
|
4273
4273
|
/** Body for delivery-window validation / counter increment. */
|
|
4274
4274
|
type DeliveryWindowValidation = DeliveryWindowValidationDto;
|
|
4275
4275
|
/** A delivery time (read shape). */
|
|
4276
|
-
type DeliveryTime = DeliveryTime$
|
|
4276
|
+
type DeliveryTime$1 = DeliveryTime$2;
|
|
4277
4277
|
/** List of delivery times (`GET /delivery-times`). */
|
|
4278
|
-
type DeliveryTimeList = DeliveryTime[];
|
|
4278
|
+
type DeliveryTimeList = DeliveryTime$1[];
|
|
4279
4279
|
/** Create body (`POST /delivery-times`). */
|
|
4280
4280
|
type DeliveryTimeInput = BasicDeliveryTime;
|
|
4281
4281
|
/** Update body (`PUT /delivery-times/{id}`). */
|
|
@@ -4367,7 +4367,7 @@ declare class ShippingService {
|
|
|
4367
4367
|
/** List all delivery times. */
|
|
4368
4368
|
listDeliveryTimes(query?: Record<string, string | number>, auth?: AuthContext): Promise<DeliveryTimeList>;
|
|
4369
4369
|
/** Retrieve one delivery time. */
|
|
4370
|
-
getDeliveryTime(deliveryTimeId: string, auth?: AuthContext): Promise<DeliveryTime>;
|
|
4370
|
+
getDeliveryTime(deliveryTimeId: string, auth?: AuthContext): Promise<DeliveryTime$1>;
|
|
4371
4371
|
/** Create a delivery time. */
|
|
4372
4372
|
createDeliveryTime(input: DeliveryTimeInput, auth?: AuthContext): Promise<DeliveryCreated>;
|
|
4373
4373
|
/** Create multiple delivery times (`POST /delivery-times/bulk`). */
|
|
@@ -4399,7 +4399,7 @@ declare class ShippingService {
|
|
|
4399
4399
|
/**
|
|
4400
4400
|
* Price calculation derived from the order entry `calculatedPrice.finalPrice`. The `finalPrice` reflects already applied discounts and fees.
|
|
4401
4401
|
*/
|
|
4402
|
-
type CalculatedPrice = {
|
|
4402
|
+
type CalculatedPrice$1 = {
|
|
4403
4403
|
/**
|
|
4404
4404
|
* Net value of the price.
|
|
4405
4405
|
*/
|
|
@@ -4425,7 +4425,7 @@ type CalculatedPrice = {
|
|
|
4425
4425
|
* Wrapper for the calculated price containing the final price after discounts and fees.
|
|
4426
4426
|
*/
|
|
4427
4427
|
type CalculatedFinalPrice = {
|
|
4428
|
-
finalPrice?: CalculatedPrice;
|
|
4428
|
+
finalPrice?: CalculatedPrice$1;
|
|
4429
4429
|
};
|
|
4430
4430
|
/**
|
|
4431
4431
|
* Core metadata fields shared across multiple objects.
|
|
@@ -4441,7 +4441,7 @@ type MetadataCore = {
|
|
|
4441
4441
|
/**
|
|
4442
4442
|
* Metadata fields required when updating an existing object.
|
|
4443
4443
|
*/
|
|
4444
|
-
type MetadataUpdate = MetadataCore & {
|
|
4444
|
+
type MetadataUpdate$1 = MetadataCore & {
|
|
4445
4445
|
/**
|
|
4446
4446
|
* Version of the object. The version is required during the update operation because of the optimistic locking mechanism.
|
|
4447
4447
|
*/
|
|
@@ -4453,7 +4453,7 @@ type MetadataUpdate = MetadataCore & {
|
|
|
4453
4453
|
* was created and last modified.
|
|
4454
4454
|
*
|
|
4455
4455
|
*/
|
|
4456
|
-
type MetadataResponse = MetadataUpdate & {
|
|
4456
|
+
type MetadataResponse = MetadataUpdate$1 & {
|
|
4457
4457
|
/**
|
|
4458
4458
|
* Date and time when the object was created. The value is returned as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`
|
|
4459
4459
|
*/
|
|
@@ -4470,7 +4470,7 @@ type BasicReturn = {
|
|
|
4470
4470
|
/**
|
|
4471
4471
|
* A list of orders that contain items to be returned. All the orders must have the same currency.
|
|
4472
4472
|
*/
|
|
4473
|
-
orders: Array<Order>;
|
|
4473
|
+
orders: Array<Order$1>;
|
|
4474
4474
|
/**
|
|
4475
4475
|
* A reason why the return is created. One of the values needs to be provided: `code` or `details`.
|
|
4476
4476
|
*/
|
|
@@ -4605,7 +4605,7 @@ type UpdateCustomerReturn = {
|
|
|
4605
4605
|
*/
|
|
4606
4606
|
id?: string;
|
|
4607
4607
|
} & BasicReturn & {
|
|
4608
|
-
metadata: MetadataUpdate;
|
|
4608
|
+
metadata: MetadataUpdate$1;
|
|
4609
4609
|
};
|
|
4610
4610
|
/**
|
|
4611
4611
|
* Base schema for a return requested by an employee.
|
|
@@ -4751,7 +4751,7 @@ type FullEmployeeReturn = FullCustomerReturn & {
|
|
|
4751
4751
|
id?: string;
|
|
4752
4752
|
};
|
|
4753
4753
|
};
|
|
4754
|
-
type FullReturnOrder = Order & {
|
|
4754
|
+
type FullReturnOrder = Order$1 & {
|
|
4755
4755
|
items?: Array<FullReturnItem>;
|
|
4756
4756
|
};
|
|
4757
4757
|
type FullReturnItem = OrderItem & {
|
|
@@ -4788,7 +4788,7 @@ type FullReturnItem = OrderItem & {
|
|
|
4788
4788
|
/**
|
|
4789
4789
|
* Unit price derived from the order entry `calculatedPrice.finalPrice` divided by the order entry amount. Includes discounts and fees. Present only if the order entry has a valid `calculatedPrice.finalPrice`.
|
|
4790
4790
|
*/
|
|
4791
|
-
calculatedUnitPrice?: CalculatedPrice;
|
|
4791
|
+
calculatedUnitPrice?: CalculatedPrice$1;
|
|
4792
4792
|
/**
|
|
4793
4793
|
* Total calculated price for the returned quantity of this item. Computed as `calculatedUnitPrice` multiplied by the returned quantity. Present only if the order entry has a valid `calculatedPrice.finalPrice`.
|
|
4794
4794
|
*/
|
|
@@ -4797,7 +4797,7 @@ type FullReturnItem = OrderItem & {
|
|
|
4797
4797
|
/**
|
|
4798
4798
|
* Represents the order which is being (fully or partially) returned.
|
|
4799
4799
|
*/
|
|
4800
|
-
type Order = {
|
|
4800
|
+
type Order$1 = {
|
|
4801
4801
|
/**
|
|
4802
4802
|
* Unique identifier of an order.
|
|
4803
4803
|
*/
|
|
@@ -5242,6 +5242,1810 @@ declare class UnitHandlingService {
|
|
|
5242
5242
|
listUnitTypes(auth?: AuthContext): Promise<string[]>;
|
|
5243
5243
|
}
|
|
5244
5244
|
|
|
5245
|
+
/**
|
|
5246
|
+
* Definition of a catalog
|
|
5247
|
+
*/
|
|
5248
|
+
type Catalog$1 = {
|
|
5249
|
+
/**
|
|
5250
|
+
* Catalog's unique identifier, generated when the catalog is created.
|
|
5251
|
+
*/
|
|
5252
|
+
id: string;
|
|
5253
|
+
name?: _Object & unknown;
|
|
5254
|
+
description?: _Object & unknown;
|
|
5255
|
+
status?: Status & unknown;
|
|
5256
|
+
visibility?: VisibilityInformation;
|
|
5257
|
+
/**
|
|
5258
|
+
* List of site identifiers on which the catalog is published.
|
|
5259
|
+
*/
|
|
5260
|
+
publishedSites?: Array<string>;
|
|
5261
|
+
metadata: Metadata$2;
|
|
5262
|
+
/**
|
|
5263
|
+
* List of root category identifiers that are assigned to the catalog.
|
|
5264
|
+
*/
|
|
5265
|
+
categoryIds?: Array<string>;
|
|
5266
|
+
};
|
|
5267
|
+
/**
|
|
5268
|
+
* Payload for creating a new catalog
|
|
5269
|
+
*/
|
|
5270
|
+
type CreateCatalog = {
|
|
5271
|
+
/**
|
|
5272
|
+
* Custom catalog identifier. If not provided, it is automatically generated.
|
|
5273
|
+
*/
|
|
5274
|
+
id?: string;
|
|
5275
|
+
name: _Object;
|
|
5276
|
+
description?: _Object;
|
|
5277
|
+
visibility?: VisibilityInformation;
|
|
5278
|
+
/**
|
|
5279
|
+
* List of site identifiers on which the catalog is published.
|
|
5280
|
+
*/
|
|
5281
|
+
publishedSites?: Array<string>;
|
|
5282
|
+
/**
|
|
5283
|
+
* List of root category identifiers that are assigned to the catalog.
|
|
5284
|
+
*/
|
|
5285
|
+
categoryIds?: Array<string>;
|
|
5286
|
+
};
|
|
5287
|
+
/**
|
|
5288
|
+
* Response for create catalog requests
|
|
5289
|
+
*/
|
|
5290
|
+
type CreateCatalogResponse = {
|
|
5291
|
+
id: string;
|
|
5292
|
+
};
|
|
5293
|
+
type UpdateMetadata = {
|
|
5294
|
+
/**
|
|
5295
|
+
* Catalog version, if provided optimistic locking will be used.
|
|
5296
|
+
*/
|
|
5297
|
+
version?: number;
|
|
5298
|
+
};
|
|
5299
|
+
type Metadata$2 = {
|
|
5300
|
+
/**
|
|
5301
|
+
* Catalog version
|
|
5302
|
+
*/
|
|
5303
|
+
version?: number;
|
|
5304
|
+
/**
|
|
5305
|
+
* Timestamp indicating when the catalog was last modified compliant with the ISO 8601 standard.
|
|
5306
|
+
*/
|
|
5307
|
+
updatedAt?: string;
|
|
5308
|
+
/**
|
|
5309
|
+
* Timestamp indicating when the catalog was created compliant with the ISO 8601 standard.
|
|
5310
|
+
*/
|
|
5311
|
+
createdAt?: string;
|
|
5312
|
+
};
|
|
5313
|
+
/**
|
|
5314
|
+
* Localized field that must be provided as a map of language codes to translations.
|
|
5315
|
+
*/
|
|
5316
|
+
type _Object = string | {
|
|
5317
|
+
[key: string]: string;
|
|
5318
|
+
};
|
|
5319
|
+
/**
|
|
5320
|
+
* Visibility status of the catalog in this moment. This value is based on configured visibility properties, and is computed for the moment the request is handled. It answers the question 'Is the catalog visible now?'
|
|
5321
|
+
*/
|
|
5322
|
+
type Status = 'not_visible' | 'visible';
|
|
5323
|
+
/**
|
|
5324
|
+
* Payload for updating a catalog.
|
|
5325
|
+
*/
|
|
5326
|
+
type UpdateCatalog = {
|
|
5327
|
+
name: _Object;
|
|
5328
|
+
description?: _Object;
|
|
5329
|
+
visibility?: VisibilityInformation;
|
|
5330
|
+
/**
|
|
5331
|
+
* List of site identifiers on which the catalog is published.
|
|
5332
|
+
*/
|
|
5333
|
+
publishedSites?: Array<string>;
|
|
5334
|
+
/**
|
|
5335
|
+
* List of root category identifiers that are assigned to the catalog.
|
|
5336
|
+
*/
|
|
5337
|
+
categoryIds?: Array<string>;
|
|
5338
|
+
metadata?: UpdateMetadata;
|
|
5339
|
+
};
|
|
5340
|
+
/**
|
|
5341
|
+
* Payload for partially updating a catalog.
|
|
5342
|
+
*/
|
|
5343
|
+
type UpdateCatalogProperties = {
|
|
5344
|
+
name?: _Object;
|
|
5345
|
+
description?: _Object;
|
|
5346
|
+
visibility?: VisibilityInformation;
|
|
5347
|
+
/**
|
|
5348
|
+
* List of site identifiers on which the catalog is published.
|
|
5349
|
+
*/
|
|
5350
|
+
publishedSites?: Array<string>;
|
|
5351
|
+
/**
|
|
5352
|
+
* List of root category identifiers that are assigned to the catalog.
|
|
5353
|
+
*/
|
|
5354
|
+
categoryIds?: Array<string>;
|
|
5355
|
+
metadata: Metadata$2;
|
|
5356
|
+
};
|
|
5357
|
+
/**
|
|
5358
|
+
* Visibility configuration for a catalog
|
|
5359
|
+
*/
|
|
5360
|
+
type VisibilityInformation = {
|
|
5361
|
+
/**
|
|
5362
|
+
* Flag indicating if the catalog is visible or not, set by the user.
|
|
5363
|
+
*/
|
|
5364
|
+
visible?: boolean;
|
|
5365
|
+
/**
|
|
5366
|
+
* Date and time from which the catalog is visible compliant with the ISO 8601 standard.
|
|
5367
|
+
*/
|
|
5368
|
+
from?: string;
|
|
5369
|
+
/**
|
|
5370
|
+
* Data and time from which the catalog is visible compliant with the ISO 8601 standard.
|
|
5371
|
+
*/
|
|
5372
|
+
to?: string;
|
|
5373
|
+
};
|
|
5374
|
+
|
|
5375
|
+
/**
|
|
5376
|
+
* Public types for the Catalog Management Service — stable names aliased over
|
|
5377
|
+
* the generated `catalog` types.
|
|
5378
|
+
*/
|
|
5379
|
+
|
|
5380
|
+
/** A catalog (read shape). */
|
|
5381
|
+
type Catalog = Catalog$1;
|
|
5382
|
+
/** List of catalogs. */
|
|
5383
|
+
type CatalogList = Catalog[];
|
|
5384
|
+
/** Create body (`POST /catalogs`). */
|
|
5385
|
+
type CatalogInput = CreateCatalog;
|
|
5386
|
+
/** Upsert body (`PUT /catalogs/{id}`). */
|
|
5387
|
+
type CatalogUpdate = UpdateCatalog;
|
|
5388
|
+
/** Partial-update body (`PATCH /catalogs/{id}`). */
|
|
5389
|
+
type CatalogPatch = UpdateCatalogProperties;
|
|
5390
|
+
/** Create / upsert response (the created catalog's id). */
|
|
5391
|
+
type CatalogCreated = CreateCatalogResponse;
|
|
5392
|
+
|
|
5393
|
+
/**
|
|
5394
|
+
* Emporix Catalog Management (`/catalog/{tenant}/catalogs`): CRUD over catalogs.
|
|
5395
|
+
* Server-side; defaults to the service token. `updateCatalog` is an upsert (PUT).
|
|
5396
|
+
*/
|
|
5397
|
+
declare class CatalogService {
|
|
5398
|
+
private readonly ctx;
|
|
5399
|
+
constructor(ctx: ClientContext);
|
|
5400
|
+
private base;
|
|
5401
|
+
/** List catalogs (filtered/sorted). */
|
|
5402
|
+
listCatalogs(query?: Record<string, string | number>, auth?: AuthContext): Promise<CatalogList>;
|
|
5403
|
+
/** Retrieve a catalog by id. */
|
|
5404
|
+
getCatalog(catalogId: string, auth?: AuthContext): Promise<Catalog>;
|
|
5405
|
+
/** Retrieve all catalogs that contain a category. */
|
|
5406
|
+
getCatalogsForCategory(categoryId: string, auth?: AuthContext): Promise<CatalogList>;
|
|
5407
|
+
/** Create a catalog. */
|
|
5408
|
+
createCatalog(input: CatalogInput, auth?: AuthContext): Promise<CatalogCreated>;
|
|
5409
|
+
/** Upsert a catalog by id (`PUT`). */
|
|
5410
|
+
updateCatalog(catalogId: string, input: CatalogUpdate, auth?: AuthContext): Promise<CatalogCreated>;
|
|
5411
|
+
/** Partially update a catalog by id (`PATCH`). */
|
|
5412
|
+
patchCatalog(catalogId: string, patch: CatalogPatch, auth?: AuthContext): Promise<void>;
|
|
5413
|
+
/** Remove a catalog by id. */
|
|
5414
|
+
deleteCatalog(catalogId: string, auth?: AuthContext): Promise<void>;
|
|
5415
|
+
}
|
|
5416
|
+
|
|
5417
|
+
type MetadataUpdate = {
|
|
5418
|
+
/**
|
|
5419
|
+
* Version of the document.
|
|
5420
|
+
*/
|
|
5421
|
+
version?: number;
|
|
5422
|
+
/**
|
|
5423
|
+
* Links to the mixin schemas. A map where the keys represent mixins set attributes and the values represent url to a schema for a particular set.
|
|
5424
|
+
*/
|
|
5425
|
+
mixins?: {
|
|
5426
|
+
[key: string]: unknown;
|
|
5427
|
+
};
|
|
5428
|
+
};
|
|
5429
|
+
type Metadata$1 = MetadataUpdate & {
|
|
5430
|
+
/**
|
|
5431
|
+
* Date and time when the document was created.
|
|
5432
|
+
*/
|
|
5433
|
+
createdAt?: string;
|
|
5434
|
+
/**
|
|
5435
|
+
* Date and time when the document was last modified.
|
|
5436
|
+
*/
|
|
5437
|
+
modifiedAt?: string;
|
|
5438
|
+
};
|
|
5439
|
+
type ResourceId = {
|
|
5440
|
+
/**
|
|
5441
|
+
* Id of a resource.
|
|
5442
|
+
*/
|
|
5443
|
+
id?: string;
|
|
5444
|
+
};
|
|
5445
|
+
type Vendor$1 = {
|
|
5446
|
+
/**
|
|
5447
|
+
* The vendor unique identifier.
|
|
5448
|
+
*/
|
|
5449
|
+
id?: string;
|
|
5450
|
+
/**
|
|
5451
|
+
* The name of the vendor.
|
|
5452
|
+
*/
|
|
5453
|
+
name?: string;
|
|
5454
|
+
/**
|
|
5455
|
+
* The type of the vendor.
|
|
5456
|
+
*/
|
|
5457
|
+
type?: 'COMPANY' | 'SUBSIDIARY';
|
|
5458
|
+
/**
|
|
5459
|
+
* The id of the parent vendor.
|
|
5460
|
+
*/
|
|
5461
|
+
parentId?: string;
|
|
5462
|
+
legalInfo?: LegalInfo;
|
|
5463
|
+
/**
|
|
5464
|
+
* The list of contact details for the vendor.
|
|
5465
|
+
*/
|
|
5466
|
+
contactDetails?: Array<VendorContactDetails>;
|
|
5467
|
+
/**
|
|
5468
|
+
* The list of locations assigned to the vendor.
|
|
5469
|
+
*/
|
|
5470
|
+
locations?: Array<Location$1>;
|
|
5471
|
+
metadata?: Metadata$1;
|
|
5472
|
+
/**
|
|
5473
|
+
* Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
|
|
5474
|
+
*/
|
|
5475
|
+
mixins?: {
|
|
5476
|
+
[key: string]: unknown;
|
|
5477
|
+
};
|
|
5478
|
+
};
|
|
5479
|
+
type LegalInfo = {
|
|
5480
|
+
/**
|
|
5481
|
+
* The legal name of the vendor.
|
|
5482
|
+
*/
|
|
5483
|
+
legalName?: string;
|
|
5484
|
+
/**
|
|
5485
|
+
* The registration date of the vendor in the ISO 8601 format.
|
|
5486
|
+
*/
|
|
5487
|
+
registrationDate?: string;
|
|
5488
|
+
/**
|
|
5489
|
+
* The country in which the vendor has been registered.
|
|
5490
|
+
*/
|
|
5491
|
+
countryOfRegistration?: string;
|
|
5492
|
+
/**
|
|
5493
|
+
* The tax registration number of the vendor.
|
|
5494
|
+
*/
|
|
5495
|
+
taxRegistrationNumber?: string;
|
|
5496
|
+
};
|
|
5497
|
+
type VendorContactDetails = {
|
|
5498
|
+
/**
|
|
5499
|
+
* The list of contact emails.
|
|
5500
|
+
*/
|
|
5501
|
+
emails?: Array<string>;
|
|
5502
|
+
/**
|
|
5503
|
+
* The list of contact phone numbers.
|
|
5504
|
+
*/
|
|
5505
|
+
phones?: Array<string>;
|
|
5506
|
+
/**
|
|
5507
|
+
* The first address line of the contact.
|
|
5508
|
+
*/
|
|
5509
|
+
addressLine1?: string;
|
|
5510
|
+
/**
|
|
5511
|
+
* The city of the contact.
|
|
5512
|
+
*/
|
|
5513
|
+
city?: string;
|
|
5514
|
+
/**
|
|
5515
|
+
* The state of the contact.
|
|
5516
|
+
*/
|
|
5517
|
+
state?: string;
|
|
5518
|
+
/**
|
|
5519
|
+
* The post code of the contact.
|
|
5520
|
+
*/
|
|
5521
|
+
postcode?: string;
|
|
5522
|
+
/**
|
|
5523
|
+
* The country code of the contact.
|
|
5524
|
+
*/
|
|
5525
|
+
countryCode?: string;
|
|
5526
|
+
};
|
|
5527
|
+
type VendorCreate = {
|
|
5528
|
+
/**
|
|
5529
|
+
* Custom vendor identifier. If not provided, it is automatically generated.
|
|
5530
|
+
*/
|
|
5531
|
+
id?: string;
|
|
5532
|
+
/**
|
|
5533
|
+
* The name of the vendor.
|
|
5534
|
+
*/
|
|
5535
|
+
name: string;
|
|
5536
|
+
/**
|
|
5537
|
+
* The type of the vendor. If not provided, the default value is: `COMPANY`.
|
|
5538
|
+
*/
|
|
5539
|
+
type?: 'COMPANY' | 'SUBSIDIARY';
|
|
5540
|
+
/**
|
|
5541
|
+
* The ID of the parent vendor.
|
|
5542
|
+
*/
|
|
5543
|
+
parentId?: string;
|
|
5544
|
+
legalInfo?: LegalInfo;
|
|
5545
|
+
/**
|
|
5546
|
+
* The list of contact details for the vendor.
|
|
5547
|
+
*/
|
|
5548
|
+
contactDetails?: Array<VendorContactDetails>;
|
|
5549
|
+
/**
|
|
5550
|
+
* The list of location IDs assigned to the vendor.
|
|
5551
|
+
*/
|
|
5552
|
+
locations?: Array<ResourceId>;
|
|
5553
|
+
/**
|
|
5554
|
+
* Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
|
|
5555
|
+
*/
|
|
5556
|
+
mixins?: {
|
|
5557
|
+
[key: string]: unknown;
|
|
5558
|
+
};
|
|
5559
|
+
};
|
|
5560
|
+
type VendorUpdate$1 = {
|
|
5561
|
+
/**
|
|
5562
|
+
* The name of the vendor.
|
|
5563
|
+
*/
|
|
5564
|
+
name: string;
|
|
5565
|
+
/**
|
|
5566
|
+
* The type of the vendor.
|
|
5567
|
+
*/
|
|
5568
|
+
type: 'COMPANY' | 'SUBSIDIARY';
|
|
5569
|
+
/**
|
|
5570
|
+
* The ID of the parent vendor.
|
|
5571
|
+
*/
|
|
5572
|
+
parentId?: string;
|
|
5573
|
+
legalInfo?: LegalInfo;
|
|
5574
|
+
/**
|
|
5575
|
+
* The list of contact details for the vendor.
|
|
5576
|
+
*/
|
|
5577
|
+
contactDetails?: Array<VendorContactDetails>;
|
|
5578
|
+
/**
|
|
5579
|
+
* The list of location IDs assigned to the vendor.
|
|
5580
|
+
*/
|
|
5581
|
+
locations?: Array<ResourceId>;
|
|
5582
|
+
metadata?: MetadataUpdate;
|
|
5583
|
+
/**
|
|
5584
|
+
* Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
|
|
5585
|
+
*/
|
|
5586
|
+
mixins?: {
|
|
5587
|
+
[key: string]: unknown;
|
|
5588
|
+
};
|
|
5589
|
+
};
|
|
5590
|
+
type Location$1 = {
|
|
5591
|
+
/**
|
|
5592
|
+
* The location unique identifier.
|
|
5593
|
+
*/
|
|
5594
|
+
id?: string;
|
|
5595
|
+
/**
|
|
5596
|
+
* The name of the location.
|
|
5597
|
+
*/
|
|
5598
|
+
name?: string;
|
|
5599
|
+
/**
|
|
5600
|
+
* The type of the location.
|
|
5601
|
+
*/
|
|
5602
|
+
type?: 'HEADQUARTER' | 'WAREHOUSE' | 'OFFICE';
|
|
5603
|
+
contactDetails?: ContactDetails;
|
|
5604
|
+
metadata?: Metadata$1;
|
|
5605
|
+
/**
|
|
5606
|
+
* Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
|
|
5607
|
+
*/
|
|
5608
|
+
mixins?: {
|
|
5609
|
+
[key: string]: unknown;
|
|
5610
|
+
};
|
|
5611
|
+
};
|
|
5612
|
+
type LocationCreate = {
|
|
5613
|
+
/**
|
|
5614
|
+
* Custom location identifier. If not provided, it is automatically generated.
|
|
5615
|
+
*/
|
|
5616
|
+
id?: string;
|
|
5617
|
+
/**
|
|
5618
|
+
* The name of the location
|
|
5619
|
+
*/
|
|
5620
|
+
name?: string;
|
|
5621
|
+
/**
|
|
5622
|
+
* The type of the location.
|
|
5623
|
+
*/
|
|
5624
|
+
type: 'HEADQUARTER' | 'WAREHOUSE' | 'OFFICE';
|
|
5625
|
+
contactDetails: ContactDetails;
|
|
5626
|
+
/**
|
|
5627
|
+
* Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
|
|
5628
|
+
*/
|
|
5629
|
+
mixins?: {
|
|
5630
|
+
[key: string]: unknown;
|
|
5631
|
+
};
|
|
5632
|
+
};
|
|
5633
|
+
type LocationUpdate = {
|
|
5634
|
+
/**
|
|
5635
|
+
* The name of the location.
|
|
5636
|
+
*/
|
|
5637
|
+
name?: string;
|
|
5638
|
+
/**
|
|
5639
|
+
* The type of the location.
|
|
5640
|
+
*/
|
|
5641
|
+
type: 'HEADQUARTER' | 'WAREHOUSE' | 'OFFICE';
|
|
5642
|
+
contactDetails: ContactDetails;
|
|
5643
|
+
metadata?: MetadataUpdate;
|
|
5644
|
+
/**
|
|
5645
|
+
* Mixins request. A map where a key represent mixins set name and a value represent a map with key-value pairs.
|
|
5646
|
+
*/
|
|
5647
|
+
mixins?: {
|
|
5648
|
+
[key: string]: unknown;
|
|
5649
|
+
};
|
|
5650
|
+
};
|
|
5651
|
+
type ContactDetails = {
|
|
5652
|
+
/**
|
|
5653
|
+
* The list of contact emails.
|
|
5654
|
+
*/
|
|
5655
|
+
emails?: Array<string>;
|
|
5656
|
+
/**
|
|
5657
|
+
* The list of contact phone numbers.
|
|
5658
|
+
*/
|
|
5659
|
+
phones?: Array<string>;
|
|
5660
|
+
/**
|
|
5661
|
+
* The first address line of the contact.
|
|
5662
|
+
*/
|
|
5663
|
+
addressLine1?: string;
|
|
5664
|
+
/**
|
|
5665
|
+
* The city of the contact.
|
|
5666
|
+
*/
|
|
5667
|
+
city?: string;
|
|
5668
|
+
/**
|
|
5669
|
+
* The state of the contact.
|
|
5670
|
+
*/
|
|
5671
|
+
state?: string;
|
|
5672
|
+
/**
|
|
5673
|
+
* The post code of the contact.
|
|
5674
|
+
*/
|
|
5675
|
+
postcode?: string;
|
|
5676
|
+
/**
|
|
5677
|
+
* The country code of the contact.
|
|
5678
|
+
*/
|
|
5679
|
+
countryCode?: string;
|
|
5680
|
+
/**
|
|
5681
|
+
* Allows to tag the location.
|
|
5682
|
+
*/
|
|
5683
|
+
tags?: Array<string>;
|
|
5684
|
+
};
|
|
5685
|
+
|
|
5686
|
+
/**
|
|
5687
|
+
* Public types for the Vendor Service — stable names aliased over the generated
|
|
5688
|
+
* `vendor-service` types. Vendor "locations" are the vendor's own pickup/
|
|
5689
|
+
* warehouse locations, distinct from the customer-management `client.locations`.
|
|
5690
|
+
*/
|
|
5691
|
+
|
|
5692
|
+
/** A vendor (read shape). */
|
|
5693
|
+
type Vendor = Vendor$1;
|
|
5694
|
+
/** List of vendors. */
|
|
5695
|
+
type VendorList = Vendor[];
|
|
5696
|
+
/** Create body (`POST /vendors`). */
|
|
5697
|
+
type VendorInput = VendorCreate;
|
|
5698
|
+
/** Upsert body (`PUT /vendors/{id}`). */
|
|
5699
|
+
type VendorUpdate = VendorUpdate$1;
|
|
5700
|
+
/** Create response — a resource id. */
|
|
5701
|
+
type VendorCreated = ResourceId;
|
|
5702
|
+
/** Search body (`POST /vendors/search`). */
|
|
5703
|
+
type VendorSearchQuery = Record<string, unknown>;
|
|
5704
|
+
/** A vendor location (read shape). */
|
|
5705
|
+
type VendorLocation = Location$1;
|
|
5706
|
+
/** List of vendor locations. */
|
|
5707
|
+
type VendorLocationList = VendorLocation[];
|
|
5708
|
+
/** Create body (`POST /locations`). */
|
|
5709
|
+
type VendorLocationInput = LocationCreate;
|
|
5710
|
+
/** Upsert body (`PUT /locations/{id}`). */
|
|
5711
|
+
type VendorLocationUpdate = LocationUpdate;
|
|
5712
|
+
|
|
5713
|
+
/**
|
|
5714
|
+
* Emporix Vendor Service (`/vendor/{tenant}/…`): vendors and their locations.
|
|
5715
|
+
* Server-side; defaults to the service token. PUT methods are upserts. Vendor
|
|
5716
|
+
* locations are the vendor's own pickup/warehouse locations (distinct from the
|
|
5717
|
+
* customer-management `client.locations`).
|
|
5718
|
+
*/
|
|
5719
|
+
declare class VendorService {
|
|
5720
|
+
private readonly ctx;
|
|
5721
|
+
constructor(ctx: ClientContext);
|
|
5722
|
+
private base;
|
|
5723
|
+
/** List all vendors. */
|
|
5724
|
+
listVendors(query?: Record<string, string | number>, auth?: AuthContext): Promise<VendorList>;
|
|
5725
|
+
/** Retrieve a vendor by id. */
|
|
5726
|
+
getVendor(vendorId: string, auth?: AuthContext): Promise<Vendor>;
|
|
5727
|
+
/** Search vendors (`POST /vendors/search`). */
|
|
5728
|
+
searchVendors(query: VendorSearchQuery, auth?: AuthContext): Promise<VendorList>;
|
|
5729
|
+
/** Create a vendor. */
|
|
5730
|
+
createVendor(input: VendorInput, auth?: AuthContext): Promise<VendorCreated>;
|
|
5731
|
+
/** Upsert a vendor by id (`PUT`). */
|
|
5732
|
+
updateVendor(vendorId: string, input: VendorUpdate, auth?: AuthContext): Promise<void>;
|
|
5733
|
+
/** Delete a vendor by id. */
|
|
5734
|
+
deleteVendor(vendorId: string, auth?: AuthContext): Promise<void>;
|
|
5735
|
+
/** List all vendor locations. */
|
|
5736
|
+
listVendorLocations(query?: Record<string, string | number>, auth?: AuthContext): Promise<VendorLocationList>;
|
|
5737
|
+
/** Retrieve a vendor location by id. */
|
|
5738
|
+
getVendorLocation(locationId: string, auth?: AuthContext): Promise<VendorLocation>;
|
|
5739
|
+
/** Create a vendor location. */
|
|
5740
|
+
createVendorLocation(input: VendorLocationInput, auth?: AuthContext): Promise<VendorCreated>;
|
|
5741
|
+
/** Upsert a vendor location by id (`PUT`). */
|
|
5742
|
+
updateVendorLocation(locationId: string, input: VendorLocationUpdate, auth?: AuthContext): Promise<void>;
|
|
5743
|
+
/** Delete a vendor location by id. */
|
|
5744
|
+
deleteVendorLocation(locationId: string, auth?: AuthContext): Promise<void>;
|
|
5745
|
+
}
|
|
5746
|
+
|
|
5747
|
+
type OrderEntryEventResponse = {
|
|
5748
|
+
/**
|
|
5749
|
+
* The event id
|
|
5750
|
+
*/
|
|
5751
|
+
eventId?: string;
|
|
5752
|
+
/**
|
|
5753
|
+
* The product id for which the event was created
|
|
5754
|
+
*/
|
|
5755
|
+
productId?: string;
|
|
5756
|
+
/**
|
|
5757
|
+
* The delivery cycle for which the event was created
|
|
5758
|
+
*/
|
|
5759
|
+
deliveryCycle?: string;
|
|
5760
|
+
/**
|
|
5761
|
+
* The order number for which the event was created
|
|
5762
|
+
*/
|
|
5763
|
+
orderNumber?: string;
|
|
5764
|
+
/**
|
|
5765
|
+
* Timestamp when the event was created
|
|
5766
|
+
*/
|
|
5767
|
+
timestamp?: string;
|
|
5768
|
+
/**
|
|
5769
|
+
* The picked amount
|
|
5770
|
+
*/
|
|
5771
|
+
pickedAmount?: number;
|
|
5772
|
+
/**
|
|
5773
|
+
* The packed amount
|
|
5774
|
+
*/
|
|
5775
|
+
packedAmount?: number;
|
|
5776
|
+
/**
|
|
5777
|
+
* The canceled amount
|
|
5778
|
+
*/
|
|
5779
|
+
canceledAmount?: number;
|
|
5780
|
+
/**
|
|
5781
|
+
* The packed amount calculated into piece
|
|
5782
|
+
*/
|
|
5783
|
+
packedAmountInPc?: number;
|
|
5784
|
+
/**
|
|
5785
|
+
* The supplier id of the product for which the event was created
|
|
5786
|
+
*/
|
|
5787
|
+
supplierId?: string;
|
|
5788
|
+
/**
|
|
5789
|
+
* The ID of the user which has created the event
|
|
5790
|
+
*/
|
|
5791
|
+
user?: string;
|
|
5792
|
+
/**
|
|
5793
|
+
* The site code for which the event was created
|
|
5794
|
+
*/
|
|
5795
|
+
site?: string;
|
|
5796
|
+
/**
|
|
5797
|
+
* The unit in which the product is packed
|
|
5798
|
+
*/
|
|
5799
|
+
unit?: string;
|
|
5800
|
+
/**
|
|
5801
|
+
* The book product flag
|
|
5802
|
+
*/
|
|
5803
|
+
bookProduct?: boolean;
|
|
5804
|
+
};
|
|
5805
|
+
type OrderEntryEventCreate = {
|
|
5806
|
+
/**
|
|
5807
|
+
* The event id generated by the client
|
|
5808
|
+
*/
|
|
5809
|
+
eventId: string;
|
|
5810
|
+
/**
|
|
5811
|
+
* The order number for which the packing event is created
|
|
5812
|
+
*/
|
|
5813
|
+
orderNumber: string;
|
|
5814
|
+
/**
|
|
5815
|
+
* The product id for which the packing event is created
|
|
5816
|
+
*/
|
|
5817
|
+
productId: string;
|
|
5818
|
+
/**
|
|
5819
|
+
* The delivery cycle for which the packing event is created
|
|
5820
|
+
*/
|
|
5821
|
+
deliveryCycle?: string;
|
|
5822
|
+
/**
|
|
5823
|
+
* The amount of picked items
|
|
5824
|
+
*/
|
|
5825
|
+
pickedAmount?: number;
|
|
5826
|
+
/**
|
|
5827
|
+
* The amount of packed items
|
|
5828
|
+
*/
|
|
5829
|
+
packedAmount?: number;
|
|
5830
|
+
/**
|
|
5831
|
+
* The amount of cancelled items
|
|
5832
|
+
*/
|
|
5833
|
+
canceledAmount?: number;
|
|
5834
|
+
/**
|
|
5835
|
+
* The supplier id
|
|
5836
|
+
*/
|
|
5837
|
+
supplierId?: string;
|
|
5838
|
+
/**
|
|
5839
|
+
* The unit of the packed item
|
|
5840
|
+
*/
|
|
5841
|
+
unit: string;
|
|
5842
|
+
/**
|
|
5843
|
+
* Timestamp of the packing event in ISO format
|
|
5844
|
+
*/
|
|
5845
|
+
timestamp: string;
|
|
5846
|
+
/**
|
|
5847
|
+
* The site code for which the event is created
|
|
5848
|
+
*/
|
|
5849
|
+
site: string;
|
|
5850
|
+
bookProduct?: boolean;
|
|
5851
|
+
};
|
|
5852
|
+
type OrderStatusChange = {
|
|
5853
|
+
/**
|
|
5854
|
+
* The new status of the order
|
|
5855
|
+
*/
|
|
5856
|
+
packingStatus: 'INITIAL' | 'IN_PROGRESS' | 'PRE_PACKED' | 'PACKED' | 'CANCELLED';
|
|
5857
|
+
};
|
|
5858
|
+
type PackagingProductsChange = {
|
|
5859
|
+
/**
|
|
5860
|
+
* The id of the product that was packed
|
|
5861
|
+
*/
|
|
5862
|
+
entryId: string;
|
|
5863
|
+
/**
|
|
5864
|
+
* The amount of packed items
|
|
5865
|
+
*/
|
|
5866
|
+
packedCount: number;
|
|
5867
|
+
};
|
|
5868
|
+
type Assignee$1 = {
|
|
5869
|
+
/**
|
|
5870
|
+
* Identifier of an assignment
|
|
5871
|
+
*/
|
|
5872
|
+
id: string;
|
|
5873
|
+
/**
|
|
5874
|
+
* Code of a site
|
|
5875
|
+
*/
|
|
5876
|
+
siteCode: string;
|
|
5877
|
+
/**
|
|
5878
|
+
* First name of assignee
|
|
5879
|
+
*/
|
|
5880
|
+
firstName: string;
|
|
5881
|
+
/**
|
|
5882
|
+
* Last name of assignee
|
|
5883
|
+
*/
|
|
5884
|
+
lastName: string;
|
|
5885
|
+
};
|
|
5886
|
+
type Order = {
|
|
5887
|
+
/**
|
|
5888
|
+
* The id of the packed order
|
|
5889
|
+
*/
|
|
5890
|
+
id?: string;
|
|
5891
|
+
/**
|
|
5892
|
+
* The site code of the packed order
|
|
5893
|
+
*/
|
|
5894
|
+
siteCode?: string;
|
|
5895
|
+
/**
|
|
5896
|
+
* The order total amount
|
|
5897
|
+
*/
|
|
5898
|
+
orderTotal?: number;
|
|
5899
|
+
/**
|
|
5900
|
+
* The order subtotal
|
|
5901
|
+
*/
|
|
5902
|
+
valueOfGoods?: number;
|
|
5903
|
+
/**
|
|
5904
|
+
* The order deposit amount
|
|
5905
|
+
*/
|
|
5906
|
+
deposit?: number;
|
|
5907
|
+
/**
|
|
5908
|
+
* The order coupons amount
|
|
5909
|
+
*/
|
|
5910
|
+
coupons?: number;
|
|
5911
|
+
/**
|
|
5912
|
+
* The order currency
|
|
5913
|
+
*/
|
|
5914
|
+
currency?: string;
|
|
5915
|
+
/**
|
|
5916
|
+
* The order entries
|
|
5917
|
+
*/
|
|
5918
|
+
entries?: Array<Entry>;
|
|
5919
|
+
customer?: Customer;
|
|
5920
|
+
delivery?: Delivery;
|
|
5921
|
+
payment?: Payment$1;
|
|
5922
|
+
/**
|
|
5923
|
+
* The current packing status of the order
|
|
5924
|
+
*/
|
|
5925
|
+
packingStatus?: 'INITIAL' | 'IN_PROGRESS' | 'PRE_PACKED' | 'PACKED' | 'CANCELLED';
|
|
5926
|
+
/**
|
|
5927
|
+
* The user data of the person that is currently packing the order
|
|
5928
|
+
*/
|
|
5929
|
+
assignees?: Array<Assignee$1>;
|
|
5930
|
+
/**
|
|
5931
|
+
* The order packaging product
|
|
5932
|
+
*/
|
|
5933
|
+
packagingProducts?: Array<Entry>;
|
|
5934
|
+
/**
|
|
5935
|
+
* The order holding area number
|
|
5936
|
+
*/
|
|
5937
|
+
holdingAreaNumber?: number;
|
|
5938
|
+
};
|
|
5939
|
+
type Entry = {
|
|
5940
|
+
/**
|
|
5941
|
+
* The entry id
|
|
5942
|
+
*/
|
|
5943
|
+
entryId?: string;
|
|
5944
|
+
/**
|
|
5945
|
+
* The product name
|
|
5946
|
+
*/
|
|
5947
|
+
productName?: string;
|
|
5948
|
+
/**
|
|
5949
|
+
* The id of the product
|
|
5950
|
+
*/
|
|
5951
|
+
productId?: string;
|
|
5952
|
+
/**
|
|
5953
|
+
* The unit price of the product
|
|
5954
|
+
*/
|
|
5955
|
+
unitPrice?: number;
|
|
5956
|
+
/**
|
|
5957
|
+
* The overall price, which is the sum of the quantities of packed products.
|
|
5958
|
+
*/
|
|
5959
|
+
totalPrice?: number;
|
|
5960
|
+
/**
|
|
5961
|
+
* The link to product image
|
|
5962
|
+
*/
|
|
5963
|
+
imageUrl?: string;
|
|
5964
|
+
unitPricingMeasure?: PricingMeasure;
|
|
5965
|
+
pricingMeasure?: PricingMeasure;
|
|
5966
|
+
pricingMeasurePrice?: number;
|
|
5967
|
+
orderUnit?: string;
|
|
5968
|
+
/**
|
|
5969
|
+
* The currently packed count of the product
|
|
5970
|
+
*/
|
|
5971
|
+
packedCount?: number;
|
|
5972
|
+
/**
|
|
5973
|
+
* The currently canceled count of the product
|
|
5974
|
+
*/
|
|
5975
|
+
canceledCount?: number;
|
|
5976
|
+
/**
|
|
5977
|
+
* The currently picked count of the product
|
|
5978
|
+
*/
|
|
5979
|
+
pickedCount?: number;
|
|
5980
|
+
/**
|
|
5981
|
+
* The currently packed amount of the product packed in pieces
|
|
5982
|
+
*/
|
|
5983
|
+
packedAmountInPc?: number;
|
|
5984
|
+
totalCount?: number;
|
|
5985
|
+
/**
|
|
5986
|
+
* The location of the product
|
|
5987
|
+
*/
|
|
5988
|
+
location?: Array<Location>;
|
|
5989
|
+
packingGroup?: string;
|
|
5990
|
+
packaging?: string;
|
|
5991
|
+
cutting?: string;
|
|
5992
|
+
customerComment?: string;
|
|
5993
|
+
barcodes?: Array<string>;
|
|
5994
|
+
weightDependent?: boolean;
|
|
5995
|
+
basePrice?: BasePrice;
|
|
5996
|
+
mhd?: string;
|
|
5997
|
+
};
|
|
5998
|
+
type Customer = {
|
|
5999
|
+
id?: string;
|
|
6000
|
+
title?: string;
|
|
6001
|
+
firstName?: string;
|
|
6002
|
+
lastName?: string;
|
|
6003
|
+
name?: string;
|
|
6004
|
+
companyName?: string;
|
|
6005
|
+
email?: string;
|
|
6006
|
+
phoneNumber?: string;
|
|
6007
|
+
};
|
|
6008
|
+
type Delivery = {
|
|
6009
|
+
deliveryTimeModel?: DeliveryTime;
|
|
6010
|
+
deliveryAddressModel?: DeliveryAddress;
|
|
6011
|
+
deliveryCostModel?: DeliveryCost;
|
|
6012
|
+
deliveryOptionModel?: DeliveryOption;
|
|
6013
|
+
deliveryWindow?: DeliveryWindow$1;
|
|
6014
|
+
};
|
|
6015
|
+
type Payment$1 = {
|
|
6016
|
+
invoiceNumber?: string;
|
|
6017
|
+
invoiceAddress?: InvoiceAddress;
|
|
6018
|
+
methods?: Array<string>;
|
|
6019
|
+
};
|
|
6020
|
+
type PricingMeasure = {
|
|
6021
|
+
unitCode?: string;
|
|
6022
|
+
value?: string;
|
|
6023
|
+
};
|
|
6024
|
+
type Location = {
|
|
6025
|
+
zone?: string;
|
|
6026
|
+
rack?: string;
|
|
6027
|
+
rackName?: string;
|
|
6028
|
+
shelf?: string;
|
|
6029
|
+
section?: string;
|
|
6030
|
+
bin?: string;
|
|
6031
|
+
};
|
|
6032
|
+
type BasePrice = {
|
|
6033
|
+
effectiveAmount?: string;
|
|
6034
|
+
originalAmount?: string;
|
|
6035
|
+
priceFactor?: string;
|
|
6036
|
+
basePriceFactor?: string;
|
|
6037
|
+
measurementUnit?: MeasurementUnit;
|
|
6038
|
+
};
|
|
6039
|
+
type DeliveryTime = {
|
|
6040
|
+
deliveryDate?: string;
|
|
6041
|
+
deliveryTimeFrom?: string;
|
|
6042
|
+
deliveryTimeTo?: string;
|
|
6043
|
+
deliveryChargeType?: string;
|
|
6044
|
+
};
|
|
6045
|
+
type DeliveryAddress = {
|
|
6046
|
+
title?: string;
|
|
6047
|
+
contactName?: string;
|
|
6048
|
+
companyName?: string;
|
|
6049
|
+
street?: string;
|
|
6050
|
+
streetNumber?: string;
|
|
6051
|
+
streetAppendix?: string;
|
|
6052
|
+
zip?: string;
|
|
6053
|
+
city?: string;
|
|
6054
|
+
country?: string;
|
|
6055
|
+
};
|
|
6056
|
+
type DeliveryCost = {
|
|
6057
|
+
amount?: number;
|
|
6058
|
+
currency?: string;
|
|
6059
|
+
};
|
|
6060
|
+
type DeliveryOption = {
|
|
6061
|
+
packaging?: string;
|
|
6062
|
+
replacement?: boolean;
|
|
6063
|
+
pickup?: boolean;
|
|
6064
|
+
deliveryNote?: string;
|
|
6065
|
+
};
|
|
6066
|
+
/**
|
|
6067
|
+
* 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
|
|
6068
|
+
*/
|
|
6069
|
+
type DeliveryWindow$1 = {
|
|
6070
|
+
/**
|
|
6071
|
+
* The selected delivery cycle for the current order for the given date
|
|
6072
|
+
*/
|
|
6073
|
+
deliveryCycle?: string;
|
|
6074
|
+
/**
|
|
6075
|
+
* The selected delivery cycle name
|
|
6076
|
+
*/
|
|
6077
|
+
deliveryCycleName?: string;
|
|
6078
|
+
/**
|
|
6079
|
+
* The delivery time until the order should be delivered
|
|
6080
|
+
*/
|
|
6081
|
+
deliveryTimeTo?: string;
|
|
6082
|
+
};
|
|
6083
|
+
type InvoiceAddress = {
|
|
6084
|
+
title?: string;
|
|
6085
|
+
contactName?: string;
|
|
6086
|
+
companyName?: string;
|
|
6087
|
+
street?: string;
|
|
6088
|
+
streetNumber?: string;
|
|
6089
|
+
streetAppendix?: string;
|
|
6090
|
+
zip?: string;
|
|
6091
|
+
city?: string;
|
|
6092
|
+
country?: string;
|
|
6093
|
+
};
|
|
6094
|
+
type RecalculationJobOrder = {
|
|
6095
|
+
orderId?: string;
|
|
6096
|
+
message?: string;
|
|
6097
|
+
jobOrderStatus?: 'SUCCESS' | 'FAILURE' | 'PENDING';
|
|
6098
|
+
};
|
|
6099
|
+
type RecalculationJob$1 = {
|
|
6100
|
+
id?: string;
|
|
6101
|
+
jobType?: 'AUTOMATIC' | 'MANUAL';
|
|
6102
|
+
orders?: Array<RecalculationJobOrder>;
|
|
6103
|
+
jobStatus?: 'SUCCESS' | 'FAILURE' | 'IN_PROGRESS';
|
|
6104
|
+
startedAt?: string;
|
|
6105
|
+
finishedAt?: string;
|
|
6106
|
+
};
|
|
6107
|
+
type RecalculationJobCreation = {
|
|
6108
|
+
/**
|
|
6109
|
+
* 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.
|
|
6110
|
+
*/
|
|
6111
|
+
orderIds?: Array<string>;
|
|
6112
|
+
/**
|
|
6113
|
+
* The recalculation job types. Possible values:
|
|
6114
|
+
* - `MANUAL` - recalculates all orders provided in the `orderIds` attribute
|
|
6115
|
+
* - `AUTOMATIC` - finds orders that need recalculation and triggers recalculation for them
|
|
6116
|
+
*/
|
|
6117
|
+
jobType: 'AUTOMATIC' | 'MANUAL';
|
|
6118
|
+
};
|
|
6119
|
+
type MeasurementUnit = {
|
|
6120
|
+
/**
|
|
6121
|
+
* The unit code of the measured quantity
|
|
6122
|
+
*/
|
|
6123
|
+
unitCode?: string;
|
|
6124
|
+
/**
|
|
6125
|
+
* The measured amount
|
|
6126
|
+
*/
|
|
6127
|
+
quantity?: number;
|
|
6128
|
+
};
|
|
6129
|
+
type OrderList = {
|
|
6130
|
+
/**
|
|
6131
|
+
* The id of the order
|
|
6132
|
+
*/
|
|
6133
|
+
orderId?: string;
|
|
6134
|
+
/**
|
|
6135
|
+
* The name of the customer
|
|
6136
|
+
*/
|
|
6137
|
+
customerName?: string;
|
|
6138
|
+
/**
|
|
6139
|
+
* The current status of the order
|
|
6140
|
+
*/
|
|
6141
|
+
packingStatus?: 'INITIAL' | 'IN_PROGRESS' | 'PRE_PACKED' | 'PACKED' | 'CANCELLED';
|
|
6142
|
+
productsTotal?: number;
|
|
6143
|
+
productsPacked?: number;
|
|
6144
|
+
productsCanceled?: number;
|
|
6145
|
+
assignees?: Array<Assignee$1>;
|
|
6146
|
+
packagingProducts?: Array<Entry>;
|
|
6147
|
+
entries?: Array<Entry>;
|
|
6148
|
+
/**
|
|
6149
|
+
* The serial number of the location where the packed order awaits transportation
|
|
6150
|
+
*/
|
|
6151
|
+
holdingAreaNumber?: number;
|
|
6152
|
+
deliveryWindow?: DeliveryWindow$1;
|
|
6153
|
+
};
|
|
6154
|
+
|
|
6155
|
+
/**
|
|
6156
|
+
* Public types for the Pick-Pack Service — stable names aliased over the
|
|
6157
|
+
* generated `pick-pack` types. Several mutating endpoints return an inline
|
|
6158
|
+
* acknowledgement (`{ message?, code? }`) rather than the resource.
|
|
6159
|
+
*/
|
|
6160
|
+
|
|
6161
|
+
/** A pick-pack (fulfillment) order — single read shape. */
|
|
6162
|
+
type PickOrder = Order;
|
|
6163
|
+
/** Packlist — list of pick-pack order summaries (`GET /orders`). */
|
|
6164
|
+
type PickOrderList = OrderList[];
|
|
6165
|
+
/** An order assignee. */
|
|
6166
|
+
type Assignee = Assignee$1;
|
|
6167
|
+
/** A packing event (read). */
|
|
6168
|
+
type PackingEvent = OrderEntryEventResponse;
|
|
6169
|
+
/** List of packing events. */
|
|
6170
|
+
type PackingEventList = PackingEvent[];
|
|
6171
|
+
/** Order cycles (`GET /orderCycles`) — a list of ids. */
|
|
6172
|
+
type OrderCycleList = string[];
|
|
6173
|
+
/** Body for `triggerRecalculation`. */
|
|
6174
|
+
type RecalculationJobInput = RecalculationJobCreation;
|
|
6175
|
+
/** A recalculation job (read). */
|
|
6176
|
+
type RecalculationJob = RecalculationJob$1;
|
|
6177
|
+
/** Inline acknowledgement returned by several mutating endpoints. */
|
|
6178
|
+
interface PickPackAck {
|
|
6179
|
+
message?: string;
|
|
6180
|
+
code?: number;
|
|
6181
|
+
}
|
|
6182
|
+
/** `triggerRecalculation` response — the created job's id. */
|
|
6183
|
+
interface RecalculationJobCreated {
|
|
6184
|
+
jobId?: string;
|
|
6185
|
+
}
|
|
6186
|
+
|
|
6187
|
+
/**
|
|
6188
|
+
* Emporix Pick-Pack Service (`/pick-pack/{tenant}/…`): fulfillment/packlist
|
|
6189
|
+
* orders, assignees, packaging, packing events, and recalculation jobs.
|
|
6190
|
+
* Server-side; defaults to the service token. Several mutating endpoints return
|
|
6191
|
+
* an acknowledgement (`{ message?, code? }`).
|
|
6192
|
+
*/
|
|
6193
|
+
declare class PickPackService {
|
|
6194
|
+
private readonly ctx;
|
|
6195
|
+
constructor(ctx: ClientContext);
|
|
6196
|
+
private base;
|
|
6197
|
+
private orderPath;
|
|
6198
|
+
/** List packlist orders. */
|
|
6199
|
+
listOrders(query?: Record<string, string | number>, auth?: AuthContext): Promise<PickOrderList>;
|
|
6200
|
+
/** Retrieve a packlist order by id. */
|
|
6201
|
+
getOrder(orderId: string, auth?: AuthContext): Promise<PickOrder>;
|
|
6202
|
+
/** Update an order's status (`PATCH`). Returns an acknowledgement. */
|
|
6203
|
+
updateOrder(orderId: string, change: OrderStatusChange, auth?: AuthContext): Promise<PickPackAck>;
|
|
6204
|
+
/** Finish an order. Returns an acknowledgement. */
|
|
6205
|
+
finishOrder(orderId: string, auth?: AuthContext): Promise<PickPackAck>;
|
|
6206
|
+
/** List order cycles (ids). */
|
|
6207
|
+
listOrderCycles(query?: Record<string, string | number>, auth?: AuthContext): Promise<OrderCycleList>;
|
|
6208
|
+
/** Add an assignee to an order. Returns an acknowledgement. */
|
|
6209
|
+
addAssignee(orderId: string, assignee: Assignee, auth?: AuthContext): Promise<PickPackAck>;
|
|
6210
|
+
/** Remove an assignee from an order. */
|
|
6211
|
+
removeAssignee(orderId: string, assigneeId: string, auth?: AuthContext): Promise<void>;
|
|
6212
|
+
/** Update packaging products for an order (`PUT`). Returns an acknowledgement. */
|
|
6213
|
+
updatePackaging(orderId: string, change: PackagingProductsChange, auth?: AuthContext): Promise<PickPackAck>;
|
|
6214
|
+
/** Create a packing event. Returns an acknowledgement. */
|
|
6215
|
+
createEvent(event: OrderEntryEventCreate, auth?: AuthContext): Promise<PickPackAck>;
|
|
6216
|
+
/** List packing events. */
|
|
6217
|
+
listEvents(query?: Record<string, string | number>, auth?: AuthContext): Promise<PackingEventList>;
|
|
6218
|
+
/** Trigger an order recalculation. Returns the created job's id. */
|
|
6219
|
+
triggerRecalculation(input: RecalculationJobInput, auth?: AuthContext): Promise<RecalculationJobCreated>;
|
|
6220
|
+
/** Retrieve a recalculation job by id. */
|
|
6221
|
+
getRecalculationJob(jobId: string, auth?: AuthContext): Promise<RecalculationJob>;
|
|
6222
|
+
}
|
|
6223
|
+
|
|
6224
|
+
type AccountId = {
|
|
6225
|
+
/**
|
|
6226
|
+
* Customer email address.
|
|
6227
|
+
*/
|
|
6228
|
+
id?: string;
|
|
6229
|
+
/**
|
|
6230
|
+
* Customer account unique identifier generated by an external identity provider.
|
|
6231
|
+
*
|
|
6232
|
+
* **Note**: This field is only applicable if the user has been registered through social login.
|
|
6233
|
+
*/
|
|
6234
|
+
providerId?: string;
|
|
6235
|
+
};
|
|
6236
|
+
/**
|
|
6237
|
+
* Customer address information.
|
|
6238
|
+
*/
|
|
6239
|
+
type Address$1 = {
|
|
6240
|
+
/**
|
|
6241
|
+
* Customer address unique identifier generated when the address is added to the customer account.
|
|
6242
|
+
*/
|
|
6243
|
+
id?: string;
|
|
6244
|
+
contactName: string;
|
|
6245
|
+
companyName?: string;
|
|
6246
|
+
street?: string;
|
|
6247
|
+
streetNumber?: string;
|
|
6248
|
+
streetAppendix?: string;
|
|
6249
|
+
extraLine1?: string;
|
|
6250
|
+
extraLine2?: string;
|
|
6251
|
+
extraLine3?: string;
|
|
6252
|
+
extraLine4?: string;
|
|
6253
|
+
zipCode?: string;
|
|
6254
|
+
city?: string;
|
|
6255
|
+
country?: string;
|
|
6256
|
+
state?: string;
|
|
6257
|
+
contactPhone?: string;
|
|
6258
|
+
/**
|
|
6259
|
+
* Flag indicating whether the address is the customer default address.
|
|
6260
|
+
*/
|
|
6261
|
+
isDefault?: boolean;
|
|
6262
|
+
tags?: Array<string>;
|
|
6263
|
+
metadata?: DefaultDtoMetadata;
|
|
6264
|
+
/**
|
|
6265
|
+
* Customer address additional properties.
|
|
6266
|
+
*/
|
|
6267
|
+
mixins?: {
|
|
6268
|
+
[key: string]: unknown;
|
|
6269
|
+
};
|
|
6270
|
+
};
|
|
6271
|
+
type AddressCommonDto = {
|
|
6272
|
+
contactName?: string;
|
|
6273
|
+
companyName?: string;
|
|
6274
|
+
street?: string;
|
|
6275
|
+
streetNumber?: string;
|
|
6276
|
+
streetAppendix?: string;
|
|
6277
|
+
extraLine1?: string;
|
|
6278
|
+
extraLine2?: string;
|
|
6279
|
+
extraLine3?: string;
|
|
6280
|
+
extraLine4?: string;
|
|
6281
|
+
zipCode?: string;
|
|
6282
|
+
city?: string;
|
|
6283
|
+
/**
|
|
6284
|
+
* 2 letter country code compliant with the ISO 3166-1 alpha-2 standard.
|
|
6285
|
+
*/
|
|
6286
|
+
country?: string;
|
|
6287
|
+
state?: string;
|
|
6288
|
+
contactPhone?: string;
|
|
6289
|
+
tags?: Array<string>;
|
|
6290
|
+
metadata?: DefaultDtoMetadata;
|
|
6291
|
+
/**
|
|
6292
|
+
* Customer address additional properties.
|
|
6293
|
+
*/
|
|
6294
|
+
mixins?: {
|
|
6295
|
+
[key: string]: unknown;
|
|
6296
|
+
};
|
|
6297
|
+
};
|
|
6298
|
+
type AddressUpdateDto = AddressCommonDto & {
|
|
6299
|
+
/**
|
|
6300
|
+
* Flag indicating whether the address is the customer default address.
|
|
6301
|
+
*/
|
|
6302
|
+
isDefault?: boolean;
|
|
6303
|
+
/**
|
|
6304
|
+
* Required if address does not exist and should be created in upsert operation.
|
|
6305
|
+
*/
|
|
6306
|
+
contactName?: string;
|
|
6307
|
+
};
|
|
6308
|
+
/**
|
|
6309
|
+
* Additional properties for B2B customer.
|
|
6310
|
+
*/
|
|
6311
|
+
type B2bCreate = {
|
|
6312
|
+
/**
|
|
6313
|
+
* Registration number of the company.
|
|
6314
|
+
*/
|
|
6315
|
+
companyRegistrationId?: string;
|
|
6316
|
+
};
|
|
6317
|
+
type B2bGet = B2bCreate & {
|
|
6318
|
+
legalEntities?: Array<{
|
|
6319
|
+
/**
|
|
6320
|
+
* ID of legal entity.
|
|
6321
|
+
*/
|
|
6322
|
+
id?: string;
|
|
6323
|
+
/**
|
|
6324
|
+
* Name of legal entity.
|
|
6325
|
+
*/
|
|
6326
|
+
name?: string;
|
|
6327
|
+
/**
|
|
6328
|
+
* ID of contact assignment.
|
|
6329
|
+
*/
|
|
6330
|
+
contactAssignmentId?: string;
|
|
6331
|
+
}>;
|
|
6332
|
+
};
|
|
6333
|
+
/**
|
|
6334
|
+
* Access control identifier that determines who can view or manage the customer.
|
|
6335
|
+
*
|
|
6336
|
+
* **Purpose**: Restricts customer visibility based on scope permissions. Only users/applications
|
|
6337
|
+
* with matching restriction scopes can access customers with a specific restriction value.
|
|
6338
|
+
*
|
|
6339
|
+
* **Access Control**:
|
|
6340
|
+
* - *Reading*: Users can only query and view customers with the `restriction` value that matches one of their authorized restrictions.
|
|
6341
|
+
*
|
|
6342
|
+
* **Validation**: The value must exist in the tenant's configured list of valid restrictions.
|
|
6343
|
+
*
|
|
6344
|
+
* **Site Synchronization**: If the `restriction` property is not set with tenant configuration property `enableSyncBetweenRestrictionsAndSiteCodes` set to `true`, the `restriction` field automatically syncs with `preferredSite` property.
|
|
6345
|
+
*
|
|
6346
|
+
*/
|
|
6347
|
+
type Restriction = string | null;
|
|
6348
|
+
type CustomerCreateDto = {
|
|
6349
|
+
title?: string;
|
|
6350
|
+
firstName?: string;
|
|
6351
|
+
middleName?: string;
|
|
6352
|
+
lastName?: string;
|
|
6353
|
+
contactPhone?: string;
|
|
6354
|
+
company?: string;
|
|
6355
|
+
/**
|
|
6356
|
+
* Customer preferred language.
|
|
6357
|
+
*/
|
|
6358
|
+
preferredLanguage?: string;
|
|
6359
|
+
/**
|
|
6360
|
+
* Customer preferred currency, compliant with the ISO 4217 standard.
|
|
6361
|
+
*/
|
|
6362
|
+
preferredCurrency?: string;
|
|
6363
|
+
/**
|
|
6364
|
+
* Customer preferred site.
|
|
6365
|
+
*/
|
|
6366
|
+
preferredSite?: string;
|
|
6367
|
+
/**
|
|
6368
|
+
* User type. Supported values are: `CUSTOMER` and `CONTACT`. If the field is empty then the user is considered as a customer.
|
|
6369
|
+
*/
|
|
6370
|
+
type?: string;
|
|
6371
|
+
/**
|
|
6372
|
+
* Url of a picture.
|
|
6373
|
+
*/
|
|
6374
|
+
photoUrl?: string;
|
|
6375
|
+
b2b?: B2bCreate;
|
|
6376
|
+
metadata?: BasicMetadataDto;
|
|
6377
|
+
/**
|
|
6378
|
+
* Customer account's additional properties. The property is not returned by default. In order to return the mixins property use `expand=mixin:*` query param.
|
|
6379
|
+
*/
|
|
6380
|
+
mixins?: {
|
|
6381
|
+
[key: string]: unknown;
|
|
6382
|
+
};
|
|
6383
|
+
restriction?: Restriction;
|
|
6384
|
+
};
|
|
6385
|
+
type CustomerCommonDto = CustomerCreateDto & {
|
|
6386
|
+
metadata?: DefaultDtoMetadata;
|
|
6387
|
+
};
|
|
6388
|
+
type CustomerForSellerDto = CustomerCommonDto & {
|
|
6389
|
+
/**
|
|
6390
|
+
* Customer unique number generated when the customer profile is created.
|
|
6391
|
+
*/
|
|
6392
|
+
customerNumber?: string;
|
|
6393
|
+
/**
|
|
6394
|
+
* Customer unique identifier generated when the customer profile is created.
|
|
6395
|
+
*/
|
|
6396
|
+
id?: string;
|
|
6397
|
+
defaultAddress?: Address$1;
|
|
6398
|
+
/**
|
|
6399
|
+
* List of accounts associated with the customer profile.
|
|
6400
|
+
*/
|
|
6401
|
+
accounts?: Array<AccountId>;
|
|
6402
|
+
/**
|
|
6403
|
+
* List of customer addresses.
|
|
6404
|
+
*/
|
|
6405
|
+
addresses?: Array<Address$1>;
|
|
6406
|
+
contactEmail?: string;
|
|
6407
|
+
/**
|
|
6408
|
+
* Flag indicating whether the customer profile is active.
|
|
6409
|
+
*/
|
|
6410
|
+
active?: boolean;
|
|
6411
|
+
/**
|
|
6412
|
+
* Flag indicating whether the customer profile is suspended.
|
|
6413
|
+
*/
|
|
6414
|
+
onHold?: boolean;
|
|
6415
|
+
/**
|
|
6416
|
+
* Customer email address.
|
|
6417
|
+
*/
|
|
6418
|
+
email?: string;
|
|
6419
|
+
b2b?: B2bGet;
|
|
6420
|
+
/**
|
|
6421
|
+
* Property indicating business model of customer. When customer is assigned to any company then it is `B2B`. Otherwise it is `B2C`.
|
|
6422
|
+
*/
|
|
6423
|
+
businessModel?: 'B2B' | 'B2C';
|
|
6424
|
+
/**
|
|
6425
|
+
* Customer creation date.
|
|
6426
|
+
*/
|
|
6427
|
+
metadataCreatedAt?: string;
|
|
6428
|
+
};
|
|
6429
|
+
type CustomerSignupBySellerDto = CustomerCreateDto & {
|
|
6430
|
+
/**
|
|
6431
|
+
* Custom customer identifier. If not provided, it is automatically generated.
|
|
6432
|
+
*/
|
|
6433
|
+
id?: string;
|
|
6434
|
+
contactEmail?: string;
|
|
6435
|
+
/**
|
|
6436
|
+
* Initial password for customer
|
|
6437
|
+
*/
|
|
6438
|
+
password?: string;
|
|
6439
|
+
};
|
|
6440
|
+
type CustomerUpdateBySellerDto = CustomerCommonDto & {
|
|
6441
|
+
contactEmail?: string;
|
|
6442
|
+
active?: boolean;
|
|
6443
|
+
onHold?: boolean;
|
|
6444
|
+
};
|
|
6445
|
+
type CustomerPatchBySellerDto = CustomerUpdateBySellerDto & {
|
|
6446
|
+
/**
|
|
6447
|
+
* Contact email address. Cannot be unset once a value is present.
|
|
6448
|
+
*/
|
|
6449
|
+
contactEmail?: string;
|
|
6450
|
+
};
|
|
6451
|
+
/**
|
|
6452
|
+
* Links to mixin schemas.
|
|
6453
|
+
*/
|
|
6454
|
+
type BasicMetadataDto = {
|
|
6455
|
+
mixins?: {
|
|
6456
|
+
[key: string]: unknown;
|
|
6457
|
+
};
|
|
6458
|
+
};
|
|
6459
|
+
type DefaultDtoMetadata = BasicMetadataDto & {
|
|
6460
|
+
version?: number;
|
|
6461
|
+
};
|
|
6462
|
+
/**
|
|
6463
|
+
* Schema for showing location of the new resource.
|
|
6464
|
+
*/
|
|
6465
|
+
type ResourceLocation = {
|
|
6466
|
+
/**
|
|
6467
|
+
* Resource identifier.
|
|
6468
|
+
*/
|
|
6469
|
+
id?: string;
|
|
6470
|
+
};
|
|
6471
|
+
type Address2 = {
|
|
6472
|
+
/**
|
|
6473
|
+
* Custom customer address identifier. If not provided, it is automatically generated.
|
|
6474
|
+
*/
|
|
6475
|
+
id?: string;
|
|
6476
|
+
contactName: string;
|
|
6477
|
+
companyName?: string;
|
|
6478
|
+
street?: string;
|
|
6479
|
+
streetNumber?: string;
|
|
6480
|
+
streetAppendix?: string;
|
|
6481
|
+
extraLine1?: string;
|
|
6482
|
+
extraLine2?: string;
|
|
6483
|
+
extraLine3?: string;
|
|
6484
|
+
extraLine4?: string;
|
|
6485
|
+
zipCode?: string;
|
|
6486
|
+
city?: string;
|
|
6487
|
+
country?: string;
|
|
6488
|
+
state?: string;
|
|
6489
|
+
contactPhone?: string;
|
|
6490
|
+
/**
|
|
6491
|
+
* Flag indicating whether the address is the customer default address.
|
|
6492
|
+
*/
|
|
6493
|
+
isDefault?: boolean;
|
|
6494
|
+
tags?: Array<string>;
|
|
6495
|
+
/**
|
|
6496
|
+
* Links to mixin schemas.
|
|
6497
|
+
*/
|
|
6498
|
+
metadata?: {
|
|
6499
|
+
mixins?: {
|
|
6500
|
+
[key: string]: unknown;
|
|
6501
|
+
};
|
|
6502
|
+
};
|
|
6503
|
+
/**
|
|
6504
|
+
* Customer address additional properties.
|
|
6505
|
+
*/
|
|
6506
|
+
mixins?: {
|
|
6507
|
+
[key: string]: unknown;
|
|
6508
|
+
};
|
|
6509
|
+
};
|
|
6510
|
+
|
|
6511
|
+
/**
|
|
6512
|
+
* Public types for the tenant-managed Customer Service (admin/seller view).
|
|
6513
|
+
* Names are prefixed `AdminCustomer*` to avoid barrel collisions with the
|
|
6514
|
+
* storefront `client.customers` types (`Customer` / `Address`).
|
|
6515
|
+
*/
|
|
6516
|
+
|
|
6517
|
+
/** A customer profile (seller/admin read shape). */
|
|
6518
|
+
type AdminCustomer = CustomerForSellerDto;
|
|
6519
|
+
/** List of customers. */
|
|
6520
|
+
type AdminCustomerList = AdminCustomer[];
|
|
6521
|
+
/** Create body (`POST /customers`). */
|
|
6522
|
+
type AdminCustomerInput = CustomerSignupBySellerDto;
|
|
6523
|
+
/** Upsert body (`PUT /customers/{num}`). */
|
|
6524
|
+
type AdminCustomerUpdate = CustomerUpdateBySellerDto;
|
|
6525
|
+
/** Partial-update body (`PATCH /customers/{num}`). */
|
|
6526
|
+
type AdminCustomerPatch = CustomerPatchBySellerDto;
|
|
6527
|
+
/** Create/upsert response — a resource location. */
|
|
6528
|
+
type AdminCustomerCreated = ResourceLocation;
|
|
6529
|
+
/** Search body (`POST /customers/search`). */
|
|
6530
|
+
type AdminCustomerSearchQuery = Record<string, unknown>;
|
|
6531
|
+
/** A customer address (read). */
|
|
6532
|
+
type AdminCustomerAddress = Address$1;
|
|
6533
|
+
/** List of customer addresses. */
|
|
6534
|
+
type AdminCustomerAddressList = AdminCustomerAddress[];
|
|
6535
|
+
/** Add-address body (`POST …/addresses`). */
|
|
6536
|
+
type AdminCustomerAddressInput = Address2;
|
|
6537
|
+
/** Upsert/patch address body (`PUT`/`PATCH …/addresses/{id}`). */
|
|
6538
|
+
type AdminCustomerAddressUpdate = AddressUpdateDto;
|
|
6539
|
+
|
|
6540
|
+
/**
|
|
6541
|
+
* Emporix Customer Service — tenant/seller-managed customer profiles and
|
|
6542
|
+
* addresses (`/customer/{tenant}/customers`). Server-side; defaults to the
|
|
6543
|
+
* service token. Distinct from the storefront `client.customers`.
|
|
6544
|
+
*/
|
|
6545
|
+
declare class CustomerAdminService {
|
|
6546
|
+
private readonly ctx;
|
|
6547
|
+
constructor(ctx: ClientContext);
|
|
6548
|
+
private base;
|
|
6549
|
+
private customerPath;
|
|
6550
|
+
private addressPath;
|
|
6551
|
+
/** List customers. */
|
|
6552
|
+
listCustomers(query?: Record<string, string | number>, auth?: AuthContext): Promise<AdminCustomerList>;
|
|
6553
|
+
/** Search customers (`POST /customers/search`). */
|
|
6554
|
+
searchCustomers(query: AdminCustomerSearchQuery, auth?: AuthContext): Promise<AdminCustomerList>;
|
|
6555
|
+
/** Retrieve a customer profile by number. */
|
|
6556
|
+
getCustomer(customerNumber: string, auth?: AuthContext): Promise<AdminCustomer>;
|
|
6557
|
+
/** Create a customer. */
|
|
6558
|
+
createCustomer(input: AdminCustomerInput, auth?: AuthContext): Promise<AdminCustomerCreated>;
|
|
6559
|
+
/** Upsert a customer profile by number (`PUT`). */
|
|
6560
|
+
upsertCustomer(customerNumber: string, input: AdminCustomerUpdate, auth?: AuthContext): Promise<AdminCustomerCreated>;
|
|
6561
|
+
/** Partially update a customer profile (`PATCH`). */
|
|
6562
|
+
patchCustomer(customerNumber: string, patch: AdminCustomerPatch, auth?: AuthContext): Promise<void>;
|
|
6563
|
+
/** Delete a customer profile. */
|
|
6564
|
+
deleteCustomer(customerNumber: string, auth?: AuthContext): Promise<void>;
|
|
6565
|
+
/** List a customer's addresses. */
|
|
6566
|
+
listAddresses(customerNumber: string, auth?: AuthContext): Promise<AdminCustomerAddressList>;
|
|
6567
|
+
/** Retrieve one address. */
|
|
6568
|
+
getAddress(customerNumber: string, addressId: string, auth?: AuthContext): Promise<AdminCustomerAddress>;
|
|
6569
|
+
/** Add an address. */
|
|
6570
|
+
addAddress(customerNumber: string, input: AdminCustomerAddressInput, auth?: AuthContext): Promise<AdminCustomerCreated>;
|
|
6571
|
+
/** Upsert an address by id (`PUT`). */
|
|
6572
|
+
upsertAddress(customerNumber: string, addressId: string, input: AdminCustomerAddressUpdate, auth?: AuthContext): Promise<AdminCustomerCreated>;
|
|
6573
|
+
/** Partially update an address by id (`PATCH`). */
|
|
6574
|
+
patchAddress(customerNumber: string, addressId: string, patch: AdminCustomerAddressUpdate, auth?: AuthContext): Promise<void>;
|
|
6575
|
+
/** Delete an address by id. */
|
|
6576
|
+
deleteAddress(customerNumber: string, addressId: string, auth?: AuthContext): Promise<void>;
|
|
6577
|
+
/** Add tags to an address (`?tags=` query). */
|
|
6578
|
+
addAddressTags(customerNumber: string, addressId: string, tags: string[], auth?: AuthContext): Promise<void>;
|
|
6579
|
+
/** Remove tags from an address (`?tags=` query). */
|
|
6580
|
+
removeAddressTags(customerNumber: string, addressId: string, tags: string[], auth?: AuthContext): Promise<void>;
|
|
6581
|
+
}
|
|
6582
|
+
|
|
6583
|
+
/**
|
|
6584
|
+
* Base schema for an approval.
|
|
6585
|
+
*/
|
|
6586
|
+
type BasicApproval = GenericApprovalForCreate & {
|
|
6587
|
+
resourceType: ResourceType;
|
|
6588
|
+
details?: Details;
|
|
6589
|
+
};
|
|
6590
|
+
/**
|
|
6591
|
+
* Base schema for an approval creation.
|
|
6592
|
+
*/
|
|
6593
|
+
type GenericApprovalForCreate = {
|
|
6594
|
+
action: ApprovalAction;
|
|
6595
|
+
/**
|
|
6596
|
+
* User who can approve the approval request.
|
|
6597
|
+
*/
|
|
6598
|
+
approver: {
|
|
6599
|
+
/**
|
|
6600
|
+
* Identifier of the user.
|
|
6601
|
+
*/
|
|
6602
|
+
userId?: string;
|
|
6603
|
+
};
|
|
6604
|
+
/**
|
|
6605
|
+
* A comment from the requestor to the approver.
|
|
6606
|
+
*/
|
|
6607
|
+
comment?: string;
|
|
6608
|
+
};
|
|
6609
|
+
/**
|
|
6610
|
+
* Checkout details for **cart** approvals. **Required** when `resourceType` is `CART`.
|
|
6611
|
+
*
|
|
6612
|
+
*/
|
|
6613
|
+
type Details = {
|
|
6614
|
+
shipping?: Shipping;
|
|
6615
|
+
payment?: Payment;
|
|
6616
|
+
/**
|
|
6617
|
+
* Methods chosen to process the payment for the order.
|
|
6618
|
+
*/
|
|
6619
|
+
paymentMethods?: Array<PaymentMethod>;
|
|
6620
|
+
/**
|
|
6621
|
+
* Three-letter currency code, compliant with the ISO 4217 standard.
|
|
6622
|
+
*/
|
|
6623
|
+
currency?: string;
|
|
6624
|
+
/**
|
|
6625
|
+
* List of addresses associated with the order.
|
|
6626
|
+
*/
|
|
6627
|
+
addresses?: Array<Address>;
|
|
6628
|
+
};
|
|
6629
|
+
/**
|
|
6630
|
+
* Information about the customer address.
|
|
6631
|
+
*/
|
|
6632
|
+
type Address = {
|
|
6633
|
+
contactName?: string;
|
|
6634
|
+
companyName?: string;
|
|
6635
|
+
street?: string;
|
|
6636
|
+
streetNumber?: string;
|
|
6637
|
+
streetAppendix?: string;
|
|
6638
|
+
zipCode?: string;
|
|
6639
|
+
city?: string;
|
|
6640
|
+
country?: string;
|
|
6641
|
+
state?: string;
|
|
6642
|
+
contactPhone?: string;
|
|
6643
|
+
/**
|
|
6644
|
+
* Type of the address data, for example `BILLING` or `SHIPPING`.
|
|
6645
|
+
*/
|
|
6646
|
+
type?: 'SHIPPING' | 'BILLING';
|
|
6647
|
+
};
|
|
6648
|
+
/**
|
|
6649
|
+
* Information about the shipping.
|
|
6650
|
+
*/
|
|
6651
|
+
type Shipping = {
|
|
6652
|
+
/**
|
|
6653
|
+
* Shipping method's unique identifier.
|
|
6654
|
+
*/
|
|
6655
|
+
methodId?: string;
|
|
6656
|
+
/**
|
|
6657
|
+
* Shipping zone identifier.
|
|
6658
|
+
*/
|
|
6659
|
+
zoneId?: string;
|
|
6660
|
+
/**
|
|
6661
|
+
* Shipping method chosen by the customer.
|
|
6662
|
+
*/
|
|
6663
|
+
methodName?: string;
|
|
6664
|
+
/**
|
|
6665
|
+
* Shipping net cost.
|
|
6666
|
+
*/
|
|
6667
|
+
amount?: number;
|
|
6668
|
+
/**
|
|
6669
|
+
* The tax code of the shipping.
|
|
6670
|
+
*/
|
|
6671
|
+
shippingTaxCode?: string;
|
|
6672
|
+
};
|
|
6673
|
+
/**
|
|
6674
|
+
* Information about the payment.
|
|
6675
|
+
*/
|
|
6676
|
+
type Payment = {
|
|
6677
|
+
paymentId?: string;
|
|
6678
|
+
customAttributes?: {
|
|
6679
|
+
[key: string]: unknown;
|
|
6680
|
+
};
|
|
6681
|
+
};
|
|
6682
|
+
type PaymentMethod = {
|
|
6683
|
+
/**
|
|
6684
|
+
* Payment provider, possible values:
|
|
6685
|
+
* * `payment-gateway` - When the Emporix Payment-Gateway service should be used to handle a payment. For details about custom attributes that are required for a particular payment mode, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments.
|
|
6686
|
+
* * `custom` - When a custom provider is used. In this case the created order has the `IN_CHECKOUT` status.
|
|
6687
|
+
* * `none` - For payment by cash or invoice.
|
|
6688
|
+
*
|
|
6689
|
+
*/
|
|
6690
|
+
provider?: string;
|
|
6691
|
+
/**
|
|
6692
|
+
* Additional information about the payment method.
|
|
6693
|
+
*/
|
|
6694
|
+
customAttributes?: {
|
|
6695
|
+
/**
|
|
6696
|
+
* Payment token used for the tokenized credit card flows. The field is used when provider type is `payment-gateway`. For more details, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments
|
|
6697
|
+
*/
|
|
6698
|
+
token?: string;
|
|
6699
|
+
/**
|
|
6700
|
+
* Identifier of a payment mode. The payment mode has to be configured in the Emporix Payment Gateway service beforehand. For more details, check https://developer.emporix.io/user-guides/system-management/payment-gateway/payments
|
|
6701
|
+
*/
|
|
6702
|
+
modeId?: string;
|
|
6703
|
+
/**
|
|
6704
|
+
* Payment type chosen by the customer, for example `paymentByCredit` or `paymentByDebit`.
|
|
6705
|
+
*/
|
|
6706
|
+
paymentType?: string;
|
|
6707
|
+
};
|
|
6708
|
+
/**
|
|
6709
|
+
* Payment method chosen by the customer, for example `invoice` or `cash-on-delivery`.
|
|
6710
|
+
*/
|
|
6711
|
+
method?: string;
|
|
6712
|
+
/**
|
|
6713
|
+
* Amount to be paid by the customer.
|
|
6714
|
+
*/
|
|
6715
|
+
amount?: number;
|
|
6716
|
+
};
|
|
6717
|
+
type User = {
|
|
6718
|
+
/**
|
|
6719
|
+
* An identifier of the user.
|
|
6720
|
+
*/
|
|
6721
|
+
userId: string;
|
|
6722
|
+
/**
|
|
6723
|
+
* First name of the user.
|
|
6724
|
+
*/
|
|
6725
|
+
firstName: string;
|
|
6726
|
+
/**
|
|
6727
|
+
* Last name of the user.
|
|
6728
|
+
*/
|
|
6729
|
+
lastName: string;
|
|
6730
|
+
};
|
|
6731
|
+
/**
|
|
6732
|
+
* Type of resource under approval.
|
|
6733
|
+
*
|
|
6734
|
+
*/
|
|
6735
|
+
type ResourceType = 'CART' | 'QUOTE';
|
|
6736
|
+
/**
|
|
6737
|
+
* Base schema for an approval action type.
|
|
6738
|
+
*/
|
|
6739
|
+
type ApprovalAction = 'CHECKOUT';
|
|
6740
|
+
/**
|
|
6741
|
+
* Base schema for the approval status.
|
|
6742
|
+
*/
|
|
6743
|
+
type ApprovalStatus = 'PENDING' | 'APPROVED' | 'CLOSED' | 'EXPIRED' | 'DECLINED';
|
|
6744
|
+
/**
|
|
6745
|
+
* An expiration date which defines when the approval will expire. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`
|
|
6746
|
+
*/
|
|
6747
|
+
type ExpiryDate = string;
|
|
6748
|
+
type GetApprovalResponse = BasicApproval & {
|
|
6749
|
+
/**
|
|
6750
|
+
* An identifier of the approval document.
|
|
6751
|
+
*/
|
|
6752
|
+
id?: string;
|
|
6753
|
+
/**
|
|
6754
|
+
* A comment from an approver user.
|
|
6755
|
+
*/
|
|
6756
|
+
approverComment?: string;
|
|
6757
|
+
resource?: ResourceResponse;
|
|
6758
|
+
requestor?: User;
|
|
6759
|
+
approver?: User;
|
|
6760
|
+
status?: ApprovalStatus;
|
|
6761
|
+
expiryDate?: ExpiryDate;
|
|
6762
|
+
metadata?: Metadata;
|
|
6763
|
+
};
|
|
6764
|
+
/**
|
|
6765
|
+
* Base schema for approval permitted response.
|
|
6766
|
+
*/
|
|
6767
|
+
type ApprovalPermittedResponse = {
|
|
6768
|
+
action: ApprovalAction;
|
|
6769
|
+
status?: ApprovalStatus;
|
|
6770
|
+
/**
|
|
6771
|
+
* Indicates if the operation is permitted.
|
|
6772
|
+
*/
|
|
6773
|
+
permitted: boolean;
|
|
6774
|
+
/**
|
|
6775
|
+
* Identifier of the approval.
|
|
6776
|
+
*/
|
|
6777
|
+
approvalId?: string;
|
|
6778
|
+
};
|
|
6779
|
+
/**
|
|
6780
|
+
* Resource of the approval.
|
|
6781
|
+
*/
|
|
6782
|
+
type ResourceResponse = {
|
|
6783
|
+
/**
|
|
6784
|
+
* The identifier of the resource.
|
|
6785
|
+
*/
|
|
6786
|
+
id?: string;
|
|
6787
|
+
items?: Array<ResourceItem>;
|
|
6788
|
+
totalPrice?: Price;
|
|
6789
|
+
subTotalPrice?: Price;
|
|
6790
|
+
subtotalAggregate?: TaxablePrice;
|
|
6791
|
+
/**
|
|
6792
|
+
* Name of the site.
|
|
6793
|
+
*/
|
|
6794
|
+
siteCode?: string;
|
|
6795
|
+
deliveryWindow?: DeliveryWindow;
|
|
6796
|
+
};
|
|
6797
|
+
/**
|
|
6798
|
+
* Item of the resource.
|
|
6799
|
+
*/
|
|
6800
|
+
type ResourceItem = {
|
|
6801
|
+
/**
|
|
6802
|
+
* Quantity of the given item.
|
|
6803
|
+
*/
|
|
6804
|
+
quantity?: number;
|
|
6805
|
+
itemPrice?: ResourceItemPrice;
|
|
6806
|
+
/**
|
|
6807
|
+
* YRN which identifies the product.
|
|
6808
|
+
* @deprecated
|
|
6809
|
+
*/
|
|
6810
|
+
itemYrn?: string;
|
|
6811
|
+
/**
|
|
6812
|
+
* Line-item identifier (e.g. quote line id).
|
|
6813
|
+
*/
|
|
6814
|
+
itemId?: string;
|
|
6815
|
+
};
|
|
6816
|
+
/**
|
|
6817
|
+
* Per-line price; used for resource line items.
|
|
6818
|
+
*/
|
|
6819
|
+
type ResourceItemPrice = {
|
|
6820
|
+
/**
|
|
6821
|
+
* Currency of the price.
|
|
6822
|
+
*/
|
|
6823
|
+
currency?: string;
|
|
6824
|
+
/**
|
|
6825
|
+
* Deprecated; prefer `unitPrice`, `newUnitPrice`, or `calculatedPrice`.
|
|
6826
|
+
* @deprecated
|
|
6827
|
+
*/
|
|
6828
|
+
amount?: number;
|
|
6829
|
+
/**
|
|
6830
|
+
* Unit net price before adjustments.
|
|
6831
|
+
*/
|
|
6832
|
+
unitPrice?: number;
|
|
6833
|
+
/**
|
|
6834
|
+
* Unit net price after adjustments (valid for quote line items).
|
|
6835
|
+
*/
|
|
6836
|
+
newUnitPrice?: number;
|
|
6837
|
+
calculatedPrice?: CalculatedPrice;
|
|
6838
|
+
};
|
|
6839
|
+
type CalculatedPrice = {
|
|
6840
|
+
price?: {
|
|
6841
|
+
/**
|
|
6842
|
+
* Net value of the price.
|
|
6843
|
+
*/
|
|
6844
|
+
netValue?: number;
|
|
6845
|
+
/**
|
|
6846
|
+
* Gross value of the price.
|
|
6847
|
+
*/
|
|
6848
|
+
grossValue?: number;
|
|
6849
|
+
/**
|
|
6850
|
+
* Tax value of the price.
|
|
6851
|
+
*/
|
|
6852
|
+
taxValue?: number;
|
|
6853
|
+
};
|
|
6854
|
+
};
|
|
6855
|
+
/**
|
|
6856
|
+
* Aggregated price (totals, subtotals) with currency and optional tax breakdown.
|
|
6857
|
+
*/
|
|
6858
|
+
type Price = {
|
|
6859
|
+
/**
|
|
6860
|
+
* Currency of the price.
|
|
6861
|
+
*/
|
|
6862
|
+
currency?: string;
|
|
6863
|
+
/**
|
|
6864
|
+
* Deprecated; use `netValue`, `grossValue`, and `taxValue` when present.
|
|
6865
|
+
* @deprecated
|
|
6866
|
+
*/
|
|
6867
|
+
amount?: number;
|
|
6868
|
+
/**
|
|
6869
|
+
* Net value of the price.
|
|
6870
|
+
*/
|
|
6871
|
+
netValue?: number;
|
|
6872
|
+
/**
|
|
6873
|
+
* Gross value of the price.
|
|
6874
|
+
*/
|
|
6875
|
+
grossValue?: number;
|
|
6876
|
+
/**
|
|
6877
|
+
* Tax value of the price.
|
|
6878
|
+
*/
|
|
6879
|
+
taxValue?: number;
|
|
6880
|
+
};
|
|
6881
|
+
/**
|
|
6882
|
+
* Price value with the currency and tax information.
|
|
6883
|
+
*/
|
|
6884
|
+
type TaxablePrice = {
|
|
6885
|
+
/**
|
|
6886
|
+
* Currency of the price.
|
|
6887
|
+
*/
|
|
6888
|
+
currency?: string;
|
|
6889
|
+
/**
|
|
6890
|
+
* Net value of the price.
|
|
6891
|
+
*/
|
|
6892
|
+
netValue?: number;
|
|
6893
|
+
/**
|
|
6894
|
+
* Gross value of the price.
|
|
6895
|
+
*/
|
|
6896
|
+
grossValue?: number;
|
|
6897
|
+
/**
|
|
6898
|
+
* Tax value of the price.
|
|
6899
|
+
*/
|
|
6900
|
+
taxValue?: number;
|
|
6901
|
+
};
|
|
6902
|
+
/**
|
|
6903
|
+
* delivery window required for order.
|
|
6904
|
+
*/
|
|
6905
|
+
type DeliveryWindow = {
|
|
6906
|
+
/**
|
|
6907
|
+
* Identifier of the delivery window.
|
|
6908
|
+
*/
|
|
6909
|
+
id?: string;
|
|
6910
|
+
/**
|
|
6911
|
+
* Identifier of the slot.
|
|
6912
|
+
*/
|
|
6913
|
+
slotId?: string;
|
|
6914
|
+
/**
|
|
6915
|
+
* Delivery date.
|
|
6916
|
+
*/
|
|
6917
|
+
deliveryDate?: string;
|
|
6918
|
+
};
|
|
6919
|
+
type CreateCartApprovalRequest = GenericApprovalForCreate & {
|
|
6920
|
+
/**
|
|
6921
|
+
* An identifier of the approval document.
|
|
6922
|
+
*/
|
|
6923
|
+
id?: string;
|
|
6924
|
+
/**
|
|
6925
|
+
* An identifier of the approval resource.
|
|
6926
|
+
*/
|
|
6927
|
+
resourceId: string;
|
|
6928
|
+
resourceType: 'CART';
|
|
6929
|
+
details: Details;
|
|
6930
|
+
};
|
|
6931
|
+
type CreateQuoteApprovalRequest = GenericApprovalForCreate & {
|
|
6932
|
+
/**
|
|
6933
|
+
* An identifier of the approval document.
|
|
6934
|
+
*/
|
|
6935
|
+
id?: string;
|
|
6936
|
+
/**
|
|
6937
|
+
* An identifier of the approval resource.
|
|
6938
|
+
*/
|
|
6939
|
+
resourceId: string;
|
|
6940
|
+
resourceType: 'QUOTE';
|
|
6941
|
+
};
|
|
6942
|
+
/**
|
|
6943
|
+
* Approval partial update operation list.
|
|
6944
|
+
*/
|
|
6945
|
+
type UpdateApprovalRequest = Array<{
|
|
6946
|
+
op: 'ADD' | 'REMOVE' | 'REPLACE';
|
|
6947
|
+
path: '/status' | '/details*' | '/comment' | '/approverComment' | '/resource/deliveryWindow*';
|
|
6948
|
+
value?: ApprovalStatus | string | {
|
|
6949
|
+
[key: string]: unknown;
|
|
6950
|
+
} | {
|
|
6951
|
+
[key: string]: unknown;
|
|
6952
|
+
};
|
|
6953
|
+
}>;
|
|
6954
|
+
type BasicMetadata = {
|
|
6955
|
+
/**
|
|
6956
|
+
* Version of the object. The version is required during the update operation because of the optimistic locking mechanism.
|
|
6957
|
+
*/
|
|
6958
|
+
version: number;
|
|
6959
|
+
};
|
|
6960
|
+
type Metadata = BasicMetadata & {
|
|
6961
|
+
/**
|
|
6962
|
+
* Date and time when the object was created. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`
|
|
6963
|
+
*/
|
|
6964
|
+
createdAt: string;
|
|
6965
|
+
/**
|
|
6966
|
+
* Date and time when the object was last modified. The value is approved as an ISO-8601 representation of an Instant. For example: `2022-04-31T13:18:02.379Z`
|
|
6967
|
+
*/
|
|
6968
|
+
modifiedAt: string;
|
|
6969
|
+
};
|
|
6970
|
+
type ApprovalId = {
|
|
6971
|
+
/**
|
|
6972
|
+
* Unique identifier of the created approval.
|
|
6973
|
+
*/
|
|
6974
|
+
id?: string;
|
|
6975
|
+
};
|
|
6976
|
+
type ApprovalPermittedRequest = {
|
|
6977
|
+
resourceType: ResourceType;
|
|
6978
|
+
/**
|
|
6979
|
+
* An identifier of the resource for approval.
|
|
6980
|
+
*/
|
|
6981
|
+
resourceId: string;
|
|
6982
|
+
action: ApprovalAction;
|
|
6983
|
+
};
|
|
6984
|
+
type SearchUsersRequest = {
|
|
6985
|
+
resourceType: ResourceType;
|
|
6986
|
+
/**
|
|
6987
|
+
* An identifier of the resource for approval.
|
|
6988
|
+
*/
|
|
6989
|
+
resourceId: string;
|
|
6990
|
+
action: ApprovalAction;
|
|
6991
|
+
};
|
|
6992
|
+
|
|
6993
|
+
/**
|
|
6994
|
+
* Public types for the Approval Service — stable names aliased over the generated
|
|
6995
|
+
* `approval-service` types (single source of truth; faithful required/optional flags).
|
|
6996
|
+
*
|
|
6997
|
+
* Every endpoint is CustomerAccessToken-only (B2B cart/quote approval workflows).
|
|
6998
|
+
*/
|
|
6999
|
+
|
|
7000
|
+
/** An approval document (read shape). */
|
|
7001
|
+
type Approval = GetApprovalResponse;
|
|
7002
|
+
/** Response of `listApprovals` — a plain array of approvals. */
|
|
7003
|
+
type ApprovalList = Approval[];
|
|
7004
|
+
/** Create body (`POST /approvals`) — a cart or quote approval request. */
|
|
7005
|
+
type ApprovalInput = CreateCartApprovalRequest | CreateQuoteApprovalRequest;
|
|
7006
|
+
/** Partial-update body (`PATCH /approvals/{id}`) — a JSON-Patch op-array. */
|
|
7007
|
+
type ApprovalPatch = UpdateApprovalRequest;
|
|
7008
|
+
/** `POST /approvals` 201 response — the created approval's `{ id }`. */
|
|
7009
|
+
type ApprovalCreated = ApprovalId;
|
|
7010
|
+
/** Body for `checkPermitted` (`POST /approval/permitted`). */
|
|
7011
|
+
type ApprovalPermittedInput = ApprovalPermittedRequest;
|
|
7012
|
+
/** Result of `checkPermitted` — `{ permitted, action, status?, approvalId? }`. */
|
|
7013
|
+
type ApprovalPermittedResult = ApprovalPermittedResponse;
|
|
7014
|
+
/** Body for `searchApprovers` (`POST /search/users`). */
|
|
7015
|
+
type ApprovalUsersQuery = SearchUsersRequest;
|
|
7016
|
+
/** Result of `searchApprovers` — a plain array of approver users. */
|
|
7017
|
+
type ApprovalUsersResult = User[];
|
|
7018
|
+
|
|
7019
|
+
/**
|
|
7020
|
+
* Emporix Approval Service (`/approval/{tenant}/…`): B2B cart/quote approval
|
|
7021
|
+
* workflows — list/view approvals, create an approval request, approve or reject
|
|
7022
|
+
* via JSON-Patch, plus permitted-checks and approver search.
|
|
7023
|
+
*
|
|
7024
|
+
* Every endpoint is **CustomerAccessToken-only**. The trailing `auth` keeps the
|
|
7025
|
+
* SDK's uniform method shape, but a customer token is required in practice — pass
|
|
7026
|
+
* `auth.customer(token)` (the React hooks supply the browser context). The
|
|
7027
|
+
* service token will be rejected by Emporix.
|
|
7028
|
+
*/
|
|
7029
|
+
declare class ApprovalService {
|
|
7030
|
+
private readonly ctx;
|
|
7031
|
+
constructor(ctx: ClientContext);
|
|
7032
|
+
private base;
|
|
7033
|
+
/** List approvals (paged via `pageNumber`/`pageSize`/`sort`/`q`). Returns an array. */
|
|
7034
|
+
listApprovals(query?: Record<string, string | number>, auth?: AuthContext): Promise<ApprovalList>;
|
|
7035
|
+
/** Retrieve a single approval by id. */
|
|
7036
|
+
getApproval(approvalId: string, auth?: AuthContext): Promise<Approval>;
|
|
7037
|
+
/** Create an approval request (cart or quote). Returns the created `{ id }`. */
|
|
7038
|
+
createApproval(input: ApprovalInput, auth?: AuthContext): Promise<ApprovalCreated>;
|
|
7039
|
+
/** Approve/reject/amend an approval via a JSON-Patch op-array (`PATCH`). */
|
|
7040
|
+
updateApproval(approvalId: string, ops: ApprovalPatch, auth?: AuthContext): Promise<void>;
|
|
7041
|
+
/** Delete an approval by id. */
|
|
7042
|
+
deleteApproval(approvalId: string, auth?: AuthContext): Promise<void>;
|
|
7043
|
+
/** Check whether an operation on a resource is permitted / needs approval. */
|
|
7044
|
+
checkPermitted(input: ApprovalPermittedInput, auth?: AuthContext): Promise<ApprovalPermittedResult>;
|
|
7045
|
+
/** Search for users eligible to approve a resource. Returns an array. */
|
|
7046
|
+
searchApprovers(input: ApprovalUsersQuery, auth?: AuthContext): Promise<ApprovalUsersResult>;
|
|
7047
|
+
}
|
|
7048
|
+
|
|
5245
7049
|
/** The Emporix SDK entry point. One instance safely serves many concurrent shoppers. */
|
|
5246
7050
|
declare class EmporixClient {
|
|
5247
7051
|
readonly customers: CustomerService;
|
|
@@ -5283,6 +7087,11 @@ declare class EmporixClient {
|
|
|
5283
7087
|
readonly sepaExport: SepaExportService;
|
|
5284
7088
|
readonly indexing: IndexingService;
|
|
5285
7089
|
readonly units: UnitHandlingService;
|
|
7090
|
+
readonly catalogs: CatalogService;
|
|
7091
|
+
readonly vendors: VendorService;
|
|
7092
|
+
readonly pickPack: PickPackService;
|
|
7093
|
+
readonly customerAdmin: CustomerAdminService;
|
|
7094
|
+
readonly approvals: ApprovalService;
|
|
5286
7095
|
/** The validated tenant this client is bound to. */
|
|
5287
7096
|
readonly tenant: string;
|
|
5288
7097
|
/**
|
|
@@ -5309,4 +7118,4 @@ declare class EmporixClient {
|
|
|
5309
7118
|
getLogLevel(service: ServiceName): LogLevel;
|
|
5310
7119
|
}
|
|
5311
7120
|
|
|
5312
|
-
export { type AddedPoints, type Agent, type AgentInput, type AgentPatchOp, type AgentSearchQuery, AiService, AuthContext, AvailabilityService, type BatchNextIdEntry, type Brand, type BrandInput, type BrandList, BrandService, type BrandUpdate, CartService, CategoryService, type CgRelation, type CgRelationList, type ChatRequest, type ChatResponse, CheckoutService, ClientConfigService, type ClientConfiguration, ClientContext, CompaniesService, type CompletionMessage, type CompletionRequest, type CompletionResponse, type Configuration$1 as Configuration, type ConfigurationDraft, ContactsService, type ConversionFactorInput, type ConversionFactorResult, type ConvertUnitInput, type ConvertUnitResult, type Country, type CountryList, CountryService, type CountryUpdate, type Coupon$1 as Coupon, type CouponCreated, type CouponInput, type CouponList, CouponService, type CouponUpdate, type Currency, type CurrencyCreated, type CurrencyInput, type CurrencyList, CurrencyService, type CurrencyUpdate, type CustomEntity, type CustomEntityDraft, type CustomInstance, type CustomInstanceDraft, CustomerGroupsService, CustomerService, type CustomerSummaryBatch, type DeleteAgentOptions, type DeleteConfigOptions, type DeliveryCreated, type DeliveryCycleInput, type DeliverySlot, type DeliverySlotList, type DeliveryTime, type DeliveryTimeInput, type DeliveryTimeList, type DeliveryTimeUpdate, type DeliveryWindow, type DeliveryWindowList, type DeliveryWindowValidation, EmporixAuthError, EmporixClient, EmporixConfig, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNotFoundError, EmporixServerError, EmporixValidationError, type ExchangeRate, type ExchangeRateCreated, type ExchangeRateInput, type ExchangeRateList, type ExchangeRateUpdate, type Fee$1 as Fee, type FeeDraft, FeeService, type FindSiteInput, type IndexConfig, type IndexConfigCreated, type IndexPublicConfig, IndexingService, type InstanceSearchBody, type ItemFee, type ItemFeeDraft, type ItemFeeSearch, type JobIdResponse, type Label, type LabelInput, type LabelList, LabelService, type LabelUpdate, type ListConfigOptions, type ListCustomEntitiesOptions, type ListFeesQuery, type ListInstancesQuery, type ListSchemasQuery, LocationsService, LogLevel, MediaService, type MetadataFilter, type MinimumFee, type NewPointsEntry, type NextIdCommandRequest, type NextIdOptions, type NextIdResponse, type NextIdsBatchRequest, type NextIdsBatchResponse, OrdersService, PaginatedItems, PaymentGatewayService, type PointsSummary, PriceService, ProductService, type QuoteInput, type QuoteResult, type QuoteSlotInput, 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 ReindexInput, ResolvedConfig, type ResourceCreated, type Return, type ReturnCreated, type ReturnInput, type ReturnList, type ReturnPatch, type ReturnUpdate, ReturnsService, RewardPointsService, SalesOrdersService, type Schema, type SchemaAttribute, type SchemaDraft, SchemaService, type SchemaTypeName, type SchemaUpdate, SegmentService, SepaExportService, type SepaJob, type SepaJobCreated, type SepaJobInput, type SequenceSchema, type SequenceSchemaCreate, SequentialIdService, ServiceName, type SessionContext, type SessionContextPatch, SessionContextService, type SetItemFeesOptions, type ShippingGroup, type ShippingGroupList, type ShippingMethod, type ShippingMethodList, type ShippingPatch, ShippingService, type ShoppingList, type ShoppingListDraft, type ShoppingListItem, ShoppingListService, type Site$1 as Site, type SiteList, SiteService, type TaxCalculationInput, type TaxCalculationRequest, type TaxCalculationResult, type TaxClass, type TaxConfig, type TaxConfigCreated, type TaxCreation as TaxConfigInput, type TaxUpdate as TaxConfigUpdate, type TaxLocation, TaxService, TenantConfigService, type TextRequest, type TextResponse, TokenProvider, type Unit, type UnitCreated, UnitHandlingService, type UnitInput, type UnitUpdate, type WebhookConfig, type WebhookConfigCreated, type WebhookConfigDraft, type WebhookConfigPatch, type WebhookDashboardAccess, WebhookService, type WebhookStatistics, type WebhookStatisticsQuery, type WebhookSubscription, type WebhookSubscriptionUpdateItem, type WebhookSubscriptionUpdateResultItem, type Zone, type ZoneList, errorFromResponse };
|
|
7121
|
+
export { type AddedPoints, type AdminCustomer, type AdminCustomerAddress, type AdminCustomerAddressInput, type AdminCustomerAddressList, type AdminCustomerAddressUpdate, type AdminCustomerCreated, type AdminCustomerInput, type AdminCustomerList, type AdminCustomerPatch, type AdminCustomerSearchQuery, type AdminCustomerUpdate, type Agent, type AgentInput, type AgentPatchOp, type AgentSearchQuery, AiService, type Approval, type ApprovalCreated, type ApprovalInput, type ApprovalList, type ApprovalPatch, type ApprovalPermittedInput, type ApprovalPermittedResult, ApprovalService, type ApprovalUsersQuery, type ApprovalUsersResult, type Assignee, AuthContext, AvailabilityService, type BatchNextIdEntry, type Brand, type BrandInput, type BrandList, BrandService, type BrandUpdate, CartService, type Catalog, type CatalogCreated, type CatalogInput, type CatalogList, type CatalogPatch, CatalogService, type CatalogUpdate, CategoryService, type CgRelation, type CgRelationList, type ChatRequest, type ChatResponse, CheckoutService, ClientConfigService, type ClientConfiguration, ClientContext, CompaniesService, type CompletionMessage, type CompletionRequest, type CompletionResponse, type Configuration$1 as Configuration, type ConfigurationDraft, ContactsService, type ConversionFactorInput, type ConversionFactorResult, type ConvertUnitInput, type ConvertUnitResult, type Country, type CountryList, CountryService, type CountryUpdate, type Coupon$1 as Coupon, type CouponCreated, type CouponInput, type CouponList, CouponService, type CouponUpdate, type Currency, type CurrencyCreated, type CurrencyInput, type CurrencyList, CurrencyService, type CurrencyUpdate, type CustomEntity, type CustomEntityDraft, type CustomInstance, type CustomInstanceDraft, CustomerAdminService, CustomerGroupsService, CustomerService, type CustomerSummaryBatch, type DeleteAgentOptions, type DeleteConfigOptions, type DeliveryCreated, type DeliveryCycleInput, type DeliverySlot, type DeliverySlotList, type DeliveryTime$1 as DeliveryTime, type DeliveryTimeInput, type DeliveryTimeList, type DeliveryTimeUpdate, type DeliveryWindow$2 as DeliveryWindow, type DeliveryWindowList, type DeliveryWindowValidation, EmporixAuthError, EmporixClient, EmporixConfig, EmporixError, EmporixForbiddenError, EmporixInsufficientScopeError, EmporixNotFoundError, EmporixServerError, EmporixValidationError, type ExchangeRate, type ExchangeRateCreated, type ExchangeRateInput, type ExchangeRateList, type ExchangeRateUpdate, type Fee$1 as Fee, type FeeDraft, FeeService, type FindSiteInput, type IndexConfig, type IndexConfigCreated, type IndexPublicConfig, IndexingService, type InstanceSearchBody, type ItemFee, type ItemFeeDraft, type ItemFeeSearch, type JobIdResponse, type Label, type LabelInput, type LabelList, LabelService, type LabelUpdate, type ListConfigOptions, type ListCustomEntitiesOptions, type ListFeesQuery, type ListInstancesQuery, type ListSchemasQuery, LocationsService, LogLevel, MediaService, type MetadataFilter, type MinimumFee, type NewPointsEntry, type NextIdCommandRequest, type NextIdOptions, type NextIdResponse, type NextIdsBatchRequest, type NextIdsBatchResponse, type OrderCycleList, type OrderEntryEventCreate, type OrderStatusChange, OrdersService, type PackagingProductsChange, type PackingEvent, type PackingEventList, PaginatedItems, PaymentGatewayService, type PickOrder, type PickOrderList, type PickPackAck, PickPackService, type PointsSummary, PriceService, ProductService, type QuoteInput, type QuoteResult, type QuoteSlotInput, RagIndexerService, type RagType, type RecalculationJob, type RecalculationJobCreated, type RecalculationJobInput, type RedeemCouponResult, type RedeemMyPointsInput, type RedeemOption, type RedeemOptionList, type RedeemedPoints, type Redemption, type RedemptionCreated, type RedemptionInput, type ReferralCoupon, type Region, type RegionList, type ReindexInput, ResolvedConfig, type ResourceCreated, type Return, type ReturnCreated, type ReturnInput, type ReturnList, type ReturnPatch, type ReturnUpdate, ReturnsService, RewardPointsService, SalesOrdersService, type Schema, type SchemaAttribute, type SchemaDraft, SchemaService, type SchemaTypeName, type SchemaUpdate, SegmentService, SepaExportService, type SepaJob, type SepaJobCreated, type SepaJobInput, type SequenceSchema, type SequenceSchemaCreate, SequentialIdService, ServiceName, type SessionContext, type SessionContextPatch, SessionContextService, type SetItemFeesOptions, type ShippingGroup, type ShippingGroupList, type ShippingMethod, type ShippingMethodList, type ShippingPatch, ShippingService, type ShoppingList, type ShoppingListDraft, type ShoppingListItem, ShoppingListService, type Site$1 as Site, type SiteList, SiteService, type TaxCalculationInput, type TaxCalculationRequest, type TaxCalculationResult, type TaxClass, type TaxConfig, type TaxConfigCreated, type TaxCreation as TaxConfigInput, type TaxUpdate as TaxConfigUpdate, type TaxLocation, TaxService, TenantConfigService, type TextRequest, type TextResponse, TokenProvider, type Unit, type UnitCreated, UnitHandlingService, type UnitInput, type UnitUpdate, type Vendor, type VendorCreated, type VendorInput, type VendorList, type VendorLocation, type VendorLocationInput, type VendorLocationList, type VendorLocationUpdate, type VendorSearchQuery, VendorService, type VendorUpdate, type WebhookConfig, type WebhookConfigCreated, type WebhookConfigDraft, type WebhookConfigPatch, type WebhookDashboardAccess, WebhookService, type WebhookStatistics, type WebhookStatisticsQuery, type WebhookSubscription, type WebhookSubscriptionUpdateItem, type WebhookSubscriptionUpdateResultItem, type Zone, type ZoneList, errorFromResponse };
|